diff --git a/.changeset/paragraph-text-align.md b/.changeset/paragraph-text-align.md new file mode 100644 index 0000000000..10c551b42b --- /dev/null +++ b/.changeset/paragraph-text-align.md @@ -0,0 +1,5 @@ +--- +'@shopify/ui-extensions': patch +--- + +Add `textAlign` prop to the checkout `Paragraph` component, supporting `'start'`, `'end'`, `'center'`, and `'auto'` values. diff --git a/packages/ui-extensions/docs/surfaces/checkout/generated/generated_docs_data.json b/packages/ui-extensions/docs/surfaces/checkout/generated/generated_docs_data.json index 19e7b684dc..193f93b32f 100644 --- a/packages/ui-extensions/docs/surfaces/checkout/generated/generated_docs_data.json +++ b/packages/ui-extensions/docs/surfaces/checkout/generated/generated_docs_data.json @@ -565,7 +565,7 @@ "syntaxKind": "MethodSignature", "name": "applyShippingAddressChange", "value": "(change: ShippingAddressUpdateChange) => Promise", - "description": "Updates the buyer's shipping address on the checkout. The provided fields are merged into the existing address without prompting the buyer. On success, the `shippingAddress` property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", + "description": "Updates the buyer's shipping address on the checkout. The provided fields are merged into the existing address without prompting the buyer. On success, the `shippingAddress` property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", "isOptional": true } ], @@ -2301,7 +2301,7 @@ "syntaxKind": "PropertySignature", "name": "analytics", "value": "Analytics", - "description": "The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event." + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details." } ], "value": "export interface Docs_Standard_AnalyticsApi\n extends Pick {}" @@ -2309,24 +2309,24 @@ "Analytics": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Analytics", - "description": "", + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "publish", "value": "(name: string, data: Record) => Promise", - "description": "Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing)." + "description": "Publishes a custom event to [Web Pixels](/docs/apps/marketing). Returns `true` when the event is successfully dispatched.\n\nThe Promise resolves to `true` when the event was dispatched. The boolean indicates dispatch confirmation only. It doesn't indicate whether any specific web pixel processed the event." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "visitor", "value": "(data: { email?: string; phone?: string; }) => Promise", - "description": "A method for capturing details about a visitor on the online store." + "description": "Submits buyer contact details for attribution and analytics purposes." } ], - "value": "export interface Analytics {\n /**\n * Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing).\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * A method for capturing details about a visitor on the online store.\n */\n visitor(data: {email?: string; phone?: string}): Promise;\n}" + "value": "export interface Analytics {\n /**\n * Publishes a custom event to [Web Pixels](/docs/apps/marketing).\n * Returns `true` when the event is successfully dispatched.\n *\n * The Promise resolves to `true` when the event was dispatched. The boolean\n * indicates dispatch confirmation only. It doesn't indicate whether any\n * specific web pixel processed the event.\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * Submits buyer contact details for attribution and analytics purposes.\n */\n visitor(data: {email?: string; phone?: string}): Promise;\n}" }, "VisitorResult": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -2367,10 +2367,10 @@ "syntaxKind": "PropertySignature", "name": "type", "value": "'error'", - "description": "Indicates that the visitor information is invalid and wasn't submitted. Examples are using the wrong data type or missing a required property." + "description": "Indicates that the visitor information is invalid and wasn't submitted. Common causes include using the wrong data type or omitting a required property." } ], - "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Examples are using the wrong data type or missing a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Common causes include using the wrong data type or omitting a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" } } } @@ -2529,7 +2529,7 @@ "syntaxKind": "PropertySignature", "name": "value", "value": "string", - "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.", + "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.\n\nAttribute values are always strings. To store structured data, serialize it to JSON and parse it when reading.", "examples": [ { "title": "Example", @@ -2544,7 +2544,7 @@ ] } ], - "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" + "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * Attribute values are always strings. To store structured data, serialize\n * it to JSON and parse it when reading.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" } } }, @@ -2564,7 +2564,7 @@ "syntaxKind": "MethodSignature", "name": "applyAttributeChange", "value": "(change: AttributeChange) => Promise", - "description": "Updates or removes an attribute on the cart and checkout. On success, the [`attributes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/attributes#standardapi-propertydetail-attributes) property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.", + "description": "Updates or removes an attribute on the cart and checkout. On success, the [`attributes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/attributes#properties-propertydetail-attributes) property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.", "deprecationMessage": "Use cart metafields instead." } ], @@ -2635,7 +2635,7 @@ "syntaxKind": "PropertySignature", "name": "value", "value": "string", - "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.", + "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.\n\nAttribute values are always strings. To store structured data, serialize it to JSON and parse it when reading.", "examples": [ { "title": "Example", @@ -2650,7 +2650,7 @@ ] } ], - "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" + "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * Attribute values are always strings. To store structured data, serialize\n * it to JSON and parse it when reading.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" }, "AttributeRemoveChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -2804,7 +2804,7 @@ "syntaxKind": "PropertySignature", "name": "value", "value": "string", - "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.", + "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.\n\nAttribute values are always strings. To store structured data, serialize it to JSON and parse it when reading.", "examples": [ { "title": "Example", @@ -2819,7 +2819,7 @@ ] } ], - "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" + "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * Attribute values are always strings. To store structured data, serialize\n * it to JSON and parse it when reading.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" }, "AttributeRemoveChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -2937,7 +2937,7 @@ "syntaxKind": "PropertySignature", "name": "value", "value": "string", - "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.", + "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.\n\nAttribute values are always strings. To store structured data, serialize it to JSON and parse it when reading.", "examples": [ { "title": "Example", @@ -2952,7 +2952,7 @@ ] } ], - "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" + "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * Attribute values are always strings. To store structured data, serialize\n * it to JSON and parse it when reading.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" } } }, @@ -3204,7 +3204,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A globally-unique identifier for the customer in the format `gid://shopify/Customer/`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", + "description": "An identifier for the customer in the format `gid://shopify/Customer/`. This value is unique per shop.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", "examples": [ { "title": "Example", @@ -3257,7 +3257,7 @@ "isPrivate": true } ], - "value": "export interface Customer {\n /**\n * A globally-unique identifier for the customer in the format `gid://shopify/Customer/`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'gid://shopify/Customer/123'\n */\n id: string;\n /**\n * The email address associated with the customer's account. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email?: string;\n /**\n * The phone number associated with the customer's account. The value is `undefined` if no phone number is on file or the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone?: string;\n /**\n * The customer's full name, typically a combination of first and last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n fullName?: string;\n /**\n * The customer's first name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n firstName?: string;\n /**\n * The customer's last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n lastName?: string;\n /**\n * The customer's profile image, such as a Gravatar avatar. Use this to personalize the extension UI for the logged-in buyer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n image: ImageDetails;\n /**\n * Whether the customer has opted in to receiving marketing communications from the merchant, such as email campaigns and promotional offers.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * > Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n *\n * @deprecated Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n */\n acceptsMarketing: boolean;\n /**\n * Whether the customer has opted in to email marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsEmailMarketing: boolean;\n /**\n * Whether the customer has opted in to SMS marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsSmsMarketing: boolean;\n /**\n * The store credit accounts owned by this customer that can be used as payment during checkout. Each account has a balance representing available store credit.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @private\n */\n storeCreditAccounts: StoreCreditAccount[];\n /**\n * The number of orders the customer has previously placed with this shop.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n ordersCount: number;\n}" + "value": "export interface Customer {\n /**\n * An identifier for the customer in the format `gid://shopify/Customer/`. This value is unique per shop.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'gid://shopify/Customer/123'\n */\n id: string;\n /**\n * The email address associated with the customer's account. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email?: string;\n /**\n * The phone number associated with the customer's account. The value is `undefined` if no phone number is on file or the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone?: string;\n /**\n * The customer's full name, typically a combination of first and last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n fullName?: string;\n /**\n * The customer's first name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n firstName?: string;\n /**\n * The customer's last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n lastName?: string;\n /**\n * The customer's profile image, such as a Gravatar avatar. Use this to personalize the extension UI for the logged-in buyer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n image: ImageDetails;\n /**\n * Whether the customer has opted in to receiving marketing communications from the merchant, such as email campaigns and promotional offers.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * > Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n *\n * @deprecated Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n */\n acceptsMarketing: boolean;\n /**\n * Whether the customer has opted in to email marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsEmailMarketing: boolean;\n /**\n * Whether the customer has opted in to SMS marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsSmsMarketing: boolean;\n /**\n * The store credit accounts owned by this customer that can be used as payment during checkout. Each account has a balance representing available store credit.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @private\n */\n storeCreditAccounts: StoreCreditAccount[];\n /**\n * The number of orders the customer has previously placed with this shop.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n ordersCount: number;\n}" }, "ImageDetails": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -3540,7 +3540,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A globally-unique identifier for the customer in the format `gid://shopify/Customer/`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", + "description": "An identifier for the customer in the format `gid://shopify/Customer/`. This value is unique per shop.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", "examples": [ { "title": "Example", @@ -3593,7 +3593,7 @@ "isPrivate": true } ], - "value": "export interface Customer {\n /**\n * A globally-unique identifier for the customer in the format `gid://shopify/Customer/`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'gid://shopify/Customer/123'\n */\n id: string;\n /**\n * The email address associated with the customer's account. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email?: string;\n /**\n * The phone number associated with the customer's account. The value is `undefined` if no phone number is on file or the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone?: string;\n /**\n * The customer's full name, typically a combination of first and last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n fullName?: string;\n /**\n * The customer's first name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n firstName?: string;\n /**\n * The customer's last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n lastName?: string;\n /**\n * The customer's profile image, such as a Gravatar avatar. Use this to personalize the extension UI for the logged-in buyer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n image: ImageDetails;\n /**\n * Whether the customer has opted in to receiving marketing communications from the merchant, such as email campaigns and promotional offers.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * > Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n *\n * @deprecated Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n */\n acceptsMarketing: boolean;\n /**\n * Whether the customer has opted in to email marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsEmailMarketing: boolean;\n /**\n * Whether the customer has opted in to SMS marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsSmsMarketing: boolean;\n /**\n * The store credit accounts owned by this customer that can be used as payment during checkout. Each account has a balance representing available store credit.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @private\n */\n storeCreditAccounts: StoreCreditAccount[];\n /**\n * The number of orders the customer has previously placed with this shop.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n ordersCount: number;\n}" + "value": "export interface Customer {\n /**\n * An identifier for the customer in the format `gid://shopify/Customer/`. This value is unique per shop.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'gid://shopify/Customer/123'\n */\n id: string;\n /**\n * The email address associated with the customer's account. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email?: string;\n /**\n * The phone number associated with the customer's account. The value is `undefined` if no phone number is on file or the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone?: string;\n /**\n * The customer's full name, typically a combination of first and last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n fullName?: string;\n /**\n * The customer's first name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n firstName?: string;\n /**\n * The customer's last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n lastName?: string;\n /**\n * The customer's profile image, such as a Gravatar avatar. Use this to personalize the extension UI for the logged-in buyer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n image: ImageDetails;\n /**\n * Whether the customer has opted in to receiving marketing communications from the merchant, such as email campaigns and promotional offers.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * > Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n *\n * @deprecated Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n */\n acceptsMarketing: boolean;\n /**\n * Whether the customer has opted in to email marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsEmailMarketing: boolean;\n /**\n * Whether the customer has opted in to SMS marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsSmsMarketing: boolean;\n /**\n * The store credit accounts owned by this customer that can be used as payment during checkout. Each account has a balance representing available store credit.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @private\n */\n storeCreditAccounts: StoreCreditAccount[];\n /**\n * The number of orders the customer has previously placed with this shop.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n ordersCount: number;\n}" }, "ImageDetails": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -4076,11 +4076,11 @@ "syntaxKind": "MethodSignature", "name": "perform", "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", + "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.\n\nRuns after all intercept results are collected. Use it for local state updates such as setting an error flag. By the time it runs, the navigation decision is final, so blocking logic belongs in the intercept handler itself, not here.", "isOptional": true } ], - "value": "interface InterceptorRequestAllow {\n /**\n * Indicates that the interceptor allows the buyer's journey to continue.\n */\n behavior: 'allow';\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" + "value": "interface InterceptorRequestAllow {\n /**\n * Indicates that the interceptor allows the buyer's journey to continue.\n */\n behavior: 'allow';\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n *\n * Runs after all intercept results are collected. Use it for local state\n * updates such as setting an error flag. By the time it runs, the navigation\n * decision is final, so blocking logic belongs in the intercept handler\n * itself, not here.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" }, "InterceptorResult": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -4144,7 +4144,7 @@ "syntaxKind": "MethodSignature", "name": "perform", "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", + "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.\n\nRuns after all intercept results are collected. Use it for local state updates such as setting an error flag. By the time it runs, the navigation decision is final, so blocking logic belongs in the intercept handler itself, not here.", "isOptional": true }, { @@ -4155,7 +4155,7 @@ "description": "The reason for blocking the interceptor request. This value isn't presented to the buyer, so it doesn't need to be localized. The value is used only for Shopify's own internal debugging and metrics." } ], - "value": "interface InterceptorRequestBlock {\n /**\n * Indicates that the interceptor blocks the buyer's journey from continuing.\n */\n behavior: 'block';\n\n /**\n * The reason for blocking the interceptor request. This value isn't presented to\n * the buyer, so it doesn't need to be localized. The value is used only for Shopify's\n * own internal debugging and metrics.\n */\n reason: string;\n\n /**\n * Used to pass errors to the checkout UI, outside your extension's UI boundaries.\n */\n errors?: ValidationError[];\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" + "value": "interface InterceptorRequestBlock {\n /**\n * Indicates that the interceptor blocks the buyer's journey from continuing.\n */\n behavior: 'block';\n\n /**\n * The reason for blocking the interceptor request. This value isn't presented to\n * the buyer, so it doesn't need to be localized. The value is used only for Shopify's\n * own internal debugging and metrics.\n */\n reason: string;\n\n /**\n * Used to pass errors to the checkout UI, outside your extension's UI boundaries.\n */\n errors?: ValidationError[];\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n *\n * Runs after all intercept results are collected. Use it for local state\n * updates such as setting an error flag. By the time it runs, the navigation\n * decision is final, so blocking logic belongs in the intercept handler\n * itself, not here.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" }, "ValidationError": { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -4426,11 +4426,11 @@ "syntaxKind": "MethodSignature", "name": "perform", "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", + "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.\n\nRuns after all intercept results are collected. Use it for local state updates such as setting an error flag. By the time it runs, the navigation decision is final, so blocking logic belongs in the intercept handler itself, not here.", "isOptional": true } ], - "value": "interface InterceptorRequestAllow {\n /**\n * Indicates that the interceptor allows the buyer's journey to continue.\n */\n behavior: 'allow';\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" + "value": "interface InterceptorRequestAllow {\n /**\n * Indicates that the interceptor allows the buyer's journey to continue.\n */\n behavior: 'allow';\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n *\n * Runs after all intercept results are collected. Use it for local state\n * updates such as setting an error flag. By the time it runs, the navigation\n * decision is final, so blocking logic belongs in the intercept handler\n * itself, not here.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" }, "InterceptorResult": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -4494,7 +4494,7 @@ "syntaxKind": "MethodSignature", "name": "perform", "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", + "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.\n\nRuns after all intercept results are collected. Use it for local state updates such as setting an error flag. By the time it runs, the navigation decision is final, so blocking logic belongs in the intercept handler itself, not here.", "isOptional": true }, { @@ -4505,7 +4505,7 @@ "description": "The reason for blocking the interceptor request. This value isn't presented to the buyer, so it doesn't need to be localized. The value is used only for Shopify's own internal debugging and metrics." } ], - "value": "interface InterceptorRequestBlock {\n /**\n * Indicates that the interceptor blocks the buyer's journey from continuing.\n */\n behavior: 'block';\n\n /**\n * The reason for blocking the interceptor request. This value isn't presented to\n * the buyer, so it doesn't need to be localized. The value is used only for Shopify's\n * own internal debugging and metrics.\n */\n reason: string;\n\n /**\n * Used to pass errors to the checkout UI, outside your extension's UI boundaries.\n */\n errors?: ValidationError[];\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" + "value": "interface InterceptorRequestBlock {\n /**\n * Indicates that the interceptor blocks the buyer's journey from continuing.\n */\n behavior: 'block';\n\n /**\n * The reason for blocking the interceptor request. This value isn't presented to\n * the buyer, so it doesn't need to be localized. The value is used only for Shopify's\n * own internal debugging and metrics.\n */\n reason: string;\n\n /**\n * Used to pass errors to the checkout UI, outside your extension's UI boundaries.\n */\n errors?: ValidationError[];\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n *\n * Runs after all intercept results are collected. Use it for local state\n * updates such as setting an error flag. By the time it runs, the navigation\n * decision is final, so blocking logic belongs in the intercept handler\n * itself, not here.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" }, "ValidationError": { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -4708,11 +4708,11 @@ "syntaxKind": "MethodSignature", "name": "perform", "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", + "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.\n\nRuns after all intercept results are collected. Use it for local state updates such as setting an error flag. By the time it runs, the navigation decision is final, so blocking logic belongs in the intercept handler itself, not here.", "isOptional": true } ], - "value": "interface InterceptorRequestAllow {\n /**\n * Indicates that the interceptor allows the buyer's journey to continue.\n */\n behavior: 'allow';\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" + "value": "interface InterceptorRequestAllow {\n /**\n * Indicates that the interceptor allows the buyer's journey to continue.\n */\n behavior: 'allow';\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n *\n * Runs after all intercept results are collected. Use it for local state\n * updates such as setting an error flag. By the time it runs, the navigation\n * decision is final, so blocking logic belongs in the intercept handler\n * itself, not here.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" }, "InterceptorResult": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -4776,7 +4776,7 @@ "syntaxKind": "MethodSignature", "name": "perform", "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", + "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.\n\nRuns after all intercept results are collected. Use it for local state updates such as setting an error flag. By the time it runs, the navigation decision is final, so blocking logic belongs in the intercept handler itself, not here.", "isOptional": true }, { @@ -4787,7 +4787,7 @@ "description": "The reason for blocking the interceptor request. This value isn't presented to the buyer, so it doesn't need to be localized. The value is used only for Shopify's own internal debugging and metrics." } ], - "value": "interface InterceptorRequestBlock {\n /**\n * Indicates that the interceptor blocks the buyer's journey from continuing.\n */\n behavior: 'block';\n\n /**\n * The reason for blocking the interceptor request. This value isn't presented to\n * the buyer, so it doesn't need to be localized. The value is used only for Shopify's\n * own internal debugging and metrics.\n */\n reason: string;\n\n /**\n * Used to pass errors to the checkout UI, outside your extension's UI boundaries.\n */\n errors?: ValidationError[];\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" + "value": "interface InterceptorRequestBlock {\n /**\n * Indicates that the interceptor blocks the buyer's journey from continuing.\n */\n behavior: 'block';\n\n /**\n * The reason for blocking the interceptor request. This value isn't presented to\n * the buyer, so it doesn't need to be localized. The value is used only for Shopify's\n * own internal debugging and metrics.\n */\n reason: string;\n\n /**\n * Used to pass errors to the checkout UI, outside your extension's UI boundaries.\n */\n errors?: ValidationError[];\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n *\n * Runs after all intercept results are collected. Use it for local state\n * updates such as setting an error flag. By the time it runs, the navigation\n * decision is final, so blocking logic belongs in the intercept handler\n * itself, not here.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" }, "ValidationError": { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -5100,7 +5100,7 @@ "syntaxKind": "PropertySignature", "name": "instructions", "value": "SubscribableSignalLike", - "description": "The cart instructions used to create the checkout and possibly limit extension capabilities.\n\nThese instructions should be checked before performing any actions that might be affected by them.\n\nFor example, if you intend to add a discount code via the `applyDiscountCodeChange` method, check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n\n> Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs aren't available. See the [update guide](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples) for more information." + "description": "The cart instructions used to create the checkout and possibly limit extension capabilities.\n\nThese instructions should be checked before performing any actions that might be affected by them.\n\nFor example, if you intend to add a discount code via the `applyDiscountCodeChange` method, check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n\n> Caution: Check cart instructions before calling select APIs, as > some may not be available. See the > [Cart Instructions API](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples) > for more information." } ], "value": "export interface Docs_Standard_CartInstructionsApi\n extends Pick {}" @@ -5784,7 +5784,7 @@ "syntaxKind": "PropertySignature", "name": "value", "value": "string", - "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.", + "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.\n\nAttribute values are always strings. To store structured data, serialize it to JSON and parse it when reading.", "examples": [ { "title": "Example", @@ -5799,7 +5799,7 @@ ] } ], - "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" + "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * Attribute values are always strings. To store structured data, serialize\n * it to JSON and parse it when reading.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" }, "CartLineCost": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -6405,7 +6405,7 @@ "syntaxKind": "PropertySignature", "name": "value", "value": "string", - "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.", + "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.\n\nAttribute values are always strings. To store structured data, serialize it to JSON and parse it when reading.", "examples": [ { "title": "Example", @@ -6420,7 +6420,7 @@ ] } ], - "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" + "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * Attribute values are always strings. To store structured data, serialize\n * it to JSON and parse it when reading.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" }, "CartLineCost": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -6918,7 +6918,7 @@ "syntaxKind": "MethodSignature", "name": "applyCartLinesChange", "value": "(change: CartLineChange) => Promise", - "description": "Adds, removes, or updates line items in the cart. The returned promise resolves when the change has been applied by the server, and the [`lines`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-lines#standardapi-propertydetail-lines) property updates with the new state.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Adds, removes, or updates line items in the cart. The returned promise resolves when the change has been applied by the server, and the [`lines`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-lines#properties-propertydetail-lines) property updates with the new state.\n\nAccepts a single change per call. To make multiple changes, call this method separately for each one.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." } ], "value": "export interface Docs_Checkout_CartLinesApi\n extends Pick {}" @@ -7024,7 +7024,7 @@ "syntaxKind": "PropertySignature", "name": "value", "value": "string", - "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.", + "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.\n\nAttribute values are always strings. To store structured data, serialize it to JSON and parse it when reading.", "examples": [ { "title": "Example", @@ -7039,7 +7039,7 @@ ] } ], - "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" + "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * Attribute values are always strings. To store structured data, serialize\n * it to JSON and parse it when reading.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" }, "CartLine": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -7754,7 +7754,7 @@ "syntaxKind": "PropertySignature", "name": "message", "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer." + "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer.\n\nRender your own localized error text rather than displaying this message to the buyer." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -7764,7 +7764,7 @@ "description": "Indicates that the line item wasn't changed successfully. Refer to the `message` property for details about the error." } ], - "value": "export interface CartLineChangeResultError {\n /**\n * Indicates that the line item wasn't changed successfully. Refer to the `message` property for details about the error.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface CartLineChangeResultError {\n /**\n * Indicates that the line item wasn't changed successfully. Refer to the `message` property for details about the error.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n *\n * Render your own localized error text rather than displaying this message\n * to the buyer.\n */\n message: string;\n}" } } }, @@ -7888,7 +7888,7 @@ "syntaxKind": "PropertySignature", "name": "value", "value": "string", - "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.", + "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.\n\nAttribute values are always strings. To store structured data, serialize it to JSON and parse it when reading.", "examples": [ { "title": "Example", @@ -7903,7 +7903,7 @@ ] } ], - "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" + "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * Attribute values are always strings. To store structured data, serialize\n * it to JSON and parse it when reading.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" }, "CartLine": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -8618,7 +8618,7 @@ "syntaxKind": "PropertySignature", "name": "message", "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer." + "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer.\n\nRender your own localized error text rather than displaying this message to the buyer." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -8628,7 +8628,7 @@ "description": "Indicates that the line item wasn't changed successfully. Refer to the `message` property for details about the error." } ], - "value": "export interface CartLineChangeResultError {\n /**\n * Indicates that the line item wasn't changed successfully. Refer to the `message` property for details about the error.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface CartLineChangeResultError {\n /**\n * Indicates that the line item wasn't changed successfully. Refer to the `message` property for details about the error.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n *\n * Render your own localized error text rather than displaying this message\n * to the buyer.\n */\n message: string;\n}" } } }, @@ -8648,7 +8648,7 @@ "syntaxKind": "PropertySignature", "name": "target", "value": "SubscribableSignalLike", - "description": "The cart line that this extension is attached to. Use this to read the line item's merchandise, quantity, cost, and attributes.\n\n> Note: Until version `2023-04`, this property was a `ReadonlySignalLike`." + "description": "The cart line that this extension is attached to. Use this to read the line item's merchandise, quantity, cost, and attributes.\n\nAvailable only on the corresponding item target. Shipping option item targets expose shipping option properties; pickup location item targets expose pickup location properties.\n\n> Note: Until version `2023-04`, this property was a `ReadonlySignalLike`." } ], "value": "export interface Docs_CartLineItem_CartLinesApi\n extends Pick {}" @@ -8796,7 +8796,7 @@ "syntaxKind": "PropertySignature", "name": "value", "value": "string", - "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.", + "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.\n\nAttribute values are always strings. To store structured data, serialize it to JSON and parse it when reading.", "examples": [ { "title": "Example", @@ -8811,7 +8811,7 @@ ] } ], - "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" + "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * Attribute values are always strings. To store structured data, serialize\n * it to JSON and parse it when reading.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" }, "CartLineCost": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -9417,7 +9417,7 @@ "syntaxKind": "PropertySignature", "name": "value", "value": "string", - "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.", + "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.\n\nAttribute values are always strings. To store structured data, serialize it to JSON and parse it when reading.", "examples": [ { "title": "Example", @@ -9432,7 +9432,7 @@ ] } ], - "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" + "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * Attribute values are always strings. To store structured data, serialize\n * it to JSON and parse it when reading.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" }, "CartLineCost": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -10038,7 +10038,7 @@ "syntaxKind": "PropertySignature", "name": "value", "value": "string", - "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.", + "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.\n\nAttribute values are always strings. To store structured data, serialize it to JSON and parse it when reading.", "examples": [ { "title": "Example", @@ -10053,7 +10053,7 @@ ] } ], - "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" + "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * Attribute values are always strings. To store structured data, serialize\n * it to JSON and parse it when reading.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" }, "CartLineCost": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -10600,7 +10600,7 @@ "syntaxKind": "PropertySignature", "name": "checkoutToken", "value": "SubscribableSignalLike", - "description": "A stable ID that represents the current checkout.\n\nThe value is `undefined` when the checkout hasn't been created on the server yet.\n\nUse this to correlate checkout sessions across your extension, web pixels, and backend systems.\n\nThis matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data) and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object)." + "description": "A stable ID that represents the current checkout.\n\nThe value is `undefined` when the checkout hasn't been created on the server yet.\n\nUse this to correlate checkout sessions across your extension, web pixels, and backend systems.\n\nThis matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data) and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n\nCan be `undefined`. Handle the `undefined` state before using the value." } ], "value": "export interface Docs_Standard_CheckoutTokenApi\n extends Pick {}" @@ -10761,17 +10761,17 @@ "syntaxKind": "PropertySignature", "name": "totalShippingAmount", "value": "SubscribableSignalLike", - "description": "The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step." + "description": "The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step.\n\n`undefined` until the buyer selects a shipping method (typically after the information step)." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "totalTaxAmount", "value": "SubscribableSignalLike", - "description": "The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet." + "description": "The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet.\n\n`undefined` when taxes haven't been calculated or aren't available for the buyer's region." } ], - "value": "export interface CartCost {\n /**\n * The sum of all line item prices at the current step of checkout, before shipping and taxes are applied. Use this value to display the base cost of the items the buyer purchased.\n */\n subtotalAmount: SubscribableSignalLike;\n\n /**\n * The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step.\n */\n totalShippingAmount: SubscribableSignalLike;\n\n /**\n * The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet.\n */\n totalTaxAmount: SubscribableSignalLike;\n\n /**\n * The minimum total at the current step of checkout. Costs not yet calculated, such as shipping on the information step, aren't included. Gift cards and store credits are excluded from this total.\n */\n totalAmount: SubscribableSignalLike;\n}" + "value": "export interface CartCost {\n /**\n * The sum of all line item prices at the current step of checkout, before shipping and taxes are applied. Use this value to display the base cost of the items the buyer purchased.\n */\n subtotalAmount: SubscribableSignalLike;\n\n /**\n * The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step.\n *\n * `undefined` until the buyer selects a shipping method (typically after the\n * information step).\n */\n totalShippingAmount: SubscribableSignalLike;\n\n /**\n * The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet.\n *\n * `undefined` when taxes haven't been calculated or aren't available for the\n * buyer's region.\n */\n totalTaxAmount: SubscribableSignalLike;\n\n /**\n * The minimum total at the current step of checkout. Costs not yet calculated, such as shipping on the information step, aren't included. Gift cards and store credits are excluded from this total.\n */\n totalAmount: SubscribableSignalLike;\n}" }, "SubscribableSignalLike": { "filePath": "src/surfaces/checkout/shared.ts", @@ -11155,7 +11155,7 @@ "syntaxKind": "PropertySignature", "name": "applyTrackingConsentChange", "value": "ApplyTrackingConsentChangeType", - "description": "Enables setting and updating customer privacy consent settings and tracking consent metafields.\n\n> Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent) to be set to `true`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." + "description": "Enables setting and updating customer privacy consent settings and tracking consent metafields.\n\n> Note: Requires the [`collect_buyer_consent` capability](/docs/apps/build/customer-accounts/capabilities#collect-buyer-consent) to be set to `true`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." }, { "filePath": "src/surfaces/checkout/api/docs.ts", @@ -11271,10 +11271,10 @@ "syntaxKind": "PropertySignature", "name": "value", "value": "string | null", - "description": "The new value to store in the metafield. Set to `null` to delete the metafield." + "description": "The new value to store in the metafield. Set to `null` to delete the metafield.\n\nConsent metafield values are strings, not booleans. Pass `null` to delete a tracking consent metafield." } ], - "value": "export interface TrackingConsentMetafieldChange {\n /**\n * The identifier for the tracking consent metafield to update.\n */\n key: string;\n /**\n * The new value to store in the metafield. Set to `null` to delete the metafield.\n */\n value: string | null;\n}" + "value": "export interface TrackingConsentMetafieldChange {\n /**\n * The identifier for the tracking consent metafield to update.\n */\n key: string;\n /**\n * The new value to store in the metafield. Set to `null` to delete the metafield.\n *\n * Consent metafield values are strings, not booleans. Pass `null` to delete\n * a tracking consent metafield.\n */\n value: string | null;\n}" }, "VisitorConsent": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -11483,31 +11483,31 @@ "syntaxKind": "PropertySignature", "name": "analytics", "value": "boolean", - "description": "Whether analytics data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Analytics data includes how the shop was used and what interactions occurred." + "description": "Whether analytics data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Analytics data includes how the shop was used and what interactions occurred.\n\nWhether analytics data can be collected right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.analytics`, before calling `shopify.analytics.publish()`." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "marketing", "value": "boolean", - "description": "Whether marketing data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Marketing data includes attribution and targeted advertising preferences." + "description": "Whether marketing data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Marketing data includes attribution and targeted advertising preferences.\n\nWhether marketing data can be collected right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.marketing`, before performing marketing-related data collection." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "preferences", "value": "boolean", - "description": "Whether preference data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Preference data includes language, currency, and sizing choices." + "description": "Whether preference data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Preference data includes language, currency, and sizing choices.\n\nWhether preference data can be collected right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.preferences`, before storing or reading buyer preference data." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "saleOfData", "value": "boolean", - "description": "Whether data can be shared with third parties based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. This typically applies to behavioral advertising data." + "description": "Whether data can be shared with third parties based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. This typically applies to behavioral advertising data.\n\nWhether buyer data can be shared with or sold to third parties right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.saleOfData`, before sharing or selling buyer data with third parties." } ], - "value": "export interface AllowedProcessing {\n /**\n * Whether analytics data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Analytics\n * data includes how the shop was used and what interactions occurred.\n */\n analytics: boolean;\n /**\n * Whether marketing data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Marketing\n * data includes attribution and targeted advertising preferences.\n */\n marketing: boolean;\n /**\n * Whether preference data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Preference\n * data includes language, currency, and sizing choices.\n */\n preferences: boolean;\n /**\n * Whether data can be shared with third parties based on the visitor's\n * consent, the merchant's privacy configuration, and the visitor's region.\n * This typically applies to behavioral advertising data.\n */\n saleOfData: boolean;\n}" + "value": "export interface AllowedProcessing {\n /**\n * Whether analytics data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Analytics\n * data includes how the shop was used and what interactions occurred.\n *\n * Whether analytics data can be collected right now. Combines the buyer's\n * consent, the merchant's privacy configuration, and the buyer's region into\n * a single boolean. Check this flag, not `visitorConsent.analytics`, before\n * calling `shopify.analytics.publish()`.\n */\n analytics: boolean;\n /**\n * Whether marketing data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Marketing\n * data includes attribution and targeted advertising preferences.\n *\n * Whether marketing data can be collected right now. Combines the buyer's\n * consent, the merchant's privacy configuration, and the buyer's region into\n * a single boolean. Check this flag, not `visitorConsent.marketing`, before\n * performing marketing-related data collection.\n */\n marketing: boolean;\n /**\n * Whether preference data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Preference\n * data includes language, currency, and sizing choices.\n *\n * Whether preference data can be collected right now. Combines the buyer's\n * consent, the merchant's privacy configuration, and the buyer's region into\n * a single boolean. Check this flag, not `visitorConsent.preferences`,\n * before storing or reading buyer preference data.\n */\n preferences: boolean;\n /**\n * Whether data can be shared with third parties based on the visitor's\n * consent, the merchant's privacy configuration, and the visitor's region.\n * This typically applies to behavioral advertising data.\n *\n * Whether buyer data can be shared with or sold to third parties right now.\n * Combines the buyer's consent, the merchant's privacy configuration, and\n * the buyer's region into a single boolean. Check this flag, not\n * `visitorConsent.saleOfData`, before sharing or selling buyer data with\n * third parties.\n */\n saleOfData: boolean;\n}" }, "TrackingConsentMetafield": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -11692,31 +11692,31 @@ "syntaxKind": "PropertySignature", "name": "analytics", "value": "boolean", - "description": "Whether analytics data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Analytics data includes how the shop was used and what interactions occurred." + "description": "Whether analytics data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Analytics data includes how the shop was used and what interactions occurred.\n\nWhether analytics data can be collected right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.analytics`, before calling `shopify.analytics.publish()`." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "marketing", "value": "boolean", - "description": "Whether marketing data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Marketing data includes attribution and targeted advertising preferences." + "description": "Whether marketing data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Marketing data includes attribution and targeted advertising preferences.\n\nWhether marketing data can be collected right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.marketing`, before performing marketing-related data collection." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "preferences", "value": "boolean", - "description": "Whether preference data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Preference data includes language, currency, and sizing choices." + "description": "Whether preference data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Preference data includes language, currency, and sizing choices.\n\nWhether preference data can be collected right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.preferences`, before storing or reading buyer preference data." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "saleOfData", "value": "boolean", - "description": "Whether data can be shared with third parties based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. This typically applies to behavioral advertising data." + "description": "Whether data can be shared with third parties based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. This typically applies to behavioral advertising data.\n\nWhether buyer data can be shared with or sold to third parties right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.saleOfData`, before sharing or selling buyer data with third parties." } ], - "value": "export interface AllowedProcessing {\n /**\n * Whether analytics data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Analytics\n * data includes how the shop was used and what interactions occurred.\n */\n analytics: boolean;\n /**\n * Whether marketing data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Marketing\n * data includes attribution and targeted advertising preferences.\n */\n marketing: boolean;\n /**\n * Whether preference data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Preference\n * data includes language, currency, and sizing choices.\n */\n preferences: boolean;\n /**\n * Whether data can be shared with third parties based on the visitor's\n * consent, the merchant's privacy configuration, and the visitor's region.\n * This typically applies to behavioral advertising data.\n */\n saleOfData: boolean;\n}" + "value": "export interface AllowedProcessing {\n /**\n * Whether analytics data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Analytics\n * data includes how the shop was used and what interactions occurred.\n *\n * Whether analytics data can be collected right now. Combines the buyer's\n * consent, the merchant's privacy configuration, and the buyer's region into\n * a single boolean. Check this flag, not `visitorConsent.analytics`, before\n * calling `shopify.analytics.publish()`.\n */\n analytics: boolean;\n /**\n * Whether marketing data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Marketing\n * data includes attribution and targeted advertising preferences.\n *\n * Whether marketing data can be collected right now. Combines the buyer's\n * consent, the merchant's privacy configuration, and the buyer's region into\n * a single boolean. Check this flag, not `visitorConsent.marketing`, before\n * performing marketing-related data collection.\n */\n marketing: boolean;\n /**\n * Whether preference data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Preference\n * data includes language, currency, and sizing choices.\n *\n * Whether preference data can be collected right now. Combines the buyer's\n * consent, the merchant's privacy configuration, and the buyer's region into\n * a single boolean. Check this flag, not `visitorConsent.preferences`,\n * before storing or reading buyer preference data.\n */\n preferences: boolean;\n /**\n * Whether data can be shared with third parties based on the visitor's\n * consent, the merchant's privacy configuration, and the visitor's region.\n * This typically applies to behavioral advertising data.\n *\n * Whether buyer data can be shared with or sold to third parties right now.\n * Combines the buyer's consent, the merchant's privacy configuration, and\n * the buyer's region into a single boolean. Check this flag, not\n * `visitorConsent.saleOfData`, before sharing or selling buyer data with\n * third parties.\n */\n saleOfData: boolean;\n}" }, "TrackingConsentMetafield": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -11903,7 +11903,7 @@ "syntaxKind": "PropertySignature", "name": "deliveryGroups", "value": "SubscribableSignalLike", - "description": "The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items." + "description": "The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n\nEmpty until the buyer enters enough address information for Shopify to calculate shipping rates." } ], "value": "export interface Docs_Standard_DeliveryApi\n extends Pick {}" @@ -13699,7 +13699,7 @@ "syntaxKind": "PropertySignature", "name": "value", "value": "string", - "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.", + "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.\n\nAttribute values are always strings. To store structured data, serialize it to JSON and parse it when reading.", "examples": [ { "title": "Example", @@ -13714,7 +13714,7 @@ ] } ], - "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" + "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * Attribute values are always strings. To store structured data, serialize\n * it to JSON and parse it when reading.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" }, "CartLineCost": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -14976,7 +14976,7 @@ "syntaxKind": "PropertySignature", "name": "isTargetSelected", "value": "SubscribableSignalLike", - "description": "Whether the buyer has selected the target shipping option. When `true`, the target option is the buyer's active choice. When `false`, the buyer has chosen a different shipping option." + "description": "Whether the buyer has selected the target shipping option. When `true`, the target option is the buyer's active choice. When `false`, the buyer has chosen a different shipping option.\n\nAvailable only on the corresponding item target. Shipping option item targets expose shipping option properties; pickup location item targets expose pickup location properties." }, { "filePath": "src/surfaces/checkout/api/shipping/shipping-option-item.ts", @@ -14990,10 +14990,10 @@ "syntaxKind": "PropertySignature", "name": "target", "value": "SubscribableSignalLike", - "description": "The shipping option that this extension is attached to. Use this to read the option's cost, carrier, delivery estimate, and other details." + "description": "The shipping option that this extension is attached to. Use this to read the option's cost, carrier, delivery estimate, and other details.\n\nAvailable only on the corresponding item target. Shipping option item targets expose shipping option properties; pickup location item targets expose pickup location properties." } ], - "value": "export interface ShippingOptionItemApi {\n /**\n * The shipping option that this extension is attached to. Use this to read the option's cost, carrier, delivery estimate, and other details.\n */\n target: SubscribableSignalLike;\n\n /**\n * Whether the buyer has selected the target shipping option. When `true`, the target option is the buyer's active choice. When `false`, the buyer has chosen a different shipping option.\n */\n isTargetSelected: SubscribableSignalLike;\n\n /**\n * The render mode of this shipping option, indicating how the extension is displayed in the checkout UI.\n */\n renderMode: ShippingOptionItemRenderMode;\n}" + "value": "export interface ShippingOptionItemApi {\n /**\n * The shipping option that this extension is attached to. Use this to read the option's cost, carrier, delivery estimate, and other details.\n *\n * Available only on the corresponding item target. Shipping option item\n * targets expose shipping option properties; pickup location item targets\n * expose pickup location properties.\n */\n target: SubscribableSignalLike;\n\n /**\n * Whether the buyer has selected the target shipping option. When `true`, the target option is the buyer's active choice. When `false`, the buyer has chosen a different shipping option.\n *\n * Available only on the corresponding item target. Shipping option item\n * targets expose shipping option properties; pickup location item targets\n * expose pickup location properties.\n */\n isTargetSelected: SubscribableSignalLike;\n\n /**\n * The render mode of this shipping option, indicating how the extension is displayed in the checkout UI.\n */\n renderMode: ShippingOptionItemRenderMode;\n}" }, "SubscribableSignalLike": { "filePath": "src/surfaces/checkout/shared.ts", @@ -18259,10 +18259,10 @@ "syntaxKind": "PropertySignature", "name": "isLocationFormVisible", "value": "SubscribableSignalLike", - "description": "Whether the location search form is currently visible to the buyer. Use this to conditionally render UI that depends on the buyer actively searching for pickup points." + "description": "Reflects which view was active when the extension loaded. When the buyer moves to the next view, the extension restarts with the current value rather than updating in place." } ], - "value": "export interface PickupPointListApi {\n /**\n * Whether the location search form is currently visible to the buyer.\n * Use this to conditionally render UI that depends on the buyer actively\n * searching for pickup points.\n */\n isLocationFormVisible: SubscribableSignalLike;\n}" + "value": "export interface PickupPointListApi {\n /**\n * Reflects which view was active when the extension loaded. When the\n * buyer moves to the next view, the extension restarts with the\n * current value rather than updating in place.\n */\n isLocationFormVisible: SubscribableSignalLike;\n}" }, "SubscribableSignalLike": { "filePath": "src/surfaces/checkout/shared.ts", @@ -18381,17 +18381,17 @@ "syntaxKind": "PropertySignature", "name": "isTargetSelected", "value": "SubscribableSignalLike", - "description": "Whether the buyer has selected the target pickup location. When `true`, the target location is the buyer's active choice. When `false`, the buyer has chosen a different pickup location." + "description": "Whether the buyer has selected the target pickup location. When `true`, the target location is the buyer's active choice. When `false`, the buyer has chosen a different pickup location.\n\nAvailable only on the corresponding item target. Shipping option item targets expose shipping option properties; pickup location item targets expose pickup location properties." }, { "filePath": "src/surfaces/checkout/api/pickup/pickup-location-item.ts", "syntaxKind": "PropertySignature", "name": "target", "value": "SubscribableSignalLike", - "description": "The pickup location that this extension is attached to. Use this to read the location's name, address, and other details." + "description": "The pickup location that this extension is attached to. Use this to read the location's name, address, and other details.\n\nAvailable only on the corresponding item target. Shipping option item targets expose shipping option properties; pickup location item targets expose pickup location properties." } ], - "value": "export interface PickupLocationItemApi {\n /**\n * The pickup location that this extension is attached to. Use this to read the location's name, address, and other details.\n */\n target: SubscribableSignalLike;\n\n /**\n * Whether the buyer has selected the target pickup location. When `true`, the target location is the buyer's active choice. When `false`, the buyer has chosen a different pickup location.\n */\n isTargetSelected: SubscribableSignalLike;\n}" + "value": "export interface PickupLocationItemApi {\n /**\n * The pickup location that this extension is attached to. Use this to read the location's name, address, and other details.\n *\n * Available only on the corresponding item target. Shipping option item\n * targets expose shipping option properties; pickup location item targets\n * expose pickup location properties.\n */\n target: SubscribableSignalLike;\n\n /**\n * Whether the buyer has selected the target pickup location. When `true`, the target location is the buyer's active choice. When `false`, the buyer has chosen a different pickup location.\n *\n * Available only on the corresponding item target. Shipping option item\n * targets expose shipping option properties; pickup location item targets\n * expose pickup location properties.\n */\n isTargetSelected: SubscribableSignalLike;\n}" }, "SubscribableSignalLike": { "filePath": "src/surfaces/checkout/shared.ts", @@ -19548,7 +19548,7 @@ "syntaxKind": "MethodSignature", "name": "applyDiscountCodeChange", "value": "(change: DiscountCodeChange) => Promise", - "description": "Adds or removes a discount code on the checkout. The returned promise resolves when the change has been applied by the server, and the [`discountCodes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/discounts#standardapi-propertydetail-discountcodes) property updates with the new state.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves discount codes through a network call.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Adds or removes a discount code on the checkout. The returned promise resolves when the change has been applied by the server, and the [`discountCodes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/discounts#properties-propertydetail-discountcodes) property updates with the new state.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves discount codes through a network call.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." } ], "value": "export interface Docs_Checkout_DiscountsApi\n extends Pick {}" @@ -20010,7 +20010,7 @@ "syntaxKind": "PropertySignature", "name": "extension", "value": "Extension", - "description": "The meta information about the extension." + "description": "Metadata about the running extension, including the current target, API version, capabilities, and editor context. Use this to conditionally render content based on where the extension is running." } ], "value": "export interface Docs_Standard_ExtensionMetaApi\n extends Pick {}" @@ -20018,7 +20018,7 @@ "Extension": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Extension", - "description": "The meta information about an extension target.", + "description": "Metadata about the running extension, including its API version, target, capabilities, and editor context. Use this to read configuration details or conditionally render content based on where the extension is running.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -20044,7 +20044,7 @@ "syntaxKind": "PropertySignature", "name": "capabilities", "value": "SubscribableSignalLike", - "description": "The allowed capabilities of the extension, defined in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n\n* [`api_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#api-access): the extension can access the Storefront API.\n\n* [`network_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access): the extension can make external network calls.\n\n* [`block_progress`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n\n* [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n\n* [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can register customer consent decisions that are honored on Shopify-managed services.\n\n* [`iframe.sources`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#iframe): the extension can embed an external URL in an iframe." + "description": "The allowed capabilities of the extension, defined in your [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -20092,7 +20092,7 @@ "syntaxKind": "PropertySignature", "name": "version", "value": "string", - "description": "The published version of the running extension target.\n\nFor unpublished extensions, the value is `undefined`.", + "description": "The published version of the running extension target.\n\nFor unpublished extensions, the value is `undefined`.\n\nDon't use this property as a stable identifier in development environments. It becomes available only after the extension is published.", "isOptional": true, "examples": [ { @@ -20108,7 +20108,7 @@ ] } ], - "value": "export interface Extension {\n /**\n * The API version that was set in the extension config file.\n *\n * @example '2024-10', '2025-01', '2025-04', '2025-07', '2025-10'\n */\n apiVersion: ApiVersion;\n\n /**\n * The allowed capabilities of the extension, defined\n * in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n *\n * * [`api_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#api-access): the extension can access the Storefront API.\n *\n * * [`network_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access): the extension can make external network calls.\n *\n * * [`block_progress`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n *\n * * [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n *\n * * [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can register customer consent decisions that are honored on Shopify-managed services.\n *\n * * [`iframe.sources`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#iframe): the extension can embed an external URL in an iframe.\n */\n capabilities: SubscribableSignalLike;\n\n /**\n * Information about the editor where the extension is being rendered.\n *\n * If the value is undefined, then the extension isn't running in an editor.\n */\n editor?: Editor;\n\n /**\n * A Boolean to show whether your extension is currently rendered to the screen.\n *\n * Shopify might render your extension before it's visible in the UI,\n * typically to pre-render extensions that appear on a later step of the\n * checkout.\n *\n * Your extension might also continue to run after the customer has navigated away\n * from where it was rendered. The extension continues running so that\n * your extension is immediately available to render if the customer navigates back.\n */\n rendered: SubscribableSignalLike;\n\n /**\n * The URL to the script that started the extension target.\n */\n scriptUrl: string;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n */\n target: Target;\n\n /**\n * The published version of the running extension target.\n *\n * For unpublished extensions, the value is `undefined`.\n *\n * @example 3.0.10\n */\n version?: string;\n}" + "value": "export interface Extension {\n /**\n * The API version that was set in the extension config file.\n *\n * @example '2024-10', '2025-01', '2025-04', '2025-07', '2025-10'\n */\n apiVersion: ApiVersion;\n\n /**\n * The allowed capabilities of the extension, defined in your\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n */\n capabilities: SubscribableSignalLike;\n\n /**\n * Information about the editor where the extension is being rendered.\n *\n * If the value is undefined, then the extension isn't running in an editor.\n */\n editor?: Editor;\n\n /**\n * A Boolean to show whether your extension is currently rendered to the screen.\n *\n * Shopify might render your extension before it's visible in the UI,\n * typically to pre-render extensions that appear on a later step of the\n * checkout.\n *\n * Your extension might also continue to run after the customer has navigated away\n * from where it was rendered. The extension continues running so that\n * your extension is immediately available to render if the customer navigates back.\n */\n rendered: SubscribableSignalLike;\n\n /**\n * The URL to the script that started the extension target.\n */\n scriptUrl: string;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n */\n target: Target;\n\n /**\n * The published version of the running extension target.\n *\n * For unpublished extensions, the value is `undefined`.\n *\n * Don't use this property as a stable identifier in development environments.\n * It becomes available only after the extension is published.\n *\n * @example 3.0.10\n */\n version?: string;\n}" }, "ApiVersion": { "filePath": "src/shared.ts", @@ -20165,7 +20165,7 @@ "Editor": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Editor", - "description": "", + "description": "Information about the editor environment when an extension is rendered inside the checkout editor. The value is `undefined` when the extension is not rendering in an editor.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -20201,7 +20201,7 @@ "Extension": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Extension", - "description": "The meta information about an extension target.", + "description": "Metadata about the running extension, including its API version, target, capabilities, and editor context. Use this to read configuration details or conditionally render content based on where the extension is running.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -20227,7 +20227,7 @@ "syntaxKind": "PropertySignature", "name": "capabilities", "value": "SubscribableSignalLike", - "description": "The allowed capabilities of the extension, defined in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n\n* [`api_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#api-access): the extension can access the Storefront API.\n\n* [`network_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access): the extension can make external network calls.\n\n* [`block_progress`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n\n* [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n\n* [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can register customer consent decisions that are honored on Shopify-managed services.\n\n* [`iframe.sources`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#iframe): the extension can embed an external URL in an iframe." + "description": "The allowed capabilities of the extension, defined in your [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -20275,7 +20275,7 @@ "syntaxKind": "PropertySignature", "name": "version", "value": "string", - "description": "The published version of the running extension target.\n\nFor unpublished extensions, the value is `undefined`.", + "description": "The published version of the running extension target.\n\nFor unpublished extensions, the value is `undefined`.\n\nDon't use this property as a stable identifier in development environments. It becomes available only after the extension is published.", "isOptional": true, "examples": [ { @@ -20291,7 +20291,7 @@ ] } ], - "value": "export interface Extension {\n /**\n * The API version that was set in the extension config file.\n *\n * @example '2024-10', '2025-01', '2025-04', '2025-07', '2025-10'\n */\n apiVersion: ApiVersion;\n\n /**\n * The allowed capabilities of the extension, defined\n * in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n *\n * * [`api_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#api-access): the extension can access the Storefront API.\n *\n * * [`network_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access): the extension can make external network calls.\n *\n * * [`block_progress`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n *\n * * [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n *\n * * [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can register customer consent decisions that are honored on Shopify-managed services.\n *\n * * [`iframe.sources`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#iframe): the extension can embed an external URL in an iframe.\n */\n capabilities: SubscribableSignalLike;\n\n /**\n * Information about the editor where the extension is being rendered.\n *\n * If the value is undefined, then the extension isn't running in an editor.\n */\n editor?: Editor;\n\n /**\n * A Boolean to show whether your extension is currently rendered to the screen.\n *\n * Shopify might render your extension before it's visible in the UI,\n * typically to pre-render extensions that appear on a later step of the\n * checkout.\n *\n * Your extension might also continue to run after the customer has navigated away\n * from where it was rendered. The extension continues running so that\n * your extension is immediately available to render if the customer navigates back.\n */\n rendered: SubscribableSignalLike;\n\n /**\n * The URL to the script that started the extension target.\n */\n scriptUrl: string;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n */\n target: Target;\n\n /**\n * The published version of the running extension target.\n *\n * For unpublished extensions, the value is `undefined`.\n *\n * @example 3.0.10\n */\n version?: string;\n}" + "value": "export interface Extension {\n /**\n * The API version that was set in the extension config file.\n *\n * @example '2024-10', '2025-01', '2025-04', '2025-07', '2025-10'\n */\n apiVersion: ApiVersion;\n\n /**\n * The allowed capabilities of the extension, defined in your\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n */\n capabilities: SubscribableSignalLike;\n\n /**\n * Information about the editor where the extension is being rendered.\n *\n * If the value is undefined, then the extension isn't running in an editor.\n */\n editor?: Editor;\n\n /**\n * A Boolean to show whether your extension is currently rendered to the screen.\n *\n * Shopify might render your extension before it's visible in the UI,\n * typically to pre-render extensions that appear on a later step of the\n * checkout.\n *\n * Your extension might also continue to run after the customer has navigated away\n * from where it was rendered. The extension continues running so that\n * your extension is immediately available to render if the customer navigates back.\n */\n rendered: SubscribableSignalLike;\n\n /**\n * The URL to the script that started the extension target.\n */\n scriptUrl: string;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n */\n target: Target;\n\n /**\n * The published version of the running extension target.\n *\n * For unpublished extensions, the value is `undefined`.\n *\n * Don't use this property as a stable identifier in development environments.\n * It becomes available only after the extension is published.\n *\n * @example 3.0.10\n */\n version?: string;\n}" }, "ApiVersion": { "filePath": "src/shared.ts", @@ -20348,7 +20348,7 @@ "Editor": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Editor", - "description": "", + "description": "Information about the editor environment when an extension is rendered inside the checkout editor. The value is `undefined` when the extension is not rendering in an editor.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -20384,7 +20384,7 @@ "Extension": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Extension", - "description": "The meta information about an extension target.", + "description": "Metadata about the running extension, including its API version, target, capabilities, and editor context. Use this to read configuration details or conditionally render content based on where the extension is running.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -20410,7 +20410,7 @@ "syntaxKind": "PropertySignature", "name": "capabilities", "value": "SubscribableSignalLike", - "description": "The allowed capabilities of the extension, defined in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n\n* [`api_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#api-access): the extension can access the Storefront API.\n\n* [`network_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access): the extension can make external network calls.\n\n* [`block_progress`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n\n* [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n\n* [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can register customer consent decisions that are honored on Shopify-managed services.\n\n* [`iframe.sources`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#iframe): the extension can embed an external URL in an iframe." + "description": "The allowed capabilities of the extension, defined in your [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -20458,7 +20458,7 @@ "syntaxKind": "PropertySignature", "name": "version", "value": "string", - "description": "The published version of the running extension target.\n\nFor unpublished extensions, the value is `undefined`.", + "description": "The published version of the running extension target.\n\nFor unpublished extensions, the value is `undefined`.\n\nDon't use this property as a stable identifier in development environments. It becomes available only after the extension is published.", "isOptional": true, "examples": [ { @@ -20474,7 +20474,7 @@ ] } ], - "value": "export interface Extension {\n /**\n * The API version that was set in the extension config file.\n *\n * @example '2024-10', '2025-01', '2025-04', '2025-07', '2025-10'\n */\n apiVersion: ApiVersion;\n\n /**\n * The allowed capabilities of the extension, defined\n * in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n *\n * * [`api_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#api-access): the extension can access the Storefront API.\n *\n * * [`network_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access): the extension can make external network calls.\n *\n * * [`block_progress`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n *\n * * [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n *\n * * [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can register customer consent decisions that are honored on Shopify-managed services.\n *\n * * [`iframe.sources`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#iframe): the extension can embed an external URL in an iframe.\n */\n capabilities: SubscribableSignalLike;\n\n /**\n * Information about the editor where the extension is being rendered.\n *\n * If the value is undefined, then the extension isn't running in an editor.\n */\n editor?: Editor;\n\n /**\n * A Boolean to show whether your extension is currently rendered to the screen.\n *\n * Shopify might render your extension before it's visible in the UI,\n * typically to pre-render extensions that appear on a later step of the\n * checkout.\n *\n * Your extension might also continue to run after the customer has navigated away\n * from where it was rendered. The extension continues running so that\n * your extension is immediately available to render if the customer navigates back.\n */\n rendered: SubscribableSignalLike;\n\n /**\n * The URL to the script that started the extension target.\n */\n scriptUrl: string;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n */\n target: Target;\n\n /**\n * The published version of the running extension target.\n *\n * For unpublished extensions, the value is `undefined`.\n *\n * @example 3.0.10\n */\n version?: string;\n}" + "value": "export interface Extension {\n /**\n * The API version that was set in the extension config file.\n *\n * @example '2024-10', '2025-01', '2025-04', '2025-07', '2025-10'\n */\n apiVersion: ApiVersion;\n\n /**\n * The allowed capabilities of the extension, defined in your\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n */\n capabilities: SubscribableSignalLike;\n\n /**\n * Information about the editor where the extension is being rendered.\n *\n * If the value is undefined, then the extension isn't running in an editor.\n */\n editor?: Editor;\n\n /**\n * A Boolean to show whether your extension is currently rendered to the screen.\n *\n * Shopify might render your extension before it's visible in the UI,\n * typically to pre-render extensions that appear on a later step of the\n * checkout.\n *\n * Your extension might also continue to run after the customer has navigated away\n * from where it was rendered. The extension continues running so that\n * your extension is immediately available to render if the customer navigates back.\n */\n rendered: SubscribableSignalLike;\n\n /**\n * The URL to the script that started the extension target.\n */\n scriptUrl: string;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n */\n target: Target;\n\n /**\n * The published version of the running extension target.\n *\n * For unpublished extensions, the value is `undefined`.\n *\n * Don't use this property as a stable identifier in development environments.\n * It becomes available only after the extension is published.\n *\n * @example 3.0.10\n */\n version?: string;\n}" }, "ApiVersion": { "filePath": "src/shared.ts", @@ -20531,7 +20531,7 @@ "Editor": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Editor", - "description": "", + "description": "Information about the editor environment when an extension is rendered inside the checkout editor. The value is `undefined` when the extension is not rendering in an editor.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -20630,7 +20630,7 @@ "Editor": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Editor", - "description": "", + "description": "Information about the editor environment when an extension is rendered inside the checkout editor. The value is `undefined` when the extension is not rendering in an editor.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -20827,7 +20827,7 @@ "syntaxKind": "MethodSignature", "name": "applyGiftCardChange", "value": "(change: GiftCardChange) => Promise", - "description": "Adds or removes a gift card from the checkout. The returned promise resolves when the change has been applied by the server, and the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/gift-cards#standardapi-propertydetail-appliedgiftcards) property updates with the new state.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves gift card codes through a network call.\n\n> Note: This method returns an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Adds or removes a gift card from the checkout. The returned promise resolves when the change has been applied by the server, and the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/gift-cards#properties-propertydetail-appliedgiftcards) property updates with the new state.\n\nUnlike other write operations, gift card changes aren't gated by a cart instruction flag.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves gift card codes through a network call.\n\n> Note: This method returns an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." } ], "value": "export interface Docs_Checkout_GiftCardsApi\n extends Pick {}" @@ -20915,7 +20915,7 @@ "syntaxKind": "PropertySignature", "name": "message", "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer." + "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer.\n\nRender your own localized error text rather than displaying this message to the buyer." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -20925,7 +20925,7 @@ "description": "Indicates that the gift card change couldn't be applied. Check the `message` property for details." } ], - "value": "export interface GiftCardChangeResultError {\n /**\n * Indicates that the gift card change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface GiftCardChangeResultError {\n /**\n * Indicates that the gift card change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n *\n * Render your own localized error text rather than displaying this message\n * to the buyer.\n */\n message: string;\n}" } } }, @@ -21122,7 +21122,7 @@ "syntaxKind": "PropertySignature", "name": "message", "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer." + "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer.\n\nRender your own localized error text rather than displaying this message to the buyer." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -21132,7 +21132,7 @@ "description": "Indicates that the gift card change couldn't be applied. Check the `message` property for details." } ], - "value": "export interface GiftCardChangeResultError {\n /**\n * Indicates that the gift card change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface GiftCardChangeResultError {\n /**\n * Indicates that the gift card change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n *\n * Render your own localized error text rather than displaying this message\n * to the buyer.\n */\n message: string;\n}" } } } @@ -21188,14 +21188,14 @@ "syntaxKind": "PropertySignature", "name": "i18n", "value": "I18n", - "description": "Utilities for translating content and formatting values according to the current [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) of the checkout.\n\nRefer to [`localization` examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples) for more information." + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use alongside [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) to build fully localized extensions." }, { "filePath": "src/surfaces/checkout/api/docs.ts", "syntaxKind": "PropertySignature", "name": "localization", "value": "Localization", - "description": "The details about the location, language, and currency of the customer. For utilities to easily format and translate content based on these details, you can use the [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n) object instead." + "description": "The buyer's language, country, currency, and timezone context. For formatting and translation helpers, use the [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#properties-propertydetail-i18n) object instead." } ], "value": "export interface Docs_Standard_LocalizationApi\n extends Pick {}" @@ -21203,7 +21203,7 @@ "I18n": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18n", - "description": "", + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use the I18n API alongside the Localization API to build fully localized extensions.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -21239,21 +21239,21 @@ "I18nTranslate": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18nTranslate", - "description": "This returns a translated string matching a key in a locale file.", + "description": "Translates a key from your extension's locale files into a localized string. Supports interpolation with placeholder replacements and pluralization via the special `count` option.", "members": [], "value": "export interface I18nTranslate {\n (\n key: string,\n options?: Record,\n ): ReplacementType extends string | number\n ? string\n : (string | ReplacementType)[];\n}" }, "Localization": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Localization", - "description": "", + "description": "The buyer's language, country, currency, and timezone context. Use this to adapt your extension to the buyer's region and display localized content.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "country", "value": "SubscribableSignalLike", - "description": "The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown." + "description": "The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n\nDerived from the buyer's shipping address. Returns `undefined` until the buyer enters a shipping address." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -21281,18 +21281,18 @@ "syntaxKind": "PropertySignature", "name": "market", "value": "SubscribableSignalLike", - "description": "The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n\n> Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.", - "deprecationMessage": "Deprecated as of version `2025-04`" + "description": "The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. The market context updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.", + "deprecationMessage": "Merchants now manage which extensions load for each\nmarket, so extensions no longer need to check this value." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "timezone", "value": "SubscribableSignalLike", - "description": "The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time." + "description": "The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time." } ], - "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n *\n * > Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" + "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n *\n * Derived from the buyer's shipping address. Returns `undefined` until the\n * buyer enters a shipping address.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout,\n * carried over from the cart context. Markets group countries and\n * regions with shared pricing, languages, and domains. The market\n * context updates when the buyer changes the country of their\n * shipping address. The value is `undefined` if the market is unknown.\n *\n * @deprecated Merchants now manage which extensions load for each\n * market, so extensions no longer need to check this value.\n */\n market: SubscribableSignalLike;\n}" }, "SubscribableSignalLike": { "filePath": "src/surfaces/checkout/shared.ts", @@ -21710,7 +21710,7 @@ "I18nTranslate": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18nTranslate", - "description": "This returns a translated string matching a key in a locale file.", + "description": "Translates a key from your extension's locale files into a localized string. Supports interpolation with placeholder replacements and pluralization via the special `count` option.", "members": [], "value": "export interface I18nTranslate {\n (\n key: string,\n options?: Record,\n ): ReplacementType extends string | number\n ? string\n : (string | ReplacementType)[];\n}" } @@ -21989,7 +21989,7 @@ "UseLocalizedFieldGeneratedType": { "filePath": "src/surfaces/checkout/preact/localized-fields.ts", "name": "UseLocalizedFieldGeneratedType", - "description": "Returns the current localized field or undefined for the specified localized field key and re-renders your component if the value changes.", + "description": "Returns the current localized field or undefined for the specified localized field key and re-renders your component if the value changes.\n\nReturns `undefined` when no field is configured for the buyer's country.", "isPublicDocs": true, "params": [ { @@ -22742,7 +22742,7 @@ "syntaxKind": "MethodSignature", "name": "applyMetafieldChange", "value": "(change: MetafieldChange) => Promise", - "description": "Creates, updates, or removes a cart metafield on the checkout. On success, the [`metafields`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/metafields#standardapi-propertydetail-metafields) property updates to reflect the change.\n\nCart metafields are copied to order metafields at order creation time if there's a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n\n> Caution: `MetafieldRemoveChange` and `MetafieldUpdateChange` are deprecated. Use cart metafields with `MetafieldRemoveCartChange` and `MetafieldUpdateCartChange` instead. If `MetafieldUpdateChange` writes a metafield with the same namespace and key as a cart metafield that's configured to copy, the cart metafield won't be copied.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Creates, updates, or removes a cart metafield on the checkout. On success, the [`metafields`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/metafields#properties-propertydetail-metafields) property updates to reflect the change.\n\nCart metafields are copied to order metafields at order creation time if there's a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n\n> Caution: `MetafieldRemoveChange` and `MetafieldUpdateChange` are deprecated. Use cart metafields with `MetafieldRemoveCartChange` and `MetafieldUpdateCartChange` instead. If `MetafieldUpdateChange` writes a metafield with the same namespace and key as a cart metafield that's configured to copy, the cart metafield won't be copied.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." } ], "value": "export interface Docs_Checkout_MetafieldsApi\n extends Pick {}" @@ -23006,7 +23006,7 @@ "syntaxKind": "PropertySignature", "name": "message", "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer." + "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer.\n\nRender your own localized error text rather than displaying this message to the buyer." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -23016,7 +23016,7 @@ "description": "Indicates that the metafield change couldn't be applied. Check the `message` property for details." } ], - "value": "export interface MetafieldChangeResultError {\n /**\n * Indicates that the metafield change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface MetafieldChangeResultError {\n /**\n * Indicates that the metafield change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n *\n * Render your own localized error text rather than displaying this message\n * to the buyer.\n */\n message: string;\n}" } } }, @@ -23298,7 +23298,7 @@ "syntaxKind": "PropertySignature", "name": "message", "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer." + "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer.\n\nRender your own localized error text rather than displaying this message to the buyer." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -23308,7 +23308,7 @@ "description": "Indicates that the metafield change couldn't be applied. Check the `message` property for details." } ], - "value": "export interface MetafieldChangeResultError {\n /**\n * Indicates that the metafield change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface MetafieldChangeResultError {\n /**\n * Indicates that the metafield change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n *\n * Render your own localized error text rather than displaying this message\n * to the buyer.\n */\n message: string;\n}" } } } @@ -23464,7 +23464,7 @@ "syntaxKind": "MethodSignature", "name": "applyNoteChange", "value": "(change: NoteChange) => Promise", - "description": "Sets or removes the buyer's note on the checkout. On success, the [`note`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/note#standardapi-propertydetail-note) property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Sets or removes the buyer's note on the checkout. On success, the [`note`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/note#properties-propertydetail-note) property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." } ], "value": "export interface Docs_Checkout_NoteApi\n extends Pick {}" @@ -23545,7 +23545,7 @@ "syntaxKind": "PropertySignature", "name": "message", "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer." + "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer.\n\nRender your own localized error text rather than displaying this message to the buyer." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -23555,7 +23555,7 @@ "description": "Indicates that the note change couldn't be applied. Check the `message` property for details." } ], - "value": "export interface NoteChangeResultError {\n /**\n * Indicates that the note change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface NoteChangeResultError {\n /**\n * Indicates that the note change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n *\n * Render your own localized error text rather than displaying this message\n * to the buyer.\n */\n message: string;\n}" } } }, @@ -23654,7 +23654,7 @@ "syntaxKind": "PropertySignature", "name": "message", "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer." + "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer.\n\nRender your own localized error text rather than displaying this message to the buyer." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -23664,7 +23664,7 @@ "description": "Indicates that the note change couldn't be applied. Check the `message` property for details." } ], - "value": "export interface NoteChangeResultError {\n /**\n * Indicates that the note change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface NoteChangeResultError {\n /**\n * Indicates that the note change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n *\n * Render your own localized error text rather than displaying this message\n * to the buyer.\n */\n message: string;\n}" } } } @@ -23792,7 +23792,7 @@ "syntaxKind": "PropertySignature", "name": "number", "value": "string", - "description": "A randomly generated alpha-numeric identifier for the order, distinct from `order.id`. The value is `undefined` for orders that were created before this field was introduced. All recent orders have a number.", + "description": "A randomly generated alpha-numeric identifier for the order, distinct from `order.id`. The value is `undefined` for orders that were created before this field was introduced. All recent orders have a number.\n\nOptional. Might not be present for orders created before 2024.", "isOptional": true }, { @@ -23803,7 +23803,7 @@ "description": "" } ], - "value": "export interface OrderConfirmation {\n order: {\n /**\n * A globally unique identifier for the order. This becomes the\n * [`Order`](/docs/api/admin-graphql/latest/objects/Order) object ID in the\n * GraphQL Admin API after the order is created.\n *\n * @example 'gid://shopify/Order/123'\n */\n id: string;\n };\n /**\n * A randomly generated alpha-numeric identifier for the order, distinct\n * from `order.id`. The value is `undefined` for orders that were created\n * before this field was introduced. All recent orders have a number.\n */\n number?: string;\n\n /**\n * Whether this is the customer's first completed order with this shop. `true` means the buyer hasn't placed an order here before. Use this to show first-purchase messaging or trigger welcome offers.\n */\n isFirstOrder: boolean;\n}" + "value": "export interface OrderConfirmation {\n order: {\n /**\n * A globally unique identifier for the order. This becomes the\n * [`Order`](/docs/api/admin-graphql/latest/objects/Order) object ID in the\n * GraphQL Admin API after the order is created.\n *\n * @example 'gid://shopify/Order/123'\n */\n id: string;\n };\n /**\n * A randomly generated alpha-numeric identifier for the order, distinct\n * from `order.id`. The value is `undefined` for orders that were created\n * before this field was introduced. All recent orders have a number.\n *\n * Optional. Might not be present for orders created before 2024.\n */\n number?: string;\n\n /**\n * Whether this is the customer's first completed order with this shop. `true` means the buyer hasn't placed an order here before. Use this to show first-purchase messaging or trigger welcome offers.\n */\n isFirstOrder: boolean;\n}" } } }, @@ -23873,14 +23873,14 @@ "syntaxKind": "PropertySignature", "name": "availablePaymentOptions", "value": "SubscribableSignalLike", - "description": "All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region." + "description": "All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n\nThe set of payment options can change when the buyer updates their address or cart, so subscribe to changes rather than reading once during initialization. Each option exposes `handle` and `type` only. Provider names, logos, fees, and installment terms aren't available." }, { "filePath": "src/surfaces/checkout/api/docs.ts", "syntaxKind": "PropertySignature", "name": "selectedPaymentOptions", "value": "SubscribableSignalLike", - "description": "The payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card)." + "description": "The payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\n\nEach option exposes `handle` and `type` only. Provider names, logos, fees, and installment terms aren't available." } ], "value": "export interface Docs_Standard_PaymentOptionsApi\n extends Pick<\n StandardApi,\n 'availablePaymentOptions' | 'selectedPaymentOptions'\n > {}" @@ -24140,7 +24140,7 @@ "syntaxKind": "PropertySignature", "name": "query", "value": ">(query: string, options?: { variables?: Variables; version?: StorefrontApiVersion; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>", - "description": "The method used to query the Storefront GraphQL API with a prefetched token.\n\nRefer to [Storefront API access examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/storefront-api) for more information." + "description": "The method used to query the Storefront GraphQL API with a prefetched token." } ], "value": "export interface Docs_Standard_QueryApi extends Pick {}" @@ -24259,7 +24259,7 @@ "syntaxKind": "PropertySignature", "name": "sessionToken", "value": "SessionToken", - "description": "The session token providing a set of claims as a signed JSON Web Token (JWT).\n\nThe token has a TTL of five minutes.\n\nIf the previous token expires, this value reflects a new session token with a new signature and expiry.\n\nRefer to [session token examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/session-token) for more information." + "description": "The session token providing a set of claims as a signed JSON Web Token (JWT).\n\nThe token has a TTL of five minutes.\n\nIf the previous token expires, this value reflects a new session token with a new signature and expiry.\n\nLearn more about [session tokens](/docs/apps/build/authentication-authorization/session-tokens)." } ], "value": "export interface Docs_Standard_SessionTokenApi\n extends Pick {}" @@ -24267,7 +24267,7 @@ "SessionToken": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SessionToken", - "description": "", + "description": "Authenticates requests between your extension and your app backend. Use session tokens to verify the identity of the buyer and the shop context when making server-side API calls. The token is a signed JWT that contains claims such as the customer ID, shop domain, and expiration.\n\nThe `sub` claim in the decoded token is present only when the buyer is logged in and the app has permission to read customer accounts. Absent for anonymous buyers.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -24303,7 +24303,7 @@ "SessionToken": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SessionToken", - "description": "", + "description": "Authenticates requests between your extension and your app backend. Use session tokens to verify the identity of the buyer and the shop context when making server-side API calls. The token is a signed JWT that contains claims such as the customer ID, shop domain, and expiration.\n\nThe `sub` claim in the decoded token is present only when the buyer is logged in and the app has permission to read customer accounts. Absent for anonymous buyers.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -24565,7 +24565,7 @@ "syntaxKind": "PropertySignature", "name": "shop", "value": "Shop", - "description": "The shop where the checkout is taking place." + "description": "The store where the checkout is taking place, including the shop name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID." } ], "value": "export interface Docs_Standard_ShopApi extends Pick {}" @@ -24573,7 +24573,7 @@ "Shop": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Shop", - "description": "", + "description": "Metadata about the merchant's store, including its name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -24613,11 +24613,11 @@ "syntaxKind": "PropertySignature", "name": "storefrontUrl", "value": "string", - "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n\n> Caution: > As of version `2024-04` this value no longer has a trailing slash.", + "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.", "isOptional": true } ], - "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n *\n * > Caution:\n * > As of version `2024-04` this value no longer has a trailing slash.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom domain.\n */\n myshopifyDomain: string;\n}" + "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom domain.\n */\n myshopifyDomain: string;\n}" } } }, @@ -24643,7 +24643,7 @@ "Shop": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Shop", - "description": "", + "description": "Metadata about the merchant's store, including its name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -24683,11 +24683,11 @@ "syntaxKind": "PropertySignature", "name": "storefrontUrl", "value": "string", - "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n\n> Caution: > As of version `2024-04` this value no longer has a trailing slash.", + "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.", "isOptional": true } ], - "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n *\n * > Caution:\n * > As of version `2024-04` this value no longer has a trailing slash.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom domain.\n */\n myshopifyDomain: string;\n}" + "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom domain.\n */\n myshopifyDomain: string;\n}" } } } @@ -24743,7 +24743,7 @@ "syntaxKind": "PropertySignature", "name": "storage", "value": "Storage", - "description": "The key-value storage for the extension.\n\nIt uses `localStorage` and should persist across the customer's current checkout session.\n\n> Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n\nData is shared across all activated extension targets of this extension. In versions 2023-07 and earlier, each activated extension target had its own storage." + "description": "Key-value storage that persists across page loads within the current checkout session. Data is shared across all activated targets associated with this extension.\n\n> Caution: Data persistence isn't guaranteed and storage is cleared when the buyer starts a new checkout." } ], "value": "export interface Docs_Standard_StorageApi\n extends Pick {}" @@ -24751,21 +24751,21 @@ "Storage": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Storage", - "description": "A key-value storage object for the extension.\n\nStored data is available only to this specific extension and any of its instances.\n\nThe storage backend is implemented with `localStorage` and should persist across the buyer's checkout session. However, data persistence isn't guaranteed.", + "description": "Key-value storage for a specific extension. Use storage to save preferences or cached data that should survive page reloads without requiring a backend call. Stored data is only available to this specific extension. The storage backend is implemented with `localStorage` and data persistence isn't guaranteed.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "delete", "value": "(key: string) => Promise", - "description": "Delete stored data by key." + "description": "Deletes a previously stored value by key." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "read", "value": "(key: string) => Promise", - "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original primitive.\n\nReturns `null` if no stored data exists." + "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original type.\n\nReturns the stored value for the given key, or `null` when no value exists. Doesn't throw on a missing key." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -24775,7 +24775,7 @@ "description": "Write stored data for this key.\n\nThe data must be serializable to JSON." } ], - "value": "export interface Storage {\n /**\n * Read and return a stored value by key.\n *\n * The stored data is deserialized from JSON and returned as\n * its original primitive.\n *\n * Returns `null` if no stored data exists.\n */\n read(key: string): Promise;\n\n /**\n * Write stored data for this key.\n *\n * The data must be serializable to JSON.\n */\n write(key: string, data: any): Promise;\n\n /**\n * Delete stored data by key.\n */\n delete(key: string): Promise;\n}" + "value": "export interface Storage {\n /**\n * Read and return a stored value by key.\n *\n * The stored data is deserialized from JSON and returned as\n * its original type.\n *\n * Returns the stored value for the given key, or `null` when no value\n * exists. Doesn't throw on a missing key.\n */\n read(key: string): Promise;\n\n /**\n * Write stored data for this key.\n *\n * The data must be serializable to JSON.\n */\n write(key: string, data: any): Promise;\n\n /**\n * Deletes a previously stored value by key.\n */\n delete(key: string): Promise;\n}" } } }, @@ -24801,21 +24801,21 @@ "Storage": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Storage", - "description": "A key-value storage object for the extension.\n\nStored data is available only to this specific extension and any of its instances.\n\nThe storage backend is implemented with `localStorage` and should persist across the buyer's checkout session. However, data persistence isn't guaranteed.", + "description": "Key-value storage for a specific extension. Use storage to save preferences or cached data that should survive page reloads without requiring a backend call. Stored data is only available to this specific extension. The storage backend is implemented with `localStorage` and data persistence isn't guaranteed.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "delete", "value": "(key: string) => Promise", - "description": "Delete stored data by key." + "description": "Deletes a previously stored value by key." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "read", "value": "(key: string) => Promise", - "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original primitive.\n\nReturns `null` if no stored data exists." + "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original type.\n\nReturns the stored value for the given key, or `null` when no value exists. Doesn't throw on a missing key." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -24825,7 +24825,7 @@ "description": "Write stored data for this key.\n\nThe data must be serializable to JSON." } ], - "value": "export interface Storage {\n /**\n * Read and return a stored value by key.\n *\n * The stored data is deserialized from JSON and returned as\n * its original primitive.\n *\n * Returns `null` if no stored data exists.\n */\n read(key: string): Promise;\n\n /**\n * Write stored data for this key.\n *\n * The data must be serializable to JSON.\n */\n write(key: string, data: any): Promise;\n\n /**\n * Delete stored data by key.\n */\n delete(key: string): Promise;\n}" + "value": "export interface Storage {\n /**\n * Read and return a stored value by key.\n *\n * The stored data is deserialized from JSON and returned as\n * its original type.\n *\n * Returns the stored value for the given key, or `null` when no value\n * exists. Doesn't throw on a missing key.\n */\n read(key: string): Promise;\n\n /**\n * Write stored data for this key.\n *\n * The data must be serializable to JSON.\n */\n write(key: string, data: any): Promise;\n\n /**\n * Deletes a previously stored value by key.\n */\n delete(key: string): Promise;\n}" } } } @@ -25443,7 +25443,7 @@ "syntaxKind": "MethodSignature", "name": "applyAttributeChange", "value": "(change: AttributeChange) => Promise", - "description": "Updates or removes an attribute on the cart and checkout. On success, the [`attributes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/attributes#standardapi-propertydetail-attributes) property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.", + "description": "Updates or removes an attribute on the cart and checkout. On success, the [`attributes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/attributes#properties-propertydetail-attributes) property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.", "deprecationMessage": "Use cart metafields instead." }, { @@ -25451,42 +25451,42 @@ "syntaxKind": "MethodSignature", "name": "applyCartLinesChange", "value": "(change: CartLineChange) => Promise", - "description": "Adds, removes, or updates line items in the cart. The returned promise resolves when the change has been applied by the server, and the [`lines`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-lines#standardapi-propertydetail-lines) property updates with the new state.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Adds, removes, or updates line items in the cart. The returned promise resolves when the change has been applied by the server, and the [`lines`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-lines#properties-propertydetail-lines) property updates with the new state.\n\nAccepts a single change per call. To make multiple changes, call this method separately for each one.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyDiscountCodeChange", "value": "(change: DiscountCodeChange) => Promise", - "description": "Adds or removes a discount code on the checkout. The returned promise resolves when the change has been applied by the server, and the [`discountCodes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/discounts#standardapi-propertydetail-discountcodes) property updates with the new state.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves discount codes through a network call.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Adds or removes a discount code on the checkout. The returned promise resolves when the change has been applied by the server, and the [`discountCodes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/discounts#properties-propertydetail-discountcodes) property updates with the new state.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves discount codes through a network call.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyGiftCardChange", "value": "(change: GiftCardChange) => Promise", - "description": "Adds or removes a gift card from the checkout. The returned promise resolves when the change has been applied by the server, and the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/gift-cards#standardapi-propertydetail-appliedgiftcards) property updates with the new state.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves gift card codes through a network call.\n\n> Note: This method returns an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Adds or removes a gift card from the checkout. The returned promise resolves when the change has been applied by the server, and the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/gift-cards#properties-propertydetail-appliedgiftcards) property updates with the new state.\n\nUnlike other write operations, gift card changes aren't gated by a cart instruction flag.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves gift card codes through a network call.\n\n> Note: This method returns an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyMetafieldChange", "value": "(change: MetafieldChange) => Promise", - "description": "Creates, updates, or removes a cart metafield on the checkout. On success, the [`metafields`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/metafields#standardapi-propertydetail-metafields) property updates to reflect the change.\n\nCart metafields are copied to order metafields at order creation time if there's a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n\n> Caution: `MetafieldRemoveChange` and `MetafieldUpdateChange` are deprecated. Use cart metafields with `MetafieldRemoveCartChange` and `MetafieldUpdateCartChange` instead. If `MetafieldUpdateChange` writes a metafield with the same namespace and key as a cart metafield that's configured to copy, the cart metafield won't be copied.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Creates, updates, or removes a cart metafield on the checkout. On success, the [`metafields`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/metafields#properties-propertydetail-metafields) property updates to reflect the change.\n\nCart metafields are copied to order metafields at order creation time if there's a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n\n> Caution: `MetafieldRemoveChange` and `MetafieldUpdateChange` are deprecated. Use cart metafields with `MetafieldRemoveCartChange` and `MetafieldUpdateCartChange` instead. If `MetafieldUpdateChange` writes a metafield with the same namespace and key as a cart metafield that's configured to copy, the cart metafield won't be copied.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyNoteChange", "value": "(change: NoteChange) => Promise", - "description": "Sets or removes the buyer's note on the checkout. On success, the [`note`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/note#standardapi-propertydetail-note) property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Sets or removes the buyer's note on the checkout. On success, the [`note`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/note#properties-propertydetail-note) property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyShippingAddressChange", "value": "(change: ShippingAddressUpdateChange) => Promise", - "description": "Updates the buyer's shipping address on the checkout. The provided fields are merged into the existing address without prompting the buyer. On success, the `shippingAddress` property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", + "description": "Updates the buyer's shipping address on the checkout. The provided fields are merged into the existing address without prompting the buyer. On success, the `shippingAddress` property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", "isOptional": true }, { @@ -25499,7 +25499,7 @@ "isPrivate": true } ], - "value": "export interface CheckoutApi {\n /**\n * Updates or removes an attribute on the cart and checkout. On success, the\n * [`attributes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/attributes#standardapi-propertydetail-attributes) property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * @deprecated Use cart metafields instead.\n */\n applyAttributeChange(change: AttributeChange): Promise;\n\n /**\n * Adds, removes, or updates line items in the cart. The returned promise resolves when the change has been applied by the server, and the [`lines`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-lines#standardapi-propertydetail-lines) property updates with the new state.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyCartLinesChange(change: CartLineChange): Promise;\n\n /**\n * Adds or removes a discount code on the checkout. The returned promise resolves when the change has been applied by the server, and the [`discountCodes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/discounts#standardapi-propertydetail-discountcodes) property updates with the new state.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves discount codes through a network call.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyDiscountCodeChange(\n change: DiscountCodeChange,\n ): Promise;\n\n /**\n * Adds or removes a gift card from the checkout. The returned promise resolves when the change has been applied by the server, and the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/gift-cards#standardapi-propertydetail-appliedgiftcards) property updates with the new state.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves gift card codes through a network call.\n *\n * > Note: This method returns an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyGiftCardChange(change: GiftCardChange): Promise;\n\n /**\n * Creates, updates, or removes a cart metafield on the checkout. On success, the\n * [`metafields`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/metafields#standardapi-propertydetail-metafields) property updates to reflect the change.\n *\n * Cart metafields are copied to order metafields at order creation time if there's a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n *\n * > Caution: `MetafieldRemoveChange` and `MetafieldUpdateChange` are deprecated. Use cart metafields with `MetafieldRemoveCartChange` and `MetafieldUpdateCartChange` instead. If `MetafieldUpdateChange` writes a metafield with the same namespace and key as a cart metafield that's configured to copy, the cart metafield won't be copied.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyMetafieldChange(change: MetafieldChange): Promise;\n\n /**\n * Sets or removes the buyer's note on the checkout. On success, the\n * [`note`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/note#standardapi-propertydetail-note)\n * property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyNoteChange(change: NoteChange): Promise;\n\n /**\n * @private\n */\n experimentalIsShopAppStyle?: boolean;\n\n /**\n * Updates the buyer's shipping address on the checkout. The provided fields\n * are merged into the existing address without prompting the buyer. On success,\n * the `shippingAddress` property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyShippingAddressChange?(\n change: ShippingAddressChange,\n ): Promise;\n}" + "value": "export interface CheckoutApi {\n /**\n * Updates or removes an attribute on the cart and checkout. On success, the\n * [`attributes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/attributes#properties-propertydetail-attributes) property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * @deprecated Use cart metafields instead.\n */\n applyAttributeChange(change: AttributeChange): Promise;\n\n /**\n * Adds, removes, or updates line items in the cart. The returned promise resolves when the change has been applied by the server, and the [`lines`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-lines#properties-propertydetail-lines) property updates with the new state.\n *\n * Accepts a single change per call. To make multiple changes, call this\n * method separately for each one.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyCartLinesChange(change: CartLineChange): Promise;\n\n /**\n * Adds or removes a discount code on the checkout. The returned promise resolves when the change has been applied by the server, and the [`discountCodes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/discounts#properties-propertydetail-discountcodes) property updates with the new state.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves discount codes through a network call.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyDiscountCodeChange(\n change: DiscountCodeChange,\n ): Promise;\n\n /**\n * Adds or removes a gift card from the checkout. The returned promise resolves when the change has been applied by the server, and the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/gift-cards#properties-propertydetail-appliedgiftcards) property updates with the new state.\n *\n * Unlike other write operations, gift card changes aren't gated by a cart\n * instruction flag.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves gift card codes through a network call.\n *\n * > Note: This method returns an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyGiftCardChange(change: GiftCardChange): Promise;\n\n /**\n * Creates, updates, or removes a cart metafield on the checkout. On success, the\n * [`metafields`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/metafields#properties-propertydetail-metafields) property updates to reflect the change.\n *\n * Cart metafields are copied to order metafields at order creation time if there's a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n *\n * > Caution: `MetafieldRemoveChange` and `MetafieldUpdateChange` are deprecated. Use cart metafields with `MetafieldRemoveCartChange` and `MetafieldUpdateCartChange` instead. If `MetafieldUpdateChange` writes a metafield with the same namespace and key as a cart metafield that's configured to copy, the cart metafield won't be copied.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyMetafieldChange(change: MetafieldChange): Promise;\n\n /**\n * Sets or removes the buyer's note on the checkout. On success, the\n * [`note`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/note#properties-propertydetail-note)\n * property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyNoteChange(change: NoteChange): Promise;\n\n /**\n * @private\n */\n experimentalIsShopAppStyle?: boolean;\n\n /**\n * Updates the buyer's shipping address on the checkout. The provided fields\n * are merged into the existing address without prompting the buyer. On success,\n * the `shippingAddress` property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyShippingAddressChange?(\n change: ShippingAddressChange,\n ): Promise;\n}" }, "AttributeChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -25566,7 +25566,7 @@ "syntaxKind": "PropertySignature", "name": "value", "value": "string", - "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.", + "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.\n\nAttribute values are always strings. To store structured data, serialize it to JSON and parse it when reading.", "examples": [ { "title": "Example", @@ -25581,7 +25581,7 @@ ] } ], - "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" + "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * Attribute values are always strings. To store structured data, serialize\n * it to JSON and parse it when reading.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" }, "AttributeRemoveChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -26434,7 +26434,7 @@ "syntaxKind": "PropertySignature", "name": "message", "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer." + "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer.\n\nRender your own localized error text rather than displaying this message to the buyer." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -26444,7 +26444,7 @@ "description": "Indicates that the line item wasn't changed successfully. Refer to the `message` property for details about the error." } ], - "value": "export interface CartLineChangeResultError {\n /**\n * Indicates that the line item wasn't changed successfully. Refer to the `message` property for details about the error.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface CartLineChangeResultError {\n /**\n * Indicates that the line item wasn't changed successfully. Refer to the `message` property for details about the error.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n *\n * Render your own localized error text rather than displaying this message\n * to the buyer.\n */\n message: string;\n}" }, "DiscountCodeChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -26624,7 +26624,7 @@ "syntaxKind": "PropertySignature", "name": "message", "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer." + "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer.\n\nRender your own localized error text rather than displaying this message to the buyer." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -26634,7 +26634,7 @@ "description": "Indicates that the gift card change couldn't be applied. Check the `message` property for details." } ], - "value": "export interface GiftCardChangeResultError {\n /**\n * Indicates that the gift card change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface GiftCardChangeResultError {\n /**\n * Indicates that the gift card change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n *\n * Render your own localized error text rather than displaying this message\n * to the buyer.\n */\n message: string;\n}" }, "MetafieldChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -26895,7 +26895,7 @@ "syntaxKind": "PropertySignature", "name": "message", "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer." + "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer.\n\nRender your own localized error text rather than displaying this message to the buyer." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -26905,7 +26905,7 @@ "description": "Indicates that the metafield change couldn't be applied. Check the `message` property for details." } ], - "value": "export interface MetafieldChangeResultError {\n /**\n * Indicates that the metafield change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface MetafieldChangeResultError {\n /**\n * Indicates that the metafield change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n *\n * Render your own localized error text rather than displaying this message\n * to the buyer.\n */\n message: string;\n}" }, "NoteChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -26983,7 +26983,7 @@ "syntaxKind": "PropertySignature", "name": "message", "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer." + "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer.\n\nRender your own localized error text rather than displaying this message to the buyer." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -26993,7 +26993,7 @@ "description": "Indicates that the note change couldn't be applied. Check the `message` property for details." } ], - "value": "export interface NoteChangeResultError {\n /**\n * Indicates that the note change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface NoteChangeResultError {\n /**\n * Indicates that the note change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n *\n * Render your own localized error text rather than displaying this message\n * to the buyer.\n */\n message: string;\n}" }, "ShippingAddressUpdateChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -27572,7 +27572,7 @@ "syntaxKind": "PropertySignature", "name": "analytics", "value": "Analytics", - "description": "The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event." + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -27586,7 +27586,7 @@ "syntaxKind": "PropertySignature", "name": "applyTrackingConsentChange", "value": "ApplyTrackingConsentChangeType", - "description": "Enables setting and updating customer privacy consent settings and tracking consent metafields.\n\n> Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent) to be set to `true`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." + "description": "Enables setting and updating customer privacy consent settings and tracking consent metafields.\n\n> Note: Requires the [`collect_buyer_consent` capability](/docs/apps/build/customer-accounts/capabilities#collect-buyer-consent) to be set to `true`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -27607,7 +27607,7 @@ "syntaxKind": "PropertySignature", "name": "availablePaymentOptions", "value": "SubscribableSignalLike", - "description": "All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region." + "description": "All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n\nThe set of payment options can change when the buyer updates their address or cart, so subscribe to changes rather than reading once during initialization. Each option exposes `handle` and `type` only. Provider names, logos, fees, and installment terms aren't available." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -27644,7 +27644,7 @@ "syntaxKind": "PropertySignature", "name": "checkoutToken", "value": "SubscribableSignalLike", - "description": "A stable ID that represents the current checkout.\n\nThe value is `undefined` when the checkout hasn't been created on the server yet.\n\nUse this to correlate checkout sessions across your extension, web pixels, and backend systems.\n\nThis matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data) and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object)." + "description": "A stable ID that represents the current checkout.\n\nThe value is `undefined` when the checkout hasn't been created on the server yet.\n\nUse this to correlate checkout sessions across your extension, web pixels, and backend systems.\n\nThis matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data) and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n\nCan be `undefined`. Handle the `undefined` state before using the value." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -27665,7 +27665,7 @@ "syntaxKind": "PropertySignature", "name": "deliveryGroups", "value": "SubscribableSignalLike", - "description": "The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items." + "description": "The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n\nEmpty until the buyer enters enough address information for Shopify to calculate shipping rates." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -27686,7 +27686,7 @@ "syntaxKind": "PropertySignature", "name": "extension", "value": "Extension", - "description": "The meta information about the extension." + "description": "Metadata about the running extension, including the current target, API version, capabilities, and editor context. Use this to conditionally render content based on where the extension is running." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -27694,7 +27694,7 @@ "name": "extensionPoint", "value": "Target", "description": "The identifier that specifies where in Shopify's UI your code is being injected. This is one of the targets you've included in your extension's configuration file.", - "deprecationMessage": "Deprecated as of version `2023-07`, use `extension.target` instead.", + "deprecationMessage": "Use `extension.target` instead.", "examples": [ { "title": "Example", @@ -27713,14 +27713,14 @@ "syntaxKind": "PropertySignature", "name": "i18n", "value": "I18n", - "description": "Utilities for translating content and formatting values according to the current [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) of the checkout.\n\nRefer to [`localization` examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples) for more information." + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use alongside [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) to build fully localized extensions." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "instructions", "value": "SubscribableSignalLike", - "description": "The cart instructions used to create the checkout and possibly limit extension capabilities.\n\nThese instructions should be checked before performing any actions that might be affected by them.\n\nFor example, if you intend to add a discount code via the `applyDiscountCodeChange` method, check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n\n> Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs aren't available. See the [update guide](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples) for more information." + "description": "The cart instructions used to create the checkout and possibly limit extension capabilities.\n\nThese instructions should be checked before performing any actions that might be affected by them.\n\nFor example, if you intend to add a discount code via the `applyDiscountCodeChange` method, check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n\n> Caution: Check cart instructions before calling select APIs, as > some may not be available. See the > [Cart Instructions API](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples) > for more information." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -27734,7 +27734,7 @@ "syntaxKind": "PropertySignature", "name": "localization", "value": "Localization", - "description": "The details about the location, language, and currency of the customer. For utilities to easily format and translate content based on these details, you can use the [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n) object instead." + "description": "The buyer's language, country, currency, and timezone context. For formatting and translation helpers, use the [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#properties-propertydetail-i18n) object instead." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -27764,21 +27764,21 @@ "syntaxKind": "PropertySignature", "name": "query", "value": ">(query: string, options?: { variables?: Variables; version?: StorefrontApiVersion; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>", - "description": "The method used to query the Storefront GraphQL API with a prefetched token.\n\nRefer to [Storefront API access examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/storefront-api) for more information." + "description": "The method used to query the Storefront GraphQL API with a prefetched token." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "selectedPaymentOptions", "value": "SubscribableSignalLike", - "description": "The payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card)." + "description": "The payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\n\nEach option exposes `handle` and `type` only. Provider names, logos, fees, and installment terms aren't available." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "sessionToken", "value": "SessionToken", - "description": "The session token providing a set of claims as a signed JSON Web Token (JWT).\n\nThe token has a TTL of five minutes.\n\nIf the previous token expires, this value reflects a new session token with a new signature and expiry.\n\nRefer to [session token examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/session-token) for more information." + "description": "The session token providing a set of claims as a signed JSON Web Token (JWT).\n\nThe token has a TTL of five minutes.\n\nIf the previous token expires, this value reflects a new session token with a new signature and expiry.\n\nLearn more about [session tokens](/docs/apps/build/authentication-authorization/session-tokens)." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -27800,14 +27800,14 @@ "syntaxKind": "PropertySignature", "name": "shop", "value": "Shop", - "description": "The shop where the checkout is taking place." + "description": "The store where the checkout is taking place, including the shop name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "storage", "value": "Storage", - "description": "The key-value storage for the extension.\n\nIt uses `localStorage` and should persist across the customer's current checkout session.\n\n> Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n\nData is shared across all activated extension targets of this extension. In versions 2023-07 and earlier, each activated extension target had its own storage." + "description": "Key-value storage that persists across page loads within the current checkout session. Data is shared across all activated targets associated with this extension.\n\n> Caution: Data persistence isn't guaranteed and storage is cleared when the buyer starts a new checkout." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -27829,29 +27829,29 @@ ] } ], - "value": "export interface StandardApi {\n /**\n * The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event.\n */\n analytics: Analytics;\n\n /**\n * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\n */\n appliedGiftCards: SubscribableSignalLike;\n\n /**\n * The cart instructions used to create the checkout and possibly limit extension capabilities.\n *\n * These instructions should be checked before performing any actions that might be affected by them.\n *\n * For example, if you intend to add a discount code via the `applyDiscountCodeChange` method,\n * check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n *\n * > Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs aren't available.\n * See the [update guide](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples) for more information.\n *\n */\n instructions: SubscribableSignalLike;\n\n /**\n * The metafields requested in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration)\n * file. These metafields are updated when there's a change in the merchandise items\n * being purchased by the customer.\n *\n * App owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` isn't supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n appMetafields: SubscribableSignalLike;\n\n /**\n * The custom key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n buyerIdentity?: BuyerIdentity;\n\n /**\n * Provides details on the buyer's progression through the checkout and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/buyer-journey#examples)\n * examples for more information.\n */\n buyerJourney: BuyerJourney;\n\n /**\n * Settings applied to the buyer's checkout.\n */\n checkoutSettings: SubscribableSignalLike;\n\n /**\n * A stable ID that represents the current checkout.\n *\n * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\n *\n * This matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data)\n * and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n */\n checkoutToken: SubscribableSignalLike;\n\n /**\n * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * The meta information about the extension.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n *\n * @deprecated Deprecated as of version `2023-07`, use `extension.target` instead.\n */\n extensionPoint: Target;\n\n /**\n * Utilities for translating content and formatting values according to the current\n * [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization)\n * of the checkout.\n *\n * Refer to [`localization` examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples)\n * for more information.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The details about the location, language, and currency of the customer. For utilities to easily\n * format and translate content based on these details, you can use the\n * [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n)\n * object instead.\n */\n localization: Localization;\n\n /**\n * The metafields that apply to the current checkout.\n *\n * Metafields are stored locally on the client and are applied to the order object after the checkout completes.\n *\n * These metafields are shared by all extensions running on checkout, and\n * persist for as long as the customer is working on this checkout.\n *\n * Once the order is created, you can query these metafields using the\n * [GraphQL Admin API](/docs/admin-api/graphql/reference/orders/order#metafield-2021-01)\n *\n * > Caution:\n * `metafields` is deprecated. Use `appMetafields` with cart metafields instead.\n *\n * @deprecated Use `appMetafields` with cart metafields instead.\n */\n metafields: SubscribableSignalLike;\n\n /**\n * A note left by the customer to the merchant, either in their cart or during checkout.\n *\n * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\n */\n note: SubscribableSignalLike;\n\n /**\n * The method used to query the Storefront GraphQL API with a prefetched token.\n *\n * Refer to [Storefront API access examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/storefront-api) for more information.\n */\n query: >(\n query: string,\n options?: {variables?: Variables; version?: StorefrontApiVersion},\n ) => Promise<{data?: Data; errors?: GraphQLError[]}>;\n\n /**\n * The payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\n */\n selectedPaymentOptions: SubscribableSignalLike;\n\n /**\n * The session token providing a set of claims as a signed JSON Web Token (JWT).\n *\n * The token has a TTL of five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/session-token) for more information.\n */\n sessionToken: SessionToken;\n\n /**\n * The settings matching the settings definition written in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates in real time as a merchant fills in the settings.\n */\n settings: SubscribableSignalLike;\n\n /**\n * The proposed customer shipping address. During the information step, the address\n * updates when the field is committed (on change) rather than every keystroke.\n * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n shippingAddress?: SubscribableSignalLike;\n\n /**\n * The proposed customer billing address. The address updates when the field is\n * committed (on change) rather than every keystroke. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided yet.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n billingAddress?: SubscribableSignalLike;\n\n /** The shop where the checkout is taking place. */\n shop: Shop;\n\n /**\n * The key-value storage for the extension.\n *\n * It uses `localStorage` and should persist across the customer's current checkout session.\n *\n * > Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n *\n * Data is shared across all activated extension targets of this extension. In versions 2023-07 and earlier,\n * each activated extension target had its own storage.\n */\n storage: Storage;\n\n /**\n * The renderer version being used for the extension.\n *\n * @example '2025-10'\n */\n version: Version;\n\n /**\n * Customer privacy consent settings and a flag denoting if consent has previously been collected.\n */\n customerPrivacy: SubscribableSignalLike;\n\n /**\n * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent) to be set to `true`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyTrackingConsentChange: ApplyTrackingConsentChangeType;\n\n /**\n * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" + "value": "export interface StandardApi {\n /**\n * Tracks custom events and sends visitor information to\n * [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events\n * and `visitor()` to submit buyer contact details.\n */\n analytics: Analytics;\n\n /**\n * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\n */\n appliedGiftCards: SubscribableSignalLike;\n\n /**\n * The cart instructions used to create the checkout and possibly limit extension capabilities.\n *\n * These instructions should be checked before performing any actions that might be affected by them.\n *\n * For example, if you intend to add a discount code via the `applyDiscountCodeChange` method,\n * check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n *\n * > Caution: Check cart instructions before calling select APIs, as\n * > some may not be available. See the\n * > [Cart Instructions API](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples)\n * > for more information.\n *\n */\n instructions: SubscribableSignalLike;\n\n /**\n * The metafields requested in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration)\n * file. These metafields are updated when there's a change in the merchandise items\n * being purchased by the customer.\n *\n * App owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` isn't supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n appMetafields: SubscribableSignalLike;\n\n /**\n * The custom key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as\n * credit cards, wallets, and local payment methods. The list depends on\n * the shop's payment configuration and the buyer's region.\n *\n * The set of payment options can change when the buyer updates their\n * address or cart, so subscribe to changes rather than reading once\n * during initialization. Each option exposes `handle` and `type` only.\n * Provider names, logos, fees, and installment terms aren't available.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n buyerIdentity?: BuyerIdentity;\n\n /**\n * Provides details on the buyer's progression through the checkout and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/buyer-journey#examples)\n * examples for more information.\n */\n buyerJourney: BuyerJourney;\n\n /**\n * Settings applied to the buyer's checkout.\n */\n checkoutSettings: SubscribableSignalLike;\n\n /**\n * A stable ID that represents the current checkout.\n *\n * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\n *\n * This matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data)\n * and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n *\n * Can be `undefined`. Handle the `undefined` state before using the value.\n */\n checkoutToken: SubscribableSignalLike;\n\n /**\n * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n *\n * Empty until the buyer enters enough address information for Shopify to\n * calculate shipping rates.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * Metadata about the running extension, including the current target, API version,\n * capabilities, and editor context. Use this to conditionally render content\n * based on where the extension is running.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n *\n * @deprecated Use `extension.target` instead.\n */\n extensionPoint: Target;\n\n /**\n * Utilities for translating strings, formatting currencies, numbers, and dates\n * according to the buyer's locale. Use alongside\n * [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization)\n * to build fully localized extensions.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The buyer's language, country, currency, and timezone context. For\n * formatting and translation helpers, use the\n * [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#properties-propertydetail-i18n)\n * object instead.\n */\n localization: Localization;\n\n /**\n * The metafields that apply to the current checkout.\n *\n * Metafields are stored locally on the client and are applied to the order object after the checkout completes.\n *\n * These metafields are shared by all extensions running on checkout, and\n * persist for as long as the customer is working on this checkout.\n *\n * Once the order is created, you can query these metafields using the\n * [GraphQL Admin API](/docs/admin-api/graphql/reference/orders/order#metafield-2021-01)\n *\n * > Caution:\n * `metafields` is deprecated. Use `appMetafields` with cart metafields instead.\n *\n * @deprecated Use `appMetafields` with cart metafields instead.\n */\n metafields: SubscribableSignalLike;\n\n /**\n * A note left by the customer to the merchant, either in their cart or during checkout.\n *\n * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\n */\n note: SubscribableSignalLike;\n\n /**\n * The method used to query the Storefront GraphQL API with a prefetched token.\n *\n */\n query: >(\n query: string,\n options?: {variables?: Variables; version?: StorefrontApiVersion},\n ) => Promise<{data?: Data; errors?: GraphQLError[]}>;\n\n /**\n * The payment options the buyer has currently selected. This updates as\n * the buyer changes their payment method. The array can contain multiple\n * entries when the buyer splits payment across methods (for example, a\n * gift card and a credit card).\n *\n * Each option exposes `handle` and `type` only. Provider names, logos,\n * fees, and installment terms aren't available.\n */\n selectedPaymentOptions: SubscribableSignalLike;\n\n /**\n * The session token providing a set of claims as a signed JSON Web Token (JWT).\n *\n * The token has a TTL of five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Learn more about [session tokens](/docs/apps/build/authentication-authorization/session-tokens).\n */\n sessionToken: SessionToken;\n\n /**\n * The settings matching the settings definition written in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates in real time as a merchant fills in the settings.\n */\n settings: SubscribableSignalLike;\n\n /**\n * The proposed customer shipping address. During the information step, the address\n * updates when the field is committed (on change) rather than every keystroke.\n * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n shippingAddress?: SubscribableSignalLike;\n\n /**\n * The proposed customer billing address. The address updates when the field is\n * committed (on change) rather than every keystroke. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided yet.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n billingAddress?: SubscribableSignalLike;\n\n /**\n * The store where the checkout is taking place, including the shop name,\n * storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.\n */\n shop: Shop;\n\n /**\n * Key-value storage that persists across page loads within the current checkout\n * session. Data is shared across all activated targets associated with\n * this extension.\n *\n * > Caution: Data persistence isn't guaranteed and storage is cleared when the\n * buyer starts a new checkout.\n */\n storage: Storage;\n\n /**\n * The renderer version being used for the extension.\n *\n * @example '2025-10'\n */\n version: Version;\n\n /**\n * Customer privacy consent settings and a flag denoting if consent has previously been collected.\n */\n customerPrivacy: SubscribableSignalLike;\n\n /**\n * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`collect_buyer_consent` capability](/docs/apps/build/customer-accounts/capabilities#collect-buyer-consent) to be set to `true`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyTrackingConsentChange: ApplyTrackingConsentChangeType;\n\n /**\n * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" }, "Analytics": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Analytics", - "description": "", + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "publish", "value": "(name: string, data: Record) => Promise", - "description": "Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing)." + "description": "Publishes a custom event to [Web Pixels](/docs/apps/marketing). Returns `true` when the event is successfully dispatched.\n\nThe Promise resolves to `true` when the event was dispatched. The boolean indicates dispatch confirmation only. It doesn't indicate whether any specific web pixel processed the event." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "visitor", "value": "(data: { email?: string; phone?: string; }) => Promise", - "description": "A method for capturing details about a visitor on the online store." + "description": "Submits buyer contact details for attribution and analytics purposes." } ], - "value": "export interface Analytics {\n /**\n * Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing).\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * A method for capturing details about a visitor on the online store.\n */\n visitor(data: {email?: string; phone?: string}): Promise;\n}" + "value": "export interface Analytics {\n /**\n * Publishes a custom event to [Web Pixels](/docs/apps/marketing).\n * Returns `true` when the event is successfully dispatched.\n *\n * The Promise resolves to `true` when the event was dispatched. The boolean\n * indicates dispatch confirmation only. It doesn't indicate whether any\n * specific web pixel processed the event.\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * Submits buyer contact details for attribution and analytics purposes.\n */\n visitor(data: {email?: string; phone?: string}): Promise;\n}" }, "VisitorResult": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -27892,10 +27892,10 @@ "syntaxKind": "PropertySignature", "name": "type", "value": "'error'", - "description": "Indicates that the visitor information is invalid and wasn't submitted. Examples are using the wrong data type or missing a required property." + "description": "Indicates that the visitor information is invalid and wasn't submitted. Common causes include using the wrong data type or omitting a required property." } ], - "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Examples are using the wrong data type or missing a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Common causes include using the wrong data type or omitting a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" }, "SubscribableSignalLike": { "filePath": "src/surfaces/checkout/shared.ts", @@ -28068,10 +28068,10 @@ "syntaxKind": "PropertySignature", "name": "value", "value": "string | null", - "description": "The new value to store in the metafield. Set to `null` to delete the metafield." + "description": "The new value to store in the metafield. Set to `null` to delete the metafield.\n\nConsent metafield values are strings, not booleans. Pass `null` to delete a tracking consent metafield." } ], - "value": "export interface TrackingConsentMetafieldChange {\n /**\n * The identifier for the tracking consent metafield to update.\n */\n key: string;\n /**\n * The new value to store in the metafield. Set to `null` to delete the metafield.\n */\n value: string | null;\n}" + "value": "export interface TrackingConsentMetafieldChange {\n /**\n * The identifier for the tracking consent metafield to update.\n */\n key: string;\n /**\n * The new value to store in the metafield. Set to `null` to delete the metafield.\n *\n * Consent metafield values are strings, not booleans. Pass `null` to delete\n * a tracking consent metafield.\n */\n value: string | null;\n}" }, "VisitorConsent": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -28370,7 +28370,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A globally-unique identifier for the customer in the format `gid://shopify/Customer/`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", + "description": "An identifier for the customer in the format `gid://shopify/Customer/`. This value is unique per shop.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", "examples": [ { "title": "Example", @@ -28423,7 +28423,7 @@ "isPrivate": true } ], - "value": "export interface Customer {\n /**\n * A globally-unique identifier for the customer in the format `gid://shopify/Customer/`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'gid://shopify/Customer/123'\n */\n id: string;\n /**\n * The email address associated with the customer's account. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email?: string;\n /**\n * The phone number associated with the customer's account. The value is `undefined` if no phone number is on file or the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone?: string;\n /**\n * The customer's full name, typically a combination of first and last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n fullName?: string;\n /**\n * The customer's first name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n firstName?: string;\n /**\n * The customer's last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n lastName?: string;\n /**\n * The customer's profile image, such as a Gravatar avatar. Use this to personalize the extension UI for the logged-in buyer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n image: ImageDetails;\n /**\n * Whether the customer has opted in to receiving marketing communications from the merchant, such as email campaigns and promotional offers.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * > Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n *\n * @deprecated Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n */\n acceptsMarketing: boolean;\n /**\n * Whether the customer has opted in to email marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsEmailMarketing: boolean;\n /**\n * Whether the customer has opted in to SMS marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsSmsMarketing: boolean;\n /**\n * The store credit accounts owned by this customer that can be used as payment during checkout. Each account has a balance representing available store credit.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @private\n */\n storeCreditAccounts: StoreCreditAccount[];\n /**\n * The number of orders the customer has previously placed with this shop.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n ordersCount: number;\n}" + "value": "export interface Customer {\n /**\n * An identifier for the customer in the format `gid://shopify/Customer/`. This value is unique per shop.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'gid://shopify/Customer/123'\n */\n id: string;\n /**\n * The email address associated with the customer's account. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email?: string;\n /**\n * The phone number associated with the customer's account. The value is `undefined` if no phone number is on file or the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone?: string;\n /**\n * The customer's full name, typically a combination of first and last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n fullName?: string;\n /**\n * The customer's first name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n firstName?: string;\n /**\n * The customer's last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n lastName?: string;\n /**\n * The customer's profile image, such as a Gravatar avatar. Use this to personalize the extension UI for the logged-in buyer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n image: ImageDetails;\n /**\n * Whether the customer has opted in to receiving marketing communications from the merchant, such as email campaigns and promotional offers.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * > Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n *\n * @deprecated Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n */\n acceptsMarketing: boolean;\n /**\n * Whether the customer has opted in to email marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsEmailMarketing: boolean;\n /**\n * Whether the customer has opted in to SMS marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsSmsMarketing: boolean;\n /**\n * The store credit accounts owned by this customer that can be used as payment during checkout. Each account has a balance representing available store credit.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @private\n */\n storeCreditAccounts: StoreCreditAccount[];\n /**\n * The number of orders the customer has previously placed with this shop.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n ordersCount: number;\n}" }, "StoreCreditAccount": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -28682,11 +28682,11 @@ "syntaxKind": "MethodSignature", "name": "perform", "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", + "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.\n\nRuns after all intercept results are collected. Use it for local state updates such as setting an error flag. By the time it runs, the navigation decision is final, so blocking logic belongs in the intercept handler itself, not here.", "isOptional": true } ], - "value": "interface InterceptorRequestAllow {\n /**\n * Indicates that the interceptor allows the buyer's journey to continue.\n */\n behavior: 'allow';\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" + "value": "interface InterceptorRequestAllow {\n /**\n * Indicates that the interceptor allows the buyer's journey to continue.\n */\n behavior: 'allow';\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n *\n * Runs after all intercept results are collected. Use it for local state\n * updates such as setting an error flag. By the time it runs, the navigation\n * decision is final, so blocking logic belongs in the intercept handler\n * itself, not here.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" }, "InterceptorResult": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -28750,7 +28750,7 @@ "syntaxKind": "MethodSignature", "name": "perform", "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", + "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.\n\nRuns after all intercept results are collected. Use it for local state updates such as setting an error flag. By the time it runs, the navigation decision is final, so blocking logic belongs in the intercept handler itself, not here.", "isOptional": true }, { @@ -28761,7 +28761,7 @@ "description": "The reason for blocking the interceptor request. This value isn't presented to the buyer, so it doesn't need to be localized. The value is used only for Shopify's own internal debugging and metrics." } ], - "value": "interface InterceptorRequestBlock {\n /**\n * Indicates that the interceptor blocks the buyer's journey from continuing.\n */\n behavior: 'block';\n\n /**\n * The reason for blocking the interceptor request. This value isn't presented to\n * the buyer, so it doesn't need to be localized. The value is used only for Shopify's\n * own internal debugging and metrics.\n */\n reason: string;\n\n /**\n * Used to pass errors to the checkout UI, outside your extension's UI boundaries.\n */\n errors?: ValidationError[];\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" + "value": "interface InterceptorRequestBlock {\n /**\n * Indicates that the interceptor blocks the buyer's journey from continuing.\n */\n behavior: 'block';\n\n /**\n * The reason for blocking the interceptor request. This value isn't presented to\n * the buyer, so it doesn't need to be localized. The value is used only for Shopify's\n * own internal debugging and metrics.\n */\n reason: string;\n\n /**\n * Used to pass errors to the checkout UI, outside your extension's UI boundaries.\n */\n errors?: ValidationError[];\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n *\n * Runs after all intercept results are collected. Use it for local state\n * updates such as setting an error flag. By the time it runs, the navigation\n * decision is final, so blocking logic belongs in the intercept handler\n * itself, not here.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" }, "ValidationError": { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -28982,17 +28982,17 @@ "syntaxKind": "PropertySignature", "name": "totalShippingAmount", "value": "SubscribableSignalLike", - "description": "The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step." + "description": "The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step.\n\n`undefined` until the buyer selects a shipping method (typically after the information step)." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "totalTaxAmount", "value": "SubscribableSignalLike", - "description": "The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet." + "description": "The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet.\n\n`undefined` when taxes haven't been calculated or aren't available for the buyer's region." } ], - "value": "export interface CartCost {\n /**\n * The sum of all line item prices at the current step of checkout, before shipping and taxes are applied. Use this value to display the base cost of the items the buyer purchased.\n */\n subtotalAmount: SubscribableSignalLike;\n\n /**\n * The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step.\n */\n totalShippingAmount: SubscribableSignalLike;\n\n /**\n * The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet.\n */\n totalTaxAmount: SubscribableSignalLike;\n\n /**\n * The minimum total at the current step of checkout. Costs not yet calculated, such as shipping on the information step, aren't included. Gift cards and store credits are excluded from this total.\n */\n totalAmount: SubscribableSignalLike;\n}" + "value": "export interface CartCost {\n /**\n * The sum of all line item prices at the current step of checkout, before shipping and taxes are applied. Use this value to display the base cost of the items the buyer purchased.\n */\n subtotalAmount: SubscribableSignalLike;\n\n /**\n * The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step.\n *\n * `undefined` until the buyer selects a shipping method (typically after the\n * information step).\n */\n totalShippingAmount: SubscribableSignalLike;\n\n /**\n * The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet.\n *\n * `undefined` when taxes haven't been calculated or aren't available for the\n * buyer's region.\n */\n totalTaxAmount: SubscribableSignalLike;\n\n /**\n * The minimum total at the current step of checkout. Costs not yet calculated, such as shipping on the information step, aren't included. Gift cards and store credits are excluded from this total.\n */\n totalAmount: SubscribableSignalLike;\n}" }, "CustomerPrivacy": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -29079,31 +29079,31 @@ "syntaxKind": "PropertySignature", "name": "analytics", "value": "boolean", - "description": "Whether analytics data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Analytics data includes how the shop was used and what interactions occurred." + "description": "Whether analytics data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Analytics data includes how the shop was used and what interactions occurred.\n\nWhether analytics data can be collected right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.analytics`, before calling `shopify.analytics.publish()`." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "marketing", "value": "boolean", - "description": "Whether marketing data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Marketing data includes attribution and targeted advertising preferences." + "description": "Whether marketing data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Marketing data includes attribution and targeted advertising preferences.\n\nWhether marketing data can be collected right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.marketing`, before performing marketing-related data collection." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "preferences", "value": "boolean", - "description": "Whether preference data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Preference data includes language, currency, and sizing choices." + "description": "Whether preference data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Preference data includes language, currency, and sizing choices.\n\nWhether preference data can be collected right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.preferences`, before storing or reading buyer preference data." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "saleOfData", "value": "boolean", - "description": "Whether data can be shared with third parties based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. This typically applies to behavioral advertising data." + "description": "Whether data can be shared with third parties based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. This typically applies to behavioral advertising data.\n\nWhether buyer data can be shared with or sold to third parties right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.saleOfData`, before sharing or selling buyer data with third parties." } ], - "value": "export interface AllowedProcessing {\n /**\n * Whether analytics data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Analytics\n * data includes how the shop was used and what interactions occurred.\n */\n analytics: boolean;\n /**\n * Whether marketing data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Marketing\n * data includes attribution and targeted advertising preferences.\n */\n marketing: boolean;\n /**\n * Whether preference data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Preference\n * data includes language, currency, and sizing choices.\n */\n preferences: boolean;\n /**\n * Whether data can be shared with third parties based on the visitor's\n * consent, the merchant's privacy configuration, and the visitor's region.\n * This typically applies to behavioral advertising data.\n */\n saleOfData: boolean;\n}" + "value": "export interface AllowedProcessing {\n /**\n * Whether analytics data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Analytics\n * data includes how the shop was used and what interactions occurred.\n *\n * Whether analytics data can be collected right now. Combines the buyer's\n * consent, the merchant's privacy configuration, and the buyer's region into\n * a single boolean. Check this flag, not `visitorConsent.analytics`, before\n * calling `shopify.analytics.publish()`.\n */\n analytics: boolean;\n /**\n * Whether marketing data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Marketing\n * data includes attribution and targeted advertising preferences.\n *\n * Whether marketing data can be collected right now. Combines the buyer's\n * consent, the merchant's privacy configuration, and the buyer's region into\n * a single boolean. Check this flag, not `visitorConsent.marketing`, before\n * performing marketing-related data collection.\n */\n marketing: boolean;\n /**\n * Whether preference data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Preference\n * data includes language, currency, and sizing choices.\n *\n * Whether preference data can be collected right now. Combines the buyer's\n * consent, the merchant's privacy configuration, and the buyer's region into\n * a single boolean. Check this flag, not `visitorConsent.preferences`,\n * before storing or reading buyer preference data.\n */\n preferences: boolean;\n /**\n * Whether data can be shared with third parties based on the visitor's\n * consent, the merchant's privacy configuration, and the visitor's region.\n * This typically applies to behavioral advertising data.\n *\n * Whether buyer data can be shared with or sold to third parties right now.\n * Combines the buyer's consent, the merchant's privacy configuration, and\n * the buyer's region into a single boolean. Check this flag, not\n * `visitorConsent.saleOfData`, before sharing or selling buyer data with\n * third parties.\n */\n saleOfData: boolean;\n}" }, "TrackingConsentMetafield": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -29641,7 +29641,7 @@ "Extension": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Extension", - "description": "The meta information about an extension target.", + "description": "Metadata about the running extension, including its API version, target, capabilities, and editor context. Use this to read configuration details or conditionally render content based on where the extension is running.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -29667,7 +29667,7 @@ "syntaxKind": "PropertySignature", "name": "capabilities", "value": "SubscribableSignalLike", - "description": "The allowed capabilities of the extension, defined in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n\n* [`api_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#api-access): the extension can access the Storefront API.\n\n* [`network_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access): the extension can make external network calls.\n\n* [`block_progress`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n\n* [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n\n* [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can register customer consent decisions that are honored on Shopify-managed services.\n\n* [`iframe.sources`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#iframe): the extension can embed an external URL in an iframe." + "description": "The allowed capabilities of the extension, defined in your [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -29715,7 +29715,7 @@ "syntaxKind": "PropertySignature", "name": "version", "value": "string", - "description": "The published version of the running extension target.\n\nFor unpublished extensions, the value is `undefined`.", + "description": "The published version of the running extension target.\n\nFor unpublished extensions, the value is `undefined`.\n\nDon't use this property as a stable identifier in development environments. It becomes available only after the extension is published.", "isOptional": true, "examples": [ { @@ -29731,7 +29731,7 @@ ] } ], - "value": "export interface Extension {\n /**\n * The API version that was set in the extension config file.\n *\n * @example '2024-10', '2025-01', '2025-04', '2025-07', '2025-10'\n */\n apiVersion: ApiVersion;\n\n /**\n * The allowed capabilities of the extension, defined\n * in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n *\n * * [`api_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#api-access): the extension can access the Storefront API.\n *\n * * [`network_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access): the extension can make external network calls.\n *\n * * [`block_progress`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n *\n * * [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n *\n * * [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can register customer consent decisions that are honored on Shopify-managed services.\n *\n * * [`iframe.sources`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#iframe): the extension can embed an external URL in an iframe.\n */\n capabilities: SubscribableSignalLike;\n\n /**\n * Information about the editor where the extension is being rendered.\n *\n * If the value is undefined, then the extension isn't running in an editor.\n */\n editor?: Editor;\n\n /**\n * A Boolean to show whether your extension is currently rendered to the screen.\n *\n * Shopify might render your extension before it's visible in the UI,\n * typically to pre-render extensions that appear on a later step of the\n * checkout.\n *\n * Your extension might also continue to run after the customer has navigated away\n * from where it was rendered. The extension continues running so that\n * your extension is immediately available to render if the customer navigates back.\n */\n rendered: SubscribableSignalLike;\n\n /**\n * The URL to the script that started the extension target.\n */\n scriptUrl: string;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n */\n target: Target;\n\n /**\n * The published version of the running extension target.\n *\n * For unpublished extensions, the value is `undefined`.\n *\n * @example 3.0.10\n */\n version?: string;\n}" + "value": "export interface Extension {\n /**\n * The API version that was set in the extension config file.\n *\n * @example '2024-10', '2025-01', '2025-04', '2025-07', '2025-10'\n */\n apiVersion: ApiVersion;\n\n /**\n * The allowed capabilities of the extension, defined in your\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n */\n capabilities: SubscribableSignalLike;\n\n /**\n * Information about the editor where the extension is being rendered.\n *\n * If the value is undefined, then the extension isn't running in an editor.\n */\n editor?: Editor;\n\n /**\n * A Boolean to show whether your extension is currently rendered to the screen.\n *\n * Shopify might render your extension before it's visible in the UI,\n * typically to pre-render extensions that appear on a later step of the\n * checkout.\n *\n * Your extension might also continue to run after the customer has navigated away\n * from where it was rendered. The extension continues running so that\n * your extension is immediately available to render if the customer navigates back.\n */\n rendered: SubscribableSignalLike;\n\n /**\n * The URL to the script that started the extension target.\n */\n scriptUrl: string;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n */\n target: Target;\n\n /**\n * The published version of the running extension target.\n *\n * For unpublished extensions, the value is `undefined`.\n *\n * Don't use this property as a stable identifier in development environments.\n * It becomes available only after the extension is published.\n *\n * @example 3.0.10\n */\n version?: string;\n}" }, "ApiVersion": { "filePath": "src/shared.ts", @@ -29750,7 +29750,7 @@ "Editor": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Editor", - "description": "", + "description": "Information about the editor environment when an extension is rendered inside the checkout editor. The value is `undefined` when the extension is not rendering in an editor.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -29765,7 +29765,7 @@ "I18n": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18n", - "description": "", + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use the I18n API alongside the Localization API to build fully localized extensions.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -29801,7 +29801,7 @@ "I18nTranslate": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18nTranslate", - "description": "This returns a translated string matching a key in a locale file.", + "description": "Translates a key from your extension's locale files into a localized string. Supports interpolation with placeholder replacements and pluralization via the special `count` option.", "members": [], "value": "export interface I18nTranslate {\n (\n key: string,\n options?: Record,\n ): ReplacementType extends string | number\n ? string\n : (string | ReplacementType)[];\n}" }, @@ -29969,14 +29969,14 @@ "Localization": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Localization", - "description": "", + "description": "The buyer's language, country, currency, and timezone context. Use this to adapt your extension to the buyer's region and display localized content.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "country", "value": "SubscribableSignalLike", - "description": "The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown." + "description": "The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n\nDerived from the buyer's shipping address. Returns `undefined` until the buyer enters a shipping address." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -30004,18 +30004,18 @@ "syntaxKind": "PropertySignature", "name": "market", "value": "SubscribableSignalLike", - "description": "The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n\n> Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.", - "deprecationMessage": "Deprecated as of version `2025-04`" + "description": "The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. The market context updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.", + "deprecationMessage": "Merchants now manage which extensions load for each\nmarket, so extensions no longer need to check this value." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "timezone", "value": "SubscribableSignalLike", - "description": "The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time." + "description": "The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time." } ], - "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n *\n * > Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" + "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n *\n * Derived from the buyer's shipping address. Returns `undefined` until the\n * buyer enters a shipping address.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout,\n * carried over from the cart context. Markets group countries and\n * regions with shared pricing, languages, and domains. The market\n * context updates when the buyer changes the country of their\n * shipping address. The value is `undefined` if the market is unknown.\n *\n * @deprecated Merchants now manage which extensions load for each\n * market, so extensions no longer need to check this value.\n */\n market: SubscribableSignalLike;\n}" }, "Country": { "filePath": "src/shared.ts", @@ -30216,7 +30216,7 @@ "SessionToken": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SessionToken", - "description": "", + "description": "Authenticates requests between your extension and your app backend. Use session tokens to verify the identity of the buyer and the shop context when making server-side API calls. The token is a signed JWT that contains claims such as the customer ID, shop domain, and expiration.\n\nThe `sub` claim in the decoded token is present only when the buyer is logged in and the app has permission to read customer accounts. Absent for anonymous buyers.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -30239,7 +30239,7 @@ "Shop": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Shop", - "description": "", + "description": "Metadata about the merchant's store, including its name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -30279,30 +30279,30 @@ "syntaxKind": "PropertySignature", "name": "storefrontUrl", "value": "string", - "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n\n> Caution: > As of version `2024-04` this value no longer has a trailing slash.", + "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.", "isOptional": true } ], - "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n *\n * > Caution:\n * > As of version `2024-04` this value no longer has a trailing slash.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom domain.\n */\n myshopifyDomain: string;\n}" + "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom domain.\n */\n myshopifyDomain: string;\n}" }, "Storage": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Storage", - "description": "A key-value storage object for the extension.\n\nStored data is available only to this specific extension and any of its instances.\n\nThe storage backend is implemented with `localStorage` and should persist across the buyer's checkout session. However, data persistence isn't guaranteed.", + "description": "Key-value storage for a specific extension. Use storage to save preferences or cached data that should survive page reloads without requiring a backend call. Stored data is only available to this specific extension. The storage backend is implemented with `localStorage` and data persistence isn't guaranteed.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "delete", "value": "(key: string) => Promise", - "description": "Delete stored data by key." + "description": "Deletes a previously stored value by key." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "read", "value": "(key: string) => Promise", - "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original primitive.\n\nReturns `null` if no stored data exists." + "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original type.\n\nReturns the stored value for the given key, or `null` when no value exists. Doesn't throw on a missing key." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -30312,7 +30312,7 @@ "description": "Write stored data for this key.\n\nThe data must be serializable to JSON." } ], - "value": "export interface Storage {\n /**\n * Read and return a stored value by key.\n *\n * The stored data is deserialized from JSON and returned as\n * its original primitive.\n *\n * Returns `null` if no stored data exists.\n */\n read(key: string): Promise;\n\n /**\n * Write stored data for this key.\n *\n * The data must be serializable to JSON.\n */\n write(key: string, data: any): Promise;\n\n /**\n * Delete stored data by key.\n */\n delete(key: string): Promise;\n}" + "value": "export interface Storage {\n /**\n * Read and return a stored value by key.\n *\n * The stored data is deserialized from JSON and returned as\n * its original type.\n *\n * Returns the stored value for the given key, or `null` when no value\n * exists. Doesn't throw on a missing key.\n */\n read(key: string): Promise;\n\n /**\n * Write stored data for this key.\n *\n * The data must be serializable to JSON.\n */\n write(key: string, data: any): Promise;\n\n /**\n * Deletes a previously stored value by key.\n */\n delete(key: string): Promise;\n}" }, "Version": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -30339,10 +30339,10 @@ "syntaxKind": "PropertySignature", "name": "target", "value": "SubscribableSignalLike", - "description": "The cart line that this extension is attached to. Use this to read the line item's merchandise, quantity, cost, and attributes.\n\n> Note: Until version `2023-04`, this property was a `ReadonlySignalLike`." + "description": "The cart line that this extension is attached to. Use this to read the line item's merchandise, quantity, cost, and attributes.\n\nAvailable only on the corresponding item target. Shipping option item targets expose shipping option properties; pickup location item targets expose pickup location properties.\n\n> Note: Until version `2023-04`, this property was a `ReadonlySignalLike`." } ], - "value": "export interface CartLineItemApi {\n /**\n * The cart line that this extension is attached to. Use this to read the\n * line item's merchandise, quantity, cost, and attributes.\n *\n * > Note: Until version `2023-04`, this property was a `ReadonlySignalLike`.\n */\n target: SubscribableSignalLike;\n}" + "value": "export interface CartLineItemApi {\n /**\n * The cart line that this extension is attached to. Use this to read the\n * line item's merchandise, quantity, cost, and attributes.\n *\n * Available only on the corresponding item target. Shipping option item\n * targets expose shipping option properties; pickup location item targets\n * expose pickup location properties.\n *\n * > Note: Until version `2023-04`, this property was a `ReadonlySignalLike`.\n */\n target: SubscribableSignalLike;\n}" }, "RedeemableApi": { "filePath": "src/surfaces/checkout/api/redeemable/redeemable.ts", @@ -30607,10 +30607,10 @@ "syntaxKind": "PropertySignature", "name": "isLocationFormVisible", "value": "SubscribableSignalLike", - "description": "Whether the location search form is currently visible to the buyer. Use this to conditionally render UI that depends on the buyer actively searching for pickup points." + "description": "Reflects which view was active when the extension loaded. When the buyer moves to the next view, the extension restarts with the current value rather than updating in place." } ], - "value": "export interface PickupPointListApi {\n /**\n * Whether the location search form is currently visible to the buyer.\n * Use this to conditionally render UI that depends on the buyer actively\n * searching for pickup points.\n */\n isLocationFormVisible: SubscribableSignalLike;\n}" + "value": "export interface PickupPointListApi {\n /**\n * Reflects which view was active when the extension loaded. When the\n * buyer moves to the next view, the extension restarts with the\n * current value rather than updating in place.\n */\n isLocationFormVisible: SubscribableSignalLike;\n}" }, "ShippingOptionItemApi": { "filePath": "src/surfaces/checkout/api/shipping/shipping-option-item.ts", @@ -30623,7 +30623,7 @@ "syntaxKind": "PropertySignature", "name": "isTargetSelected", "value": "SubscribableSignalLike", - "description": "Whether the buyer has selected the target shipping option. When `true`, the target option is the buyer's active choice. When `false`, the buyer has chosen a different shipping option." + "description": "Whether the buyer has selected the target shipping option. When `true`, the target option is the buyer's active choice. When `false`, the buyer has chosen a different shipping option.\n\nAvailable only on the corresponding item target. Shipping option item targets expose shipping option properties; pickup location item targets expose pickup location properties." }, { "filePath": "src/surfaces/checkout/api/shipping/shipping-option-item.ts", @@ -30637,10 +30637,10 @@ "syntaxKind": "PropertySignature", "name": "target", "value": "SubscribableSignalLike", - "description": "The shipping option that this extension is attached to. Use this to read the option's cost, carrier, delivery estimate, and other details." + "description": "The shipping option that this extension is attached to. Use this to read the option's cost, carrier, delivery estimate, and other details.\n\nAvailable only on the corresponding item target. Shipping option item targets expose shipping option properties; pickup location item targets expose pickup location properties." } ], - "value": "export interface ShippingOptionItemApi {\n /**\n * The shipping option that this extension is attached to. Use this to read the option's cost, carrier, delivery estimate, and other details.\n */\n target: SubscribableSignalLike;\n\n /**\n * Whether the buyer has selected the target shipping option. When `true`, the target option is the buyer's active choice. When `false`, the buyer has chosen a different shipping option.\n */\n isTargetSelected: SubscribableSignalLike;\n\n /**\n * The render mode of this shipping option, indicating how the extension is displayed in the checkout UI.\n */\n renderMode: ShippingOptionItemRenderMode;\n}" + "value": "export interface ShippingOptionItemApi {\n /**\n * The shipping option that this extension is attached to. Use this to read the option's cost, carrier, delivery estimate, and other details.\n *\n * Available only on the corresponding item target. Shipping option item\n * targets expose shipping option properties; pickup location item targets\n * expose pickup location properties.\n */\n target: SubscribableSignalLike;\n\n /**\n * Whether the buyer has selected the target shipping option. When `true`, the target option is the buyer's active choice. When `false`, the buyer has chosen a different shipping option.\n *\n * Available only on the corresponding item target. Shipping option item\n * targets expose shipping option properties; pickup location item targets\n * expose pickup location properties.\n */\n isTargetSelected: SubscribableSignalLike;\n\n /**\n * The render mode of this shipping option, indicating how the extension is displayed in the checkout UI.\n */\n renderMode: ShippingOptionItemRenderMode;\n}" }, "ShippingOptionItemRenderMode": { "filePath": "src/surfaces/checkout/api/shipping/shipping-option-item.ts", @@ -30784,7 +30784,7 @@ "syntaxKind": "PropertySignature", "name": "number", "value": "string", - "description": "A randomly generated alpha-numeric identifier for the order, distinct from `order.id`. The value is `undefined` for orders that were created before this field was introduced. All recent orders have a number.", + "description": "A randomly generated alpha-numeric identifier for the order, distinct from `order.id`. The value is `undefined` for orders that were created before this field was introduced. All recent orders have a number.\n\nOptional. Might not be present for orders created before 2024.", "isOptional": true }, { @@ -30795,7 +30795,7 @@ "description": "" } ], - "value": "export interface OrderConfirmation {\n order: {\n /**\n * A globally unique identifier for the order. This becomes the\n * [`Order`](/docs/api/admin-graphql/latest/objects/Order) object ID in the\n * GraphQL Admin API after the order is created.\n *\n * @example 'gid://shopify/Order/123'\n */\n id: string;\n };\n /**\n * A randomly generated alpha-numeric identifier for the order, distinct\n * from `order.id`. The value is `undefined` for orders that were created\n * before this field was introduced. All recent orders have a number.\n */\n number?: string;\n\n /**\n * Whether this is the customer's first completed order with this shop. `true` means the buyer hasn't placed an order here before. Use this to show first-purchase messaging or trigger welcome offers.\n */\n isFirstOrder: boolean;\n}" + "value": "export interface OrderConfirmation {\n order: {\n /**\n * A globally unique identifier for the order. This becomes the\n * [`Order`](/docs/api/admin-graphql/latest/objects/Order) object ID in the\n * GraphQL Admin API after the order is created.\n *\n * @example 'gid://shopify/Order/123'\n */\n id: string;\n };\n /**\n * A randomly generated alpha-numeric identifier for the order, distinct\n * from `order.id`. The value is `undefined` for orders that were created\n * before this field was introduced. All recent orders have a number.\n *\n * Optional. Might not be present for orders created before 2024.\n */\n number?: string;\n\n /**\n * Whether this is the customer's first completed order with this shop. `true` means the buyer hasn't placed an order here before. Use this to show first-purchase messaging or trigger welcome offers.\n */\n isFirstOrder: boolean;\n}" }, "AllowedComponents": { "filePath": "src/surfaces/checkout/shared.ts", @@ -30815,17 +30815,17 @@ "syntaxKind": "PropertySignature", "name": "isTargetSelected", "value": "SubscribableSignalLike", - "description": "Whether the buyer has selected the target pickup location. When `true`, the target location is the buyer's active choice. When `false`, the buyer has chosen a different pickup location." + "description": "Whether the buyer has selected the target pickup location. When `true`, the target location is the buyer's active choice. When `false`, the buyer has chosen a different pickup location.\n\nAvailable only on the corresponding item target. Shipping option item targets expose shipping option properties; pickup location item targets expose pickup location properties." }, { "filePath": "src/surfaces/checkout/api/pickup/pickup-location-item.ts", "syntaxKind": "PropertySignature", "name": "target", "value": "SubscribableSignalLike", - "description": "The pickup location that this extension is attached to. Use this to read the location's name, address, and other details." + "description": "The pickup location that this extension is attached to. Use this to read the location's name, address, and other details.\n\nAvailable only on the corresponding item target. Shipping option item targets expose shipping option properties; pickup location item targets expose pickup location properties." } ], - "value": "export interface PickupLocationItemApi {\n /**\n * The pickup location that this extension is attached to. Use this to read the location's name, address, and other details.\n */\n target: SubscribableSignalLike;\n\n /**\n * Whether the buyer has selected the target pickup location. When `true`, the target location is the buyer's active choice. When `false`, the buyer has chosen a different pickup location.\n */\n isTargetSelected: SubscribableSignalLike;\n}" + "value": "export interface PickupLocationItemApi {\n /**\n * The pickup location that this extension is attached to. Use this to read the location's name, address, and other details.\n *\n * Available only on the corresponding item target. Shipping option item\n * targets expose shipping option properties; pickup location item targets\n * expose pickup location properties.\n */\n target: SubscribableSignalLike;\n\n /**\n * Whether the buyer has selected the target pickup location. When `true`, the target location is the buyer's active choice. When `false`, the buyer has chosen a different pickup location.\n *\n * Available only on the corresponding item target. Shipping option item\n * targets expose shipping option properties; pickup location item targets\n * expose pickup location properties.\n */\n isTargetSelected: SubscribableSignalLike;\n}" }, "AnyThankYouComponent": { "filePath": "src/surfaces/checkout/shared.ts", @@ -31489,7 +31489,7 @@ "syntaxKind": "MethodSignature", "name": "applyAttributeChange", "value": "(change: AttributeChange) => Promise", - "description": "Updates or removes an attribute on the cart and checkout. On success, the [`attributes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/attributes#standardapi-propertydetail-attributes) property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.", + "description": "Updates or removes an attribute on the cart and checkout. On success, the [`attributes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/attributes#properties-propertydetail-attributes) property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.", "deprecationMessage": "Use cart metafields instead." }, { @@ -31497,42 +31497,42 @@ "syntaxKind": "MethodSignature", "name": "applyCartLinesChange", "value": "(change: CartLineChange) => Promise", - "description": "Adds, removes, or updates line items in the cart. The returned promise resolves when the change has been applied by the server, and the [`lines`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-lines#standardapi-propertydetail-lines) property updates with the new state.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Adds, removes, or updates line items in the cart. The returned promise resolves when the change has been applied by the server, and the [`lines`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-lines#properties-propertydetail-lines) property updates with the new state.\n\nAccepts a single change per call. To make multiple changes, call this method separately for each one.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyDiscountCodeChange", "value": "(change: DiscountCodeChange) => Promise", - "description": "Adds or removes a discount code on the checkout. The returned promise resolves when the change has been applied by the server, and the [`discountCodes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/discounts#standardapi-propertydetail-discountcodes) property updates with the new state.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves discount codes through a network call.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Adds or removes a discount code on the checkout. The returned promise resolves when the change has been applied by the server, and the [`discountCodes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/discounts#properties-propertydetail-discountcodes) property updates with the new state.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves discount codes through a network call.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyGiftCardChange", "value": "(change: GiftCardChange) => Promise", - "description": "Adds or removes a gift card from the checkout. The returned promise resolves when the change has been applied by the server, and the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/gift-cards#standardapi-propertydetail-appliedgiftcards) property updates with the new state.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves gift card codes through a network call.\n\n> Note: This method returns an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Adds or removes a gift card from the checkout. The returned promise resolves when the change has been applied by the server, and the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/gift-cards#properties-propertydetail-appliedgiftcards) property updates with the new state.\n\nUnlike other write operations, gift card changes aren't gated by a cart instruction flag.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves gift card codes through a network call.\n\n> Note: This method returns an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyMetafieldChange", "value": "(change: MetafieldChange) => Promise", - "description": "Creates, updates, or removes a cart metafield on the checkout. On success, the [`metafields`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/metafields#standardapi-propertydetail-metafields) property updates to reflect the change.\n\nCart metafields are copied to order metafields at order creation time if there's a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n\n> Caution: `MetafieldRemoveChange` and `MetafieldUpdateChange` are deprecated. Use cart metafields with `MetafieldRemoveCartChange` and `MetafieldUpdateCartChange` instead. If `MetafieldUpdateChange` writes a metafield with the same namespace and key as a cart metafield that's configured to copy, the cart metafield won't be copied.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Creates, updates, or removes a cart metafield on the checkout. On success, the [`metafields`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/metafields#properties-propertydetail-metafields) property updates to reflect the change.\n\nCart metafields are copied to order metafields at order creation time if there's a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n\n> Caution: `MetafieldRemoveChange` and `MetafieldUpdateChange` are deprecated. Use cart metafields with `MetafieldRemoveCartChange` and `MetafieldUpdateCartChange` instead. If `MetafieldUpdateChange` writes a metafield with the same namespace and key as a cart metafield that's configured to copy, the cart metafield won't be copied.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyNoteChange", "value": "(change: NoteChange) => Promise", - "description": "Sets or removes the buyer's note on the checkout. On success, the [`note`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/note#standardapi-propertydetail-note) property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Sets or removes the buyer's note on the checkout. On success, the [`note`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/note#properties-propertydetail-note) property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyShippingAddressChange", "value": "(change: ShippingAddressUpdateChange) => Promise", - "description": "Updates the buyer's shipping address on the checkout. The provided fields are merged into the existing address without prompting the buyer. On success, the `shippingAddress` property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", + "description": "Updates the buyer's shipping address on the checkout. The provided fields are merged into the existing address without prompting the buyer. On success, the `shippingAddress` property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", "isOptional": true }, { @@ -31545,7 +31545,7 @@ "isPrivate": true } ], - "value": "export interface CheckoutApi {\n /**\n * Updates or removes an attribute on the cart and checkout. On success, the\n * [`attributes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/attributes#standardapi-propertydetail-attributes) property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * @deprecated Use cart metafields instead.\n */\n applyAttributeChange(change: AttributeChange): Promise;\n\n /**\n * Adds, removes, or updates line items in the cart. The returned promise resolves when the change has been applied by the server, and the [`lines`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-lines#standardapi-propertydetail-lines) property updates with the new state.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyCartLinesChange(change: CartLineChange): Promise;\n\n /**\n * Adds or removes a discount code on the checkout. The returned promise resolves when the change has been applied by the server, and the [`discountCodes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/discounts#standardapi-propertydetail-discountcodes) property updates with the new state.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves discount codes through a network call.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyDiscountCodeChange(\n change: DiscountCodeChange,\n ): Promise;\n\n /**\n * Adds or removes a gift card from the checkout. The returned promise resolves when the change has been applied by the server, and the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/gift-cards#standardapi-propertydetail-appliedgiftcards) property updates with the new state.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves gift card codes through a network call.\n *\n * > Note: This method returns an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyGiftCardChange(change: GiftCardChange): Promise;\n\n /**\n * Creates, updates, or removes a cart metafield on the checkout. On success, the\n * [`metafields`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/metafields#standardapi-propertydetail-metafields) property updates to reflect the change.\n *\n * Cart metafields are copied to order metafields at order creation time if there's a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n *\n * > Caution: `MetafieldRemoveChange` and `MetafieldUpdateChange` are deprecated. Use cart metafields with `MetafieldRemoveCartChange` and `MetafieldUpdateCartChange` instead. If `MetafieldUpdateChange` writes a metafield with the same namespace and key as a cart metafield that's configured to copy, the cart metafield won't be copied.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyMetafieldChange(change: MetafieldChange): Promise;\n\n /**\n * Sets or removes the buyer's note on the checkout. On success, the\n * [`note`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/note#standardapi-propertydetail-note)\n * property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyNoteChange(change: NoteChange): Promise;\n\n /**\n * @private\n */\n experimentalIsShopAppStyle?: boolean;\n\n /**\n * Updates the buyer's shipping address on the checkout. The provided fields\n * are merged into the existing address without prompting the buyer. On success,\n * the `shippingAddress` property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyShippingAddressChange?(\n change: ShippingAddressChange,\n ): Promise;\n}" + "value": "export interface CheckoutApi {\n /**\n * Updates or removes an attribute on the cart and checkout. On success, the\n * [`attributes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/attributes#properties-propertydetail-attributes) property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * @deprecated Use cart metafields instead.\n */\n applyAttributeChange(change: AttributeChange): Promise;\n\n /**\n * Adds, removes, or updates line items in the cart. The returned promise resolves when the change has been applied by the server, and the [`lines`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-lines#properties-propertydetail-lines) property updates with the new state.\n *\n * Accepts a single change per call. To make multiple changes, call this\n * method separately for each one.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyCartLinesChange(change: CartLineChange): Promise;\n\n /**\n * Adds or removes a discount code on the checkout. The returned promise resolves when the change has been applied by the server, and the [`discountCodes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/discounts#properties-propertydetail-discountcodes) property updates with the new state.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves discount codes through a network call.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyDiscountCodeChange(\n change: DiscountCodeChange,\n ): Promise;\n\n /**\n * Adds or removes a gift card from the checkout. The returned promise resolves when the change has been applied by the server, and the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/gift-cards#properties-propertydetail-appliedgiftcards) property updates with the new state.\n *\n * Unlike other write operations, gift card changes aren't gated by a cart\n * instruction flag.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves gift card codes through a network call.\n *\n * > Note: This method returns an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyGiftCardChange(change: GiftCardChange): Promise;\n\n /**\n * Creates, updates, or removes a cart metafield on the checkout. On success, the\n * [`metafields`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/metafields#properties-propertydetail-metafields) property updates to reflect the change.\n *\n * Cart metafields are copied to order metafields at order creation time if there's a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n *\n * > Caution: `MetafieldRemoveChange` and `MetafieldUpdateChange` are deprecated. Use cart metafields with `MetafieldRemoveCartChange` and `MetafieldUpdateCartChange` instead. If `MetafieldUpdateChange` writes a metafield with the same namespace and key as a cart metafield that's configured to copy, the cart metafield won't be copied.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyMetafieldChange(change: MetafieldChange): Promise;\n\n /**\n * Sets or removes the buyer's note on the checkout. On success, the\n * [`note`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/note#properties-propertydetail-note)\n * property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyNoteChange(change: NoteChange): Promise;\n\n /**\n * @private\n */\n experimentalIsShopAppStyle?: boolean;\n\n /**\n * Updates the buyer's shipping address on the checkout. The provided fields\n * are merged into the existing address without prompting the buyer. On success,\n * the `shippingAddress` property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyShippingAddressChange?(\n change: ShippingAddressChange,\n ): Promise;\n}" }, "AttributeChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -31612,7 +31612,7 @@ "syntaxKind": "PropertySignature", "name": "value", "value": "string", - "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.", + "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.\n\nAttribute values are always strings. To store structured data, serialize it to JSON and parse it when reading.", "examples": [ { "title": "Example", @@ -31627,7 +31627,7 @@ ] } ], - "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" + "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * Attribute values are always strings. To store structured data, serialize\n * it to JSON and parse it when reading.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" }, "AttributeRemoveChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -32480,7 +32480,7 @@ "syntaxKind": "PropertySignature", "name": "message", "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer." + "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer.\n\nRender your own localized error text rather than displaying this message to the buyer." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -32490,7 +32490,7 @@ "description": "Indicates that the line item wasn't changed successfully. Refer to the `message` property for details about the error." } ], - "value": "export interface CartLineChangeResultError {\n /**\n * Indicates that the line item wasn't changed successfully. Refer to the `message` property for details about the error.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface CartLineChangeResultError {\n /**\n * Indicates that the line item wasn't changed successfully. Refer to the `message` property for details about the error.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n *\n * Render your own localized error text rather than displaying this message\n * to the buyer.\n */\n message: string;\n}" }, "DiscountCodeChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -32670,7 +32670,7 @@ "syntaxKind": "PropertySignature", "name": "message", "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer." + "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer.\n\nRender your own localized error text rather than displaying this message to the buyer." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -32680,7 +32680,7 @@ "description": "Indicates that the gift card change couldn't be applied. Check the `message` property for details." } ], - "value": "export interface GiftCardChangeResultError {\n /**\n * Indicates that the gift card change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface GiftCardChangeResultError {\n /**\n * Indicates that the gift card change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n *\n * Render your own localized error text rather than displaying this message\n * to the buyer.\n */\n message: string;\n}" }, "MetafieldChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -32941,7 +32941,7 @@ "syntaxKind": "PropertySignature", "name": "message", "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer." + "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer.\n\nRender your own localized error text rather than displaying this message to the buyer." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -32951,7 +32951,7 @@ "description": "Indicates that the metafield change couldn't be applied. Check the `message` property for details." } ], - "value": "export interface MetafieldChangeResultError {\n /**\n * Indicates that the metafield change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface MetafieldChangeResultError {\n /**\n * Indicates that the metafield change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n *\n * Render your own localized error text rather than displaying this message\n * to the buyer.\n */\n message: string;\n}" }, "NoteChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -33029,7 +33029,7 @@ "syntaxKind": "PropertySignature", "name": "message", "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer." + "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer.\n\nRender your own localized error text rather than displaying this message to the buyer." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -33039,7 +33039,7 @@ "description": "Indicates that the note change couldn't be applied. Check the `message` property for details." } ], - "value": "export interface NoteChangeResultError {\n /**\n * Indicates that the note change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface NoteChangeResultError {\n /**\n * Indicates that the note change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n *\n * Render your own localized error text rather than displaying this message\n * to the buyer.\n */\n message: string;\n}" }, "ShippingAddressUpdateChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -33618,7 +33618,7 @@ "syntaxKind": "PropertySignature", "name": "analytics", "value": "Analytics", - "description": "The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event." + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -33632,7 +33632,7 @@ "syntaxKind": "PropertySignature", "name": "applyTrackingConsentChange", "value": "ApplyTrackingConsentChangeType", - "description": "Enables setting and updating customer privacy consent settings and tracking consent metafields.\n\n> Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent) to be set to `true`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." + "description": "Enables setting and updating customer privacy consent settings and tracking consent metafields.\n\n> Note: Requires the [`collect_buyer_consent` capability](/docs/apps/build/customer-accounts/capabilities#collect-buyer-consent) to be set to `true`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -33653,7 +33653,7 @@ "syntaxKind": "PropertySignature", "name": "availablePaymentOptions", "value": "SubscribableSignalLike", - "description": "All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region." + "description": "All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n\nThe set of payment options can change when the buyer updates their address or cart, so subscribe to changes rather than reading once during initialization. Each option exposes `handle` and `type` only. Provider names, logos, fees, and installment terms aren't available." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -33690,7 +33690,7 @@ "syntaxKind": "PropertySignature", "name": "checkoutToken", "value": "SubscribableSignalLike", - "description": "A stable ID that represents the current checkout.\n\nThe value is `undefined` when the checkout hasn't been created on the server yet.\n\nUse this to correlate checkout sessions across your extension, web pixels, and backend systems.\n\nThis matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data) and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object)." + "description": "A stable ID that represents the current checkout.\n\nThe value is `undefined` when the checkout hasn't been created on the server yet.\n\nUse this to correlate checkout sessions across your extension, web pixels, and backend systems.\n\nThis matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data) and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n\nCan be `undefined`. Handle the `undefined` state before using the value." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -33711,7 +33711,7 @@ "syntaxKind": "PropertySignature", "name": "deliveryGroups", "value": "SubscribableSignalLike", - "description": "The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items." + "description": "The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n\nEmpty until the buyer enters enough address information for Shopify to calculate shipping rates." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -33732,7 +33732,7 @@ "syntaxKind": "PropertySignature", "name": "extension", "value": "Extension", - "description": "The meta information about the extension." + "description": "Metadata about the running extension, including the current target, API version, capabilities, and editor context. Use this to conditionally render content based on where the extension is running." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -33740,7 +33740,7 @@ "name": "extensionPoint", "value": "Target", "description": "The identifier that specifies where in Shopify's UI your code is being injected. This is one of the targets you've included in your extension's configuration file.", - "deprecationMessage": "Deprecated as of version `2023-07`, use `extension.target` instead.", + "deprecationMessage": "Use `extension.target` instead.", "examples": [ { "title": "Example", @@ -33759,14 +33759,14 @@ "syntaxKind": "PropertySignature", "name": "i18n", "value": "I18n", - "description": "Utilities for translating content and formatting values according to the current [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) of the checkout.\n\nRefer to [`localization` examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples) for more information." + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use alongside [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) to build fully localized extensions." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "instructions", "value": "SubscribableSignalLike", - "description": "The cart instructions used to create the checkout and possibly limit extension capabilities.\n\nThese instructions should be checked before performing any actions that might be affected by them.\n\nFor example, if you intend to add a discount code via the `applyDiscountCodeChange` method, check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n\n> Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs aren't available. See the [update guide](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples) for more information." + "description": "The cart instructions used to create the checkout and possibly limit extension capabilities.\n\nThese instructions should be checked before performing any actions that might be affected by them.\n\nFor example, if you intend to add a discount code via the `applyDiscountCodeChange` method, check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n\n> Caution: Check cart instructions before calling select APIs, as > some may not be available. See the > [Cart Instructions API](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples) > for more information." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -33780,7 +33780,7 @@ "syntaxKind": "PropertySignature", "name": "localization", "value": "Localization", - "description": "The details about the location, language, and currency of the customer. For utilities to easily format and translate content based on these details, you can use the [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n) object instead." + "description": "The buyer's language, country, currency, and timezone context. For formatting and translation helpers, use the [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#properties-propertydetail-i18n) object instead." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -33810,21 +33810,21 @@ "syntaxKind": "PropertySignature", "name": "query", "value": ">(query: string, options?: { variables?: Variables; version?: StorefrontApiVersion; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>", - "description": "The method used to query the Storefront GraphQL API with a prefetched token.\n\nRefer to [Storefront API access examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/storefront-api) for more information." + "description": "The method used to query the Storefront GraphQL API with a prefetched token." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "selectedPaymentOptions", "value": "SubscribableSignalLike", - "description": "The payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card)." + "description": "The payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\n\nEach option exposes `handle` and `type` only. Provider names, logos, fees, and installment terms aren't available." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "sessionToken", "value": "SessionToken", - "description": "The session token providing a set of claims as a signed JSON Web Token (JWT).\n\nThe token has a TTL of five minutes.\n\nIf the previous token expires, this value reflects a new session token with a new signature and expiry.\n\nRefer to [session token examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/session-token) for more information." + "description": "The session token providing a set of claims as a signed JSON Web Token (JWT).\n\nThe token has a TTL of five minutes.\n\nIf the previous token expires, this value reflects a new session token with a new signature and expiry.\n\nLearn more about [session tokens](/docs/apps/build/authentication-authorization/session-tokens)." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -33846,14 +33846,14 @@ "syntaxKind": "PropertySignature", "name": "shop", "value": "Shop", - "description": "The shop where the checkout is taking place." + "description": "The store where the checkout is taking place, including the shop name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "storage", "value": "Storage", - "description": "The key-value storage for the extension.\n\nIt uses `localStorage` and should persist across the customer's current checkout session.\n\n> Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n\nData is shared across all activated extension targets of this extension. In versions 2023-07 and earlier, each activated extension target had its own storage." + "description": "Key-value storage that persists across page loads within the current checkout session. Data is shared across all activated targets associated with this extension.\n\n> Caution: Data persistence isn't guaranteed and storage is cleared when the buyer starts a new checkout." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -33875,29 +33875,29 @@ ] } ], - "value": "export interface StandardApi {\n /**\n * The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event.\n */\n analytics: Analytics;\n\n /**\n * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\n */\n appliedGiftCards: SubscribableSignalLike;\n\n /**\n * The cart instructions used to create the checkout and possibly limit extension capabilities.\n *\n * These instructions should be checked before performing any actions that might be affected by them.\n *\n * For example, if you intend to add a discount code via the `applyDiscountCodeChange` method,\n * check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n *\n * > Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs aren't available.\n * See the [update guide](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples) for more information.\n *\n */\n instructions: SubscribableSignalLike;\n\n /**\n * The metafields requested in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration)\n * file. These metafields are updated when there's a change in the merchandise items\n * being purchased by the customer.\n *\n * App owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` isn't supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n appMetafields: SubscribableSignalLike;\n\n /**\n * The custom key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n buyerIdentity?: BuyerIdentity;\n\n /**\n * Provides details on the buyer's progression through the checkout and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/buyer-journey#examples)\n * examples for more information.\n */\n buyerJourney: BuyerJourney;\n\n /**\n * Settings applied to the buyer's checkout.\n */\n checkoutSettings: SubscribableSignalLike;\n\n /**\n * A stable ID that represents the current checkout.\n *\n * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\n *\n * This matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data)\n * and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n */\n checkoutToken: SubscribableSignalLike;\n\n /**\n * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * The meta information about the extension.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n *\n * @deprecated Deprecated as of version `2023-07`, use `extension.target` instead.\n */\n extensionPoint: Target;\n\n /**\n * Utilities for translating content and formatting values according to the current\n * [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization)\n * of the checkout.\n *\n * Refer to [`localization` examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples)\n * for more information.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The details about the location, language, and currency of the customer. For utilities to easily\n * format and translate content based on these details, you can use the\n * [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n)\n * object instead.\n */\n localization: Localization;\n\n /**\n * The metafields that apply to the current checkout.\n *\n * Metafields are stored locally on the client and are applied to the order object after the checkout completes.\n *\n * These metafields are shared by all extensions running on checkout, and\n * persist for as long as the customer is working on this checkout.\n *\n * Once the order is created, you can query these metafields using the\n * [GraphQL Admin API](/docs/admin-api/graphql/reference/orders/order#metafield-2021-01)\n *\n * > Caution:\n * `metafields` is deprecated. Use `appMetafields` with cart metafields instead.\n *\n * @deprecated Use `appMetafields` with cart metafields instead.\n */\n metafields: SubscribableSignalLike;\n\n /**\n * A note left by the customer to the merchant, either in their cart or during checkout.\n *\n * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\n */\n note: SubscribableSignalLike;\n\n /**\n * The method used to query the Storefront GraphQL API with a prefetched token.\n *\n * Refer to [Storefront API access examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/storefront-api) for more information.\n */\n query: >(\n query: string,\n options?: {variables?: Variables; version?: StorefrontApiVersion},\n ) => Promise<{data?: Data; errors?: GraphQLError[]}>;\n\n /**\n * The payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\n */\n selectedPaymentOptions: SubscribableSignalLike;\n\n /**\n * The session token providing a set of claims as a signed JSON Web Token (JWT).\n *\n * The token has a TTL of five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/session-token) for more information.\n */\n sessionToken: SessionToken;\n\n /**\n * The settings matching the settings definition written in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates in real time as a merchant fills in the settings.\n */\n settings: SubscribableSignalLike;\n\n /**\n * The proposed customer shipping address. During the information step, the address\n * updates when the field is committed (on change) rather than every keystroke.\n * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n shippingAddress?: SubscribableSignalLike;\n\n /**\n * The proposed customer billing address. The address updates when the field is\n * committed (on change) rather than every keystroke. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided yet.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n billingAddress?: SubscribableSignalLike;\n\n /** The shop where the checkout is taking place. */\n shop: Shop;\n\n /**\n * The key-value storage for the extension.\n *\n * It uses `localStorage` and should persist across the customer's current checkout session.\n *\n * > Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n *\n * Data is shared across all activated extension targets of this extension. In versions 2023-07 and earlier,\n * each activated extension target had its own storage.\n */\n storage: Storage;\n\n /**\n * The renderer version being used for the extension.\n *\n * @example '2025-10'\n */\n version: Version;\n\n /**\n * Customer privacy consent settings and a flag denoting if consent has previously been collected.\n */\n customerPrivacy: SubscribableSignalLike;\n\n /**\n * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent) to be set to `true`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyTrackingConsentChange: ApplyTrackingConsentChangeType;\n\n /**\n * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" + "value": "export interface StandardApi {\n /**\n * Tracks custom events and sends visitor information to\n * [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events\n * and `visitor()` to submit buyer contact details.\n */\n analytics: Analytics;\n\n /**\n * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\n */\n appliedGiftCards: SubscribableSignalLike;\n\n /**\n * The cart instructions used to create the checkout and possibly limit extension capabilities.\n *\n * These instructions should be checked before performing any actions that might be affected by them.\n *\n * For example, if you intend to add a discount code via the `applyDiscountCodeChange` method,\n * check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n *\n * > Caution: Check cart instructions before calling select APIs, as\n * > some may not be available. See the\n * > [Cart Instructions API](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples)\n * > for more information.\n *\n */\n instructions: SubscribableSignalLike;\n\n /**\n * The metafields requested in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration)\n * file. These metafields are updated when there's a change in the merchandise items\n * being purchased by the customer.\n *\n * App owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` isn't supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n appMetafields: SubscribableSignalLike;\n\n /**\n * The custom key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as\n * credit cards, wallets, and local payment methods. The list depends on\n * the shop's payment configuration and the buyer's region.\n *\n * The set of payment options can change when the buyer updates their\n * address or cart, so subscribe to changes rather than reading once\n * during initialization. Each option exposes `handle` and `type` only.\n * Provider names, logos, fees, and installment terms aren't available.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n buyerIdentity?: BuyerIdentity;\n\n /**\n * Provides details on the buyer's progression through the checkout and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/buyer-journey#examples)\n * examples for more information.\n */\n buyerJourney: BuyerJourney;\n\n /**\n * Settings applied to the buyer's checkout.\n */\n checkoutSettings: SubscribableSignalLike;\n\n /**\n * A stable ID that represents the current checkout.\n *\n * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\n *\n * This matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data)\n * and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n *\n * Can be `undefined`. Handle the `undefined` state before using the value.\n */\n checkoutToken: SubscribableSignalLike;\n\n /**\n * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n *\n * Empty until the buyer enters enough address information for Shopify to\n * calculate shipping rates.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * Metadata about the running extension, including the current target, API version,\n * capabilities, and editor context. Use this to conditionally render content\n * based on where the extension is running.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n *\n * @deprecated Use `extension.target` instead.\n */\n extensionPoint: Target;\n\n /**\n * Utilities for translating strings, formatting currencies, numbers, and dates\n * according to the buyer's locale. Use alongside\n * [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization)\n * to build fully localized extensions.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The buyer's language, country, currency, and timezone context. For\n * formatting and translation helpers, use the\n * [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#properties-propertydetail-i18n)\n * object instead.\n */\n localization: Localization;\n\n /**\n * The metafields that apply to the current checkout.\n *\n * Metafields are stored locally on the client and are applied to the order object after the checkout completes.\n *\n * These metafields are shared by all extensions running on checkout, and\n * persist for as long as the customer is working on this checkout.\n *\n * Once the order is created, you can query these metafields using the\n * [GraphQL Admin API](/docs/admin-api/graphql/reference/orders/order#metafield-2021-01)\n *\n * > Caution:\n * `metafields` is deprecated. Use `appMetafields` with cart metafields instead.\n *\n * @deprecated Use `appMetafields` with cart metafields instead.\n */\n metafields: SubscribableSignalLike;\n\n /**\n * A note left by the customer to the merchant, either in their cart or during checkout.\n *\n * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\n */\n note: SubscribableSignalLike;\n\n /**\n * The method used to query the Storefront GraphQL API with a prefetched token.\n *\n */\n query: >(\n query: string,\n options?: {variables?: Variables; version?: StorefrontApiVersion},\n ) => Promise<{data?: Data; errors?: GraphQLError[]}>;\n\n /**\n * The payment options the buyer has currently selected. This updates as\n * the buyer changes their payment method. The array can contain multiple\n * entries when the buyer splits payment across methods (for example, a\n * gift card and a credit card).\n *\n * Each option exposes `handle` and `type` only. Provider names, logos,\n * fees, and installment terms aren't available.\n */\n selectedPaymentOptions: SubscribableSignalLike;\n\n /**\n * The session token providing a set of claims as a signed JSON Web Token (JWT).\n *\n * The token has a TTL of five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Learn more about [session tokens](/docs/apps/build/authentication-authorization/session-tokens).\n */\n sessionToken: SessionToken;\n\n /**\n * The settings matching the settings definition written in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates in real time as a merchant fills in the settings.\n */\n settings: SubscribableSignalLike;\n\n /**\n * The proposed customer shipping address. During the information step, the address\n * updates when the field is committed (on change) rather than every keystroke.\n * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n shippingAddress?: SubscribableSignalLike;\n\n /**\n * The proposed customer billing address. The address updates when the field is\n * committed (on change) rather than every keystroke. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided yet.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n billingAddress?: SubscribableSignalLike;\n\n /**\n * The store where the checkout is taking place, including the shop name,\n * storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.\n */\n shop: Shop;\n\n /**\n * Key-value storage that persists across page loads within the current checkout\n * session. Data is shared across all activated targets associated with\n * this extension.\n *\n * > Caution: Data persistence isn't guaranteed and storage is cleared when the\n * buyer starts a new checkout.\n */\n storage: Storage;\n\n /**\n * The renderer version being used for the extension.\n *\n * @example '2025-10'\n */\n version: Version;\n\n /**\n * Customer privacy consent settings and a flag denoting if consent has previously been collected.\n */\n customerPrivacy: SubscribableSignalLike;\n\n /**\n * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`collect_buyer_consent` capability](/docs/apps/build/customer-accounts/capabilities#collect-buyer-consent) to be set to `true`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyTrackingConsentChange: ApplyTrackingConsentChangeType;\n\n /**\n * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" }, "Analytics": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Analytics", - "description": "", + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "publish", "value": "(name: string, data: Record) => Promise", - "description": "Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing)." + "description": "Publishes a custom event to [Web Pixels](/docs/apps/marketing). Returns `true` when the event is successfully dispatched.\n\nThe Promise resolves to `true` when the event was dispatched. The boolean indicates dispatch confirmation only. It doesn't indicate whether any specific web pixel processed the event." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "visitor", "value": "(data: { email?: string; phone?: string; }) => Promise", - "description": "A method for capturing details about a visitor on the online store." + "description": "Submits buyer contact details for attribution and analytics purposes." } ], - "value": "export interface Analytics {\n /**\n * Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing).\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * A method for capturing details about a visitor on the online store.\n */\n visitor(data: {email?: string; phone?: string}): Promise;\n}" + "value": "export interface Analytics {\n /**\n * Publishes a custom event to [Web Pixels](/docs/apps/marketing).\n * Returns `true` when the event is successfully dispatched.\n *\n * The Promise resolves to `true` when the event was dispatched. The boolean\n * indicates dispatch confirmation only. It doesn't indicate whether any\n * specific web pixel processed the event.\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * Submits buyer contact details for attribution and analytics purposes.\n */\n visitor(data: {email?: string; phone?: string}): Promise;\n}" }, "VisitorResult": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -33938,10 +33938,10 @@ "syntaxKind": "PropertySignature", "name": "type", "value": "'error'", - "description": "Indicates that the visitor information is invalid and wasn't submitted. Examples are using the wrong data type or missing a required property." + "description": "Indicates that the visitor information is invalid and wasn't submitted. Common causes include using the wrong data type or omitting a required property." } ], - "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Examples are using the wrong data type or missing a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Common causes include using the wrong data type or omitting a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" }, "SubscribableSignalLike": { "filePath": "src/surfaces/checkout/shared.ts", @@ -34114,10 +34114,10 @@ "syntaxKind": "PropertySignature", "name": "value", "value": "string | null", - "description": "The new value to store in the metafield. Set to `null` to delete the metafield." + "description": "The new value to store in the metafield. Set to `null` to delete the metafield.\n\nConsent metafield values are strings, not booleans. Pass `null` to delete a tracking consent metafield." } ], - "value": "export interface TrackingConsentMetafieldChange {\n /**\n * The identifier for the tracking consent metafield to update.\n */\n key: string;\n /**\n * The new value to store in the metafield. Set to `null` to delete the metafield.\n */\n value: string | null;\n}" + "value": "export interface TrackingConsentMetafieldChange {\n /**\n * The identifier for the tracking consent metafield to update.\n */\n key: string;\n /**\n * The new value to store in the metafield. Set to `null` to delete the metafield.\n *\n * Consent metafield values are strings, not booleans. Pass `null` to delete\n * a tracking consent metafield.\n */\n value: string | null;\n}" }, "VisitorConsent": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -34416,7 +34416,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A globally-unique identifier for the customer in the format `gid://shopify/Customer/`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", + "description": "An identifier for the customer in the format `gid://shopify/Customer/`. This value is unique per shop.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", "examples": [ { "title": "Example", @@ -34469,7 +34469,7 @@ "isPrivate": true } ], - "value": "export interface Customer {\n /**\n * A globally-unique identifier for the customer in the format `gid://shopify/Customer/`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'gid://shopify/Customer/123'\n */\n id: string;\n /**\n * The email address associated with the customer's account. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email?: string;\n /**\n * The phone number associated with the customer's account. The value is `undefined` if no phone number is on file or the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone?: string;\n /**\n * The customer's full name, typically a combination of first and last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n fullName?: string;\n /**\n * The customer's first name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n firstName?: string;\n /**\n * The customer's last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n lastName?: string;\n /**\n * The customer's profile image, such as a Gravatar avatar. Use this to personalize the extension UI for the logged-in buyer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n image: ImageDetails;\n /**\n * Whether the customer has opted in to receiving marketing communications from the merchant, such as email campaigns and promotional offers.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * > Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n *\n * @deprecated Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n */\n acceptsMarketing: boolean;\n /**\n * Whether the customer has opted in to email marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsEmailMarketing: boolean;\n /**\n * Whether the customer has opted in to SMS marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsSmsMarketing: boolean;\n /**\n * The store credit accounts owned by this customer that can be used as payment during checkout. Each account has a balance representing available store credit.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @private\n */\n storeCreditAccounts: StoreCreditAccount[];\n /**\n * The number of orders the customer has previously placed with this shop.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n ordersCount: number;\n}" + "value": "export interface Customer {\n /**\n * An identifier for the customer in the format `gid://shopify/Customer/`. This value is unique per shop.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'gid://shopify/Customer/123'\n */\n id: string;\n /**\n * The email address associated with the customer's account. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email?: string;\n /**\n * The phone number associated with the customer's account. The value is `undefined` if no phone number is on file or the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone?: string;\n /**\n * The customer's full name, typically a combination of first and last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n fullName?: string;\n /**\n * The customer's first name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n firstName?: string;\n /**\n * The customer's last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n lastName?: string;\n /**\n * The customer's profile image, such as a Gravatar avatar. Use this to personalize the extension UI for the logged-in buyer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n image: ImageDetails;\n /**\n * Whether the customer has opted in to receiving marketing communications from the merchant, such as email campaigns and promotional offers.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * > Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n *\n * @deprecated Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n */\n acceptsMarketing: boolean;\n /**\n * Whether the customer has opted in to email marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsEmailMarketing: boolean;\n /**\n * Whether the customer has opted in to SMS marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsSmsMarketing: boolean;\n /**\n * The store credit accounts owned by this customer that can be used as payment during checkout. Each account has a balance representing available store credit.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @private\n */\n storeCreditAccounts: StoreCreditAccount[];\n /**\n * The number of orders the customer has previously placed with this shop.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n ordersCount: number;\n}" }, "StoreCreditAccount": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -34728,11 +34728,11 @@ "syntaxKind": "MethodSignature", "name": "perform", "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", + "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.\n\nRuns after all intercept results are collected. Use it for local state updates such as setting an error flag. By the time it runs, the navigation decision is final, so blocking logic belongs in the intercept handler itself, not here.", "isOptional": true } ], - "value": "interface InterceptorRequestAllow {\n /**\n * Indicates that the interceptor allows the buyer's journey to continue.\n */\n behavior: 'allow';\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" + "value": "interface InterceptorRequestAllow {\n /**\n * Indicates that the interceptor allows the buyer's journey to continue.\n */\n behavior: 'allow';\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n *\n * Runs after all intercept results are collected. Use it for local state\n * updates such as setting an error flag. By the time it runs, the navigation\n * decision is final, so blocking logic belongs in the intercept handler\n * itself, not here.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" }, "InterceptorResult": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -34796,7 +34796,7 @@ "syntaxKind": "MethodSignature", "name": "perform", "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", + "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.\n\nRuns after all intercept results are collected. Use it for local state updates such as setting an error flag. By the time it runs, the navigation decision is final, so blocking logic belongs in the intercept handler itself, not here.", "isOptional": true }, { @@ -34807,7 +34807,7 @@ "description": "The reason for blocking the interceptor request. This value isn't presented to the buyer, so it doesn't need to be localized. The value is used only for Shopify's own internal debugging and metrics." } ], - "value": "interface InterceptorRequestBlock {\n /**\n * Indicates that the interceptor blocks the buyer's journey from continuing.\n */\n behavior: 'block';\n\n /**\n * The reason for blocking the interceptor request. This value isn't presented to\n * the buyer, so it doesn't need to be localized. The value is used only for Shopify's\n * own internal debugging and metrics.\n */\n reason: string;\n\n /**\n * Used to pass errors to the checkout UI, outside your extension's UI boundaries.\n */\n errors?: ValidationError[];\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" + "value": "interface InterceptorRequestBlock {\n /**\n * Indicates that the interceptor blocks the buyer's journey from continuing.\n */\n behavior: 'block';\n\n /**\n * The reason for blocking the interceptor request. This value isn't presented to\n * the buyer, so it doesn't need to be localized. The value is used only for Shopify's\n * own internal debugging and metrics.\n */\n reason: string;\n\n /**\n * Used to pass errors to the checkout UI, outside your extension's UI boundaries.\n */\n errors?: ValidationError[];\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n *\n * Runs after all intercept results are collected. Use it for local state\n * updates such as setting an error flag. By the time it runs, the navigation\n * decision is final, so blocking logic belongs in the intercept handler\n * itself, not here.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" }, "ValidationError": { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -35028,17 +35028,17 @@ "syntaxKind": "PropertySignature", "name": "totalShippingAmount", "value": "SubscribableSignalLike", - "description": "The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step." + "description": "The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step.\n\n`undefined` until the buyer selects a shipping method (typically after the information step)." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "totalTaxAmount", "value": "SubscribableSignalLike", - "description": "The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet." + "description": "The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet.\n\n`undefined` when taxes haven't been calculated or aren't available for the buyer's region." } ], - "value": "export interface CartCost {\n /**\n * The sum of all line item prices at the current step of checkout, before shipping and taxes are applied. Use this value to display the base cost of the items the buyer purchased.\n */\n subtotalAmount: SubscribableSignalLike;\n\n /**\n * The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step.\n */\n totalShippingAmount: SubscribableSignalLike;\n\n /**\n * The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet.\n */\n totalTaxAmount: SubscribableSignalLike;\n\n /**\n * The minimum total at the current step of checkout. Costs not yet calculated, such as shipping on the information step, aren't included. Gift cards and store credits are excluded from this total.\n */\n totalAmount: SubscribableSignalLike;\n}" + "value": "export interface CartCost {\n /**\n * The sum of all line item prices at the current step of checkout, before shipping and taxes are applied. Use this value to display the base cost of the items the buyer purchased.\n */\n subtotalAmount: SubscribableSignalLike;\n\n /**\n * The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step.\n *\n * `undefined` until the buyer selects a shipping method (typically after the\n * information step).\n */\n totalShippingAmount: SubscribableSignalLike;\n\n /**\n * The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet.\n *\n * `undefined` when taxes haven't been calculated or aren't available for the\n * buyer's region.\n */\n totalTaxAmount: SubscribableSignalLike;\n\n /**\n * The minimum total at the current step of checkout. Costs not yet calculated, such as shipping on the information step, aren't included. Gift cards and store credits are excluded from this total.\n */\n totalAmount: SubscribableSignalLike;\n}" }, "CustomerPrivacy": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -35125,31 +35125,31 @@ "syntaxKind": "PropertySignature", "name": "analytics", "value": "boolean", - "description": "Whether analytics data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Analytics data includes how the shop was used and what interactions occurred." + "description": "Whether analytics data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Analytics data includes how the shop was used and what interactions occurred.\n\nWhether analytics data can be collected right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.analytics`, before calling `shopify.analytics.publish()`." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "marketing", "value": "boolean", - "description": "Whether marketing data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Marketing data includes attribution and targeted advertising preferences." + "description": "Whether marketing data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Marketing data includes attribution and targeted advertising preferences.\n\nWhether marketing data can be collected right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.marketing`, before performing marketing-related data collection." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "preferences", "value": "boolean", - "description": "Whether preference data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Preference data includes language, currency, and sizing choices." + "description": "Whether preference data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Preference data includes language, currency, and sizing choices.\n\nWhether preference data can be collected right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.preferences`, before storing or reading buyer preference data." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "saleOfData", "value": "boolean", - "description": "Whether data can be shared with third parties based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. This typically applies to behavioral advertising data." + "description": "Whether data can be shared with third parties based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. This typically applies to behavioral advertising data.\n\nWhether buyer data can be shared with or sold to third parties right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.saleOfData`, before sharing or selling buyer data with third parties." } ], - "value": "export interface AllowedProcessing {\n /**\n * Whether analytics data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Analytics\n * data includes how the shop was used and what interactions occurred.\n */\n analytics: boolean;\n /**\n * Whether marketing data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Marketing\n * data includes attribution and targeted advertising preferences.\n */\n marketing: boolean;\n /**\n * Whether preference data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Preference\n * data includes language, currency, and sizing choices.\n */\n preferences: boolean;\n /**\n * Whether data can be shared with third parties based on the visitor's\n * consent, the merchant's privacy configuration, and the visitor's region.\n * This typically applies to behavioral advertising data.\n */\n saleOfData: boolean;\n}" + "value": "export interface AllowedProcessing {\n /**\n * Whether analytics data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Analytics\n * data includes how the shop was used and what interactions occurred.\n *\n * Whether analytics data can be collected right now. Combines the buyer's\n * consent, the merchant's privacy configuration, and the buyer's region into\n * a single boolean. Check this flag, not `visitorConsent.analytics`, before\n * calling `shopify.analytics.publish()`.\n */\n analytics: boolean;\n /**\n * Whether marketing data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Marketing\n * data includes attribution and targeted advertising preferences.\n *\n * Whether marketing data can be collected right now. Combines the buyer's\n * consent, the merchant's privacy configuration, and the buyer's region into\n * a single boolean. Check this flag, not `visitorConsent.marketing`, before\n * performing marketing-related data collection.\n */\n marketing: boolean;\n /**\n * Whether preference data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Preference\n * data includes language, currency, and sizing choices.\n *\n * Whether preference data can be collected right now. Combines the buyer's\n * consent, the merchant's privacy configuration, and the buyer's region into\n * a single boolean. Check this flag, not `visitorConsent.preferences`,\n * before storing or reading buyer preference data.\n */\n preferences: boolean;\n /**\n * Whether data can be shared with third parties based on the visitor's\n * consent, the merchant's privacy configuration, and the visitor's region.\n * This typically applies to behavioral advertising data.\n *\n * Whether buyer data can be shared with or sold to third parties right now.\n * Combines the buyer's consent, the merchant's privacy configuration, and\n * the buyer's region into a single boolean. Check this flag, not\n * `visitorConsent.saleOfData`, before sharing or selling buyer data with\n * third parties.\n */\n saleOfData: boolean;\n}" }, "TrackingConsentMetafield": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -35687,7 +35687,7 @@ "Extension": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Extension", - "description": "The meta information about an extension target.", + "description": "Metadata about the running extension, including its API version, target, capabilities, and editor context. Use this to read configuration details or conditionally render content based on where the extension is running.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -35713,7 +35713,7 @@ "syntaxKind": "PropertySignature", "name": "capabilities", "value": "SubscribableSignalLike", - "description": "The allowed capabilities of the extension, defined in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n\n* [`api_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#api-access): the extension can access the Storefront API.\n\n* [`network_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access): the extension can make external network calls.\n\n* [`block_progress`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n\n* [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n\n* [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can register customer consent decisions that are honored on Shopify-managed services.\n\n* [`iframe.sources`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#iframe): the extension can embed an external URL in an iframe." + "description": "The allowed capabilities of the extension, defined in your [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -35761,7 +35761,7 @@ "syntaxKind": "PropertySignature", "name": "version", "value": "string", - "description": "The published version of the running extension target.\n\nFor unpublished extensions, the value is `undefined`.", + "description": "The published version of the running extension target.\n\nFor unpublished extensions, the value is `undefined`.\n\nDon't use this property as a stable identifier in development environments. It becomes available only after the extension is published.", "isOptional": true, "examples": [ { @@ -35777,7 +35777,7 @@ ] } ], - "value": "export interface Extension {\n /**\n * The API version that was set in the extension config file.\n *\n * @example '2024-10', '2025-01', '2025-04', '2025-07', '2025-10'\n */\n apiVersion: ApiVersion;\n\n /**\n * The allowed capabilities of the extension, defined\n * in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n *\n * * [`api_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#api-access): the extension can access the Storefront API.\n *\n * * [`network_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access): the extension can make external network calls.\n *\n * * [`block_progress`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n *\n * * [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n *\n * * [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can register customer consent decisions that are honored on Shopify-managed services.\n *\n * * [`iframe.sources`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#iframe): the extension can embed an external URL in an iframe.\n */\n capabilities: SubscribableSignalLike;\n\n /**\n * Information about the editor where the extension is being rendered.\n *\n * If the value is undefined, then the extension isn't running in an editor.\n */\n editor?: Editor;\n\n /**\n * A Boolean to show whether your extension is currently rendered to the screen.\n *\n * Shopify might render your extension before it's visible in the UI,\n * typically to pre-render extensions that appear on a later step of the\n * checkout.\n *\n * Your extension might also continue to run after the customer has navigated away\n * from where it was rendered. The extension continues running so that\n * your extension is immediately available to render if the customer navigates back.\n */\n rendered: SubscribableSignalLike;\n\n /**\n * The URL to the script that started the extension target.\n */\n scriptUrl: string;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n */\n target: Target;\n\n /**\n * The published version of the running extension target.\n *\n * For unpublished extensions, the value is `undefined`.\n *\n * @example 3.0.10\n */\n version?: string;\n}" + "value": "export interface Extension {\n /**\n * The API version that was set in the extension config file.\n *\n * @example '2024-10', '2025-01', '2025-04', '2025-07', '2025-10'\n */\n apiVersion: ApiVersion;\n\n /**\n * The allowed capabilities of the extension, defined in your\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n */\n capabilities: SubscribableSignalLike;\n\n /**\n * Information about the editor where the extension is being rendered.\n *\n * If the value is undefined, then the extension isn't running in an editor.\n */\n editor?: Editor;\n\n /**\n * A Boolean to show whether your extension is currently rendered to the screen.\n *\n * Shopify might render your extension before it's visible in the UI,\n * typically to pre-render extensions that appear on a later step of the\n * checkout.\n *\n * Your extension might also continue to run after the customer has navigated away\n * from where it was rendered. The extension continues running so that\n * your extension is immediately available to render if the customer navigates back.\n */\n rendered: SubscribableSignalLike;\n\n /**\n * The URL to the script that started the extension target.\n */\n scriptUrl: string;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n */\n target: Target;\n\n /**\n * The published version of the running extension target.\n *\n * For unpublished extensions, the value is `undefined`.\n *\n * Don't use this property as a stable identifier in development environments.\n * It becomes available only after the extension is published.\n *\n * @example 3.0.10\n */\n version?: string;\n}" }, "ApiVersion": { "filePath": "src/shared.ts", @@ -35796,7 +35796,7 @@ "Editor": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Editor", - "description": "", + "description": "Information about the editor environment when an extension is rendered inside the checkout editor. The value is `undefined` when the extension is not rendering in an editor.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -35811,7 +35811,7 @@ "I18n": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18n", - "description": "", + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use the I18n API alongside the Localization API to build fully localized extensions.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -35847,7 +35847,7 @@ "I18nTranslate": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18nTranslate", - "description": "This returns a translated string matching a key in a locale file.", + "description": "Translates a key from your extension's locale files into a localized string. Supports interpolation with placeholder replacements and pluralization via the special `count` option.", "members": [], "value": "export interface I18nTranslate {\n (\n key: string,\n options?: Record,\n ): ReplacementType extends string | number\n ? string\n : (string | ReplacementType)[];\n}" }, @@ -36015,14 +36015,14 @@ "Localization": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Localization", - "description": "", + "description": "The buyer's language, country, currency, and timezone context. Use this to adapt your extension to the buyer's region and display localized content.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "country", "value": "SubscribableSignalLike", - "description": "The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown." + "description": "The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n\nDerived from the buyer's shipping address. Returns `undefined` until the buyer enters a shipping address." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -36050,18 +36050,18 @@ "syntaxKind": "PropertySignature", "name": "market", "value": "SubscribableSignalLike", - "description": "The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n\n> Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.", - "deprecationMessage": "Deprecated as of version `2025-04`" + "description": "The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. The market context updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.", + "deprecationMessage": "Merchants now manage which extensions load for each\nmarket, so extensions no longer need to check this value." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "timezone", "value": "SubscribableSignalLike", - "description": "The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time." + "description": "The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time." } ], - "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n *\n * > Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" + "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n *\n * Derived from the buyer's shipping address. Returns `undefined` until the\n * buyer enters a shipping address.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout,\n * carried over from the cart context. Markets group countries and\n * regions with shared pricing, languages, and domains. The market\n * context updates when the buyer changes the country of their\n * shipping address. The value is `undefined` if the market is unknown.\n *\n * @deprecated Merchants now manage which extensions load for each\n * market, so extensions no longer need to check this value.\n */\n market: SubscribableSignalLike;\n}" }, "Country": { "filePath": "src/shared.ts", @@ -36262,7 +36262,7 @@ "SessionToken": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SessionToken", - "description": "", + "description": "Authenticates requests between your extension and your app backend. Use session tokens to verify the identity of the buyer and the shop context when making server-side API calls. The token is a signed JWT that contains claims such as the customer ID, shop domain, and expiration.\n\nThe `sub` claim in the decoded token is present only when the buyer is logged in and the app has permission to read customer accounts. Absent for anonymous buyers.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -36285,7 +36285,7 @@ "Shop": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Shop", - "description": "", + "description": "Metadata about the merchant's store, including its name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -36325,30 +36325,30 @@ "syntaxKind": "PropertySignature", "name": "storefrontUrl", "value": "string", - "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n\n> Caution: > As of version `2024-04` this value no longer has a trailing slash.", + "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.", "isOptional": true } ], - "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n *\n * > Caution:\n * > As of version `2024-04` this value no longer has a trailing slash.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom domain.\n */\n myshopifyDomain: string;\n}" + "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom domain.\n */\n myshopifyDomain: string;\n}" }, "Storage": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Storage", - "description": "A key-value storage object for the extension.\n\nStored data is available only to this specific extension and any of its instances.\n\nThe storage backend is implemented with `localStorage` and should persist across the buyer's checkout session. However, data persistence isn't guaranteed.", + "description": "Key-value storage for a specific extension. Use storage to save preferences or cached data that should survive page reloads without requiring a backend call. Stored data is only available to this specific extension. The storage backend is implemented with `localStorage` and data persistence isn't guaranteed.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "delete", "value": "(key: string) => Promise", - "description": "Delete stored data by key." + "description": "Deletes a previously stored value by key." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "read", "value": "(key: string) => Promise", - "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original primitive.\n\nReturns `null` if no stored data exists." + "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original type.\n\nReturns the stored value for the given key, or `null` when no value exists. Doesn't throw on a missing key." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -36358,7 +36358,7 @@ "description": "Write stored data for this key.\n\nThe data must be serializable to JSON." } ], - "value": "export interface Storage {\n /**\n * Read and return a stored value by key.\n *\n * The stored data is deserialized from JSON and returned as\n * its original primitive.\n *\n * Returns `null` if no stored data exists.\n */\n read(key: string): Promise;\n\n /**\n * Write stored data for this key.\n *\n * The data must be serializable to JSON.\n */\n write(key: string, data: any): Promise;\n\n /**\n * Delete stored data by key.\n */\n delete(key: string): Promise;\n}" + "value": "export interface Storage {\n /**\n * Read and return a stored value by key.\n *\n * The stored data is deserialized from JSON and returned as\n * its original type.\n *\n * Returns the stored value for the given key, or `null` when no value\n * exists. Doesn't throw on a missing key.\n */\n read(key: string): Promise;\n\n /**\n * Write stored data for this key.\n *\n * The data must be serializable to JSON.\n */\n write(key: string, data: any): Promise;\n\n /**\n * Deletes a previously stored value by key.\n */\n delete(key: string): Promise;\n}" }, "Version": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -36385,10 +36385,10 @@ "syntaxKind": "PropertySignature", "name": "target", "value": "SubscribableSignalLike", - "description": "The cart line that this extension is attached to. Use this to read the line item's merchandise, quantity, cost, and attributes.\n\n> Note: Until version `2023-04`, this property was a `ReadonlySignalLike`." + "description": "The cart line that this extension is attached to. Use this to read the line item's merchandise, quantity, cost, and attributes.\n\nAvailable only on the corresponding item target. Shipping option item targets expose shipping option properties; pickup location item targets expose pickup location properties.\n\n> Note: Until version `2023-04`, this property was a `ReadonlySignalLike`." } ], - "value": "export interface CartLineItemApi {\n /**\n * The cart line that this extension is attached to. Use this to read the\n * line item's merchandise, quantity, cost, and attributes.\n *\n * > Note: Until version `2023-04`, this property was a `ReadonlySignalLike`.\n */\n target: SubscribableSignalLike;\n}" + "value": "export interface CartLineItemApi {\n /**\n * The cart line that this extension is attached to. Use this to read the\n * line item's merchandise, quantity, cost, and attributes.\n *\n * Available only on the corresponding item target. Shipping option item\n * targets expose shipping option properties; pickup location item targets\n * expose pickup location properties.\n *\n * > Note: Until version `2023-04`, this property was a `ReadonlySignalLike`.\n */\n target: SubscribableSignalLike;\n}" }, "RedeemableApi": { "filePath": "src/surfaces/checkout/api/redeemable/redeemable.ts", @@ -36653,10 +36653,10 @@ "syntaxKind": "PropertySignature", "name": "isLocationFormVisible", "value": "SubscribableSignalLike", - "description": "Whether the location search form is currently visible to the buyer. Use this to conditionally render UI that depends on the buyer actively searching for pickup points." + "description": "Reflects which view was active when the extension loaded. When the buyer moves to the next view, the extension restarts with the current value rather than updating in place." } ], - "value": "export interface PickupPointListApi {\n /**\n * Whether the location search form is currently visible to the buyer.\n * Use this to conditionally render UI that depends on the buyer actively\n * searching for pickup points.\n */\n isLocationFormVisible: SubscribableSignalLike;\n}" + "value": "export interface PickupPointListApi {\n /**\n * Reflects which view was active when the extension loaded. When the\n * buyer moves to the next view, the extension restarts with the\n * current value rather than updating in place.\n */\n isLocationFormVisible: SubscribableSignalLike;\n}" }, "ShippingOptionItemApi": { "filePath": "src/surfaces/checkout/api/shipping/shipping-option-item.ts", @@ -36669,7 +36669,7 @@ "syntaxKind": "PropertySignature", "name": "isTargetSelected", "value": "SubscribableSignalLike", - "description": "Whether the buyer has selected the target shipping option. When `true`, the target option is the buyer's active choice. When `false`, the buyer has chosen a different shipping option." + "description": "Whether the buyer has selected the target shipping option. When `true`, the target option is the buyer's active choice. When `false`, the buyer has chosen a different shipping option.\n\nAvailable only on the corresponding item target. Shipping option item targets expose shipping option properties; pickup location item targets expose pickup location properties." }, { "filePath": "src/surfaces/checkout/api/shipping/shipping-option-item.ts", @@ -36683,10 +36683,10 @@ "syntaxKind": "PropertySignature", "name": "target", "value": "SubscribableSignalLike", - "description": "The shipping option that this extension is attached to. Use this to read the option's cost, carrier, delivery estimate, and other details." + "description": "The shipping option that this extension is attached to. Use this to read the option's cost, carrier, delivery estimate, and other details.\n\nAvailable only on the corresponding item target. Shipping option item targets expose shipping option properties; pickup location item targets expose pickup location properties." } ], - "value": "export interface ShippingOptionItemApi {\n /**\n * The shipping option that this extension is attached to. Use this to read the option's cost, carrier, delivery estimate, and other details.\n */\n target: SubscribableSignalLike;\n\n /**\n * Whether the buyer has selected the target shipping option. When `true`, the target option is the buyer's active choice. When `false`, the buyer has chosen a different shipping option.\n */\n isTargetSelected: SubscribableSignalLike;\n\n /**\n * The render mode of this shipping option, indicating how the extension is displayed in the checkout UI.\n */\n renderMode: ShippingOptionItemRenderMode;\n}" + "value": "export interface ShippingOptionItemApi {\n /**\n * The shipping option that this extension is attached to. Use this to read the option's cost, carrier, delivery estimate, and other details.\n *\n * Available only on the corresponding item target. Shipping option item\n * targets expose shipping option properties; pickup location item targets\n * expose pickup location properties.\n */\n target: SubscribableSignalLike;\n\n /**\n * Whether the buyer has selected the target shipping option. When `true`, the target option is the buyer's active choice. When `false`, the buyer has chosen a different shipping option.\n *\n * Available only on the corresponding item target. Shipping option item\n * targets expose shipping option properties; pickup location item targets\n * expose pickup location properties.\n */\n isTargetSelected: SubscribableSignalLike;\n\n /**\n * The render mode of this shipping option, indicating how the extension is displayed in the checkout UI.\n */\n renderMode: ShippingOptionItemRenderMode;\n}" }, "ShippingOptionItemRenderMode": { "filePath": "src/surfaces/checkout/api/shipping/shipping-option-item.ts", @@ -36830,7 +36830,7 @@ "syntaxKind": "PropertySignature", "name": "number", "value": "string", - "description": "A randomly generated alpha-numeric identifier for the order, distinct from `order.id`. The value is `undefined` for orders that were created before this field was introduced. All recent orders have a number.", + "description": "A randomly generated alpha-numeric identifier for the order, distinct from `order.id`. The value is `undefined` for orders that were created before this field was introduced. All recent orders have a number.\n\nOptional. Might not be present for orders created before 2024.", "isOptional": true }, { @@ -36841,7 +36841,7 @@ "description": "" } ], - "value": "export interface OrderConfirmation {\n order: {\n /**\n * A globally unique identifier for the order. This becomes the\n * [`Order`](/docs/api/admin-graphql/latest/objects/Order) object ID in the\n * GraphQL Admin API after the order is created.\n *\n * @example 'gid://shopify/Order/123'\n */\n id: string;\n };\n /**\n * A randomly generated alpha-numeric identifier for the order, distinct\n * from `order.id`. The value is `undefined` for orders that were created\n * before this field was introduced. All recent orders have a number.\n */\n number?: string;\n\n /**\n * Whether this is the customer's first completed order with this shop. `true` means the buyer hasn't placed an order here before. Use this to show first-purchase messaging or trigger welcome offers.\n */\n isFirstOrder: boolean;\n}" + "value": "export interface OrderConfirmation {\n order: {\n /**\n * A globally unique identifier for the order. This becomes the\n * [`Order`](/docs/api/admin-graphql/latest/objects/Order) object ID in the\n * GraphQL Admin API after the order is created.\n *\n * @example 'gid://shopify/Order/123'\n */\n id: string;\n };\n /**\n * A randomly generated alpha-numeric identifier for the order, distinct\n * from `order.id`. The value is `undefined` for orders that were created\n * before this field was introduced. All recent orders have a number.\n *\n * Optional. Might not be present for orders created before 2024.\n */\n number?: string;\n\n /**\n * Whether this is the customer's first completed order with this shop. `true` means the buyer hasn't placed an order here before. Use this to show first-purchase messaging or trigger welcome offers.\n */\n isFirstOrder: boolean;\n}" }, "AllowedComponents": { "filePath": "src/surfaces/checkout/shared.ts", @@ -36861,17 +36861,17 @@ "syntaxKind": "PropertySignature", "name": "isTargetSelected", "value": "SubscribableSignalLike", - "description": "Whether the buyer has selected the target pickup location. When `true`, the target location is the buyer's active choice. When `false`, the buyer has chosen a different pickup location." + "description": "Whether the buyer has selected the target pickup location. When `true`, the target location is the buyer's active choice. When `false`, the buyer has chosen a different pickup location.\n\nAvailable only on the corresponding item target. Shipping option item targets expose shipping option properties; pickup location item targets expose pickup location properties." }, { "filePath": "src/surfaces/checkout/api/pickup/pickup-location-item.ts", "syntaxKind": "PropertySignature", "name": "target", "value": "SubscribableSignalLike", - "description": "The pickup location that this extension is attached to. Use this to read the location's name, address, and other details." + "description": "The pickup location that this extension is attached to. Use this to read the location's name, address, and other details.\n\nAvailable only on the corresponding item target. Shipping option item targets expose shipping option properties; pickup location item targets expose pickup location properties." } ], - "value": "export interface PickupLocationItemApi {\n /**\n * The pickup location that this extension is attached to. Use this to read the location's name, address, and other details.\n */\n target: SubscribableSignalLike;\n\n /**\n * Whether the buyer has selected the target pickup location. When `true`, the target location is the buyer's active choice. When `false`, the buyer has chosen a different pickup location.\n */\n isTargetSelected: SubscribableSignalLike;\n}" + "value": "export interface PickupLocationItemApi {\n /**\n * The pickup location that this extension is attached to. Use this to read the location's name, address, and other details.\n *\n * Available only on the corresponding item target. Shipping option item\n * targets expose shipping option properties; pickup location item targets\n * expose pickup location properties.\n */\n target: SubscribableSignalLike;\n\n /**\n * Whether the buyer has selected the target pickup location. When `true`, the target location is the buyer's active choice. When `false`, the buyer has chosen a different pickup location.\n *\n * Available only on the corresponding item target. Shipping option item\n * targets expose shipping option properties; pickup location item targets\n * expose pickup location properties.\n */\n isTargetSelected: SubscribableSignalLike;\n}" }, "AnyThankYouComponent": { "filePath": "src/surfaces/checkout/shared.ts", @@ -37703,7 +37703,7 @@ "syntaxKind": "PropertySignature", "name": "localization", "value": "Localization", - "description": "The details about the location, language, and currency of the customer. For utilities to easily format and translate content based on these details, you can use the [`i18n`](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-i18n) object instead." + "description": "The details about the location, language, and currency of the customer. For utilities to easily format and translate content based on these details, you can use the [`i18n`](/docs/api/checkout-ui-extensions/apis/localization#properties-propertydetail-i18n) object instead." }, { "filePath": "src/surfaces/checkout/api/address-autocomplete/standard.ts", @@ -37725,7 +37725,7 @@ "syntaxKind": "PropertySignature", "name": "sessionToken", "value": "SessionToken", - "description": "The session token providing a set of claims as a signed JSON Web Token (JWT).\n\nThe token has a TTL of 5 minutes.\n\nIf the previous token expires, this value will reflect a new session token with a new signature and expiry.\n\nRefer to [session token examples](/docs/api/checkout-ui-extensions/apis/session-token) for more information." + "description": "The session token providing a set of claims as a signed JSON Web Token (JWT).\n\nThe token has a TTL of 5 minutes.\n\nIf the previous token expires, this value will reflect a new session token with a new signature and expiry.\n\nLearn more about [session tokens](/docs/apps/build/authentication-authorization/session-tokens)." }, { "filePath": "src/surfaces/checkout/api/address-autocomplete/standard.ts", @@ -37776,29 +37776,29 @@ ] } ], - "value": "export interface AddressAutocompleteStandardApi<\n Target extends\n | 'purchase.address-autocomplete.suggest'\n | 'purchase.address-autocomplete.format-suggestion',\n> {\n /**\n * The metafields requested in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration)\n * file. These metafields are updated when there's a change in the merchandise items\n * being purchased by the customer.\n *\n * App owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` is not supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * > Tip:\n * > Cart metafields are only available on carts created via the Storefront API version `2023-04` or later.*\n */\n appMetafields: AppMetafieldEntry[];\n\n /**\n * The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event.\n */\n analytics: Analytics;\n\n /**\n * The custom attributes left by the customer to the merchant, either in their cart or during checkout.\n */\n attributes: Attribute[] | undefined;\n\n /**\n * The proposed customer billing address. The address updates when the field is\n * committed (on change) rather than every keystroke.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n billingAddress?: MailingAddress | undefined;\n\n /**\n * A stable ID that represents the current checkout.\n *\n * This matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data)\n * and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n */\n checkoutToken: CheckoutToken | undefined;\n\n /**\n * The meta information about the extension.\n */\n extension: Extension;\n\n /**\n * Utilities for translating content and formatting values according to the current\n * [`localization`](/docs/api/checkout-ui-extensions/apis/localization)\n * Type 'RunnableExtensionInstance' is not assignable to type 'ExtensionInstance'.\n *\n * Refer to [`localization` examples](/docs/api/checkout-ui-extensions/apis/localization#examples)\n * for more information.\n */\n i18n: I18n;\n\n /**\n * The details about the location, language, and currency of the customer. For utilities to easily\n * format and translate content based on these details, you can use the\n * [`i18n`](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-i18n)\n * object instead.\n */\n localization: Localization;\n\n /**\n * The metafields that apply to the current checkout.\n *\n * Metafields are stored locally on the client and are applied to the order object after the checkout completes.\n * They are shared by all extensions running on checkout, and\n * persist for as long as the customer is working on this checkout.\n *\n * Once the order is created, you can query these metafields using the\n * [GraphQL Admin API](/docs/admin-api/graphql/reference/orders/order#metafield-2021-01)\n *\n * > Caution:\n * `metafields` is deprecated. Use `appMetafields` with cart metafields instead.\n *\n * @deprecated Use `appMetafields` with cart metafields instead.\n */\n metafields: Metafield[];\n\n /**\n * The method used to query the Storefront GraphQL API with a prefetched token.\n *\n * Refer to [Storefront API access examples](/docs/api/checkout-ui-extensions/apis/storefront-api) for more information.\n */\n query: >(\n query: string,\n options?: {variables?: Variables; version?: StorefrontApiVersion},\n ) => Promise<{data?: Data; errors?: GraphQLError[]}>;\n\n /**\n * The session token providing a set of claims as a signed JSON Web Token (JWT).\n *\n * The token has a TTL of 5 minutes.\n *\n * If the previous token expires, this value will reflect a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/apis/session-token) for more information.\n */\n sessionToken: SessionToken;\n\n /**\n * The settings matching the settings definition written in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/apis/settings#examples) for more information.\n *\n * > Note: The settings are empty when an extension is being installed in the [checkout editor](https://help.shopify.com/en/manual/checkout-settings/checkout-extensibility/checkout-editor).\n\n */\n settings: ExtensionSettings;\n\n /**\n * The proposed customer shipping address. During the information step,\n * the address updates when the field is committed (on change) rather than every keystroke.\n *\n * > Note: An address value is only present if delivery is required. Otherwise, the subscribable value is undefined.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n shippingAddress?: MailingAddress | undefined;\n\n /** The shop where the checkout is taking place. */\n shop: Shop;\n\n /**\n * The key-value storage for the extension.\n *\n * It uses `localStorage` and should persist across the customer's current checkout session.\n *\n * > Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n *\n * Data is shared across all activated extension targets of this extension. In versions 2023-07 and earlier,\n * each activated extension target had its own storage.\n */\n storage: Storage;\n\n /**\n * The runner version being used for the extension.\n *\n * @example 'unstable'\n */\n version: Version;\n}" + "value": "export interface AddressAutocompleteStandardApi<\n Target extends\n | 'purchase.address-autocomplete.suggest'\n | 'purchase.address-autocomplete.format-suggestion',\n> {\n /**\n * The metafields requested in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration)\n * file. These metafields are updated when there's a change in the merchandise items\n * being purchased by the customer.\n *\n * App owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` is not supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * > Tip:\n * > Cart metafields are only available on carts created via the Storefront API version `2023-04` or later.*\n */\n appMetafields: AppMetafieldEntry[];\n\n /**\n * The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event.\n */\n analytics: Analytics;\n\n /**\n * The custom attributes left by the customer to the merchant, either in their cart or during checkout.\n */\n attributes: Attribute[] | undefined;\n\n /**\n * The proposed customer billing address. The address updates when the field is\n * committed (on change) rather than every keystroke.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n billingAddress?: MailingAddress | undefined;\n\n /**\n * A stable ID that represents the current checkout.\n *\n * This matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data)\n * and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n */\n checkoutToken: CheckoutToken | undefined;\n\n /**\n * The meta information about the extension.\n */\n extension: Extension;\n\n /**\n * Utilities for translating content and formatting values according to the current\n * [`localization`](/docs/api/checkout-ui-extensions/apis/localization)\n * Type 'RunnableExtensionInstance' is not assignable to type 'ExtensionInstance'.\n *\n * Refer to [`localization` examples](/docs/api/checkout-ui-extensions/apis/localization#examples)\n * for more information.\n */\n i18n: I18n;\n\n /**\n * The details about the location, language, and currency of the customer. For utilities to easily\n * format and translate content based on these details, you can use the\n * [`i18n`](/docs/api/checkout-ui-extensions/apis/localization#properties-propertydetail-i18n)\n * object instead.\n */\n localization: Localization;\n\n /**\n * The metafields that apply to the current checkout.\n *\n * Metafields are stored locally on the client and are applied to the order object after the checkout completes.\n * They are shared by all extensions running on checkout, and\n * persist for as long as the customer is working on this checkout.\n *\n * Once the order is created, you can query these metafields using the\n * [GraphQL Admin API](/docs/admin-api/graphql/reference/orders/order#metafield-2021-01)\n *\n * > Caution:\n * `metafields` is deprecated. Use `appMetafields` with cart metafields instead.\n *\n * @deprecated Use `appMetafields` with cart metafields instead.\n */\n metafields: Metafield[];\n\n /**\n * The method used to query the Storefront GraphQL API with a prefetched token.\n *\n * Refer to [Storefront API access examples](/docs/api/checkout-ui-extensions/apis/storefront-api) for more information.\n */\n query: >(\n query: string,\n options?: {variables?: Variables; version?: StorefrontApiVersion},\n ) => Promise<{data?: Data; errors?: GraphQLError[]}>;\n\n /**\n * The session token providing a set of claims as a signed JSON Web Token (JWT).\n *\n * The token has a TTL of 5 minutes.\n *\n * If the previous token expires, this value will reflect a new session token with a new signature and expiry.\n *\n * Learn more about [session tokens](/docs/apps/build/authentication-authorization/session-tokens).\n */\n sessionToken: SessionToken;\n\n /**\n * The settings matching the settings definition written in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/apis/settings#examples) for more information.\n *\n * > Note: The settings are empty when an extension is being installed in the [checkout editor](https://help.shopify.com/en/manual/checkout-settings/checkout-extensibility/checkout-editor).\n\n */\n settings: ExtensionSettings;\n\n /**\n * The proposed customer shipping address. During the information step,\n * the address updates when the field is committed (on change) rather than every keystroke.\n *\n * > Note: An address value is only present if delivery is required. Otherwise, the subscribable value is undefined.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n shippingAddress?: MailingAddress | undefined;\n\n /** The shop where the checkout is taking place. */\n shop: Shop;\n\n /**\n * The key-value storage for the extension.\n *\n * It uses `localStorage` and should persist across the customer's current checkout session.\n *\n * > Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n *\n * Data is shared across all activated extension targets of this extension. In versions 2023-07 and earlier,\n * each activated extension target had its own storage.\n */\n storage: Storage;\n\n /**\n * The runner version being used for the extension.\n *\n * @example 'unstable'\n */\n version: Version;\n}" }, "Analytics": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Analytics", - "description": "", + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "publish", "value": "(name: string, data: Record) => Promise", - "description": "Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing)." + "description": "Publishes a custom event to [Web Pixels](/docs/apps/marketing). Returns `true` when the event is successfully dispatched.\n\nThe Promise resolves to `true` when the event was dispatched. The boolean indicates dispatch confirmation only. It doesn't indicate whether any specific web pixel processed the event." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "visitor", "value": "(data: { email?: string; phone?: string; }) => Promise", - "description": "A method for capturing details about a visitor on the online store." + "description": "Submits buyer contact details for attribution and analytics purposes." } ], - "value": "export interface Analytics {\n /**\n * Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing).\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * A method for capturing details about a visitor on the online store.\n */\n visitor(data: {email?: string; phone?: string}): Promise;\n}" + "value": "export interface Analytics {\n /**\n * Publishes a custom event to [Web Pixels](/docs/apps/marketing).\n * Returns `true` when the event is successfully dispatched.\n *\n * The Promise resolves to `true` when the event was dispatched. The boolean\n * indicates dispatch confirmation only. It doesn't indicate whether any\n * specific web pixel processed the event.\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * Submits buyer contact details for attribution and analytics purposes.\n */\n visitor(data: {email?: string; phone?: string}): Promise;\n}" }, "VisitorResult": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -37839,10 +37839,10 @@ "syntaxKind": "PropertySignature", "name": "type", "value": "'error'", - "description": "Indicates that the visitor information is invalid and wasn't submitted. Examples are using the wrong data type or missing a required property." + "description": "Indicates that the visitor information is invalid and wasn't submitted. Common causes include using the wrong data type or omitting a required property." } ], - "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Examples are using the wrong data type or missing a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Common causes include using the wrong data type or omitting a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" }, "AppMetafieldEntry": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -37972,7 +37972,7 @@ "syntaxKind": "PropertySignature", "name": "value", "value": "string", - "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.", + "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.\n\nAttribute values are always strings. To store structured data, serialize it to JSON and parse it when reading.", "examples": [ { "title": "Example", @@ -37987,7 +37987,7 @@ ] } ], - "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" + "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * Attribute values are always strings. To store structured data, serialize\n * it to JSON and parse it when reading.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" }, "MailingAddress": { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -38343,7 +38343,7 @@ "Editor": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Editor", - "description": "", + "description": "Information about the editor environment when an extension is rendered inside the checkout editor. The value is `undefined` when the extension is not rendering in an editor.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -38358,7 +38358,7 @@ "I18n": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18n", - "description": "", + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use the I18n API alongside the Localization API to build fully localized extensions.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -38394,7 +38394,7 @@ "I18nTranslate": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18nTranslate", - "description": "This returns a translated string matching a key in a locale file.", + "description": "Translates a key from your extension's locale files into a localized string. Supports interpolation with placeholder replacements and pluralization via the special `count` option.", "members": [], "value": "export interface I18nTranslate {\n (\n key: string,\n options?: Record,\n ): ReplacementType extends string | number\n ? string\n : (string | ReplacementType)[];\n}" }, @@ -38643,7 +38643,7 @@ "SessionToken": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SessionToken", - "description": "", + "description": "Authenticates requests between your extension and your app backend. Use session tokens to verify the identity of the buyer and the shop context when making server-side API calls. The token is a signed JWT that contains claims such as the customer ID, shop domain, and expiration.\n\nThe `sub` claim in the decoded token is present only when the buyer is logged in and the app has permission to read customer accounts. Absent for anonymous buyers.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -38666,7 +38666,7 @@ "Shop": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Shop", - "description": "", + "description": "Metadata about the merchant's store, including its name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -38706,30 +38706,30 @@ "syntaxKind": "PropertySignature", "name": "storefrontUrl", "value": "string", - "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n\n> Caution: > As of version `2024-04` this value no longer has a trailing slash.", + "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.", "isOptional": true } ], - "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n *\n * > Caution:\n * > As of version `2024-04` this value no longer has a trailing slash.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom domain.\n */\n myshopifyDomain: string;\n}" + "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom domain.\n */\n myshopifyDomain: string;\n}" }, "Storage": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Storage", - "description": "A key-value storage object for the extension.\n\nStored data is available only to this specific extension and any of its instances.\n\nThe storage backend is implemented with `localStorage` and should persist across the buyer's checkout session. However, data persistence isn't guaranteed.", + "description": "Key-value storage for a specific extension. Use storage to save preferences or cached data that should survive page reloads without requiring a backend call. Stored data is only available to this specific extension. The storage backend is implemented with `localStorage` and data persistence isn't guaranteed.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "delete", "value": "(key: string) => Promise", - "description": "Delete stored data by key." + "description": "Deletes a previously stored value by key." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "read", "value": "(key: string) => Promise", - "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original primitive.\n\nReturns `null` if no stored data exists." + "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original type.\n\nReturns the stored value for the given key, or `null` when no value exists. Doesn't throw on a missing key." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -38739,7 +38739,7 @@ "description": "Write stored data for this key.\n\nThe data must be serializable to JSON." } ], - "value": "export interface Storage {\n /**\n * Read and return a stored value by key.\n *\n * The stored data is deserialized from JSON and returned as\n * its original primitive.\n *\n * Returns `null` if no stored data exists.\n */\n read(key: string): Promise;\n\n /**\n * Write stored data for this key.\n *\n * The data must be serializable to JSON.\n */\n write(key: string, data: any): Promise;\n\n /**\n * Delete stored data by key.\n */\n delete(key: string): Promise;\n}" + "value": "export interface Storage {\n /**\n * Read and return a stored value by key.\n *\n * The stored data is deserialized from JSON and returned as\n * its original type.\n *\n * Returns the stored value for the given key, or `null` when no value\n * exists. Doesn't throw on a missing key.\n */\n read(key: string): Promise;\n\n /**\n * Write stored data for this key.\n *\n * The data must be serializable to JSON.\n */\n write(key: string, data: any): Promise;\n\n /**\n * Deletes a previously stored value by key.\n */\n delete(key: string): Promise;\n}" }, "Version": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -38912,10 +38912,10 @@ "syntaxKind": "PropertySignature", "name": "suggestions", "value": "AddressAutocompleteSuggestion[]", - "description": "An array of address autocomplete suggestions to show to the buyer.\n\n> Note: Only the first five suggestions will be displayed to the buyer." + "description": "An array of address autocomplete suggestions to show to the buyer. Checkout displays up to five address suggestions. Return no more than five. Additional suggestions are ignored." } ], - "value": "export interface AddressAutocompleteSuggestOutput {\n /**\n * An array of address autocomplete suggestions to show to the buyer.\n *\n * > Note: Only the first five suggestions will be displayed to the buyer.\n */\n suggestions: AddressAutocompleteSuggestion[];\n}" + "value": "export interface AddressAutocompleteSuggestOutput {\n /**\n * An array of address autocomplete suggestions to show to the buyer.\n * Checkout displays up to five address suggestions. Return no more\n * than five. Additional suggestions are ignored.\n */\n suggestions: AddressAutocompleteSuggestion[];\n}" }, "AddressAutocompleteSuggestion": { "filePath": "src/surfaces/checkout/api/address-autocomplete/shared.ts", @@ -39277,7 +39277,7 @@ "syntaxKind": "PropertySignature", "name": "localization", "value": "Localization", - "description": "The details about the location, language, and currency of the customer. For utilities to easily format and translate content based on these details, you can use the [`i18n`](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-i18n) object instead." + "description": "The details about the location, language, and currency of the customer. For utilities to easily format and translate content based on these details, you can use the [`i18n`](/docs/api/checkout-ui-extensions/apis/localization#properties-propertydetail-i18n) object instead." }, { "filePath": "src/surfaces/checkout/api/address-autocomplete/standard.ts", @@ -39299,7 +39299,7 @@ "syntaxKind": "PropertySignature", "name": "sessionToken", "value": "SessionToken", - "description": "The session token providing a set of claims as a signed JSON Web Token (JWT).\n\nThe token has a TTL of 5 minutes.\n\nIf the previous token expires, this value will reflect a new session token with a new signature and expiry.\n\nRefer to [session token examples](/docs/api/checkout-ui-extensions/apis/session-token) for more information." + "description": "The session token providing a set of claims as a signed JSON Web Token (JWT).\n\nThe token has a TTL of 5 minutes.\n\nIf the previous token expires, this value will reflect a new session token with a new signature and expiry.\n\nLearn more about [session tokens](/docs/apps/build/authentication-authorization/session-tokens)." }, { "filePath": "src/surfaces/checkout/api/address-autocomplete/standard.ts", @@ -39350,29 +39350,29 @@ ] } ], - "value": "export interface AddressAutocompleteStandardApi<\n Target extends\n | 'purchase.address-autocomplete.suggest'\n | 'purchase.address-autocomplete.format-suggestion',\n> {\n /**\n * The metafields requested in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration)\n * file. These metafields are updated when there's a change in the merchandise items\n * being purchased by the customer.\n *\n * App owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` is not supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * > Tip:\n * > Cart metafields are only available on carts created via the Storefront API version `2023-04` or later.*\n */\n appMetafields: AppMetafieldEntry[];\n\n /**\n * The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event.\n */\n analytics: Analytics;\n\n /**\n * The custom attributes left by the customer to the merchant, either in their cart or during checkout.\n */\n attributes: Attribute[] | undefined;\n\n /**\n * The proposed customer billing address. The address updates when the field is\n * committed (on change) rather than every keystroke.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n billingAddress?: MailingAddress | undefined;\n\n /**\n * A stable ID that represents the current checkout.\n *\n * This matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data)\n * and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n */\n checkoutToken: CheckoutToken | undefined;\n\n /**\n * The meta information about the extension.\n */\n extension: Extension;\n\n /**\n * Utilities for translating content and formatting values according to the current\n * [`localization`](/docs/api/checkout-ui-extensions/apis/localization)\n * Type 'RunnableExtensionInstance' is not assignable to type 'ExtensionInstance'.\n *\n * Refer to [`localization` examples](/docs/api/checkout-ui-extensions/apis/localization#examples)\n * for more information.\n */\n i18n: I18n;\n\n /**\n * The details about the location, language, and currency of the customer. For utilities to easily\n * format and translate content based on these details, you can use the\n * [`i18n`](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-i18n)\n * object instead.\n */\n localization: Localization;\n\n /**\n * The metafields that apply to the current checkout.\n *\n * Metafields are stored locally on the client and are applied to the order object after the checkout completes.\n * They are shared by all extensions running on checkout, and\n * persist for as long as the customer is working on this checkout.\n *\n * Once the order is created, you can query these metafields using the\n * [GraphQL Admin API](/docs/admin-api/graphql/reference/orders/order#metafield-2021-01)\n *\n * > Caution:\n * `metafields` is deprecated. Use `appMetafields` with cart metafields instead.\n *\n * @deprecated Use `appMetafields` with cart metafields instead.\n */\n metafields: Metafield[];\n\n /**\n * The method used to query the Storefront GraphQL API with a prefetched token.\n *\n * Refer to [Storefront API access examples](/docs/api/checkout-ui-extensions/apis/storefront-api) for more information.\n */\n query: >(\n query: string,\n options?: {variables?: Variables; version?: StorefrontApiVersion},\n ) => Promise<{data?: Data; errors?: GraphQLError[]}>;\n\n /**\n * The session token providing a set of claims as a signed JSON Web Token (JWT).\n *\n * The token has a TTL of 5 minutes.\n *\n * If the previous token expires, this value will reflect a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/apis/session-token) for more information.\n */\n sessionToken: SessionToken;\n\n /**\n * The settings matching the settings definition written in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/apis/settings#examples) for more information.\n *\n * > Note: The settings are empty when an extension is being installed in the [checkout editor](https://help.shopify.com/en/manual/checkout-settings/checkout-extensibility/checkout-editor).\n\n */\n settings: ExtensionSettings;\n\n /**\n * The proposed customer shipping address. During the information step,\n * the address updates when the field is committed (on change) rather than every keystroke.\n *\n * > Note: An address value is only present if delivery is required. Otherwise, the subscribable value is undefined.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n shippingAddress?: MailingAddress | undefined;\n\n /** The shop where the checkout is taking place. */\n shop: Shop;\n\n /**\n * The key-value storage for the extension.\n *\n * It uses `localStorage` and should persist across the customer's current checkout session.\n *\n * > Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n *\n * Data is shared across all activated extension targets of this extension. In versions 2023-07 and earlier,\n * each activated extension target had its own storage.\n */\n storage: Storage;\n\n /**\n * The runner version being used for the extension.\n *\n * @example 'unstable'\n */\n version: Version;\n}" + "value": "export interface AddressAutocompleteStandardApi<\n Target extends\n | 'purchase.address-autocomplete.suggest'\n | 'purchase.address-autocomplete.format-suggestion',\n> {\n /**\n * The metafields requested in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration)\n * file. These metafields are updated when there's a change in the merchandise items\n * being purchased by the customer.\n *\n * App owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` is not supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * > Tip:\n * > Cart metafields are only available on carts created via the Storefront API version `2023-04` or later.*\n */\n appMetafields: AppMetafieldEntry[];\n\n /**\n * The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event.\n */\n analytics: Analytics;\n\n /**\n * The custom attributes left by the customer to the merchant, either in their cart or during checkout.\n */\n attributes: Attribute[] | undefined;\n\n /**\n * The proposed customer billing address. The address updates when the field is\n * committed (on change) rather than every keystroke.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n billingAddress?: MailingAddress | undefined;\n\n /**\n * A stable ID that represents the current checkout.\n *\n * This matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data)\n * and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n */\n checkoutToken: CheckoutToken | undefined;\n\n /**\n * The meta information about the extension.\n */\n extension: Extension;\n\n /**\n * Utilities for translating content and formatting values according to the current\n * [`localization`](/docs/api/checkout-ui-extensions/apis/localization)\n * Type 'RunnableExtensionInstance' is not assignable to type 'ExtensionInstance'.\n *\n * Refer to [`localization` examples](/docs/api/checkout-ui-extensions/apis/localization#examples)\n * for more information.\n */\n i18n: I18n;\n\n /**\n * The details about the location, language, and currency of the customer. For utilities to easily\n * format and translate content based on these details, you can use the\n * [`i18n`](/docs/api/checkout-ui-extensions/apis/localization#properties-propertydetail-i18n)\n * object instead.\n */\n localization: Localization;\n\n /**\n * The metafields that apply to the current checkout.\n *\n * Metafields are stored locally on the client and are applied to the order object after the checkout completes.\n * They are shared by all extensions running on checkout, and\n * persist for as long as the customer is working on this checkout.\n *\n * Once the order is created, you can query these metafields using the\n * [GraphQL Admin API](/docs/admin-api/graphql/reference/orders/order#metafield-2021-01)\n *\n * > Caution:\n * `metafields` is deprecated. Use `appMetafields` with cart metafields instead.\n *\n * @deprecated Use `appMetafields` with cart metafields instead.\n */\n metafields: Metafield[];\n\n /**\n * The method used to query the Storefront GraphQL API with a prefetched token.\n *\n * Refer to [Storefront API access examples](/docs/api/checkout-ui-extensions/apis/storefront-api) for more information.\n */\n query: >(\n query: string,\n options?: {variables?: Variables; version?: StorefrontApiVersion},\n ) => Promise<{data?: Data; errors?: GraphQLError[]}>;\n\n /**\n * The session token providing a set of claims as a signed JSON Web Token (JWT).\n *\n * The token has a TTL of 5 minutes.\n *\n * If the previous token expires, this value will reflect a new session token with a new signature and expiry.\n *\n * Learn more about [session tokens](/docs/apps/build/authentication-authorization/session-tokens).\n */\n sessionToken: SessionToken;\n\n /**\n * The settings matching the settings definition written in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/apis/settings#examples) for more information.\n *\n * > Note: The settings are empty when an extension is being installed in the [checkout editor](https://help.shopify.com/en/manual/checkout-settings/checkout-extensibility/checkout-editor).\n\n */\n settings: ExtensionSettings;\n\n /**\n * The proposed customer shipping address. During the information step,\n * the address updates when the field is committed (on change) rather than every keystroke.\n *\n * > Note: An address value is only present if delivery is required. Otherwise, the subscribable value is undefined.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n shippingAddress?: MailingAddress | undefined;\n\n /** The shop where the checkout is taking place. */\n shop: Shop;\n\n /**\n * The key-value storage for the extension.\n *\n * It uses `localStorage` and should persist across the customer's current checkout session.\n *\n * > Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n *\n * Data is shared across all activated extension targets of this extension. In versions 2023-07 and earlier,\n * each activated extension target had its own storage.\n */\n storage: Storage;\n\n /**\n * The runner version being used for the extension.\n *\n * @example 'unstable'\n */\n version: Version;\n}" }, "Analytics": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Analytics", - "description": "", + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "publish", "value": "(name: string, data: Record) => Promise", - "description": "Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing)." + "description": "Publishes a custom event to [Web Pixels](/docs/apps/marketing). Returns `true` when the event is successfully dispatched.\n\nThe Promise resolves to `true` when the event was dispatched. The boolean indicates dispatch confirmation only. It doesn't indicate whether any specific web pixel processed the event." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "visitor", "value": "(data: { email?: string; phone?: string; }) => Promise", - "description": "A method for capturing details about a visitor on the online store." + "description": "Submits buyer contact details for attribution and analytics purposes." } ], - "value": "export interface Analytics {\n /**\n * Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing).\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * A method for capturing details about a visitor on the online store.\n */\n visitor(data: {email?: string; phone?: string}): Promise;\n}" + "value": "export interface Analytics {\n /**\n * Publishes a custom event to [Web Pixels](/docs/apps/marketing).\n * Returns `true` when the event is successfully dispatched.\n *\n * The Promise resolves to `true` when the event was dispatched. The boolean\n * indicates dispatch confirmation only. It doesn't indicate whether any\n * specific web pixel processed the event.\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * Submits buyer contact details for attribution and analytics purposes.\n */\n visitor(data: {email?: string; phone?: string}): Promise;\n}" }, "VisitorResult": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -39413,10 +39413,10 @@ "syntaxKind": "PropertySignature", "name": "type", "value": "'error'", - "description": "Indicates that the visitor information is invalid and wasn't submitted. Examples are using the wrong data type or missing a required property." + "description": "Indicates that the visitor information is invalid and wasn't submitted. Common causes include using the wrong data type or omitting a required property." } ], - "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Examples are using the wrong data type or missing a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Common causes include using the wrong data type or omitting a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" }, "AppMetafieldEntry": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -39546,7 +39546,7 @@ "syntaxKind": "PropertySignature", "name": "value", "value": "string", - "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.", + "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.\n\nAttribute values are always strings. To store structured data, serialize it to JSON and parse it when reading.", "examples": [ { "title": "Example", @@ -39561,7 +39561,7 @@ ] } ], - "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" + "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * Attribute values are always strings. To store structured data, serialize\n * it to JSON and parse it when reading.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" }, "MailingAddress": { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -39917,7 +39917,7 @@ "Editor": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Editor", - "description": "", + "description": "Information about the editor environment when an extension is rendered inside the checkout editor. The value is `undefined` when the extension is not rendering in an editor.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -39932,7 +39932,7 @@ "I18n": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18n", - "description": "", + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use the I18n API alongside the Localization API to build fully localized extensions.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -39968,7 +39968,7 @@ "I18nTranslate": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18nTranslate", - "description": "This returns a translated string matching a key in a locale file.", + "description": "Translates a key from your extension's locale files into a localized string. Supports interpolation with placeholder replacements and pluralization via the special `count` option.", "members": [], "value": "export interface I18nTranslate {\n (\n key: string,\n options?: Record,\n ): ReplacementType extends string | number\n ? string\n : (string | ReplacementType)[];\n}" }, @@ -40217,7 +40217,7 @@ "SessionToken": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SessionToken", - "description": "", + "description": "Authenticates requests between your extension and your app backend. Use session tokens to verify the identity of the buyer and the shop context when making server-side API calls. The token is a signed JWT that contains claims such as the customer ID, shop domain, and expiration.\n\nThe `sub` claim in the decoded token is present only when the buyer is logged in and the app has permission to read customer accounts. Absent for anonymous buyers.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -40240,7 +40240,7 @@ "Shop": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Shop", - "description": "", + "description": "Metadata about the merchant's store, including its name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -40280,30 +40280,30 @@ "syntaxKind": "PropertySignature", "name": "storefrontUrl", "value": "string", - "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n\n> Caution: > As of version `2024-04` this value no longer has a trailing slash.", + "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.", "isOptional": true } ], - "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n *\n * > Caution:\n * > As of version `2024-04` this value no longer has a trailing slash.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom domain.\n */\n myshopifyDomain: string;\n}" + "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom domain.\n */\n myshopifyDomain: string;\n}" }, "Storage": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Storage", - "description": "A key-value storage object for the extension.\n\nStored data is available only to this specific extension and any of its instances.\n\nThe storage backend is implemented with `localStorage` and should persist across the buyer's checkout session. However, data persistence isn't guaranteed.", + "description": "Key-value storage for a specific extension. Use storage to save preferences or cached data that should survive page reloads without requiring a backend call. Stored data is only available to this specific extension. The storage backend is implemented with `localStorage` and data persistence isn't guaranteed.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "delete", "value": "(key: string) => Promise", - "description": "Delete stored data by key." + "description": "Deletes a previously stored value by key." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "read", "value": "(key: string) => Promise", - "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original primitive.\n\nReturns `null` if no stored data exists." + "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original type.\n\nReturns the stored value for the given key, or `null` when no value exists. Doesn't throw on a missing key." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -40313,7 +40313,7 @@ "description": "Write stored data for this key.\n\nThe data must be serializable to JSON." } ], - "value": "export interface Storage {\n /**\n * Read and return a stored value by key.\n *\n * The stored data is deserialized from JSON and returned as\n * its original primitive.\n *\n * Returns `null` if no stored data exists.\n */\n read(key: string): Promise;\n\n /**\n * Write stored data for this key.\n *\n * The data must be serializable to JSON.\n */\n write(key: string, data: any): Promise;\n\n /**\n * Delete stored data by key.\n */\n delete(key: string): Promise;\n}" + "value": "export interface Storage {\n /**\n * Read and return a stored value by key.\n *\n * The stored data is deserialized from JSON and returned as\n * its original type.\n *\n * Returns the stored value for the given key, or `null` when no value\n * exists. Doesn't throw on a missing key.\n */\n read(key: string): Promise;\n\n /**\n * Write stored data for this key.\n *\n * The data must be serializable to JSON.\n */\n write(key: string, data: any): Promise;\n\n /**\n * Deletes a previously stored value by key.\n */\n delete(key: string): Promise;\n}" }, "Version": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -40389,7 +40389,7 @@ "syntaxKind": "MethodSignature", "name": "applyAttributeChange", "value": "(change: AttributeChange) => Promise", - "description": "Updates or removes an attribute on the cart and checkout. On success, the [`attributes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/attributes#standardapi-propertydetail-attributes) property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.", + "description": "Updates or removes an attribute on the cart and checkout. On success, the [`attributes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/attributes#properties-propertydetail-attributes) property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.", "deprecationMessage": "Use cart metafields instead." }, { @@ -40397,42 +40397,42 @@ "syntaxKind": "MethodSignature", "name": "applyCartLinesChange", "value": "(change: CartLineChange) => Promise", - "description": "Adds, removes, or updates line items in the cart. The returned promise resolves when the change has been applied by the server, and the [`lines`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-lines#standardapi-propertydetail-lines) property updates with the new state.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Adds, removes, or updates line items in the cart. The returned promise resolves when the change has been applied by the server, and the [`lines`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-lines#properties-propertydetail-lines) property updates with the new state.\n\nAccepts a single change per call. To make multiple changes, call this method separately for each one.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyDiscountCodeChange", "value": "(change: DiscountCodeChange) => Promise", - "description": "Adds or removes a discount code on the checkout. The returned promise resolves when the change has been applied by the server, and the [`discountCodes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/discounts#standardapi-propertydetail-discountcodes) property updates with the new state.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves discount codes through a network call.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Adds or removes a discount code on the checkout. The returned promise resolves when the change has been applied by the server, and the [`discountCodes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/discounts#properties-propertydetail-discountcodes) property updates with the new state.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves discount codes through a network call.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyGiftCardChange", "value": "(change: GiftCardChange) => Promise", - "description": "Adds or removes a gift card from the checkout. The returned promise resolves when the change has been applied by the server, and the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/gift-cards#standardapi-propertydetail-appliedgiftcards) property updates with the new state.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves gift card codes through a network call.\n\n> Note: This method returns an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Adds or removes a gift card from the checkout. The returned promise resolves when the change has been applied by the server, and the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/gift-cards#properties-propertydetail-appliedgiftcards) property updates with the new state.\n\nUnlike other write operations, gift card changes aren't gated by a cart instruction flag.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves gift card codes through a network call.\n\n> Note: This method returns an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyMetafieldChange", "value": "(change: MetafieldChange) => Promise", - "description": "Creates, updates, or removes a cart metafield on the checkout. On success, the [`metafields`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/metafields#standardapi-propertydetail-metafields) property updates to reflect the change.\n\nCart metafields are copied to order metafields at order creation time if there's a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n\n> Caution: `MetafieldRemoveChange` and `MetafieldUpdateChange` are deprecated. Use cart metafields with `MetafieldRemoveCartChange` and `MetafieldUpdateCartChange` instead. If `MetafieldUpdateChange` writes a metafield with the same namespace and key as a cart metafield that's configured to copy, the cart metafield won't be copied.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Creates, updates, or removes a cart metafield on the checkout. On success, the [`metafields`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/metafields#properties-propertydetail-metafields) property updates to reflect the change.\n\nCart metafields are copied to order metafields at order creation time if there's a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n\n> Caution: `MetafieldRemoveChange` and `MetafieldUpdateChange` are deprecated. Use cart metafields with `MetafieldRemoveCartChange` and `MetafieldUpdateCartChange` instead. If `MetafieldUpdateChange` writes a metafield with the same namespace and key as a cart metafield that's configured to copy, the cart metafield won't be copied.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyNoteChange", "value": "(change: NoteChange) => Promise", - "description": "Sets or removes the buyer's note on the checkout. On success, the [`note`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/note#standardapi-propertydetail-note) property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Sets or removes the buyer's note on the checkout. On success, the [`note`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/note#properties-propertydetail-note) property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyShippingAddressChange", "value": "(change: ShippingAddressUpdateChange) => Promise", - "description": "Updates the buyer's shipping address on the checkout. The provided fields are merged into the existing address without prompting the buyer. On success, the `shippingAddress` property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", + "description": "Updates the buyer's shipping address on the checkout. The provided fields are merged into the existing address without prompting the buyer. On success, the `shippingAddress` property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", "isOptional": true }, { @@ -40445,7 +40445,7 @@ "isPrivate": true } ], - "value": "export interface CheckoutApi {\n /**\n * Updates or removes an attribute on the cart and checkout. On success, the\n * [`attributes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/attributes#standardapi-propertydetail-attributes) property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * @deprecated Use cart metafields instead.\n */\n applyAttributeChange(change: AttributeChange): Promise;\n\n /**\n * Adds, removes, or updates line items in the cart. The returned promise resolves when the change has been applied by the server, and the [`lines`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-lines#standardapi-propertydetail-lines) property updates with the new state.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyCartLinesChange(change: CartLineChange): Promise;\n\n /**\n * Adds or removes a discount code on the checkout. The returned promise resolves when the change has been applied by the server, and the [`discountCodes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/discounts#standardapi-propertydetail-discountcodes) property updates with the new state.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves discount codes through a network call.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyDiscountCodeChange(\n change: DiscountCodeChange,\n ): Promise;\n\n /**\n * Adds or removes a gift card from the checkout. The returned promise resolves when the change has been applied by the server, and the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/gift-cards#standardapi-propertydetail-appliedgiftcards) property updates with the new state.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves gift card codes through a network call.\n *\n * > Note: This method returns an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyGiftCardChange(change: GiftCardChange): Promise;\n\n /**\n * Creates, updates, or removes a cart metafield on the checkout. On success, the\n * [`metafields`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/metafields#standardapi-propertydetail-metafields) property updates to reflect the change.\n *\n * Cart metafields are copied to order metafields at order creation time if there's a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n *\n * > Caution: `MetafieldRemoveChange` and `MetafieldUpdateChange` are deprecated. Use cart metafields with `MetafieldRemoveCartChange` and `MetafieldUpdateCartChange` instead. If `MetafieldUpdateChange` writes a metafield with the same namespace and key as a cart metafield that's configured to copy, the cart metafield won't be copied.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyMetafieldChange(change: MetafieldChange): Promise;\n\n /**\n * Sets or removes the buyer's note on the checkout. On success, the\n * [`note`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/note#standardapi-propertydetail-note)\n * property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyNoteChange(change: NoteChange): Promise;\n\n /**\n * @private\n */\n experimentalIsShopAppStyle?: boolean;\n\n /**\n * Updates the buyer's shipping address on the checkout. The provided fields\n * are merged into the existing address without prompting the buyer. On success,\n * the `shippingAddress` property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyShippingAddressChange?(\n change: ShippingAddressChange,\n ): Promise;\n}" + "value": "export interface CheckoutApi {\n /**\n * Updates or removes an attribute on the cart and checkout. On success, the\n * [`attributes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/attributes#properties-propertydetail-attributes) property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * @deprecated Use cart metafields instead.\n */\n applyAttributeChange(change: AttributeChange): Promise;\n\n /**\n * Adds, removes, or updates line items in the cart. The returned promise resolves when the change has been applied by the server, and the [`lines`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-lines#properties-propertydetail-lines) property updates with the new state.\n *\n * Accepts a single change per call. To make multiple changes, call this\n * method separately for each one.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyCartLinesChange(change: CartLineChange): Promise;\n\n /**\n * Adds or removes a discount code on the checkout. The returned promise resolves when the change has been applied by the server, and the [`discountCodes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/discounts#properties-propertydetail-discountcodes) property updates with the new state.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves discount codes through a network call.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyDiscountCodeChange(\n change: DiscountCodeChange,\n ): Promise;\n\n /**\n * Adds or removes a gift card from the checkout. The returned promise resolves when the change has been applied by the server, and the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/gift-cards#properties-propertydetail-appliedgiftcards) property updates with the new state.\n *\n * Unlike other write operations, gift card changes aren't gated by a cart\n * instruction flag.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves gift card codes through a network call.\n *\n * > Note: This method returns an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyGiftCardChange(change: GiftCardChange): Promise;\n\n /**\n * Creates, updates, or removes a cart metafield on the checkout. On success, the\n * [`metafields`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/metafields#properties-propertydetail-metafields) property updates to reflect the change.\n *\n * Cart metafields are copied to order metafields at order creation time if there's a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n *\n * > Caution: `MetafieldRemoveChange` and `MetafieldUpdateChange` are deprecated. Use cart metafields with `MetafieldRemoveCartChange` and `MetafieldUpdateCartChange` instead. If `MetafieldUpdateChange` writes a metafield with the same namespace and key as a cart metafield that's configured to copy, the cart metafield won't be copied.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyMetafieldChange(change: MetafieldChange): Promise;\n\n /**\n * Sets or removes the buyer's note on the checkout. On success, the\n * [`note`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/note#properties-propertydetail-note)\n * property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyNoteChange(change: NoteChange): Promise;\n\n /**\n * @private\n */\n experimentalIsShopAppStyle?: boolean;\n\n /**\n * Updates the buyer's shipping address on the checkout. The provided fields\n * are merged into the existing address without prompting the buyer. On success,\n * the `shippingAddress` property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyShippingAddressChange?(\n change: ShippingAddressChange,\n ): Promise;\n}" }, "AttributeChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -40512,7 +40512,7 @@ "syntaxKind": "PropertySignature", "name": "value", "value": "string", - "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.", + "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.\n\nAttribute values are always strings. To store structured data, serialize it to JSON and parse it when reading.", "examples": [ { "title": "Example", @@ -40527,7 +40527,7 @@ ] } ], - "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" + "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * Attribute values are always strings. To store structured data, serialize\n * it to JSON and parse it when reading.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" }, "AttributeRemoveChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -41380,7 +41380,7 @@ "syntaxKind": "PropertySignature", "name": "message", "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer." + "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer.\n\nRender your own localized error text rather than displaying this message to the buyer." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -41390,7 +41390,7 @@ "description": "Indicates that the line item wasn't changed successfully. Refer to the `message` property for details about the error." } ], - "value": "export interface CartLineChangeResultError {\n /**\n * Indicates that the line item wasn't changed successfully. Refer to the `message` property for details about the error.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface CartLineChangeResultError {\n /**\n * Indicates that the line item wasn't changed successfully. Refer to the `message` property for details about the error.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n *\n * Render your own localized error text rather than displaying this message\n * to the buyer.\n */\n message: string;\n}" }, "DiscountCodeChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -41570,7 +41570,7 @@ "syntaxKind": "PropertySignature", "name": "message", "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer." + "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer.\n\nRender your own localized error text rather than displaying this message to the buyer." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -41580,7 +41580,7 @@ "description": "Indicates that the gift card change couldn't be applied. Check the `message` property for details." } ], - "value": "export interface GiftCardChangeResultError {\n /**\n * Indicates that the gift card change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface GiftCardChangeResultError {\n /**\n * Indicates that the gift card change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n *\n * Render your own localized error text rather than displaying this message\n * to the buyer.\n */\n message: string;\n}" }, "MetafieldChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -41841,7 +41841,7 @@ "syntaxKind": "PropertySignature", "name": "message", "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer." + "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer.\n\nRender your own localized error text rather than displaying this message to the buyer." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -41851,7 +41851,7 @@ "description": "Indicates that the metafield change couldn't be applied. Check the `message` property for details." } ], - "value": "export interface MetafieldChangeResultError {\n /**\n * Indicates that the metafield change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface MetafieldChangeResultError {\n /**\n * Indicates that the metafield change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n *\n * Render your own localized error text rather than displaying this message\n * to the buyer.\n */\n message: string;\n}" }, "NoteChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -41929,7 +41929,7 @@ "syntaxKind": "PropertySignature", "name": "message", "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer." + "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer.\n\nRender your own localized error text rather than displaying this message to the buyer." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -41939,7 +41939,7 @@ "description": "Indicates that the note change couldn't be applied. Check the `message` property for details." } ], - "value": "export interface NoteChangeResultError {\n /**\n * Indicates that the note change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface NoteChangeResultError {\n /**\n * Indicates that the note change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n *\n * Render your own localized error text rather than displaying this message\n * to the buyer.\n */\n message: string;\n}" }, "ShippingAddressUpdateChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -42525,7 +42525,7 @@ "syntaxKind": "PropertySignature", "name": "analytics", "value": "Analytics", - "description": "The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event." + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -42539,7 +42539,7 @@ "syntaxKind": "PropertySignature", "name": "applyTrackingConsentChange", "value": "ApplyTrackingConsentChangeType", - "description": "Enables setting and updating customer privacy consent settings and tracking consent metafields.\n\n> Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent) to be set to `true`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." + "description": "Enables setting and updating customer privacy consent settings and tracking consent metafields.\n\n> Note: Requires the [`collect_buyer_consent` capability](/docs/apps/build/customer-accounts/capabilities#collect-buyer-consent) to be set to `true`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -42560,7 +42560,7 @@ "syntaxKind": "PropertySignature", "name": "availablePaymentOptions", "value": "SubscribableSignalLike", - "description": "All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region." + "description": "All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n\nThe set of payment options can change when the buyer updates their address or cart, so subscribe to changes rather than reading once during initialization. Each option exposes `handle` and `type` only. Provider names, logos, fees, and installment terms aren't available." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -42597,7 +42597,7 @@ "syntaxKind": "PropertySignature", "name": "checkoutToken", "value": "SubscribableSignalLike", - "description": "A stable ID that represents the current checkout.\n\nThe value is `undefined` when the checkout hasn't been created on the server yet.\n\nUse this to correlate checkout sessions across your extension, web pixels, and backend systems.\n\nThis matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data) and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object)." + "description": "A stable ID that represents the current checkout.\n\nThe value is `undefined` when the checkout hasn't been created on the server yet.\n\nUse this to correlate checkout sessions across your extension, web pixels, and backend systems.\n\nThis matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data) and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n\nCan be `undefined`. Handle the `undefined` state before using the value." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -42618,7 +42618,7 @@ "syntaxKind": "PropertySignature", "name": "deliveryGroups", "value": "SubscribableSignalLike", - "description": "The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items." + "description": "The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n\nEmpty until the buyer enters enough address information for Shopify to calculate shipping rates." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -42639,7 +42639,7 @@ "syntaxKind": "PropertySignature", "name": "extension", "value": "Extension", - "description": "The meta information about the extension." + "description": "Metadata about the running extension, including the current target, API version, capabilities, and editor context. Use this to conditionally render content based on where the extension is running." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -42647,7 +42647,7 @@ "name": "extensionPoint", "value": "Target", "description": "The identifier that specifies where in Shopify's UI your code is being injected. This is one of the targets you've included in your extension's configuration file.", - "deprecationMessage": "Deprecated as of version `2023-07`, use `extension.target` instead.", + "deprecationMessage": "Use `extension.target` instead.", "examples": [ { "title": "Example", @@ -42666,14 +42666,14 @@ "syntaxKind": "PropertySignature", "name": "i18n", "value": "I18n", - "description": "Utilities for translating content and formatting values according to the current [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) of the checkout.\n\nRefer to [`localization` examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples) for more information." + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use alongside [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) to build fully localized extensions." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "instructions", "value": "SubscribableSignalLike", - "description": "The cart instructions used to create the checkout and possibly limit extension capabilities.\n\nThese instructions should be checked before performing any actions that might be affected by them.\n\nFor example, if you intend to add a discount code via the `applyDiscountCodeChange` method, check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n\n> Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs aren't available. See the [update guide](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples) for more information." + "description": "The cart instructions used to create the checkout and possibly limit extension capabilities.\n\nThese instructions should be checked before performing any actions that might be affected by them.\n\nFor example, if you intend to add a discount code via the `applyDiscountCodeChange` method, check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n\n> Caution: Check cart instructions before calling select APIs, as > some may not be available. See the > [Cart Instructions API](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples) > for more information." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -42687,7 +42687,7 @@ "syntaxKind": "PropertySignature", "name": "localization", "value": "Localization", - "description": "The details about the location, language, and currency of the customer. For utilities to easily format and translate content based on these details, you can use the [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n) object instead." + "description": "The buyer's language, country, currency, and timezone context. For formatting and translation helpers, use the [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#properties-propertydetail-i18n) object instead." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -42717,21 +42717,21 @@ "syntaxKind": "PropertySignature", "name": "query", "value": ">(query: string, options?: { variables?: Variables; version?: StorefrontApiVersion; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>", - "description": "The method used to query the Storefront GraphQL API with a prefetched token.\n\nRefer to [Storefront API access examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/storefront-api) for more information." + "description": "The method used to query the Storefront GraphQL API with a prefetched token." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "selectedPaymentOptions", "value": "SubscribableSignalLike", - "description": "The payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card)." + "description": "The payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\n\nEach option exposes `handle` and `type` only. Provider names, logos, fees, and installment terms aren't available." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "sessionToken", "value": "SessionToken", - "description": "The session token providing a set of claims as a signed JSON Web Token (JWT).\n\nThe token has a TTL of five minutes.\n\nIf the previous token expires, this value reflects a new session token with a new signature and expiry.\n\nRefer to [session token examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/session-token) for more information." + "description": "The session token providing a set of claims as a signed JSON Web Token (JWT).\n\nThe token has a TTL of five minutes.\n\nIf the previous token expires, this value reflects a new session token with a new signature and expiry.\n\nLearn more about [session tokens](/docs/apps/build/authentication-authorization/session-tokens)." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -42753,14 +42753,14 @@ "syntaxKind": "PropertySignature", "name": "shop", "value": "Shop", - "description": "The shop where the checkout is taking place." + "description": "The store where the checkout is taking place, including the shop name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "storage", "value": "Storage", - "description": "The key-value storage for the extension.\n\nIt uses `localStorage` and should persist across the customer's current checkout session.\n\n> Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n\nData is shared across all activated extension targets of this extension. In versions 2023-07 and earlier, each activated extension target had its own storage." + "description": "Key-value storage that persists across page loads within the current checkout session. Data is shared across all activated targets associated with this extension.\n\n> Caution: Data persistence isn't guaranteed and storage is cleared when the buyer starts a new checkout." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -42782,29 +42782,29 @@ ] } ], - "value": "export interface StandardApi {\n /**\n * The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event.\n */\n analytics: Analytics;\n\n /**\n * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\n */\n appliedGiftCards: SubscribableSignalLike;\n\n /**\n * The cart instructions used to create the checkout and possibly limit extension capabilities.\n *\n * These instructions should be checked before performing any actions that might be affected by them.\n *\n * For example, if you intend to add a discount code via the `applyDiscountCodeChange` method,\n * check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n *\n * > Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs aren't available.\n * See the [update guide](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples) for more information.\n *\n */\n instructions: SubscribableSignalLike;\n\n /**\n * The metafields requested in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration)\n * file. These metafields are updated when there's a change in the merchandise items\n * being purchased by the customer.\n *\n * App owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` isn't supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n appMetafields: SubscribableSignalLike;\n\n /**\n * The custom key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n buyerIdentity?: BuyerIdentity;\n\n /**\n * Provides details on the buyer's progression through the checkout and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/buyer-journey#examples)\n * examples for more information.\n */\n buyerJourney: BuyerJourney;\n\n /**\n * Settings applied to the buyer's checkout.\n */\n checkoutSettings: SubscribableSignalLike;\n\n /**\n * A stable ID that represents the current checkout.\n *\n * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\n *\n * This matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data)\n * and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n */\n checkoutToken: SubscribableSignalLike;\n\n /**\n * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * The meta information about the extension.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n *\n * @deprecated Deprecated as of version `2023-07`, use `extension.target` instead.\n */\n extensionPoint: Target;\n\n /**\n * Utilities for translating content and formatting values according to the current\n * [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization)\n * of the checkout.\n *\n * Refer to [`localization` examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples)\n * for more information.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The details about the location, language, and currency of the customer. For utilities to easily\n * format and translate content based on these details, you can use the\n * [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n)\n * object instead.\n */\n localization: Localization;\n\n /**\n * The metafields that apply to the current checkout.\n *\n * Metafields are stored locally on the client and are applied to the order object after the checkout completes.\n *\n * These metafields are shared by all extensions running on checkout, and\n * persist for as long as the customer is working on this checkout.\n *\n * Once the order is created, you can query these metafields using the\n * [GraphQL Admin API](/docs/admin-api/graphql/reference/orders/order#metafield-2021-01)\n *\n * > Caution:\n * `metafields` is deprecated. Use `appMetafields` with cart metafields instead.\n *\n * @deprecated Use `appMetafields` with cart metafields instead.\n */\n metafields: SubscribableSignalLike;\n\n /**\n * A note left by the customer to the merchant, either in their cart or during checkout.\n *\n * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\n */\n note: SubscribableSignalLike;\n\n /**\n * The method used to query the Storefront GraphQL API with a prefetched token.\n *\n * Refer to [Storefront API access examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/storefront-api) for more information.\n */\n query: >(\n query: string,\n options?: {variables?: Variables; version?: StorefrontApiVersion},\n ) => Promise<{data?: Data; errors?: GraphQLError[]}>;\n\n /**\n * The payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\n */\n selectedPaymentOptions: SubscribableSignalLike;\n\n /**\n * The session token providing a set of claims as a signed JSON Web Token (JWT).\n *\n * The token has a TTL of five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/session-token) for more information.\n */\n sessionToken: SessionToken;\n\n /**\n * The settings matching the settings definition written in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates in real time as a merchant fills in the settings.\n */\n settings: SubscribableSignalLike;\n\n /**\n * The proposed customer shipping address. During the information step, the address\n * updates when the field is committed (on change) rather than every keystroke.\n * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n shippingAddress?: SubscribableSignalLike;\n\n /**\n * The proposed customer billing address. The address updates when the field is\n * committed (on change) rather than every keystroke. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided yet.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n billingAddress?: SubscribableSignalLike;\n\n /** The shop where the checkout is taking place. */\n shop: Shop;\n\n /**\n * The key-value storage for the extension.\n *\n * It uses `localStorage` and should persist across the customer's current checkout session.\n *\n * > Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n *\n * Data is shared across all activated extension targets of this extension. In versions 2023-07 and earlier,\n * each activated extension target had its own storage.\n */\n storage: Storage;\n\n /**\n * The renderer version being used for the extension.\n *\n * @example '2025-10'\n */\n version: Version;\n\n /**\n * Customer privacy consent settings and a flag denoting if consent has previously been collected.\n */\n customerPrivacy: SubscribableSignalLike;\n\n /**\n * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent) to be set to `true`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyTrackingConsentChange: ApplyTrackingConsentChangeType;\n\n /**\n * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" + "value": "export interface StandardApi {\n /**\n * Tracks custom events and sends visitor information to\n * [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events\n * and `visitor()` to submit buyer contact details.\n */\n analytics: Analytics;\n\n /**\n * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\n */\n appliedGiftCards: SubscribableSignalLike;\n\n /**\n * The cart instructions used to create the checkout and possibly limit extension capabilities.\n *\n * These instructions should be checked before performing any actions that might be affected by them.\n *\n * For example, if you intend to add a discount code via the `applyDiscountCodeChange` method,\n * check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n *\n * > Caution: Check cart instructions before calling select APIs, as\n * > some may not be available. See the\n * > [Cart Instructions API](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples)\n * > for more information.\n *\n */\n instructions: SubscribableSignalLike;\n\n /**\n * The metafields requested in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration)\n * file. These metafields are updated when there's a change in the merchandise items\n * being purchased by the customer.\n *\n * App owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` isn't supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n appMetafields: SubscribableSignalLike;\n\n /**\n * The custom key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as\n * credit cards, wallets, and local payment methods. The list depends on\n * the shop's payment configuration and the buyer's region.\n *\n * The set of payment options can change when the buyer updates their\n * address or cart, so subscribe to changes rather than reading once\n * during initialization. Each option exposes `handle` and `type` only.\n * Provider names, logos, fees, and installment terms aren't available.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n buyerIdentity?: BuyerIdentity;\n\n /**\n * Provides details on the buyer's progression through the checkout and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/buyer-journey#examples)\n * examples for more information.\n */\n buyerJourney: BuyerJourney;\n\n /**\n * Settings applied to the buyer's checkout.\n */\n checkoutSettings: SubscribableSignalLike;\n\n /**\n * A stable ID that represents the current checkout.\n *\n * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\n *\n * This matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data)\n * and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n *\n * Can be `undefined`. Handle the `undefined` state before using the value.\n */\n checkoutToken: SubscribableSignalLike;\n\n /**\n * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n *\n * Empty until the buyer enters enough address information for Shopify to\n * calculate shipping rates.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * Metadata about the running extension, including the current target, API version,\n * capabilities, and editor context. Use this to conditionally render content\n * based on where the extension is running.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n *\n * @deprecated Use `extension.target` instead.\n */\n extensionPoint: Target;\n\n /**\n * Utilities for translating strings, formatting currencies, numbers, and dates\n * according to the buyer's locale. Use alongside\n * [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization)\n * to build fully localized extensions.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The buyer's language, country, currency, and timezone context. For\n * formatting and translation helpers, use the\n * [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#properties-propertydetail-i18n)\n * object instead.\n */\n localization: Localization;\n\n /**\n * The metafields that apply to the current checkout.\n *\n * Metafields are stored locally on the client and are applied to the order object after the checkout completes.\n *\n * These metafields are shared by all extensions running on checkout, and\n * persist for as long as the customer is working on this checkout.\n *\n * Once the order is created, you can query these metafields using the\n * [GraphQL Admin API](/docs/admin-api/graphql/reference/orders/order#metafield-2021-01)\n *\n * > Caution:\n * `metafields` is deprecated. Use `appMetafields` with cart metafields instead.\n *\n * @deprecated Use `appMetafields` with cart metafields instead.\n */\n metafields: SubscribableSignalLike;\n\n /**\n * A note left by the customer to the merchant, either in their cart or during checkout.\n *\n * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\n */\n note: SubscribableSignalLike;\n\n /**\n * The method used to query the Storefront GraphQL API with a prefetched token.\n *\n */\n query: >(\n query: string,\n options?: {variables?: Variables; version?: StorefrontApiVersion},\n ) => Promise<{data?: Data; errors?: GraphQLError[]}>;\n\n /**\n * The payment options the buyer has currently selected. This updates as\n * the buyer changes their payment method. The array can contain multiple\n * entries when the buyer splits payment across methods (for example, a\n * gift card and a credit card).\n *\n * Each option exposes `handle` and `type` only. Provider names, logos,\n * fees, and installment terms aren't available.\n */\n selectedPaymentOptions: SubscribableSignalLike;\n\n /**\n * The session token providing a set of claims as a signed JSON Web Token (JWT).\n *\n * The token has a TTL of five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Learn more about [session tokens](/docs/apps/build/authentication-authorization/session-tokens).\n */\n sessionToken: SessionToken;\n\n /**\n * The settings matching the settings definition written in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates in real time as a merchant fills in the settings.\n */\n settings: SubscribableSignalLike;\n\n /**\n * The proposed customer shipping address. During the information step, the address\n * updates when the field is committed (on change) rather than every keystroke.\n * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n shippingAddress?: SubscribableSignalLike;\n\n /**\n * The proposed customer billing address. The address updates when the field is\n * committed (on change) rather than every keystroke. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided yet.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n billingAddress?: SubscribableSignalLike;\n\n /**\n * The store where the checkout is taking place, including the shop name,\n * storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.\n */\n shop: Shop;\n\n /**\n * Key-value storage that persists across page loads within the current checkout\n * session. Data is shared across all activated targets associated with\n * this extension.\n *\n * > Caution: Data persistence isn't guaranteed and storage is cleared when the\n * buyer starts a new checkout.\n */\n storage: Storage;\n\n /**\n * The renderer version being used for the extension.\n *\n * @example '2025-10'\n */\n version: Version;\n\n /**\n * Customer privacy consent settings and a flag denoting if consent has previously been collected.\n */\n customerPrivacy: SubscribableSignalLike;\n\n /**\n * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`collect_buyer_consent` capability](/docs/apps/build/customer-accounts/capabilities#collect-buyer-consent) to be set to `true`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyTrackingConsentChange: ApplyTrackingConsentChangeType;\n\n /**\n * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" }, "Analytics": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Analytics", - "description": "", + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "publish", "value": "(name: string, data: Record) => Promise", - "description": "Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing)." + "description": "Publishes a custom event to [Web Pixels](/docs/apps/marketing). Returns `true` when the event is successfully dispatched.\n\nThe Promise resolves to `true` when the event was dispatched. The boolean indicates dispatch confirmation only. It doesn't indicate whether any specific web pixel processed the event." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "visitor", "value": "(data: { email?: string; phone?: string; }) => Promise", - "description": "A method for capturing details about a visitor on the online store." + "description": "Submits buyer contact details for attribution and analytics purposes." } ], - "value": "export interface Analytics {\n /**\n * Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing).\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * A method for capturing details about a visitor on the online store.\n */\n visitor(data: {email?: string; phone?: string}): Promise;\n}" + "value": "export interface Analytics {\n /**\n * Publishes a custom event to [Web Pixels](/docs/apps/marketing).\n * Returns `true` when the event is successfully dispatched.\n *\n * The Promise resolves to `true` when the event was dispatched. The boolean\n * indicates dispatch confirmation only. It doesn't indicate whether any\n * specific web pixel processed the event.\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * Submits buyer contact details for attribution and analytics purposes.\n */\n visitor(data: {email?: string; phone?: string}): Promise;\n}" }, "VisitorResult": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -42845,10 +42845,10 @@ "syntaxKind": "PropertySignature", "name": "type", "value": "'error'", - "description": "Indicates that the visitor information is invalid and wasn't submitted. Examples are using the wrong data type or missing a required property." + "description": "Indicates that the visitor information is invalid and wasn't submitted. Common causes include using the wrong data type or omitting a required property." } ], - "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Examples are using the wrong data type or missing a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Common causes include using the wrong data type or omitting a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" }, "SubscribableSignalLike": { "filePath": "src/surfaces/checkout/shared.ts", @@ -43062,10 +43062,10 @@ "syntaxKind": "PropertySignature", "name": "value", "value": "string | null", - "description": "The new value to store in the metafield. Set to `null` to delete the metafield." + "description": "The new value to store in the metafield. Set to `null` to delete the metafield.\n\nConsent metafield values are strings, not booleans. Pass `null` to delete a tracking consent metafield." } ], - "value": "export interface TrackingConsentMetafieldChange {\n /**\n * The identifier for the tracking consent metafield to update.\n */\n key: string;\n /**\n * The new value to store in the metafield. Set to `null` to delete the metafield.\n */\n value: string | null;\n}" + "value": "export interface TrackingConsentMetafieldChange {\n /**\n * The identifier for the tracking consent metafield to update.\n */\n key: string;\n /**\n * The new value to store in the metafield. Set to `null` to delete the metafield.\n *\n * Consent metafield values are strings, not booleans. Pass `null` to delete\n * a tracking consent metafield.\n */\n value: string | null;\n}" }, "VisitorConsent": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -43279,7 +43279,7 @@ "syntaxKind": "PropertySignature", "name": "value", "value": "string", - "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.", + "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.\n\nAttribute values are always strings. To store structured data, serialize it to JSON and parse it when reading.", "examples": [ { "title": "Example", @@ -43294,7 +43294,7 @@ ] } ], - "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" + "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * Attribute values are always strings. To store structured data, serialize\n * it to JSON and parse it when reading.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" }, "PaymentOption": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -43645,7 +43645,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A globally-unique identifier for the customer in the format `gid://shopify/Customer/`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", + "description": "An identifier for the customer in the format `gid://shopify/Customer/`. This value is unique per shop.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", "examples": [ { "title": "Example", @@ -43698,7 +43698,7 @@ "isPrivate": true } ], - "value": "export interface Customer {\n /**\n * A globally-unique identifier for the customer in the format `gid://shopify/Customer/`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'gid://shopify/Customer/123'\n */\n id: string;\n /**\n * The email address associated with the customer's account. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email?: string;\n /**\n * The phone number associated with the customer's account. The value is `undefined` if no phone number is on file or the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone?: string;\n /**\n * The customer's full name, typically a combination of first and last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n fullName?: string;\n /**\n * The customer's first name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n firstName?: string;\n /**\n * The customer's last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n lastName?: string;\n /**\n * The customer's profile image, such as a Gravatar avatar. Use this to personalize the extension UI for the logged-in buyer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n image: ImageDetails;\n /**\n * Whether the customer has opted in to receiving marketing communications from the merchant, such as email campaigns and promotional offers.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * > Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n *\n * @deprecated Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n */\n acceptsMarketing: boolean;\n /**\n * Whether the customer has opted in to email marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsEmailMarketing: boolean;\n /**\n * Whether the customer has opted in to SMS marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsSmsMarketing: boolean;\n /**\n * The store credit accounts owned by this customer that can be used as payment during checkout. Each account has a balance representing available store credit.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @private\n */\n storeCreditAccounts: StoreCreditAccount[];\n /**\n * The number of orders the customer has previously placed with this shop.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n ordersCount: number;\n}" + "value": "export interface Customer {\n /**\n * An identifier for the customer in the format `gid://shopify/Customer/`. This value is unique per shop.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'gid://shopify/Customer/123'\n */\n id: string;\n /**\n * The email address associated with the customer's account. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email?: string;\n /**\n * The phone number associated with the customer's account. The value is `undefined` if no phone number is on file or the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone?: string;\n /**\n * The customer's full name, typically a combination of first and last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n fullName?: string;\n /**\n * The customer's first name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n firstName?: string;\n /**\n * The customer's last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n lastName?: string;\n /**\n * The customer's profile image, such as a Gravatar avatar. Use this to personalize the extension UI for the logged-in buyer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n image: ImageDetails;\n /**\n * Whether the customer has opted in to receiving marketing communications from the merchant, such as email campaigns and promotional offers.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * > Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n *\n * @deprecated Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n */\n acceptsMarketing: boolean;\n /**\n * Whether the customer has opted in to email marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsEmailMarketing: boolean;\n /**\n * Whether the customer has opted in to SMS marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsSmsMarketing: boolean;\n /**\n * The store credit accounts owned by this customer that can be used as payment during checkout. Each account has a balance representing available store credit.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @private\n */\n storeCreditAccounts: StoreCreditAccount[];\n /**\n * The number of orders the customer has previously placed with this shop.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n ordersCount: number;\n}" }, "ImageDetails": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -43980,11 +43980,11 @@ "syntaxKind": "MethodSignature", "name": "perform", "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", + "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.\n\nRuns after all intercept results are collected. Use it for local state updates such as setting an error flag. By the time it runs, the navigation decision is final, so blocking logic belongs in the intercept handler itself, not here.", "isOptional": true } ], - "value": "interface InterceptorRequestAllow {\n /**\n * Indicates that the interceptor allows the buyer's journey to continue.\n */\n behavior: 'allow';\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" + "value": "interface InterceptorRequestAllow {\n /**\n * Indicates that the interceptor allows the buyer's journey to continue.\n */\n behavior: 'allow';\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n *\n * Runs after all intercept results are collected. Use it for local state\n * updates such as setting an error flag. By the time it runs, the navigation\n * decision is final, so blocking logic belongs in the intercept handler\n * itself, not here.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" }, "InterceptorResult": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -44048,7 +44048,7 @@ "syntaxKind": "MethodSignature", "name": "perform", "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", + "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.\n\nRuns after all intercept results are collected. Use it for local state updates such as setting an error flag. By the time it runs, the navigation decision is final, so blocking logic belongs in the intercept handler itself, not here.", "isOptional": true }, { @@ -44059,7 +44059,7 @@ "description": "The reason for blocking the interceptor request. This value isn't presented to the buyer, so it doesn't need to be localized. The value is used only for Shopify's own internal debugging and metrics." } ], - "value": "interface InterceptorRequestBlock {\n /**\n * Indicates that the interceptor blocks the buyer's journey from continuing.\n */\n behavior: 'block';\n\n /**\n * The reason for blocking the interceptor request. This value isn't presented to\n * the buyer, so it doesn't need to be localized. The value is used only for Shopify's\n * own internal debugging and metrics.\n */\n reason: string;\n\n /**\n * Used to pass errors to the checkout UI, outside your extension's UI boundaries.\n */\n errors?: ValidationError[];\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" + "value": "interface InterceptorRequestBlock {\n /**\n * Indicates that the interceptor blocks the buyer's journey from continuing.\n */\n behavior: 'block';\n\n /**\n * The reason for blocking the interceptor request. This value isn't presented to\n * the buyer, so it doesn't need to be localized. The value is used only for Shopify's\n * own internal debugging and metrics.\n */\n reason: string;\n\n /**\n * Used to pass errors to the checkout UI, outside your extension's UI boundaries.\n */\n errors?: ValidationError[];\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n *\n * Runs after all intercept results are collected. Use it for local state\n * updates such as setting an error flag. By the time it runs, the navigation\n * decision is final, so blocking logic belongs in the intercept handler\n * itself, not here.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" }, "ValidationError": { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -44280,17 +44280,17 @@ "syntaxKind": "PropertySignature", "name": "totalShippingAmount", "value": "SubscribableSignalLike", - "description": "The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step." + "description": "The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step.\n\n`undefined` until the buyer selects a shipping method (typically after the information step)." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "totalTaxAmount", "value": "SubscribableSignalLike", - "description": "The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet." + "description": "The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet.\n\n`undefined` when taxes haven't been calculated or aren't available for the buyer's region." } ], - "value": "export interface CartCost {\n /**\n * The sum of all line item prices at the current step of checkout, before shipping and taxes are applied. Use this value to display the base cost of the items the buyer purchased.\n */\n subtotalAmount: SubscribableSignalLike;\n\n /**\n * The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step.\n */\n totalShippingAmount: SubscribableSignalLike;\n\n /**\n * The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet.\n */\n totalTaxAmount: SubscribableSignalLike;\n\n /**\n * The minimum total at the current step of checkout. Costs not yet calculated, such as shipping on the information step, aren't included. Gift cards and store credits are excluded from this total.\n */\n totalAmount: SubscribableSignalLike;\n}" + "value": "export interface CartCost {\n /**\n * The sum of all line item prices at the current step of checkout, before shipping and taxes are applied. Use this value to display the base cost of the items the buyer purchased.\n */\n subtotalAmount: SubscribableSignalLike;\n\n /**\n * The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step.\n *\n * `undefined` until the buyer selects a shipping method (typically after the\n * information step).\n */\n totalShippingAmount: SubscribableSignalLike;\n\n /**\n * The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet.\n *\n * `undefined` when taxes haven't been calculated or aren't available for the\n * buyer's region.\n */\n totalTaxAmount: SubscribableSignalLike;\n\n /**\n * The minimum total at the current step of checkout. Costs not yet calculated, such as shipping on the information step, aren't included. Gift cards and store credits are excluded from this total.\n */\n totalAmount: SubscribableSignalLike;\n}" }, "CustomerPrivacy": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -44377,31 +44377,31 @@ "syntaxKind": "PropertySignature", "name": "analytics", "value": "boolean", - "description": "Whether analytics data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Analytics data includes how the shop was used and what interactions occurred." + "description": "Whether analytics data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Analytics data includes how the shop was used and what interactions occurred.\n\nWhether analytics data can be collected right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.analytics`, before calling `shopify.analytics.publish()`." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "marketing", "value": "boolean", - "description": "Whether marketing data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Marketing data includes attribution and targeted advertising preferences." + "description": "Whether marketing data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Marketing data includes attribution and targeted advertising preferences.\n\nWhether marketing data can be collected right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.marketing`, before performing marketing-related data collection." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "preferences", "value": "boolean", - "description": "Whether preference data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Preference data includes language, currency, and sizing choices." + "description": "Whether preference data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Preference data includes language, currency, and sizing choices.\n\nWhether preference data can be collected right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.preferences`, before storing or reading buyer preference data." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "saleOfData", "value": "boolean", - "description": "Whether data can be shared with third parties based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. This typically applies to behavioral advertising data." + "description": "Whether data can be shared with third parties based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. This typically applies to behavioral advertising data.\n\nWhether buyer data can be shared with or sold to third parties right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.saleOfData`, before sharing or selling buyer data with third parties." } ], - "value": "export interface AllowedProcessing {\n /**\n * Whether analytics data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Analytics\n * data includes how the shop was used and what interactions occurred.\n */\n analytics: boolean;\n /**\n * Whether marketing data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Marketing\n * data includes attribution and targeted advertising preferences.\n */\n marketing: boolean;\n /**\n * Whether preference data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Preference\n * data includes language, currency, and sizing choices.\n */\n preferences: boolean;\n /**\n * Whether data can be shared with third parties based on the visitor's\n * consent, the merchant's privacy configuration, and the visitor's region.\n * This typically applies to behavioral advertising data.\n */\n saleOfData: boolean;\n}" + "value": "export interface AllowedProcessing {\n /**\n * Whether analytics data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Analytics\n * data includes how the shop was used and what interactions occurred.\n *\n * Whether analytics data can be collected right now. Combines the buyer's\n * consent, the merchant's privacy configuration, and the buyer's region into\n * a single boolean. Check this flag, not `visitorConsent.analytics`, before\n * calling `shopify.analytics.publish()`.\n */\n analytics: boolean;\n /**\n * Whether marketing data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Marketing\n * data includes attribution and targeted advertising preferences.\n *\n * Whether marketing data can be collected right now. Combines the buyer's\n * consent, the merchant's privacy configuration, and the buyer's region into\n * a single boolean. Check this flag, not `visitorConsent.marketing`, before\n * performing marketing-related data collection.\n */\n marketing: boolean;\n /**\n * Whether preference data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Preference\n * data includes language, currency, and sizing choices.\n *\n * Whether preference data can be collected right now. Combines the buyer's\n * consent, the merchant's privacy configuration, and the buyer's region into\n * a single boolean. Check this flag, not `visitorConsent.preferences`,\n * before storing or reading buyer preference data.\n */\n preferences: boolean;\n /**\n * Whether data can be shared with third parties based on the visitor's\n * consent, the merchant's privacy configuration, and the visitor's region.\n * This typically applies to behavioral advertising data.\n *\n * Whether buyer data can be shared with or sold to third parties right now.\n * Combines the buyer's consent, the merchant's privacy configuration, and\n * the buyer's region into a single boolean. Check this flag, not\n * `visitorConsent.saleOfData`, before sharing or selling buyer data with\n * third parties.\n */\n saleOfData: boolean;\n}" }, "TrackingConsentMetafield": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -45093,7 +45093,7 @@ "Extension": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Extension", - "description": "The meta information about an extension target.", + "description": "Metadata about the running extension, including its API version, target, capabilities, and editor context. Use this to read configuration details or conditionally render content based on where the extension is running.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -45119,7 +45119,7 @@ "syntaxKind": "PropertySignature", "name": "capabilities", "value": "SubscribableSignalLike", - "description": "The allowed capabilities of the extension, defined in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n\n* [`api_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#api-access): the extension can access the Storefront API.\n\n* [`network_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access): the extension can make external network calls.\n\n* [`block_progress`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n\n* [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n\n* [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can register customer consent decisions that are honored on Shopify-managed services.\n\n* [`iframe.sources`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#iframe): the extension can embed an external URL in an iframe." + "description": "The allowed capabilities of the extension, defined in your [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -45167,7 +45167,7 @@ "syntaxKind": "PropertySignature", "name": "version", "value": "string", - "description": "The published version of the running extension target.\n\nFor unpublished extensions, the value is `undefined`.", + "description": "The published version of the running extension target.\n\nFor unpublished extensions, the value is `undefined`.\n\nDon't use this property as a stable identifier in development environments. It becomes available only after the extension is published.", "isOptional": true, "examples": [ { @@ -45183,7 +45183,7 @@ ] } ], - "value": "export interface Extension {\n /**\n * The API version that was set in the extension config file.\n *\n * @example '2024-10', '2025-01', '2025-04', '2025-07', '2025-10'\n */\n apiVersion: ApiVersion;\n\n /**\n * The allowed capabilities of the extension, defined\n * in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n *\n * * [`api_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#api-access): the extension can access the Storefront API.\n *\n * * [`network_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access): the extension can make external network calls.\n *\n * * [`block_progress`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n *\n * * [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n *\n * * [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can register customer consent decisions that are honored on Shopify-managed services.\n *\n * * [`iframe.sources`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#iframe): the extension can embed an external URL in an iframe.\n */\n capabilities: SubscribableSignalLike;\n\n /**\n * Information about the editor where the extension is being rendered.\n *\n * If the value is undefined, then the extension isn't running in an editor.\n */\n editor?: Editor;\n\n /**\n * A Boolean to show whether your extension is currently rendered to the screen.\n *\n * Shopify might render your extension before it's visible in the UI,\n * typically to pre-render extensions that appear on a later step of the\n * checkout.\n *\n * Your extension might also continue to run after the customer has navigated away\n * from where it was rendered. The extension continues running so that\n * your extension is immediately available to render if the customer navigates back.\n */\n rendered: SubscribableSignalLike;\n\n /**\n * The URL to the script that started the extension target.\n */\n scriptUrl: string;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n */\n target: Target;\n\n /**\n * The published version of the running extension target.\n *\n * For unpublished extensions, the value is `undefined`.\n *\n * @example 3.0.10\n */\n version?: string;\n}" + "value": "export interface Extension {\n /**\n * The API version that was set in the extension config file.\n *\n * @example '2024-10', '2025-01', '2025-04', '2025-07', '2025-10'\n */\n apiVersion: ApiVersion;\n\n /**\n * The allowed capabilities of the extension, defined in your\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n */\n capabilities: SubscribableSignalLike;\n\n /**\n * Information about the editor where the extension is being rendered.\n *\n * If the value is undefined, then the extension isn't running in an editor.\n */\n editor?: Editor;\n\n /**\n * A Boolean to show whether your extension is currently rendered to the screen.\n *\n * Shopify might render your extension before it's visible in the UI,\n * typically to pre-render extensions that appear on a later step of the\n * checkout.\n *\n * Your extension might also continue to run after the customer has navigated away\n * from where it was rendered. The extension continues running so that\n * your extension is immediately available to render if the customer navigates back.\n */\n rendered: SubscribableSignalLike;\n\n /**\n * The URL to the script that started the extension target.\n */\n scriptUrl: string;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n */\n target: Target;\n\n /**\n * The published version of the running extension target.\n *\n * For unpublished extensions, the value is `undefined`.\n *\n * Don't use this property as a stable identifier in development environments.\n * It becomes available only after the extension is published.\n *\n * @example 3.0.10\n */\n version?: string;\n}" }, "ApiVersion": { "filePath": "src/shared.ts", @@ -45202,7 +45202,7 @@ "Editor": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Editor", - "description": "", + "description": "Information about the editor environment when an extension is rendered inside the checkout editor. The value is `undefined` when the extension is not rendering in an editor.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -45217,7 +45217,7 @@ "I18n": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18n", - "description": "", + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use the I18n API alongside the Localization API to build fully localized extensions.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -45253,7 +45253,7 @@ "I18nTranslate": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18nTranslate", - "description": "This returns a translated string matching a key in a locale file.", + "description": "Translates a key from your extension's locale files into a localized string. Supports interpolation with placeholder replacements and pluralization via the special `count` option.", "members": [], "value": "export interface I18nTranslate {\n (\n key: string,\n options?: Record,\n ): ReplacementType extends string | number\n ? string\n : (string | ReplacementType)[];\n}" }, @@ -45817,14 +45817,14 @@ "Localization": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Localization", - "description": "", + "description": "The buyer's language, country, currency, and timezone context. Use this to adapt your extension to the buyer's region and display localized content.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "country", "value": "SubscribableSignalLike", - "description": "The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown." + "description": "The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n\nDerived from the buyer's shipping address. Returns `undefined` until the buyer enters a shipping address." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -45852,18 +45852,18 @@ "syntaxKind": "PropertySignature", "name": "market", "value": "SubscribableSignalLike", - "description": "The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n\n> Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.", - "deprecationMessage": "Deprecated as of version `2025-04`" + "description": "The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. The market context updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.", + "deprecationMessage": "Merchants now manage which extensions load for each\nmarket, so extensions no longer need to check this value." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "timezone", "value": "SubscribableSignalLike", - "description": "The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time." + "description": "The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time." } ], - "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n *\n * > Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" + "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n *\n * Derived from the buyer's shipping address. Returns `undefined` until the\n * buyer enters a shipping address.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout,\n * carried over from the cart context. Markets group countries and\n * regions with shared pricing, languages, and domains. The market\n * context updates when the buyer changes the country of their\n * shipping address. The value is `undefined` if the market is unknown.\n *\n * @deprecated Merchants now manage which extensions load for each\n * market, so extensions no longer need to check this value.\n */\n market: SubscribableSignalLike;\n}" }, "Country": { "filePath": "src/shared.ts", @@ -46064,7 +46064,7 @@ "SessionToken": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SessionToken", - "description": "", + "description": "Authenticates requests between your extension and your app backend. Use session tokens to verify the identity of the buyer and the shop context when making server-side API calls. The token is a signed JWT that contains claims such as the customer ID, shop domain, and expiration.\n\nThe `sub` claim in the decoded token is present only when the buyer is logged in and the app has permission to read customer accounts. Absent for anonymous buyers.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -46323,7 +46323,7 @@ "Shop": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Shop", - "description": "", + "description": "Metadata about the merchant's store, including its name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -46363,30 +46363,30 @@ "syntaxKind": "PropertySignature", "name": "storefrontUrl", "value": "string", - "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n\n> Caution: > As of version `2024-04` this value no longer has a trailing slash.", + "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.", "isOptional": true } ], - "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n *\n * > Caution:\n * > As of version `2024-04` this value no longer has a trailing slash.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom domain.\n */\n myshopifyDomain: string;\n}" + "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom domain.\n */\n myshopifyDomain: string;\n}" }, "Storage": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Storage", - "description": "A key-value storage object for the extension.\n\nStored data is available only to this specific extension and any of its instances.\n\nThe storage backend is implemented with `localStorage` and should persist across the buyer's checkout session. However, data persistence isn't guaranteed.", + "description": "Key-value storage for a specific extension. Use storage to save preferences or cached data that should survive page reloads without requiring a backend call. Stored data is only available to this specific extension. The storage backend is implemented with `localStorage` and data persistence isn't guaranteed.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "delete", "value": "(key: string) => Promise", - "description": "Delete stored data by key." + "description": "Deletes a previously stored value by key." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "read", "value": "(key: string) => Promise", - "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original primitive.\n\nReturns `null` if no stored data exists." + "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original type.\n\nReturns the stored value for the given key, or `null` when no value exists. Doesn't throw on a missing key." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -46396,7 +46396,7 @@ "description": "Write stored data for this key.\n\nThe data must be serializable to JSON." } ], - "value": "export interface Storage {\n /**\n * Read and return a stored value by key.\n *\n * The stored data is deserialized from JSON and returned as\n * its original primitive.\n *\n * Returns `null` if no stored data exists.\n */\n read(key: string): Promise;\n\n /**\n * Write stored data for this key.\n *\n * The data must be serializable to JSON.\n */\n write(key: string, data: any): Promise;\n\n /**\n * Delete stored data by key.\n */\n delete(key: string): Promise;\n}" + "value": "export interface Storage {\n /**\n * Read and return a stored value by key.\n *\n * The stored data is deserialized from JSON and returned as\n * its original type.\n *\n * Returns the stored value for the given key, or `null` when no value\n * exists. Doesn't throw on a missing key.\n */\n read(key: string): Promise;\n\n /**\n * Write stored data for this key.\n *\n * The data must be serializable to JSON.\n */\n write(key: string, data: any): Promise;\n\n /**\n * Deletes a previously stored value by key.\n */\n delete(key: string): Promise;\n}" }, "Version": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -46472,7 +46472,7 @@ "syntaxKind": "MethodSignature", "name": "applyAttributeChange", "value": "(change: AttributeChange) => Promise", - "description": "Updates or removes an attribute on the cart and checkout. On success, the [`attributes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/attributes#standardapi-propertydetail-attributes) property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.", + "description": "Updates or removes an attribute on the cart and checkout. On success, the [`attributes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/attributes#properties-propertydetail-attributes) property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.", "deprecationMessage": "Use cart metafields instead." }, { @@ -46480,42 +46480,42 @@ "syntaxKind": "MethodSignature", "name": "applyCartLinesChange", "value": "(change: CartLineChange) => Promise", - "description": "Adds, removes, or updates line items in the cart. The returned promise resolves when the change has been applied by the server, and the [`lines`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-lines#standardapi-propertydetail-lines) property updates with the new state.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Adds, removes, or updates line items in the cart. The returned promise resolves when the change has been applied by the server, and the [`lines`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-lines#properties-propertydetail-lines) property updates with the new state.\n\nAccepts a single change per call. To make multiple changes, call this method separately for each one.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyDiscountCodeChange", "value": "(change: DiscountCodeChange) => Promise", - "description": "Adds or removes a discount code on the checkout. The returned promise resolves when the change has been applied by the server, and the [`discountCodes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/discounts#standardapi-propertydetail-discountcodes) property updates with the new state.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves discount codes through a network call.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Adds or removes a discount code on the checkout. The returned promise resolves when the change has been applied by the server, and the [`discountCodes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/discounts#properties-propertydetail-discountcodes) property updates with the new state.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves discount codes through a network call.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyGiftCardChange", "value": "(change: GiftCardChange) => Promise", - "description": "Adds or removes a gift card from the checkout. The returned promise resolves when the change has been applied by the server, and the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/gift-cards#standardapi-propertydetail-appliedgiftcards) property updates with the new state.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves gift card codes through a network call.\n\n> Note: This method returns an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Adds or removes a gift card from the checkout. The returned promise resolves when the change has been applied by the server, and the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/gift-cards#properties-propertydetail-appliedgiftcards) property updates with the new state.\n\nUnlike other write operations, gift card changes aren't gated by a cart instruction flag.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves gift card codes through a network call.\n\n> Note: This method returns an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyMetafieldChange", "value": "(change: MetafieldChange) => Promise", - "description": "Creates, updates, or removes a cart metafield on the checkout. On success, the [`metafields`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/metafields#standardapi-propertydetail-metafields) property updates to reflect the change.\n\nCart metafields are copied to order metafields at order creation time if there's a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n\n> Caution: `MetafieldRemoveChange` and `MetafieldUpdateChange` are deprecated. Use cart metafields with `MetafieldRemoveCartChange` and `MetafieldUpdateCartChange` instead. If `MetafieldUpdateChange` writes a metafield with the same namespace and key as a cart metafield that's configured to copy, the cart metafield won't be copied.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Creates, updates, or removes a cart metafield on the checkout. On success, the [`metafields`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/metafields#properties-propertydetail-metafields) property updates to reflect the change.\n\nCart metafields are copied to order metafields at order creation time if there's a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n\n> Caution: `MetafieldRemoveChange` and `MetafieldUpdateChange` are deprecated. Use cart metafields with `MetafieldRemoveCartChange` and `MetafieldUpdateCartChange` instead. If `MetafieldUpdateChange` writes a metafield with the same namespace and key as a cart metafield that's configured to copy, the cart metafield won't be copied.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyNoteChange", "value": "(change: NoteChange) => Promise", - "description": "Sets or removes the buyer's note on the checkout. On success, the [`note`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/note#standardapi-propertydetail-note) property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Sets or removes the buyer's note on the checkout. On success, the [`note`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/note#properties-propertydetail-note) property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyShippingAddressChange", "value": "(change: ShippingAddressUpdateChange) => Promise", - "description": "Updates the buyer's shipping address on the checkout. The provided fields are merged into the existing address without prompting the buyer. On success, the `shippingAddress` property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", + "description": "Updates the buyer's shipping address on the checkout. The provided fields are merged into the existing address without prompting the buyer. On success, the `shippingAddress` property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", "isOptional": true }, { @@ -46528,7 +46528,7 @@ "isPrivate": true } ], - "value": "export interface CheckoutApi {\n /**\n * Updates or removes an attribute on the cart and checkout. On success, the\n * [`attributes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/attributes#standardapi-propertydetail-attributes) property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * @deprecated Use cart metafields instead.\n */\n applyAttributeChange(change: AttributeChange): Promise;\n\n /**\n * Adds, removes, or updates line items in the cart. The returned promise resolves when the change has been applied by the server, and the [`lines`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-lines#standardapi-propertydetail-lines) property updates with the new state.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyCartLinesChange(change: CartLineChange): Promise;\n\n /**\n * Adds or removes a discount code on the checkout. The returned promise resolves when the change has been applied by the server, and the [`discountCodes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/discounts#standardapi-propertydetail-discountcodes) property updates with the new state.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves discount codes through a network call.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyDiscountCodeChange(\n change: DiscountCodeChange,\n ): Promise;\n\n /**\n * Adds or removes a gift card from the checkout. The returned promise resolves when the change has been applied by the server, and the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/gift-cards#standardapi-propertydetail-appliedgiftcards) property updates with the new state.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves gift card codes through a network call.\n *\n * > Note: This method returns an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyGiftCardChange(change: GiftCardChange): Promise;\n\n /**\n * Creates, updates, or removes a cart metafield on the checkout. On success, the\n * [`metafields`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/metafields#standardapi-propertydetail-metafields) property updates to reflect the change.\n *\n * Cart metafields are copied to order metafields at order creation time if there's a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n *\n * > Caution: `MetafieldRemoveChange` and `MetafieldUpdateChange` are deprecated. Use cart metafields with `MetafieldRemoveCartChange` and `MetafieldUpdateCartChange` instead. If `MetafieldUpdateChange` writes a metafield with the same namespace and key as a cart metafield that's configured to copy, the cart metafield won't be copied.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyMetafieldChange(change: MetafieldChange): Promise;\n\n /**\n * Sets or removes the buyer's note on the checkout. On success, the\n * [`note`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/note#standardapi-propertydetail-note)\n * property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyNoteChange(change: NoteChange): Promise;\n\n /**\n * @private\n */\n experimentalIsShopAppStyle?: boolean;\n\n /**\n * Updates the buyer's shipping address on the checkout. The provided fields\n * are merged into the existing address without prompting the buyer. On success,\n * the `shippingAddress` property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyShippingAddressChange?(\n change: ShippingAddressChange,\n ): Promise;\n}" + "value": "export interface CheckoutApi {\n /**\n * Updates or removes an attribute on the cart and checkout. On success, the\n * [`attributes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/attributes#properties-propertydetail-attributes) property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * @deprecated Use cart metafields instead.\n */\n applyAttributeChange(change: AttributeChange): Promise;\n\n /**\n * Adds, removes, or updates line items in the cart. The returned promise resolves when the change has been applied by the server, and the [`lines`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-lines#properties-propertydetail-lines) property updates with the new state.\n *\n * Accepts a single change per call. To make multiple changes, call this\n * method separately for each one.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyCartLinesChange(change: CartLineChange): Promise;\n\n /**\n * Adds or removes a discount code on the checkout. The returned promise resolves when the change has been applied by the server, and the [`discountCodes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/discounts#properties-propertydetail-discountcodes) property updates with the new state.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves discount codes through a network call.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyDiscountCodeChange(\n change: DiscountCodeChange,\n ): Promise;\n\n /**\n * Adds or removes a gift card from the checkout. The returned promise resolves when the change has been applied by the server, and the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/gift-cards#properties-propertydetail-appliedgiftcards) property updates with the new state.\n *\n * Unlike other write operations, gift card changes aren't gated by a cart\n * instruction flag.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves gift card codes through a network call.\n *\n * > Note: This method returns an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyGiftCardChange(change: GiftCardChange): Promise;\n\n /**\n * Creates, updates, or removes a cart metafield on the checkout. On success, the\n * [`metafields`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/metafields#properties-propertydetail-metafields) property updates to reflect the change.\n *\n * Cart metafields are copied to order metafields at order creation time if there's a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n *\n * > Caution: `MetafieldRemoveChange` and `MetafieldUpdateChange` are deprecated. Use cart metafields with `MetafieldRemoveCartChange` and `MetafieldUpdateCartChange` instead. If `MetafieldUpdateChange` writes a metafield with the same namespace and key as a cart metafield that's configured to copy, the cart metafield won't be copied.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyMetafieldChange(change: MetafieldChange): Promise;\n\n /**\n * Sets or removes the buyer's note on the checkout. On success, the\n * [`note`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/note#properties-propertydetail-note)\n * property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyNoteChange(change: NoteChange): Promise;\n\n /**\n * @private\n */\n experimentalIsShopAppStyle?: boolean;\n\n /**\n * Updates the buyer's shipping address on the checkout. The provided fields\n * are merged into the existing address without prompting the buyer. On success,\n * the `shippingAddress` property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyShippingAddressChange?(\n change: ShippingAddressChange,\n ): Promise;\n}" }, "AttributeChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -46595,7 +46595,7 @@ "syntaxKind": "PropertySignature", "name": "value", "value": "string", - "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.", + "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.\n\nAttribute values are always strings. To store structured data, serialize it to JSON and parse it when reading.", "examples": [ { "title": "Example", @@ -46610,7 +46610,7 @@ ] } ], - "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" + "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * Attribute values are always strings. To store structured data, serialize\n * it to JSON and parse it when reading.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" }, "AttributeRemoveChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -47463,7 +47463,7 @@ "syntaxKind": "PropertySignature", "name": "message", "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer." + "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer.\n\nRender your own localized error text rather than displaying this message to the buyer." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -47473,7 +47473,7 @@ "description": "Indicates that the line item wasn't changed successfully. Refer to the `message` property for details about the error." } ], - "value": "export interface CartLineChangeResultError {\n /**\n * Indicates that the line item wasn't changed successfully. Refer to the `message` property for details about the error.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface CartLineChangeResultError {\n /**\n * Indicates that the line item wasn't changed successfully. Refer to the `message` property for details about the error.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n *\n * Render your own localized error text rather than displaying this message\n * to the buyer.\n */\n message: string;\n}" }, "DiscountCodeChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -47653,7 +47653,7 @@ "syntaxKind": "PropertySignature", "name": "message", "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer." + "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer.\n\nRender your own localized error text rather than displaying this message to the buyer." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -47663,7 +47663,7 @@ "description": "Indicates that the gift card change couldn't be applied. Check the `message` property for details." } ], - "value": "export interface GiftCardChangeResultError {\n /**\n * Indicates that the gift card change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface GiftCardChangeResultError {\n /**\n * Indicates that the gift card change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n *\n * Render your own localized error text rather than displaying this message\n * to the buyer.\n */\n message: string;\n}" }, "MetafieldChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -47924,7 +47924,7 @@ "syntaxKind": "PropertySignature", "name": "message", "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer." + "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer.\n\nRender your own localized error text rather than displaying this message to the buyer." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -47934,7 +47934,7 @@ "description": "Indicates that the metafield change couldn't be applied. Check the `message` property for details." } ], - "value": "export interface MetafieldChangeResultError {\n /**\n * Indicates that the metafield change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface MetafieldChangeResultError {\n /**\n * Indicates that the metafield change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n *\n * Render your own localized error text rather than displaying this message\n * to the buyer.\n */\n message: string;\n}" }, "NoteChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -48012,7 +48012,7 @@ "syntaxKind": "PropertySignature", "name": "message", "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer." + "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer.\n\nRender your own localized error text rather than displaying this message to the buyer." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -48022,7 +48022,7 @@ "description": "Indicates that the note change couldn't be applied. Check the `message` property for details." } ], - "value": "export interface NoteChangeResultError {\n /**\n * Indicates that the note change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface NoteChangeResultError {\n /**\n * Indicates that the note change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n *\n * Render your own localized error text rather than displaying this message\n * to the buyer.\n */\n message: string;\n}" }, "ShippingAddressUpdateChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -48608,7 +48608,7 @@ "syntaxKind": "PropertySignature", "name": "analytics", "value": "Analytics", - "description": "The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event." + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -48622,7 +48622,7 @@ "syntaxKind": "PropertySignature", "name": "applyTrackingConsentChange", "value": "ApplyTrackingConsentChangeType", - "description": "Enables setting and updating customer privacy consent settings and tracking consent metafields.\n\n> Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent) to be set to `true`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." + "description": "Enables setting and updating customer privacy consent settings and tracking consent metafields.\n\n> Note: Requires the [`collect_buyer_consent` capability](/docs/apps/build/customer-accounts/capabilities#collect-buyer-consent) to be set to `true`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -48643,7 +48643,7 @@ "syntaxKind": "PropertySignature", "name": "availablePaymentOptions", "value": "SubscribableSignalLike", - "description": "All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region." + "description": "All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n\nThe set of payment options can change when the buyer updates their address or cart, so subscribe to changes rather than reading once during initialization. Each option exposes `handle` and `type` only. Provider names, logos, fees, and installment terms aren't available." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -48680,7 +48680,7 @@ "syntaxKind": "PropertySignature", "name": "checkoutToken", "value": "SubscribableSignalLike", - "description": "A stable ID that represents the current checkout.\n\nThe value is `undefined` when the checkout hasn't been created on the server yet.\n\nUse this to correlate checkout sessions across your extension, web pixels, and backend systems.\n\nThis matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data) and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object)." + "description": "A stable ID that represents the current checkout.\n\nThe value is `undefined` when the checkout hasn't been created on the server yet.\n\nUse this to correlate checkout sessions across your extension, web pixels, and backend systems.\n\nThis matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data) and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n\nCan be `undefined`. Handle the `undefined` state before using the value." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -48701,7 +48701,7 @@ "syntaxKind": "PropertySignature", "name": "deliveryGroups", "value": "SubscribableSignalLike", - "description": "The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items." + "description": "The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n\nEmpty until the buyer enters enough address information for Shopify to calculate shipping rates." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -48722,7 +48722,7 @@ "syntaxKind": "PropertySignature", "name": "extension", "value": "Extension", - "description": "The meta information about the extension." + "description": "Metadata about the running extension, including the current target, API version, capabilities, and editor context. Use this to conditionally render content based on where the extension is running." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -48730,7 +48730,7 @@ "name": "extensionPoint", "value": "Target", "description": "The identifier that specifies where in Shopify's UI your code is being injected. This is one of the targets you've included in your extension's configuration file.", - "deprecationMessage": "Deprecated as of version `2023-07`, use `extension.target` instead.", + "deprecationMessage": "Use `extension.target` instead.", "examples": [ { "title": "Example", @@ -48749,14 +48749,14 @@ "syntaxKind": "PropertySignature", "name": "i18n", "value": "I18n", - "description": "Utilities for translating content and formatting values according to the current [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) of the checkout.\n\nRefer to [`localization` examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples) for more information." + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use alongside [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) to build fully localized extensions." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "instructions", "value": "SubscribableSignalLike", - "description": "The cart instructions used to create the checkout and possibly limit extension capabilities.\n\nThese instructions should be checked before performing any actions that might be affected by them.\n\nFor example, if you intend to add a discount code via the `applyDiscountCodeChange` method, check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n\n> Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs aren't available. See the [update guide](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples) for more information." + "description": "The cart instructions used to create the checkout and possibly limit extension capabilities.\n\nThese instructions should be checked before performing any actions that might be affected by them.\n\nFor example, if you intend to add a discount code via the `applyDiscountCodeChange` method, check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n\n> Caution: Check cart instructions before calling select APIs, as > some may not be available. See the > [Cart Instructions API](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples) > for more information." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -48770,7 +48770,7 @@ "syntaxKind": "PropertySignature", "name": "localization", "value": "Localization", - "description": "The details about the location, language, and currency of the customer. For utilities to easily format and translate content based on these details, you can use the [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n) object instead." + "description": "The buyer's language, country, currency, and timezone context. For formatting and translation helpers, use the [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#properties-propertydetail-i18n) object instead." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -48800,21 +48800,21 @@ "syntaxKind": "PropertySignature", "name": "query", "value": ">(query: string, options?: { variables?: Variables; version?: StorefrontApiVersion; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>", - "description": "The method used to query the Storefront GraphQL API with a prefetched token.\n\nRefer to [Storefront API access examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/storefront-api) for more information." + "description": "The method used to query the Storefront GraphQL API with a prefetched token." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "selectedPaymentOptions", "value": "SubscribableSignalLike", - "description": "The payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card)." + "description": "The payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\n\nEach option exposes `handle` and `type` only. Provider names, logos, fees, and installment terms aren't available." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "sessionToken", "value": "SessionToken", - "description": "The session token providing a set of claims as a signed JSON Web Token (JWT).\n\nThe token has a TTL of five minutes.\n\nIf the previous token expires, this value reflects a new session token with a new signature and expiry.\n\nRefer to [session token examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/session-token) for more information." + "description": "The session token providing a set of claims as a signed JSON Web Token (JWT).\n\nThe token has a TTL of five minutes.\n\nIf the previous token expires, this value reflects a new session token with a new signature and expiry.\n\nLearn more about [session tokens](/docs/apps/build/authentication-authorization/session-tokens)." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -48836,14 +48836,14 @@ "syntaxKind": "PropertySignature", "name": "shop", "value": "Shop", - "description": "The shop where the checkout is taking place." + "description": "The store where the checkout is taking place, including the shop name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "storage", "value": "Storage", - "description": "The key-value storage for the extension.\n\nIt uses `localStorage` and should persist across the customer's current checkout session.\n\n> Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n\nData is shared across all activated extension targets of this extension. In versions 2023-07 and earlier, each activated extension target had its own storage." + "description": "Key-value storage that persists across page loads within the current checkout session. Data is shared across all activated targets associated with this extension.\n\n> Caution: Data persistence isn't guaranteed and storage is cleared when the buyer starts a new checkout." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -48865,29 +48865,29 @@ ] } ], - "value": "export interface StandardApi {\n /**\n * The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event.\n */\n analytics: Analytics;\n\n /**\n * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\n */\n appliedGiftCards: SubscribableSignalLike;\n\n /**\n * The cart instructions used to create the checkout and possibly limit extension capabilities.\n *\n * These instructions should be checked before performing any actions that might be affected by them.\n *\n * For example, if you intend to add a discount code via the `applyDiscountCodeChange` method,\n * check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n *\n * > Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs aren't available.\n * See the [update guide](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples) for more information.\n *\n */\n instructions: SubscribableSignalLike;\n\n /**\n * The metafields requested in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration)\n * file. These metafields are updated when there's a change in the merchandise items\n * being purchased by the customer.\n *\n * App owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` isn't supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n appMetafields: SubscribableSignalLike;\n\n /**\n * The custom key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n buyerIdentity?: BuyerIdentity;\n\n /**\n * Provides details on the buyer's progression through the checkout and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/buyer-journey#examples)\n * examples for more information.\n */\n buyerJourney: BuyerJourney;\n\n /**\n * Settings applied to the buyer's checkout.\n */\n checkoutSettings: SubscribableSignalLike;\n\n /**\n * A stable ID that represents the current checkout.\n *\n * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\n *\n * This matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data)\n * and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n */\n checkoutToken: SubscribableSignalLike;\n\n /**\n * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * The meta information about the extension.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n *\n * @deprecated Deprecated as of version `2023-07`, use `extension.target` instead.\n */\n extensionPoint: Target;\n\n /**\n * Utilities for translating content and formatting values according to the current\n * [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization)\n * of the checkout.\n *\n * Refer to [`localization` examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples)\n * for more information.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The details about the location, language, and currency of the customer. For utilities to easily\n * format and translate content based on these details, you can use the\n * [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n)\n * object instead.\n */\n localization: Localization;\n\n /**\n * The metafields that apply to the current checkout.\n *\n * Metafields are stored locally on the client and are applied to the order object after the checkout completes.\n *\n * These metafields are shared by all extensions running on checkout, and\n * persist for as long as the customer is working on this checkout.\n *\n * Once the order is created, you can query these metafields using the\n * [GraphQL Admin API](/docs/admin-api/graphql/reference/orders/order#metafield-2021-01)\n *\n * > Caution:\n * `metafields` is deprecated. Use `appMetafields` with cart metafields instead.\n *\n * @deprecated Use `appMetafields` with cart metafields instead.\n */\n metafields: SubscribableSignalLike;\n\n /**\n * A note left by the customer to the merchant, either in their cart or during checkout.\n *\n * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\n */\n note: SubscribableSignalLike;\n\n /**\n * The method used to query the Storefront GraphQL API with a prefetched token.\n *\n * Refer to [Storefront API access examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/storefront-api) for more information.\n */\n query: >(\n query: string,\n options?: {variables?: Variables; version?: StorefrontApiVersion},\n ) => Promise<{data?: Data; errors?: GraphQLError[]}>;\n\n /**\n * The payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\n */\n selectedPaymentOptions: SubscribableSignalLike;\n\n /**\n * The session token providing a set of claims as a signed JSON Web Token (JWT).\n *\n * The token has a TTL of five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/session-token) for more information.\n */\n sessionToken: SessionToken;\n\n /**\n * The settings matching the settings definition written in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates in real time as a merchant fills in the settings.\n */\n settings: SubscribableSignalLike;\n\n /**\n * The proposed customer shipping address. During the information step, the address\n * updates when the field is committed (on change) rather than every keystroke.\n * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n shippingAddress?: SubscribableSignalLike;\n\n /**\n * The proposed customer billing address. The address updates when the field is\n * committed (on change) rather than every keystroke. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided yet.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n billingAddress?: SubscribableSignalLike;\n\n /** The shop where the checkout is taking place. */\n shop: Shop;\n\n /**\n * The key-value storage for the extension.\n *\n * It uses `localStorage` and should persist across the customer's current checkout session.\n *\n * > Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n *\n * Data is shared across all activated extension targets of this extension. In versions 2023-07 and earlier,\n * each activated extension target had its own storage.\n */\n storage: Storage;\n\n /**\n * The renderer version being used for the extension.\n *\n * @example '2025-10'\n */\n version: Version;\n\n /**\n * Customer privacy consent settings and a flag denoting if consent has previously been collected.\n */\n customerPrivacy: SubscribableSignalLike;\n\n /**\n * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent) to be set to `true`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyTrackingConsentChange: ApplyTrackingConsentChangeType;\n\n /**\n * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" + "value": "export interface StandardApi {\n /**\n * Tracks custom events and sends visitor information to\n * [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events\n * and `visitor()` to submit buyer contact details.\n */\n analytics: Analytics;\n\n /**\n * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\n */\n appliedGiftCards: SubscribableSignalLike;\n\n /**\n * The cart instructions used to create the checkout and possibly limit extension capabilities.\n *\n * These instructions should be checked before performing any actions that might be affected by them.\n *\n * For example, if you intend to add a discount code via the `applyDiscountCodeChange` method,\n * check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n *\n * > Caution: Check cart instructions before calling select APIs, as\n * > some may not be available. See the\n * > [Cart Instructions API](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples)\n * > for more information.\n *\n */\n instructions: SubscribableSignalLike;\n\n /**\n * The metafields requested in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration)\n * file. These metafields are updated when there's a change in the merchandise items\n * being purchased by the customer.\n *\n * App owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` isn't supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n appMetafields: SubscribableSignalLike;\n\n /**\n * The custom key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as\n * credit cards, wallets, and local payment methods. The list depends on\n * the shop's payment configuration and the buyer's region.\n *\n * The set of payment options can change when the buyer updates their\n * address or cart, so subscribe to changes rather than reading once\n * during initialization. Each option exposes `handle` and `type` only.\n * Provider names, logos, fees, and installment terms aren't available.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n buyerIdentity?: BuyerIdentity;\n\n /**\n * Provides details on the buyer's progression through the checkout and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/buyer-journey#examples)\n * examples for more information.\n */\n buyerJourney: BuyerJourney;\n\n /**\n * Settings applied to the buyer's checkout.\n */\n checkoutSettings: SubscribableSignalLike;\n\n /**\n * A stable ID that represents the current checkout.\n *\n * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\n *\n * This matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data)\n * and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n *\n * Can be `undefined`. Handle the `undefined` state before using the value.\n */\n checkoutToken: SubscribableSignalLike;\n\n /**\n * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n *\n * Empty until the buyer enters enough address information for Shopify to\n * calculate shipping rates.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * Metadata about the running extension, including the current target, API version,\n * capabilities, and editor context. Use this to conditionally render content\n * based on where the extension is running.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n *\n * @deprecated Use `extension.target` instead.\n */\n extensionPoint: Target;\n\n /**\n * Utilities for translating strings, formatting currencies, numbers, and dates\n * according to the buyer's locale. Use alongside\n * [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization)\n * to build fully localized extensions.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The buyer's language, country, currency, and timezone context. For\n * formatting and translation helpers, use the\n * [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#properties-propertydetail-i18n)\n * object instead.\n */\n localization: Localization;\n\n /**\n * The metafields that apply to the current checkout.\n *\n * Metafields are stored locally on the client and are applied to the order object after the checkout completes.\n *\n * These metafields are shared by all extensions running on checkout, and\n * persist for as long as the customer is working on this checkout.\n *\n * Once the order is created, you can query these metafields using the\n * [GraphQL Admin API](/docs/admin-api/graphql/reference/orders/order#metafield-2021-01)\n *\n * > Caution:\n * `metafields` is deprecated. Use `appMetafields` with cart metafields instead.\n *\n * @deprecated Use `appMetafields` with cart metafields instead.\n */\n metafields: SubscribableSignalLike;\n\n /**\n * A note left by the customer to the merchant, either in their cart or during checkout.\n *\n * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\n */\n note: SubscribableSignalLike;\n\n /**\n * The method used to query the Storefront GraphQL API with a prefetched token.\n *\n */\n query: >(\n query: string,\n options?: {variables?: Variables; version?: StorefrontApiVersion},\n ) => Promise<{data?: Data; errors?: GraphQLError[]}>;\n\n /**\n * The payment options the buyer has currently selected. This updates as\n * the buyer changes their payment method. The array can contain multiple\n * entries when the buyer splits payment across methods (for example, a\n * gift card and a credit card).\n *\n * Each option exposes `handle` and `type` only. Provider names, logos,\n * fees, and installment terms aren't available.\n */\n selectedPaymentOptions: SubscribableSignalLike;\n\n /**\n * The session token providing a set of claims as a signed JSON Web Token (JWT).\n *\n * The token has a TTL of five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Learn more about [session tokens](/docs/apps/build/authentication-authorization/session-tokens).\n */\n sessionToken: SessionToken;\n\n /**\n * The settings matching the settings definition written in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates in real time as a merchant fills in the settings.\n */\n settings: SubscribableSignalLike;\n\n /**\n * The proposed customer shipping address. During the information step, the address\n * updates when the field is committed (on change) rather than every keystroke.\n * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n shippingAddress?: SubscribableSignalLike;\n\n /**\n * The proposed customer billing address. The address updates when the field is\n * committed (on change) rather than every keystroke. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided yet.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n billingAddress?: SubscribableSignalLike;\n\n /**\n * The store where the checkout is taking place, including the shop name,\n * storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.\n */\n shop: Shop;\n\n /**\n * Key-value storage that persists across page loads within the current checkout\n * session. Data is shared across all activated targets associated with\n * this extension.\n *\n * > Caution: Data persistence isn't guaranteed and storage is cleared when the\n * buyer starts a new checkout.\n */\n storage: Storage;\n\n /**\n * The renderer version being used for the extension.\n *\n * @example '2025-10'\n */\n version: Version;\n\n /**\n * Customer privacy consent settings and a flag denoting if consent has previously been collected.\n */\n customerPrivacy: SubscribableSignalLike;\n\n /**\n * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`collect_buyer_consent` capability](/docs/apps/build/customer-accounts/capabilities#collect-buyer-consent) to be set to `true`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyTrackingConsentChange: ApplyTrackingConsentChangeType;\n\n /**\n * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" }, "Analytics": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Analytics", - "description": "", + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "publish", "value": "(name: string, data: Record) => Promise", - "description": "Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing)." + "description": "Publishes a custom event to [Web Pixels](/docs/apps/marketing). Returns `true` when the event is successfully dispatched.\n\nThe Promise resolves to `true` when the event was dispatched. The boolean indicates dispatch confirmation only. It doesn't indicate whether any specific web pixel processed the event." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "visitor", "value": "(data: { email?: string; phone?: string; }) => Promise", - "description": "A method for capturing details about a visitor on the online store." + "description": "Submits buyer contact details for attribution and analytics purposes." } ], - "value": "export interface Analytics {\n /**\n * Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing).\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * A method for capturing details about a visitor on the online store.\n */\n visitor(data: {email?: string; phone?: string}): Promise;\n}" + "value": "export interface Analytics {\n /**\n * Publishes a custom event to [Web Pixels](/docs/apps/marketing).\n * Returns `true` when the event is successfully dispatched.\n *\n * The Promise resolves to `true` when the event was dispatched. The boolean\n * indicates dispatch confirmation only. It doesn't indicate whether any\n * specific web pixel processed the event.\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * Submits buyer contact details for attribution and analytics purposes.\n */\n visitor(data: {email?: string; phone?: string}): Promise;\n}" }, "VisitorResult": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -48928,10 +48928,10 @@ "syntaxKind": "PropertySignature", "name": "type", "value": "'error'", - "description": "Indicates that the visitor information is invalid and wasn't submitted. Examples are using the wrong data type or missing a required property." + "description": "Indicates that the visitor information is invalid and wasn't submitted. Common causes include using the wrong data type or omitting a required property." } ], - "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Examples are using the wrong data type or missing a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Common causes include using the wrong data type or omitting a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" }, "SubscribableSignalLike": { "filePath": "src/surfaces/checkout/shared.ts", @@ -49145,10 +49145,10 @@ "syntaxKind": "PropertySignature", "name": "value", "value": "string | null", - "description": "The new value to store in the metafield. Set to `null` to delete the metafield." + "description": "The new value to store in the metafield. Set to `null` to delete the metafield.\n\nConsent metafield values are strings, not booleans. Pass `null` to delete a tracking consent metafield." } ], - "value": "export interface TrackingConsentMetafieldChange {\n /**\n * The identifier for the tracking consent metafield to update.\n */\n key: string;\n /**\n * The new value to store in the metafield. Set to `null` to delete the metafield.\n */\n value: string | null;\n}" + "value": "export interface TrackingConsentMetafieldChange {\n /**\n * The identifier for the tracking consent metafield to update.\n */\n key: string;\n /**\n * The new value to store in the metafield. Set to `null` to delete the metafield.\n *\n * Consent metafield values are strings, not booleans. Pass `null` to delete\n * a tracking consent metafield.\n */\n value: string | null;\n}" }, "VisitorConsent": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -49362,7 +49362,7 @@ "syntaxKind": "PropertySignature", "name": "value", "value": "string", - "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.", + "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.\n\nAttribute values are always strings. To store structured data, serialize it to JSON and parse it when reading.", "examples": [ { "title": "Example", @@ -49377,7 +49377,7 @@ ] } ], - "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" + "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * Attribute values are always strings. To store structured data, serialize\n * it to JSON and parse it when reading.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" }, "PaymentOption": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -49728,7 +49728,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A globally-unique identifier for the customer in the format `gid://shopify/Customer/`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", + "description": "An identifier for the customer in the format `gid://shopify/Customer/`. This value is unique per shop.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", "examples": [ { "title": "Example", @@ -49781,7 +49781,7 @@ "isPrivate": true } ], - "value": "export interface Customer {\n /**\n * A globally-unique identifier for the customer in the format `gid://shopify/Customer/`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'gid://shopify/Customer/123'\n */\n id: string;\n /**\n * The email address associated with the customer's account. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email?: string;\n /**\n * The phone number associated with the customer's account. The value is `undefined` if no phone number is on file or the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone?: string;\n /**\n * The customer's full name, typically a combination of first and last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n fullName?: string;\n /**\n * The customer's first name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n firstName?: string;\n /**\n * The customer's last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n lastName?: string;\n /**\n * The customer's profile image, such as a Gravatar avatar. Use this to personalize the extension UI for the logged-in buyer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n image: ImageDetails;\n /**\n * Whether the customer has opted in to receiving marketing communications from the merchant, such as email campaigns and promotional offers.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * > Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n *\n * @deprecated Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n */\n acceptsMarketing: boolean;\n /**\n * Whether the customer has opted in to email marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsEmailMarketing: boolean;\n /**\n * Whether the customer has opted in to SMS marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsSmsMarketing: boolean;\n /**\n * The store credit accounts owned by this customer that can be used as payment during checkout. Each account has a balance representing available store credit.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @private\n */\n storeCreditAccounts: StoreCreditAccount[];\n /**\n * The number of orders the customer has previously placed with this shop.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n ordersCount: number;\n}" + "value": "export interface Customer {\n /**\n * An identifier for the customer in the format `gid://shopify/Customer/`. This value is unique per shop.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'gid://shopify/Customer/123'\n */\n id: string;\n /**\n * The email address associated with the customer's account. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email?: string;\n /**\n * The phone number associated with the customer's account. The value is `undefined` if no phone number is on file or the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone?: string;\n /**\n * The customer's full name, typically a combination of first and last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n fullName?: string;\n /**\n * The customer's first name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n firstName?: string;\n /**\n * The customer's last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n lastName?: string;\n /**\n * The customer's profile image, such as a Gravatar avatar. Use this to personalize the extension UI for the logged-in buyer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n image: ImageDetails;\n /**\n * Whether the customer has opted in to receiving marketing communications from the merchant, such as email campaigns and promotional offers.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * > Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n *\n * @deprecated Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n */\n acceptsMarketing: boolean;\n /**\n * Whether the customer has opted in to email marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsEmailMarketing: boolean;\n /**\n * Whether the customer has opted in to SMS marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsSmsMarketing: boolean;\n /**\n * The store credit accounts owned by this customer that can be used as payment during checkout. Each account has a balance representing available store credit.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @private\n */\n storeCreditAccounts: StoreCreditAccount[];\n /**\n * The number of orders the customer has previously placed with this shop.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n ordersCount: number;\n}" }, "ImageDetails": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -50063,11 +50063,11 @@ "syntaxKind": "MethodSignature", "name": "perform", "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", + "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.\n\nRuns after all intercept results are collected. Use it for local state updates such as setting an error flag. By the time it runs, the navigation decision is final, so blocking logic belongs in the intercept handler itself, not here.", "isOptional": true } ], - "value": "interface InterceptorRequestAllow {\n /**\n * Indicates that the interceptor allows the buyer's journey to continue.\n */\n behavior: 'allow';\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" + "value": "interface InterceptorRequestAllow {\n /**\n * Indicates that the interceptor allows the buyer's journey to continue.\n */\n behavior: 'allow';\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n *\n * Runs after all intercept results are collected. Use it for local state\n * updates such as setting an error flag. By the time it runs, the navigation\n * decision is final, so blocking logic belongs in the intercept handler\n * itself, not here.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" }, "InterceptorResult": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -50131,7 +50131,7 @@ "syntaxKind": "MethodSignature", "name": "perform", "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", + "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.\n\nRuns after all intercept results are collected. Use it for local state updates such as setting an error flag. By the time it runs, the navigation decision is final, so blocking logic belongs in the intercept handler itself, not here.", "isOptional": true }, { @@ -50142,7 +50142,7 @@ "description": "The reason for blocking the interceptor request. This value isn't presented to the buyer, so it doesn't need to be localized. The value is used only for Shopify's own internal debugging and metrics." } ], - "value": "interface InterceptorRequestBlock {\n /**\n * Indicates that the interceptor blocks the buyer's journey from continuing.\n */\n behavior: 'block';\n\n /**\n * The reason for blocking the interceptor request. This value isn't presented to\n * the buyer, so it doesn't need to be localized. The value is used only for Shopify's\n * own internal debugging and metrics.\n */\n reason: string;\n\n /**\n * Used to pass errors to the checkout UI, outside your extension's UI boundaries.\n */\n errors?: ValidationError[];\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" + "value": "interface InterceptorRequestBlock {\n /**\n * Indicates that the interceptor blocks the buyer's journey from continuing.\n */\n behavior: 'block';\n\n /**\n * The reason for blocking the interceptor request. This value isn't presented to\n * the buyer, so it doesn't need to be localized. The value is used only for Shopify's\n * own internal debugging and metrics.\n */\n reason: string;\n\n /**\n * Used to pass errors to the checkout UI, outside your extension's UI boundaries.\n */\n errors?: ValidationError[];\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n *\n * Runs after all intercept results are collected. Use it for local state\n * updates such as setting an error flag. By the time it runs, the navigation\n * decision is final, so blocking logic belongs in the intercept handler\n * itself, not here.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" }, "ValidationError": { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -50363,17 +50363,17 @@ "syntaxKind": "PropertySignature", "name": "totalShippingAmount", "value": "SubscribableSignalLike", - "description": "The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step." + "description": "The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step.\n\n`undefined` until the buyer selects a shipping method (typically after the information step)." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "totalTaxAmount", "value": "SubscribableSignalLike", - "description": "The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet." + "description": "The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet.\n\n`undefined` when taxes haven't been calculated or aren't available for the buyer's region." } ], - "value": "export interface CartCost {\n /**\n * The sum of all line item prices at the current step of checkout, before shipping and taxes are applied. Use this value to display the base cost of the items the buyer purchased.\n */\n subtotalAmount: SubscribableSignalLike;\n\n /**\n * The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step.\n */\n totalShippingAmount: SubscribableSignalLike;\n\n /**\n * The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet.\n */\n totalTaxAmount: SubscribableSignalLike;\n\n /**\n * The minimum total at the current step of checkout. Costs not yet calculated, such as shipping on the information step, aren't included. Gift cards and store credits are excluded from this total.\n */\n totalAmount: SubscribableSignalLike;\n}" + "value": "export interface CartCost {\n /**\n * The sum of all line item prices at the current step of checkout, before shipping and taxes are applied. Use this value to display the base cost of the items the buyer purchased.\n */\n subtotalAmount: SubscribableSignalLike;\n\n /**\n * The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step.\n *\n * `undefined` until the buyer selects a shipping method (typically after the\n * information step).\n */\n totalShippingAmount: SubscribableSignalLike;\n\n /**\n * The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet.\n *\n * `undefined` when taxes haven't been calculated or aren't available for the\n * buyer's region.\n */\n totalTaxAmount: SubscribableSignalLike;\n\n /**\n * The minimum total at the current step of checkout. Costs not yet calculated, such as shipping on the information step, aren't included. Gift cards and store credits are excluded from this total.\n */\n totalAmount: SubscribableSignalLike;\n}" }, "CustomerPrivacy": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -50460,31 +50460,31 @@ "syntaxKind": "PropertySignature", "name": "analytics", "value": "boolean", - "description": "Whether analytics data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Analytics data includes how the shop was used and what interactions occurred." + "description": "Whether analytics data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Analytics data includes how the shop was used and what interactions occurred.\n\nWhether analytics data can be collected right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.analytics`, before calling `shopify.analytics.publish()`." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "marketing", "value": "boolean", - "description": "Whether marketing data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Marketing data includes attribution and targeted advertising preferences." + "description": "Whether marketing data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Marketing data includes attribution and targeted advertising preferences.\n\nWhether marketing data can be collected right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.marketing`, before performing marketing-related data collection." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "preferences", "value": "boolean", - "description": "Whether preference data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Preference data includes language, currency, and sizing choices." + "description": "Whether preference data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Preference data includes language, currency, and sizing choices.\n\nWhether preference data can be collected right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.preferences`, before storing or reading buyer preference data." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "saleOfData", "value": "boolean", - "description": "Whether data can be shared with third parties based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. This typically applies to behavioral advertising data." + "description": "Whether data can be shared with third parties based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. This typically applies to behavioral advertising data.\n\nWhether buyer data can be shared with or sold to third parties right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.saleOfData`, before sharing or selling buyer data with third parties." } ], - "value": "export interface AllowedProcessing {\n /**\n * Whether analytics data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Analytics\n * data includes how the shop was used and what interactions occurred.\n */\n analytics: boolean;\n /**\n * Whether marketing data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Marketing\n * data includes attribution and targeted advertising preferences.\n */\n marketing: boolean;\n /**\n * Whether preference data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Preference\n * data includes language, currency, and sizing choices.\n */\n preferences: boolean;\n /**\n * Whether data can be shared with third parties based on the visitor's\n * consent, the merchant's privacy configuration, and the visitor's region.\n * This typically applies to behavioral advertising data.\n */\n saleOfData: boolean;\n}" + "value": "export interface AllowedProcessing {\n /**\n * Whether analytics data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Analytics\n * data includes how the shop was used and what interactions occurred.\n *\n * Whether analytics data can be collected right now. Combines the buyer's\n * consent, the merchant's privacy configuration, and the buyer's region into\n * a single boolean. Check this flag, not `visitorConsent.analytics`, before\n * calling `shopify.analytics.publish()`.\n */\n analytics: boolean;\n /**\n * Whether marketing data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Marketing\n * data includes attribution and targeted advertising preferences.\n *\n * Whether marketing data can be collected right now. Combines the buyer's\n * consent, the merchant's privacy configuration, and the buyer's region into\n * a single boolean. Check this flag, not `visitorConsent.marketing`, before\n * performing marketing-related data collection.\n */\n marketing: boolean;\n /**\n * Whether preference data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Preference\n * data includes language, currency, and sizing choices.\n *\n * Whether preference data can be collected right now. Combines the buyer's\n * consent, the merchant's privacy configuration, and the buyer's region into\n * a single boolean. Check this flag, not `visitorConsent.preferences`,\n * before storing or reading buyer preference data.\n */\n preferences: boolean;\n /**\n * Whether data can be shared with third parties based on the visitor's\n * consent, the merchant's privacy configuration, and the visitor's region.\n * This typically applies to behavioral advertising data.\n *\n * Whether buyer data can be shared with or sold to third parties right now.\n * Combines the buyer's consent, the merchant's privacy configuration, and\n * the buyer's region into a single boolean. Check this flag, not\n * `visitorConsent.saleOfData`, before sharing or selling buyer data with\n * third parties.\n */\n saleOfData: boolean;\n}" }, "TrackingConsentMetafield": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -51176,7 +51176,7 @@ "Extension": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Extension", - "description": "The meta information about an extension target.", + "description": "Metadata about the running extension, including its API version, target, capabilities, and editor context. Use this to read configuration details or conditionally render content based on where the extension is running.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -51202,7 +51202,7 @@ "syntaxKind": "PropertySignature", "name": "capabilities", "value": "SubscribableSignalLike", - "description": "The allowed capabilities of the extension, defined in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n\n* [`api_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#api-access): the extension can access the Storefront API.\n\n* [`network_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access): the extension can make external network calls.\n\n* [`block_progress`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n\n* [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n\n* [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can register customer consent decisions that are honored on Shopify-managed services.\n\n* [`iframe.sources`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#iframe): the extension can embed an external URL in an iframe." + "description": "The allowed capabilities of the extension, defined in your [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -51250,7 +51250,7 @@ "syntaxKind": "PropertySignature", "name": "version", "value": "string", - "description": "The published version of the running extension target.\n\nFor unpublished extensions, the value is `undefined`.", + "description": "The published version of the running extension target.\n\nFor unpublished extensions, the value is `undefined`.\n\nDon't use this property as a stable identifier in development environments. It becomes available only after the extension is published.", "isOptional": true, "examples": [ { @@ -51266,7 +51266,7 @@ ] } ], - "value": "export interface Extension {\n /**\n * The API version that was set in the extension config file.\n *\n * @example '2024-10', '2025-01', '2025-04', '2025-07', '2025-10'\n */\n apiVersion: ApiVersion;\n\n /**\n * The allowed capabilities of the extension, defined\n * in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n *\n * * [`api_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#api-access): the extension can access the Storefront API.\n *\n * * [`network_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access): the extension can make external network calls.\n *\n * * [`block_progress`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n *\n * * [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n *\n * * [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can register customer consent decisions that are honored on Shopify-managed services.\n *\n * * [`iframe.sources`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#iframe): the extension can embed an external URL in an iframe.\n */\n capabilities: SubscribableSignalLike;\n\n /**\n * Information about the editor where the extension is being rendered.\n *\n * If the value is undefined, then the extension isn't running in an editor.\n */\n editor?: Editor;\n\n /**\n * A Boolean to show whether your extension is currently rendered to the screen.\n *\n * Shopify might render your extension before it's visible in the UI,\n * typically to pre-render extensions that appear on a later step of the\n * checkout.\n *\n * Your extension might also continue to run after the customer has navigated away\n * from where it was rendered. The extension continues running so that\n * your extension is immediately available to render if the customer navigates back.\n */\n rendered: SubscribableSignalLike;\n\n /**\n * The URL to the script that started the extension target.\n */\n scriptUrl: string;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n */\n target: Target;\n\n /**\n * The published version of the running extension target.\n *\n * For unpublished extensions, the value is `undefined`.\n *\n * @example 3.0.10\n */\n version?: string;\n}" + "value": "export interface Extension {\n /**\n * The API version that was set in the extension config file.\n *\n * @example '2024-10', '2025-01', '2025-04', '2025-07', '2025-10'\n */\n apiVersion: ApiVersion;\n\n /**\n * The allowed capabilities of the extension, defined in your\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n */\n capabilities: SubscribableSignalLike;\n\n /**\n * Information about the editor where the extension is being rendered.\n *\n * If the value is undefined, then the extension isn't running in an editor.\n */\n editor?: Editor;\n\n /**\n * A Boolean to show whether your extension is currently rendered to the screen.\n *\n * Shopify might render your extension before it's visible in the UI,\n * typically to pre-render extensions that appear on a later step of the\n * checkout.\n *\n * Your extension might also continue to run after the customer has navigated away\n * from where it was rendered. The extension continues running so that\n * your extension is immediately available to render if the customer navigates back.\n */\n rendered: SubscribableSignalLike;\n\n /**\n * The URL to the script that started the extension target.\n */\n scriptUrl: string;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n */\n target: Target;\n\n /**\n * The published version of the running extension target.\n *\n * For unpublished extensions, the value is `undefined`.\n *\n * Don't use this property as a stable identifier in development environments.\n * It becomes available only after the extension is published.\n *\n * @example 3.0.10\n */\n version?: string;\n}" }, "ApiVersion": { "filePath": "src/shared.ts", @@ -51285,7 +51285,7 @@ "Editor": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Editor", - "description": "", + "description": "Information about the editor environment when an extension is rendered inside the checkout editor. The value is `undefined` when the extension is not rendering in an editor.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -51300,7 +51300,7 @@ "I18n": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18n", - "description": "", + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use the I18n API alongside the Localization API to build fully localized extensions.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -51336,7 +51336,7 @@ "I18nTranslate": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18nTranslate", - "description": "This returns a translated string matching a key in a locale file.", + "description": "Translates a key from your extension's locale files into a localized string. Supports interpolation with placeholder replacements and pluralization via the special `count` option.", "members": [], "value": "export interface I18nTranslate {\n (\n key: string,\n options?: Record,\n ): ReplacementType extends string | number\n ? string\n : (string | ReplacementType)[];\n}" }, @@ -51900,14 +51900,14 @@ "Localization": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Localization", - "description": "", + "description": "The buyer's language, country, currency, and timezone context. Use this to adapt your extension to the buyer's region and display localized content.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "country", "value": "SubscribableSignalLike", - "description": "The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown." + "description": "The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n\nDerived from the buyer's shipping address. Returns `undefined` until the buyer enters a shipping address." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -51935,18 +51935,18 @@ "syntaxKind": "PropertySignature", "name": "market", "value": "SubscribableSignalLike", - "description": "The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n\n> Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.", - "deprecationMessage": "Deprecated as of version `2025-04`" + "description": "The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. The market context updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.", + "deprecationMessage": "Merchants now manage which extensions load for each\nmarket, so extensions no longer need to check this value." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "timezone", "value": "SubscribableSignalLike", - "description": "The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time." + "description": "The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time." } ], - "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n *\n * > Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" + "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n *\n * Derived from the buyer's shipping address. Returns `undefined` until the\n * buyer enters a shipping address.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout,\n * carried over from the cart context. Markets group countries and\n * regions with shared pricing, languages, and domains. The market\n * context updates when the buyer changes the country of their\n * shipping address. The value is `undefined` if the market is unknown.\n *\n * @deprecated Merchants now manage which extensions load for each\n * market, so extensions no longer need to check this value.\n */\n market: SubscribableSignalLike;\n}" }, "Country": { "filePath": "src/shared.ts", @@ -52147,7 +52147,7 @@ "SessionToken": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SessionToken", - "description": "", + "description": "Authenticates requests between your extension and your app backend. Use session tokens to verify the identity of the buyer and the shop context when making server-side API calls. The token is a signed JWT that contains claims such as the customer ID, shop domain, and expiration.\n\nThe `sub` claim in the decoded token is present only when the buyer is logged in and the app has permission to read customer accounts. Absent for anonymous buyers.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -52406,7 +52406,7 @@ "Shop": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Shop", - "description": "", + "description": "Metadata about the merchant's store, including its name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -52446,30 +52446,30 @@ "syntaxKind": "PropertySignature", "name": "storefrontUrl", "value": "string", - "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n\n> Caution: > As of version `2024-04` this value no longer has a trailing slash.", + "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.", "isOptional": true } ], - "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n *\n * > Caution:\n * > As of version `2024-04` this value no longer has a trailing slash.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom domain.\n */\n myshopifyDomain: string;\n}" + "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom domain.\n */\n myshopifyDomain: string;\n}" }, "Storage": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Storage", - "description": "A key-value storage object for the extension.\n\nStored data is available only to this specific extension and any of its instances.\n\nThe storage backend is implemented with `localStorage` and should persist across the buyer's checkout session. However, data persistence isn't guaranteed.", + "description": "Key-value storage for a specific extension. Use storage to save preferences or cached data that should survive page reloads without requiring a backend call. Stored data is only available to this specific extension. The storage backend is implemented with `localStorage` and data persistence isn't guaranteed.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "delete", "value": "(key: string) => Promise", - "description": "Delete stored data by key." + "description": "Deletes a previously stored value by key." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "read", "value": "(key: string) => Promise", - "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original primitive.\n\nReturns `null` if no stored data exists." + "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original type.\n\nReturns the stored value for the given key, or `null` when no value exists. Doesn't throw on a missing key." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -52479,7 +52479,7 @@ "description": "Write stored data for this key.\n\nThe data must be serializable to JSON." } ], - "value": "export interface Storage {\n /**\n * Read and return a stored value by key.\n *\n * The stored data is deserialized from JSON and returned as\n * its original primitive.\n *\n * Returns `null` if no stored data exists.\n */\n read(key: string): Promise;\n\n /**\n * Write stored data for this key.\n *\n * The data must be serializable to JSON.\n */\n write(key: string, data: any): Promise;\n\n /**\n * Delete stored data by key.\n */\n delete(key: string): Promise;\n}" + "value": "export interface Storage {\n /**\n * Read and return a stored value by key.\n *\n * The stored data is deserialized from JSON and returned as\n * its original type.\n *\n * Returns the stored value for the given key, or `null` when no value\n * exists. Doesn't throw on a missing key.\n */\n read(key: string): Promise;\n\n /**\n * Write stored data for this key.\n *\n * The data must be serializable to JSON.\n */\n write(key: string, data: any): Promise;\n\n /**\n * Deletes a previously stored value by key.\n */\n delete(key: string): Promise;\n}" }, "Version": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -52556,10 +52556,10 @@ "syntaxKind": "PropertySignature", "name": "target", "value": "SubscribableSignalLike", - "description": "The cart line that this extension is attached to. Use this to read the line item's merchandise, quantity, cost, and attributes.\n\n> Note: Until version `2023-04`, this property was a `ReadonlySignalLike`." + "description": "The cart line that this extension is attached to. Use this to read the line item's merchandise, quantity, cost, and attributes.\n\nAvailable only on the corresponding item target. Shipping option item targets expose shipping option properties; pickup location item targets expose pickup location properties.\n\n> Note: Until version `2023-04`, this property was a `ReadonlySignalLike`." } ], - "value": "export interface CartLineItemApi {\n /**\n * The cart line that this extension is attached to. Use this to read the\n * line item's merchandise, quantity, cost, and attributes.\n *\n * > Note: Until version `2023-04`, this property was a `ReadonlySignalLike`.\n */\n target: SubscribableSignalLike;\n}" + "value": "export interface CartLineItemApi {\n /**\n * The cart line that this extension is attached to. Use this to read the\n * line item's merchandise, quantity, cost, and attributes.\n *\n * Available only on the corresponding item target. Shipping option item\n * targets expose shipping option properties; pickup location item targets\n * expose pickup location properties.\n *\n * > Note: Until version `2023-04`, this property was a `ReadonlySignalLike`.\n */\n target: SubscribableSignalLike;\n}" }, "SubscribableSignalLike": { "filePath": "src/surfaces/checkout/shared.ts", @@ -52704,7 +52704,7 @@ "syntaxKind": "PropertySignature", "name": "value", "value": "string", - "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.", + "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.\n\nAttribute values are always strings. To store structured data, serialize it to JSON and parse it when reading.", "examples": [ { "title": "Example", @@ -52719,7 +52719,7 @@ ] } ], - "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" + "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * Attribute values are always strings. To store structured data, serialize\n * it to JSON and parse it when reading.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" }, "CartLineCost": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -53216,7 +53216,7 @@ "syntaxKind": "MethodSignature", "name": "applyAttributeChange", "value": "(change: AttributeChange) => Promise", - "description": "Updates or removes an attribute on the cart and checkout. On success, the [`attributes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/attributes#standardapi-propertydetail-attributes) property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.", + "description": "Updates or removes an attribute on the cart and checkout. On success, the [`attributes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/attributes#properties-propertydetail-attributes) property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.", "deprecationMessage": "Use cart metafields instead." }, { @@ -53224,42 +53224,42 @@ "syntaxKind": "MethodSignature", "name": "applyCartLinesChange", "value": "(change: CartLineChange) => Promise", - "description": "Adds, removes, or updates line items in the cart. The returned promise resolves when the change has been applied by the server, and the [`lines`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-lines#standardapi-propertydetail-lines) property updates with the new state.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Adds, removes, or updates line items in the cart. The returned promise resolves when the change has been applied by the server, and the [`lines`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-lines#properties-propertydetail-lines) property updates with the new state.\n\nAccepts a single change per call. To make multiple changes, call this method separately for each one.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyDiscountCodeChange", "value": "(change: DiscountCodeChange) => Promise", - "description": "Adds or removes a discount code on the checkout. The returned promise resolves when the change has been applied by the server, and the [`discountCodes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/discounts#standardapi-propertydetail-discountcodes) property updates with the new state.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves discount codes through a network call.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Adds or removes a discount code on the checkout. The returned promise resolves when the change has been applied by the server, and the [`discountCodes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/discounts#properties-propertydetail-discountcodes) property updates with the new state.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves discount codes through a network call.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyGiftCardChange", "value": "(change: GiftCardChange) => Promise", - "description": "Adds or removes a gift card from the checkout. The returned promise resolves when the change has been applied by the server, and the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/gift-cards#standardapi-propertydetail-appliedgiftcards) property updates with the new state.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves gift card codes through a network call.\n\n> Note: This method returns an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Adds or removes a gift card from the checkout. The returned promise resolves when the change has been applied by the server, and the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/gift-cards#properties-propertydetail-appliedgiftcards) property updates with the new state.\n\nUnlike other write operations, gift card changes aren't gated by a cart instruction flag.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves gift card codes through a network call.\n\n> Note: This method returns an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyMetafieldChange", "value": "(change: MetafieldChange) => Promise", - "description": "Creates, updates, or removes a cart metafield on the checkout. On success, the [`metafields`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/metafields#standardapi-propertydetail-metafields) property updates to reflect the change.\n\nCart metafields are copied to order metafields at order creation time if there's a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n\n> Caution: `MetafieldRemoveChange` and `MetafieldUpdateChange` are deprecated. Use cart metafields with `MetafieldRemoveCartChange` and `MetafieldUpdateCartChange` instead. If `MetafieldUpdateChange` writes a metafield with the same namespace and key as a cart metafield that's configured to copy, the cart metafield won't be copied.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Creates, updates, or removes a cart metafield on the checkout. On success, the [`metafields`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/metafields#properties-propertydetail-metafields) property updates to reflect the change.\n\nCart metafields are copied to order metafields at order creation time if there's a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n\n> Caution: `MetafieldRemoveChange` and `MetafieldUpdateChange` are deprecated. Use cart metafields with `MetafieldRemoveCartChange` and `MetafieldUpdateCartChange` instead. If `MetafieldUpdateChange` writes a metafield with the same namespace and key as a cart metafield that's configured to copy, the cart metafield won't be copied.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyNoteChange", "value": "(change: NoteChange) => Promise", - "description": "Sets or removes the buyer's note on the checkout. On success, the [`note`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/note#standardapi-propertydetail-note) property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Sets or removes the buyer's note on the checkout. On success, the [`note`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/note#properties-propertydetail-note) property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyShippingAddressChange", "value": "(change: ShippingAddressUpdateChange) => Promise", - "description": "Updates the buyer's shipping address on the checkout. The provided fields are merged into the existing address without prompting the buyer. On success, the `shippingAddress` property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", + "description": "Updates the buyer's shipping address on the checkout. The provided fields are merged into the existing address without prompting the buyer. On success, the `shippingAddress` property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", "isOptional": true }, { @@ -53272,7 +53272,7 @@ "isPrivate": true } ], - "value": "export interface CheckoutApi {\n /**\n * Updates or removes an attribute on the cart and checkout. On success, the\n * [`attributes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/attributes#standardapi-propertydetail-attributes) property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * @deprecated Use cart metafields instead.\n */\n applyAttributeChange(change: AttributeChange): Promise;\n\n /**\n * Adds, removes, or updates line items in the cart. The returned promise resolves when the change has been applied by the server, and the [`lines`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-lines#standardapi-propertydetail-lines) property updates with the new state.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyCartLinesChange(change: CartLineChange): Promise;\n\n /**\n * Adds or removes a discount code on the checkout. The returned promise resolves when the change has been applied by the server, and the [`discountCodes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/discounts#standardapi-propertydetail-discountcodes) property updates with the new state.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves discount codes through a network call.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyDiscountCodeChange(\n change: DiscountCodeChange,\n ): Promise;\n\n /**\n * Adds or removes a gift card from the checkout. The returned promise resolves when the change has been applied by the server, and the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/gift-cards#standardapi-propertydetail-appliedgiftcards) property updates with the new state.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves gift card codes through a network call.\n *\n * > Note: This method returns an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyGiftCardChange(change: GiftCardChange): Promise;\n\n /**\n * Creates, updates, or removes a cart metafield on the checkout. On success, the\n * [`metafields`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/metafields#standardapi-propertydetail-metafields) property updates to reflect the change.\n *\n * Cart metafields are copied to order metafields at order creation time if there's a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n *\n * > Caution: `MetafieldRemoveChange` and `MetafieldUpdateChange` are deprecated. Use cart metafields with `MetafieldRemoveCartChange` and `MetafieldUpdateCartChange` instead. If `MetafieldUpdateChange` writes a metafield with the same namespace and key as a cart metafield that's configured to copy, the cart metafield won't be copied.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyMetafieldChange(change: MetafieldChange): Promise;\n\n /**\n * Sets or removes the buyer's note on the checkout. On success, the\n * [`note`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/note#standardapi-propertydetail-note)\n * property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyNoteChange(change: NoteChange): Promise;\n\n /**\n * @private\n */\n experimentalIsShopAppStyle?: boolean;\n\n /**\n * Updates the buyer's shipping address on the checkout. The provided fields\n * are merged into the existing address without prompting the buyer. On success,\n * the `shippingAddress` property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyShippingAddressChange?(\n change: ShippingAddressChange,\n ): Promise;\n}" + "value": "export interface CheckoutApi {\n /**\n * Updates or removes an attribute on the cart and checkout. On success, the\n * [`attributes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/attributes#properties-propertydetail-attributes) property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * @deprecated Use cart metafields instead.\n */\n applyAttributeChange(change: AttributeChange): Promise;\n\n /**\n * Adds, removes, or updates line items in the cart. The returned promise resolves when the change has been applied by the server, and the [`lines`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-lines#properties-propertydetail-lines) property updates with the new state.\n *\n * Accepts a single change per call. To make multiple changes, call this\n * method separately for each one.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyCartLinesChange(change: CartLineChange): Promise;\n\n /**\n * Adds or removes a discount code on the checkout. The returned promise resolves when the change has been applied by the server, and the [`discountCodes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/discounts#properties-propertydetail-discountcodes) property updates with the new state.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves discount codes through a network call.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyDiscountCodeChange(\n change: DiscountCodeChange,\n ): Promise;\n\n /**\n * Adds or removes a gift card from the checkout. The returned promise resolves when the change has been applied by the server, and the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/gift-cards#properties-propertydetail-appliedgiftcards) property updates with the new state.\n *\n * Unlike other write operations, gift card changes aren't gated by a cart\n * instruction flag.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves gift card codes through a network call.\n *\n * > Note: This method returns an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyGiftCardChange(change: GiftCardChange): Promise;\n\n /**\n * Creates, updates, or removes a cart metafield on the checkout. On success, the\n * [`metafields`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/metafields#properties-propertydetail-metafields) property updates to reflect the change.\n *\n * Cart metafields are copied to order metafields at order creation time if there's a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n *\n * > Caution: `MetafieldRemoveChange` and `MetafieldUpdateChange` are deprecated. Use cart metafields with `MetafieldRemoveCartChange` and `MetafieldUpdateCartChange` instead. If `MetafieldUpdateChange` writes a metafield with the same namespace and key as a cart metafield that's configured to copy, the cart metafield won't be copied.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyMetafieldChange(change: MetafieldChange): Promise;\n\n /**\n * Sets or removes the buyer's note on the checkout. On success, the\n * [`note`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/note#properties-propertydetail-note)\n * property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyNoteChange(change: NoteChange): Promise;\n\n /**\n * @private\n */\n experimentalIsShopAppStyle?: boolean;\n\n /**\n * Updates the buyer's shipping address on the checkout. The provided fields\n * are merged into the existing address without prompting the buyer. On success,\n * the `shippingAddress` property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyShippingAddressChange?(\n change: ShippingAddressChange,\n ): Promise;\n}" }, "AttributeChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -53339,7 +53339,7 @@ "syntaxKind": "PropertySignature", "name": "value", "value": "string", - "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.", + "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.\n\nAttribute values are always strings. To store structured data, serialize it to JSON and parse it when reading.", "examples": [ { "title": "Example", @@ -53354,7 +53354,7 @@ ] } ], - "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" + "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * Attribute values are always strings. To store structured data, serialize\n * it to JSON and parse it when reading.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" }, "AttributeRemoveChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -54207,7 +54207,7 @@ "syntaxKind": "PropertySignature", "name": "message", "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer." + "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer.\n\nRender your own localized error text rather than displaying this message to the buyer." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -54217,7 +54217,7 @@ "description": "Indicates that the line item wasn't changed successfully. Refer to the `message` property for details about the error." } ], - "value": "export interface CartLineChangeResultError {\n /**\n * Indicates that the line item wasn't changed successfully. Refer to the `message` property for details about the error.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface CartLineChangeResultError {\n /**\n * Indicates that the line item wasn't changed successfully. Refer to the `message` property for details about the error.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n *\n * Render your own localized error text rather than displaying this message\n * to the buyer.\n */\n message: string;\n}" }, "DiscountCodeChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -54397,7 +54397,7 @@ "syntaxKind": "PropertySignature", "name": "message", "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer." + "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer.\n\nRender your own localized error text rather than displaying this message to the buyer." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -54407,7 +54407,7 @@ "description": "Indicates that the gift card change couldn't be applied. Check the `message` property for details." } ], - "value": "export interface GiftCardChangeResultError {\n /**\n * Indicates that the gift card change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface GiftCardChangeResultError {\n /**\n * Indicates that the gift card change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n *\n * Render your own localized error text rather than displaying this message\n * to the buyer.\n */\n message: string;\n}" }, "MetafieldChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -54668,7 +54668,7 @@ "syntaxKind": "PropertySignature", "name": "message", "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer." + "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer.\n\nRender your own localized error text rather than displaying this message to the buyer." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -54678,7 +54678,7 @@ "description": "Indicates that the metafield change couldn't be applied. Check the `message` property for details." } ], - "value": "export interface MetafieldChangeResultError {\n /**\n * Indicates that the metafield change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface MetafieldChangeResultError {\n /**\n * Indicates that the metafield change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n *\n * Render your own localized error text rather than displaying this message\n * to the buyer.\n */\n message: string;\n}" }, "NoteChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -54756,7 +54756,7 @@ "syntaxKind": "PropertySignature", "name": "message", "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer." + "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer.\n\nRender your own localized error text rather than displaying this message to the buyer." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -54766,7 +54766,7 @@ "description": "Indicates that the note change couldn't be applied. Check the `message` property for details." } ], - "value": "export interface NoteChangeResultError {\n /**\n * Indicates that the note change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface NoteChangeResultError {\n /**\n * Indicates that the note change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n *\n * Render your own localized error text rather than displaying this message\n * to the buyer.\n */\n message: string;\n}" }, "ShippingAddressUpdateChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -55352,7 +55352,7 @@ "syntaxKind": "PropertySignature", "name": "analytics", "value": "Analytics", - "description": "The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event." + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -55366,7 +55366,7 @@ "syntaxKind": "PropertySignature", "name": "applyTrackingConsentChange", "value": "ApplyTrackingConsentChangeType", - "description": "Enables setting and updating customer privacy consent settings and tracking consent metafields.\n\n> Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent) to be set to `true`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." + "description": "Enables setting and updating customer privacy consent settings and tracking consent metafields.\n\n> Note: Requires the [`collect_buyer_consent` capability](/docs/apps/build/customer-accounts/capabilities#collect-buyer-consent) to be set to `true`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -55387,7 +55387,7 @@ "syntaxKind": "PropertySignature", "name": "availablePaymentOptions", "value": "SubscribableSignalLike", - "description": "All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region." + "description": "All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n\nThe set of payment options can change when the buyer updates their address or cart, so subscribe to changes rather than reading once during initialization. Each option exposes `handle` and `type` only. Provider names, logos, fees, and installment terms aren't available." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -55424,7 +55424,7 @@ "syntaxKind": "PropertySignature", "name": "checkoutToken", "value": "SubscribableSignalLike", - "description": "A stable ID that represents the current checkout.\n\nThe value is `undefined` when the checkout hasn't been created on the server yet.\n\nUse this to correlate checkout sessions across your extension, web pixels, and backend systems.\n\nThis matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data) and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object)." + "description": "A stable ID that represents the current checkout.\n\nThe value is `undefined` when the checkout hasn't been created on the server yet.\n\nUse this to correlate checkout sessions across your extension, web pixels, and backend systems.\n\nThis matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data) and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n\nCan be `undefined`. Handle the `undefined` state before using the value." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -55445,7 +55445,7 @@ "syntaxKind": "PropertySignature", "name": "deliveryGroups", "value": "SubscribableSignalLike", - "description": "The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items." + "description": "The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n\nEmpty until the buyer enters enough address information for Shopify to calculate shipping rates." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -55466,7 +55466,7 @@ "syntaxKind": "PropertySignature", "name": "extension", "value": "Extension", - "description": "The meta information about the extension." + "description": "Metadata about the running extension, including the current target, API version, capabilities, and editor context. Use this to conditionally render content based on where the extension is running." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -55474,7 +55474,7 @@ "name": "extensionPoint", "value": "Target", "description": "The identifier that specifies where in Shopify's UI your code is being injected. This is one of the targets you've included in your extension's configuration file.", - "deprecationMessage": "Deprecated as of version `2023-07`, use `extension.target` instead.", + "deprecationMessage": "Use `extension.target` instead.", "examples": [ { "title": "Example", @@ -55493,14 +55493,14 @@ "syntaxKind": "PropertySignature", "name": "i18n", "value": "I18n", - "description": "Utilities for translating content and formatting values according to the current [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) of the checkout.\n\nRefer to [`localization` examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples) for more information." + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use alongside [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) to build fully localized extensions." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "instructions", "value": "SubscribableSignalLike", - "description": "The cart instructions used to create the checkout and possibly limit extension capabilities.\n\nThese instructions should be checked before performing any actions that might be affected by them.\n\nFor example, if you intend to add a discount code via the `applyDiscountCodeChange` method, check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n\n> Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs aren't available. See the [update guide](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples) for more information." + "description": "The cart instructions used to create the checkout and possibly limit extension capabilities.\n\nThese instructions should be checked before performing any actions that might be affected by them.\n\nFor example, if you intend to add a discount code via the `applyDiscountCodeChange` method, check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n\n> Caution: Check cart instructions before calling select APIs, as > some may not be available. See the > [Cart Instructions API](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples) > for more information." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -55514,7 +55514,7 @@ "syntaxKind": "PropertySignature", "name": "localization", "value": "Localization", - "description": "The details about the location, language, and currency of the customer. For utilities to easily format and translate content based on these details, you can use the [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n) object instead." + "description": "The buyer's language, country, currency, and timezone context. For formatting and translation helpers, use the [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#properties-propertydetail-i18n) object instead." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -55544,21 +55544,21 @@ "syntaxKind": "PropertySignature", "name": "query", "value": ">(query: string, options?: { variables?: Variables; version?: StorefrontApiVersion; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>", - "description": "The method used to query the Storefront GraphQL API with a prefetched token.\n\nRefer to [Storefront API access examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/storefront-api) for more information." + "description": "The method used to query the Storefront GraphQL API with a prefetched token." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "selectedPaymentOptions", "value": "SubscribableSignalLike", - "description": "The payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card)." + "description": "The payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\n\nEach option exposes `handle` and `type` only. Provider names, logos, fees, and installment terms aren't available." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "sessionToken", "value": "SessionToken", - "description": "The session token providing a set of claims as a signed JSON Web Token (JWT).\n\nThe token has a TTL of five minutes.\n\nIf the previous token expires, this value reflects a new session token with a new signature and expiry.\n\nRefer to [session token examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/session-token) for more information." + "description": "The session token providing a set of claims as a signed JSON Web Token (JWT).\n\nThe token has a TTL of five minutes.\n\nIf the previous token expires, this value reflects a new session token with a new signature and expiry.\n\nLearn more about [session tokens](/docs/apps/build/authentication-authorization/session-tokens)." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -55580,14 +55580,14 @@ "syntaxKind": "PropertySignature", "name": "shop", "value": "Shop", - "description": "The shop where the checkout is taking place." + "description": "The store where the checkout is taking place, including the shop name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "storage", "value": "Storage", - "description": "The key-value storage for the extension.\n\nIt uses `localStorage` and should persist across the customer's current checkout session.\n\n> Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n\nData is shared across all activated extension targets of this extension. In versions 2023-07 and earlier, each activated extension target had its own storage." + "description": "Key-value storage that persists across page loads within the current checkout session. Data is shared across all activated targets associated with this extension.\n\n> Caution: Data persistence isn't guaranteed and storage is cleared when the buyer starts a new checkout." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -55609,29 +55609,29 @@ ] } ], - "value": "export interface StandardApi {\n /**\n * The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event.\n */\n analytics: Analytics;\n\n /**\n * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\n */\n appliedGiftCards: SubscribableSignalLike;\n\n /**\n * The cart instructions used to create the checkout and possibly limit extension capabilities.\n *\n * These instructions should be checked before performing any actions that might be affected by them.\n *\n * For example, if you intend to add a discount code via the `applyDiscountCodeChange` method,\n * check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n *\n * > Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs aren't available.\n * See the [update guide](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples) for more information.\n *\n */\n instructions: SubscribableSignalLike;\n\n /**\n * The metafields requested in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration)\n * file. These metafields are updated when there's a change in the merchandise items\n * being purchased by the customer.\n *\n * App owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` isn't supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n appMetafields: SubscribableSignalLike;\n\n /**\n * The custom key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n buyerIdentity?: BuyerIdentity;\n\n /**\n * Provides details on the buyer's progression through the checkout and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/buyer-journey#examples)\n * examples for more information.\n */\n buyerJourney: BuyerJourney;\n\n /**\n * Settings applied to the buyer's checkout.\n */\n checkoutSettings: SubscribableSignalLike;\n\n /**\n * A stable ID that represents the current checkout.\n *\n * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\n *\n * This matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data)\n * and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n */\n checkoutToken: SubscribableSignalLike;\n\n /**\n * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * The meta information about the extension.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n *\n * @deprecated Deprecated as of version `2023-07`, use `extension.target` instead.\n */\n extensionPoint: Target;\n\n /**\n * Utilities for translating content and formatting values according to the current\n * [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization)\n * of the checkout.\n *\n * Refer to [`localization` examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples)\n * for more information.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The details about the location, language, and currency of the customer. For utilities to easily\n * format and translate content based on these details, you can use the\n * [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n)\n * object instead.\n */\n localization: Localization;\n\n /**\n * The metafields that apply to the current checkout.\n *\n * Metafields are stored locally on the client and are applied to the order object after the checkout completes.\n *\n * These metafields are shared by all extensions running on checkout, and\n * persist for as long as the customer is working on this checkout.\n *\n * Once the order is created, you can query these metafields using the\n * [GraphQL Admin API](/docs/admin-api/graphql/reference/orders/order#metafield-2021-01)\n *\n * > Caution:\n * `metafields` is deprecated. Use `appMetafields` with cart metafields instead.\n *\n * @deprecated Use `appMetafields` with cart metafields instead.\n */\n metafields: SubscribableSignalLike;\n\n /**\n * A note left by the customer to the merchant, either in their cart or during checkout.\n *\n * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\n */\n note: SubscribableSignalLike;\n\n /**\n * The method used to query the Storefront GraphQL API with a prefetched token.\n *\n * Refer to [Storefront API access examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/storefront-api) for more information.\n */\n query: >(\n query: string,\n options?: {variables?: Variables; version?: StorefrontApiVersion},\n ) => Promise<{data?: Data; errors?: GraphQLError[]}>;\n\n /**\n * The payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\n */\n selectedPaymentOptions: SubscribableSignalLike;\n\n /**\n * The session token providing a set of claims as a signed JSON Web Token (JWT).\n *\n * The token has a TTL of five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/session-token) for more information.\n */\n sessionToken: SessionToken;\n\n /**\n * The settings matching the settings definition written in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates in real time as a merchant fills in the settings.\n */\n settings: SubscribableSignalLike;\n\n /**\n * The proposed customer shipping address. During the information step, the address\n * updates when the field is committed (on change) rather than every keystroke.\n * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n shippingAddress?: SubscribableSignalLike;\n\n /**\n * The proposed customer billing address. The address updates when the field is\n * committed (on change) rather than every keystroke. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided yet.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n billingAddress?: SubscribableSignalLike;\n\n /** The shop where the checkout is taking place. */\n shop: Shop;\n\n /**\n * The key-value storage for the extension.\n *\n * It uses `localStorage` and should persist across the customer's current checkout session.\n *\n * > Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n *\n * Data is shared across all activated extension targets of this extension. In versions 2023-07 and earlier,\n * each activated extension target had its own storage.\n */\n storage: Storage;\n\n /**\n * The renderer version being used for the extension.\n *\n * @example '2025-10'\n */\n version: Version;\n\n /**\n * Customer privacy consent settings and a flag denoting if consent has previously been collected.\n */\n customerPrivacy: SubscribableSignalLike;\n\n /**\n * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent) to be set to `true`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyTrackingConsentChange: ApplyTrackingConsentChangeType;\n\n /**\n * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" + "value": "export interface StandardApi {\n /**\n * Tracks custom events and sends visitor information to\n * [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events\n * and `visitor()` to submit buyer contact details.\n */\n analytics: Analytics;\n\n /**\n * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\n */\n appliedGiftCards: SubscribableSignalLike;\n\n /**\n * The cart instructions used to create the checkout and possibly limit extension capabilities.\n *\n * These instructions should be checked before performing any actions that might be affected by them.\n *\n * For example, if you intend to add a discount code via the `applyDiscountCodeChange` method,\n * check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n *\n * > Caution: Check cart instructions before calling select APIs, as\n * > some may not be available. See the\n * > [Cart Instructions API](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples)\n * > for more information.\n *\n */\n instructions: SubscribableSignalLike;\n\n /**\n * The metafields requested in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration)\n * file. These metafields are updated when there's a change in the merchandise items\n * being purchased by the customer.\n *\n * App owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` isn't supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n appMetafields: SubscribableSignalLike;\n\n /**\n * The custom key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as\n * credit cards, wallets, and local payment methods. The list depends on\n * the shop's payment configuration and the buyer's region.\n *\n * The set of payment options can change when the buyer updates their\n * address or cart, so subscribe to changes rather than reading once\n * during initialization. Each option exposes `handle` and `type` only.\n * Provider names, logos, fees, and installment terms aren't available.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n buyerIdentity?: BuyerIdentity;\n\n /**\n * Provides details on the buyer's progression through the checkout and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/buyer-journey#examples)\n * examples for more information.\n */\n buyerJourney: BuyerJourney;\n\n /**\n * Settings applied to the buyer's checkout.\n */\n checkoutSettings: SubscribableSignalLike;\n\n /**\n * A stable ID that represents the current checkout.\n *\n * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\n *\n * This matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data)\n * and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n *\n * Can be `undefined`. Handle the `undefined` state before using the value.\n */\n checkoutToken: SubscribableSignalLike;\n\n /**\n * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n *\n * Empty until the buyer enters enough address information for Shopify to\n * calculate shipping rates.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * Metadata about the running extension, including the current target, API version,\n * capabilities, and editor context. Use this to conditionally render content\n * based on where the extension is running.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n *\n * @deprecated Use `extension.target` instead.\n */\n extensionPoint: Target;\n\n /**\n * Utilities for translating strings, formatting currencies, numbers, and dates\n * according to the buyer's locale. Use alongside\n * [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization)\n * to build fully localized extensions.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The buyer's language, country, currency, and timezone context. For\n * formatting and translation helpers, use the\n * [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#properties-propertydetail-i18n)\n * object instead.\n */\n localization: Localization;\n\n /**\n * The metafields that apply to the current checkout.\n *\n * Metafields are stored locally on the client and are applied to the order object after the checkout completes.\n *\n * These metafields are shared by all extensions running on checkout, and\n * persist for as long as the customer is working on this checkout.\n *\n * Once the order is created, you can query these metafields using the\n * [GraphQL Admin API](/docs/admin-api/graphql/reference/orders/order#metafield-2021-01)\n *\n * > Caution:\n * `metafields` is deprecated. Use `appMetafields` with cart metafields instead.\n *\n * @deprecated Use `appMetafields` with cart metafields instead.\n */\n metafields: SubscribableSignalLike;\n\n /**\n * A note left by the customer to the merchant, either in their cart or during checkout.\n *\n * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\n */\n note: SubscribableSignalLike;\n\n /**\n * The method used to query the Storefront GraphQL API with a prefetched token.\n *\n */\n query: >(\n query: string,\n options?: {variables?: Variables; version?: StorefrontApiVersion},\n ) => Promise<{data?: Data; errors?: GraphQLError[]}>;\n\n /**\n * The payment options the buyer has currently selected. This updates as\n * the buyer changes their payment method. The array can contain multiple\n * entries when the buyer splits payment across methods (for example, a\n * gift card and a credit card).\n *\n * Each option exposes `handle` and `type` only. Provider names, logos,\n * fees, and installment terms aren't available.\n */\n selectedPaymentOptions: SubscribableSignalLike;\n\n /**\n * The session token providing a set of claims as a signed JSON Web Token (JWT).\n *\n * The token has a TTL of five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Learn more about [session tokens](/docs/apps/build/authentication-authorization/session-tokens).\n */\n sessionToken: SessionToken;\n\n /**\n * The settings matching the settings definition written in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates in real time as a merchant fills in the settings.\n */\n settings: SubscribableSignalLike;\n\n /**\n * The proposed customer shipping address. During the information step, the address\n * updates when the field is committed (on change) rather than every keystroke.\n * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n shippingAddress?: SubscribableSignalLike;\n\n /**\n * The proposed customer billing address. The address updates when the field is\n * committed (on change) rather than every keystroke. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided yet.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n billingAddress?: SubscribableSignalLike;\n\n /**\n * The store where the checkout is taking place, including the shop name,\n * storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.\n */\n shop: Shop;\n\n /**\n * Key-value storage that persists across page loads within the current checkout\n * session. Data is shared across all activated targets associated with\n * this extension.\n *\n * > Caution: Data persistence isn't guaranteed and storage is cleared when the\n * buyer starts a new checkout.\n */\n storage: Storage;\n\n /**\n * The renderer version being used for the extension.\n *\n * @example '2025-10'\n */\n version: Version;\n\n /**\n * Customer privacy consent settings and a flag denoting if consent has previously been collected.\n */\n customerPrivacy: SubscribableSignalLike;\n\n /**\n * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`collect_buyer_consent` capability](/docs/apps/build/customer-accounts/capabilities#collect-buyer-consent) to be set to `true`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyTrackingConsentChange: ApplyTrackingConsentChangeType;\n\n /**\n * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" }, "Analytics": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Analytics", - "description": "", + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "publish", "value": "(name: string, data: Record) => Promise", - "description": "Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing)." + "description": "Publishes a custom event to [Web Pixels](/docs/apps/marketing). Returns `true` when the event is successfully dispatched.\n\nThe Promise resolves to `true` when the event was dispatched. The boolean indicates dispatch confirmation only. It doesn't indicate whether any specific web pixel processed the event." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "visitor", "value": "(data: { email?: string; phone?: string; }) => Promise", - "description": "A method for capturing details about a visitor on the online store." + "description": "Submits buyer contact details for attribution and analytics purposes." } ], - "value": "export interface Analytics {\n /**\n * Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing).\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * A method for capturing details about a visitor on the online store.\n */\n visitor(data: {email?: string; phone?: string}): Promise;\n}" + "value": "export interface Analytics {\n /**\n * Publishes a custom event to [Web Pixels](/docs/apps/marketing).\n * Returns `true` when the event is successfully dispatched.\n *\n * The Promise resolves to `true` when the event was dispatched. The boolean\n * indicates dispatch confirmation only. It doesn't indicate whether any\n * specific web pixel processed the event.\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * Submits buyer contact details for attribution and analytics purposes.\n */\n visitor(data: {email?: string; phone?: string}): Promise;\n}" }, "VisitorResult": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -55672,10 +55672,10 @@ "syntaxKind": "PropertySignature", "name": "type", "value": "'error'", - "description": "Indicates that the visitor information is invalid and wasn't submitted. Examples are using the wrong data type or missing a required property." + "description": "Indicates that the visitor information is invalid and wasn't submitted. Common causes include using the wrong data type or omitting a required property." } ], - "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Examples are using the wrong data type or missing a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Common causes include using the wrong data type or omitting a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" }, "SubscribableSignalLike": { "filePath": "src/surfaces/checkout/shared.ts", @@ -55889,10 +55889,10 @@ "syntaxKind": "PropertySignature", "name": "value", "value": "string | null", - "description": "The new value to store in the metafield. Set to `null` to delete the metafield." + "description": "The new value to store in the metafield. Set to `null` to delete the metafield.\n\nConsent metafield values are strings, not booleans. Pass `null` to delete a tracking consent metafield." } ], - "value": "export interface TrackingConsentMetafieldChange {\n /**\n * The identifier for the tracking consent metafield to update.\n */\n key: string;\n /**\n * The new value to store in the metafield. Set to `null` to delete the metafield.\n */\n value: string | null;\n}" + "value": "export interface TrackingConsentMetafieldChange {\n /**\n * The identifier for the tracking consent metafield to update.\n */\n key: string;\n /**\n * The new value to store in the metafield. Set to `null` to delete the metafield.\n *\n * Consent metafield values are strings, not booleans. Pass `null` to delete\n * a tracking consent metafield.\n */\n value: string | null;\n}" }, "VisitorConsent": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -56106,7 +56106,7 @@ "syntaxKind": "PropertySignature", "name": "value", "value": "string", - "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.", + "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.\n\nAttribute values are always strings. To store structured data, serialize it to JSON and parse it when reading.", "examples": [ { "title": "Example", @@ -56121,7 +56121,7 @@ ] } ], - "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" + "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * Attribute values are always strings. To store structured data, serialize\n * it to JSON and parse it when reading.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" }, "PaymentOption": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -56472,7 +56472,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A globally-unique identifier for the customer in the format `gid://shopify/Customer/`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", + "description": "An identifier for the customer in the format `gid://shopify/Customer/`. This value is unique per shop.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", "examples": [ { "title": "Example", @@ -56525,7 +56525,7 @@ "isPrivate": true } ], - "value": "export interface Customer {\n /**\n * A globally-unique identifier for the customer in the format `gid://shopify/Customer/`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'gid://shopify/Customer/123'\n */\n id: string;\n /**\n * The email address associated with the customer's account. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email?: string;\n /**\n * The phone number associated with the customer's account. The value is `undefined` if no phone number is on file or the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone?: string;\n /**\n * The customer's full name, typically a combination of first and last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n fullName?: string;\n /**\n * The customer's first name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n firstName?: string;\n /**\n * The customer's last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n lastName?: string;\n /**\n * The customer's profile image, such as a Gravatar avatar. Use this to personalize the extension UI for the logged-in buyer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n image: ImageDetails;\n /**\n * Whether the customer has opted in to receiving marketing communications from the merchant, such as email campaigns and promotional offers.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * > Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n *\n * @deprecated Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n */\n acceptsMarketing: boolean;\n /**\n * Whether the customer has opted in to email marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsEmailMarketing: boolean;\n /**\n * Whether the customer has opted in to SMS marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsSmsMarketing: boolean;\n /**\n * The store credit accounts owned by this customer that can be used as payment during checkout. Each account has a balance representing available store credit.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @private\n */\n storeCreditAccounts: StoreCreditAccount[];\n /**\n * The number of orders the customer has previously placed with this shop.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n ordersCount: number;\n}" + "value": "export interface Customer {\n /**\n * An identifier for the customer in the format `gid://shopify/Customer/`. This value is unique per shop.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'gid://shopify/Customer/123'\n */\n id: string;\n /**\n * The email address associated with the customer's account. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email?: string;\n /**\n * The phone number associated with the customer's account. The value is `undefined` if no phone number is on file or the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone?: string;\n /**\n * The customer's full name, typically a combination of first and last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n fullName?: string;\n /**\n * The customer's first name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n firstName?: string;\n /**\n * The customer's last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n lastName?: string;\n /**\n * The customer's profile image, such as a Gravatar avatar. Use this to personalize the extension UI for the logged-in buyer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n image: ImageDetails;\n /**\n * Whether the customer has opted in to receiving marketing communications from the merchant, such as email campaigns and promotional offers.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * > Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n *\n * @deprecated Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n */\n acceptsMarketing: boolean;\n /**\n * Whether the customer has opted in to email marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsEmailMarketing: boolean;\n /**\n * Whether the customer has opted in to SMS marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsSmsMarketing: boolean;\n /**\n * The store credit accounts owned by this customer that can be used as payment during checkout. Each account has a balance representing available store credit.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @private\n */\n storeCreditAccounts: StoreCreditAccount[];\n /**\n * The number of orders the customer has previously placed with this shop.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n ordersCount: number;\n}" }, "ImageDetails": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -56807,11 +56807,11 @@ "syntaxKind": "MethodSignature", "name": "perform", "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", + "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.\n\nRuns after all intercept results are collected. Use it for local state updates such as setting an error flag. By the time it runs, the navigation decision is final, so blocking logic belongs in the intercept handler itself, not here.", "isOptional": true } ], - "value": "interface InterceptorRequestAllow {\n /**\n * Indicates that the interceptor allows the buyer's journey to continue.\n */\n behavior: 'allow';\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" + "value": "interface InterceptorRequestAllow {\n /**\n * Indicates that the interceptor allows the buyer's journey to continue.\n */\n behavior: 'allow';\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n *\n * Runs after all intercept results are collected. Use it for local state\n * updates such as setting an error flag. By the time it runs, the navigation\n * decision is final, so blocking logic belongs in the intercept handler\n * itself, not here.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" }, "InterceptorResult": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -56875,7 +56875,7 @@ "syntaxKind": "MethodSignature", "name": "perform", "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", + "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.\n\nRuns after all intercept results are collected. Use it for local state updates such as setting an error flag. By the time it runs, the navigation decision is final, so blocking logic belongs in the intercept handler itself, not here.", "isOptional": true }, { @@ -56886,7 +56886,7 @@ "description": "The reason for blocking the interceptor request. This value isn't presented to the buyer, so it doesn't need to be localized. The value is used only for Shopify's own internal debugging and metrics." } ], - "value": "interface InterceptorRequestBlock {\n /**\n * Indicates that the interceptor blocks the buyer's journey from continuing.\n */\n behavior: 'block';\n\n /**\n * The reason for blocking the interceptor request. This value isn't presented to\n * the buyer, so it doesn't need to be localized. The value is used only for Shopify's\n * own internal debugging and metrics.\n */\n reason: string;\n\n /**\n * Used to pass errors to the checkout UI, outside your extension's UI boundaries.\n */\n errors?: ValidationError[];\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" + "value": "interface InterceptorRequestBlock {\n /**\n * Indicates that the interceptor blocks the buyer's journey from continuing.\n */\n behavior: 'block';\n\n /**\n * The reason for blocking the interceptor request. This value isn't presented to\n * the buyer, so it doesn't need to be localized. The value is used only for Shopify's\n * own internal debugging and metrics.\n */\n reason: string;\n\n /**\n * Used to pass errors to the checkout UI, outside your extension's UI boundaries.\n */\n errors?: ValidationError[];\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n *\n * Runs after all intercept results are collected. Use it for local state\n * updates such as setting an error flag. By the time it runs, the navigation\n * decision is final, so blocking logic belongs in the intercept handler\n * itself, not here.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" }, "ValidationError": { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -57107,17 +57107,17 @@ "syntaxKind": "PropertySignature", "name": "totalShippingAmount", "value": "SubscribableSignalLike", - "description": "The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step." + "description": "The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step.\n\n`undefined` until the buyer selects a shipping method (typically after the information step)." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "totalTaxAmount", "value": "SubscribableSignalLike", - "description": "The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet." + "description": "The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet.\n\n`undefined` when taxes haven't been calculated or aren't available for the buyer's region." } ], - "value": "export interface CartCost {\n /**\n * The sum of all line item prices at the current step of checkout, before shipping and taxes are applied. Use this value to display the base cost of the items the buyer purchased.\n */\n subtotalAmount: SubscribableSignalLike;\n\n /**\n * The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step.\n */\n totalShippingAmount: SubscribableSignalLike;\n\n /**\n * The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet.\n */\n totalTaxAmount: SubscribableSignalLike;\n\n /**\n * The minimum total at the current step of checkout. Costs not yet calculated, such as shipping on the information step, aren't included. Gift cards and store credits are excluded from this total.\n */\n totalAmount: SubscribableSignalLike;\n}" + "value": "export interface CartCost {\n /**\n * The sum of all line item prices at the current step of checkout, before shipping and taxes are applied. Use this value to display the base cost of the items the buyer purchased.\n */\n subtotalAmount: SubscribableSignalLike;\n\n /**\n * The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step.\n *\n * `undefined` until the buyer selects a shipping method (typically after the\n * information step).\n */\n totalShippingAmount: SubscribableSignalLike;\n\n /**\n * The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet.\n *\n * `undefined` when taxes haven't been calculated or aren't available for the\n * buyer's region.\n */\n totalTaxAmount: SubscribableSignalLike;\n\n /**\n * The minimum total at the current step of checkout. Costs not yet calculated, such as shipping on the information step, aren't included. Gift cards and store credits are excluded from this total.\n */\n totalAmount: SubscribableSignalLike;\n}" }, "CustomerPrivacy": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -57204,31 +57204,31 @@ "syntaxKind": "PropertySignature", "name": "analytics", "value": "boolean", - "description": "Whether analytics data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Analytics data includes how the shop was used and what interactions occurred." + "description": "Whether analytics data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Analytics data includes how the shop was used and what interactions occurred.\n\nWhether analytics data can be collected right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.analytics`, before calling `shopify.analytics.publish()`." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "marketing", "value": "boolean", - "description": "Whether marketing data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Marketing data includes attribution and targeted advertising preferences." + "description": "Whether marketing data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Marketing data includes attribution and targeted advertising preferences.\n\nWhether marketing data can be collected right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.marketing`, before performing marketing-related data collection." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "preferences", "value": "boolean", - "description": "Whether preference data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Preference data includes language, currency, and sizing choices." + "description": "Whether preference data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Preference data includes language, currency, and sizing choices.\n\nWhether preference data can be collected right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.preferences`, before storing or reading buyer preference data." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "saleOfData", "value": "boolean", - "description": "Whether data can be shared with third parties based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. This typically applies to behavioral advertising data." + "description": "Whether data can be shared with third parties based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. This typically applies to behavioral advertising data.\n\nWhether buyer data can be shared with or sold to third parties right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.saleOfData`, before sharing or selling buyer data with third parties." } ], - "value": "export interface AllowedProcessing {\n /**\n * Whether analytics data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Analytics\n * data includes how the shop was used and what interactions occurred.\n */\n analytics: boolean;\n /**\n * Whether marketing data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Marketing\n * data includes attribution and targeted advertising preferences.\n */\n marketing: boolean;\n /**\n * Whether preference data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Preference\n * data includes language, currency, and sizing choices.\n */\n preferences: boolean;\n /**\n * Whether data can be shared with third parties based on the visitor's\n * consent, the merchant's privacy configuration, and the visitor's region.\n * This typically applies to behavioral advertising data.\n */\n saleOfData: boolean;\n}" + "value": "export interface AllowedProcessing {\n /**\n * Whether analytics data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Analytics\n * data includes how the shop was used and what interactions occurred.\n *\n * Whether analytics data can be collected right now. Combines the buyer's\n * consent, the merchant's privacy configuration, and the buyer's region into\n * a single boolean. Check this flag, not `visitorConsent.analytics`, before\n * calling `shopify.analytics.publish()`.\n */\n analytics: boolean;\n /**\n * Whether marketing data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Marketing\n * data includes attribution and targeted advertising preferences.\n *\n * Whether marketing data can be collected right now. Combines the buyer's\n * consent, the merchant's privacy configuration, and the buyer's region into\n * a single boolean. Check this flag, not `visitorConsent.marketing`, before\n * performing marketing-related data collection.\n */\n marketing: boolean;\n /**\n * Whether preference data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Preference\n * data includes language, currency, and sizing choices.\n *\n * Whether preference data can be collected right now. Combines the buyer's\n * consent, the merchant's privacy configuration, and the buyer's region into\n * a single boolean. Check this flag, not `visitorConsent.preferences`,\n * before storing or reading buyer preference data.\n */\n preferences: boolean;\n /**\n * Whether data can be shared with third parties based on the visitor's\n * consent, the merchant's privacy configuration, and the visitor's region.\n * This typically applies to behavioral advertising data.\n *\n * Whether buyer data can be shared with or sold to third parties right now.\n * Combines the buyer's consent, the merchant's privacy configuration, and\n * the buyer's region into a single boolean. Check this flag, not\n * `visitorConsent.saleOfData`, before sharing or selling buyer data with\n * third parties.\n */\n saleOfData: boolean;\n}" }, "TrackingConsentMetafield": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -57920,7 +57920,7 @@ "Extension": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Extension", - "description": "The meta information about an extension target.", + "description": "Metadata about the running extension, including its API version, target, capabilities, and editor context. Use this to read configuration details or conditionally render content based on where the extension is running.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -57946,7 +57946,7 @@ "syntaxKind": "PropertySignature", "name": "capabilities", "value": "SubscribableSignalLike", - "description": "The allowed capabilities of the extension, defined in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n\n* [`api_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#api-access): the extension can access the Storefront API.\n\n* [`network_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access): the extension can make external network calls.\n\n* [`block_progress`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n\n* [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n\n* [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can register customer consent decisions that are honored on Shopify-managed services.\n\n* [`iframe.sources`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#iframe): the extension can embed an external URL in an iframe." + "description": "The allowed capabilities of the extension, defined in your [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -57994,7 +57994,7 @@ "syntaxKind": "PropertySignature", "name": "version", "value": "string", - "description": "The published version of the running extension target.\n\nFor unpublished extensions, the value is `undefined`.", + "description": "The published version of the running extension target.\n\nFor unpublished extensions, the value is `undefined`.\n\nDon't use this property as a stable identifier in development environments. It becomes available only after the extension is published.", "isOptional": true, "examples": [ { @@ -58010,7 +58010,7 @@ ] } ], - "value": "export interface Extension {\n /**\n * The API version that was set in the extension config file.\n *\n * @example '2024-10', '2025-01', '2025-04', '2025-07', '2025-10'\n */\n apiVersion: ApiVersion;\n\n /**\n * The allowed capabilities of the extension, defined\n * in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n *\n * * [`api_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#api-access): the extension can access the Storefront API.\n *\n * * [`network_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access): the extension can make external network calls.\n *\n * * [`block_progress`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n *\n * * [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n *\n * * [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can register customer consent decisions that are honored on Shopify-managed services.\n *\n * * [`iframe.sources`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#iframe): the extension can embed an external URL in an iframe.\n */\n capabilities: SubscribableSignalLike;\n\n /**\n * Information about the editor where the extension is being rendered.\n *\n * If the value is undefined, then the extension isn't running in an editor.\n */\n editor?: Editor;\n\n /**\n * A Boolean to show whether your extension is currently rendered to the screen.\n *\n * Shopify might render your extension before it's visible in the UI,\n * typically to pre-render extensions that appear on a later step of the\n * checkout.\n *\n * Your extension might also continue to run after the customer has navigated away\n * from where it was rendered. The extension continues running so that\n * your extension is immediately available to render if the customer navigates back.\n */\n rendered: SubscribableSignalLike;\n\n /**\n * The URL to the script that started the extension target.\n */\n scriptUrl: string;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n */\n target: Target;\n\n /**\n * The published version of the running extension target.\n *\n * For unpublished extensions, the value is `undefined`.\n *\n * @example 3.0.10\n */\n version?: string;\n}" + "value": "export interface Extension {\n /**\n * The API version that was set in the extension config file.\n *\n * @example '2024-10', '2025-01', '2025-04', '2025-07', '2025-10'\n */\n apiVersion: ApiVersion;\n\n /**\n * The allowed capabilities of the extension, defined in your\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n */\n capabilities: SubscribableSignalLike;\n\n /**\n * Information about the editor where the extension is being rendered.\n *\n * If the value is undefined, then the extension isn't running in an editor.\n */\n editor?: Editor;\n\n /**\n * A Boolean to show whether your extension is currently rendered to the screen.\n *\n * Shopify might render your extension before it's visible in the UI,\n * typically to pre-render extensions that appear on a later step of the\n * checkout.\n *\n * Your extension might also continue to run after the customer has navigated away\n * from where it was rendered. The extension continues running so that\n * your extension is immediately available to render if the customer navigates back.\n */\n rendered: SubscribableSignalLike;\n\n /**\n * The URL to the script that started the extension target.\n */\n scriptUrl: string;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n */\n target: Target;\n\n /**\n * The published version of the running extension target.\n *\n * For unpublished extensions, the value is `undefined`.\n *\n * Don't use this property as a stable identifier in development environments.\n * It becomes available only after the extension is published.\n *\n * @example 3.0.10\n */\n version?: string;\n}" }, "ApiVersion": { "filePath": "src/shared.ts", @@ -58029,7 +58029,7 @@ "Editor": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Editor", - "description": "", + "description": "Information about the editor environment when an extension is rendered inside the checkout editor. The value is `undefined` when the extension is not rendering in an editor.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -58044,7 +58044,7 @@ "I18n": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18n", - "description": "", + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use the I18n API alongside the Localization API to build fully localized extensions.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -58080,7 +58080,7 @@ "I18nTranslate": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18nTranslate", - "description": "This returns a translated string matching a key in a locale file.", + "description": "Translates a key from your extension's locale files into a localized string. Supports interpolation with placeholder replacements and pluralization via the special `count` option.", "members": [], "value": "export interface I18nTranslate {\n (\n key: string,\n options?: Record,\n ): ReplacementType extends string | number\n ? string\n : (string | ReplacementType)[];\n}" }, @@ -58644,14 +58644,14 @@ "Localization": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Localization", - "description": "", + "description": "The buyer's language, country, currency, and timezone context. Use this to adapt your extension to the buyer's region and display localized content.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "country", "value": "SubscribableSignalLike", - "description": "The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown." + "description": "The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n\nDerived from the buyer's shipping address. Returns `undefined` until the buyer enters a shipping address." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -58679,18 +58679,18 @@ "syntaxKind": "PropertySignature", "name": "market", "value": "SubscribableSignalLike", - "description": "The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n\n> Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.", - "deprecationMessage": "Deprecated as of version `2025-04`" + "description": "The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. The market context updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.", + "deprecationMessage": "Merchants now manage which extensions load for each\nmarket, so extensions no longer need to check this value." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "timezone", "value": "SubscribableSignalLike", - "description": "The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time." + "description": "The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time." } ], - "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n *\n * > Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" + "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n *\n * Derived from the buyer's shipping address. Returns `undefined` until the\n * buyer enters a shipping address.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout,\n * carried over from the cart context. Markets group countries and\n * regions with shared pricing, languages, and domains. The market\n * context updates when the buyer changes the country of their\n * shipping address. The value is `undefined` if the market is unknown.\n *\n * @deprecated Merchants now manage which extensions load for each\n * market, so extensions no longer need to check this value.\n */\n market: SubscribableSignalLike;\n}" }, "Country": { "filePath": "src/shared.ts", @@ -58891,7 +58891,7 @@ "SessionToken": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SessionToken", - "description": "", + "description": "Authenticates requests between your extension and your app backend. Use session tokens to verify the identity of the buyer and the shop context when making server-side API calls. The token is a signed JWT that contains claims such as the customer ID, shop domain, and expiration.\n\nThe `sub` claim in the decoded token is present only when the buyer is logged in and the app has permission to read customer accounts. Absent for anonymous buyers.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -59150,7 +59150,7 @@ "Shop": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Shop", - "description": "", + "description": "Metadata about the merchant's store, including its name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -59190,30 +59190,30 @@ "syntaxKind": "PropertySignature", "name": "storefrontUrl", "value": "string", - "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n\n> Caution: > As of version `2024-04` this value no longer has a trailing slash.", + "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.", "isOptional": true } ], - "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n *\n * > Caution:\n * > As of version `2024-04` this value no longer has a trailing slash.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom domain.\n */\n myshopifyDomain: string;\n}" + "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom domain.\n */\n myshopifyDomain: string;\n}" }, "Storage": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Storage", - "description": "A key-value storage object for the extension.\n\nStored data is available only to this specific extension and any of its instances.\n\nThe storage backend is implemented with `localStorage` and should persist across the buyer's checkout session. However, data persistence isn't guaranteed.", + "description": "Key-value storage for a specific extension. Use storage to save preferences or cached data that should survive page reloads without requiring a backend call. Stored data is only available to this specific extension. The storage backend is implemented with `localStorage` and data persistence isn't guaranteed.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "delete", "value": "(key: string) => Promise", - "description": "Delete stored data by key." + "description": "Deletes a previously stored value by key." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "read", "value": "(key: string) => Promise", - "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original primitive.\n\nReturns `null` if no stored data exists." + "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original type.\n\nReturns the stored value for the given key, or `null` when no value exists. Doesn't throw on a missing key." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -59223,7 +59223,7 @@ "description": "Write stored data for this key.\n\nThe data must be serializable to JSON." } ], - "value": "export interface Storage {\n /**\n * Read and return a stored value by key.\n *\n * The stored data is deserialized from JSON and returned as\n * its original primitive.\n *\n * Returns `null` if no stored data exists.\n */\n read(key: string): Promise;\n\n /**\n * Write stored data for this key.\n *\n * The data must be serializable to JSON.\n */\n write(key: string, data: any): Promise;\n\n /**\n * Delete stored data by key.\n */\n delete(key: string): Promise;\n}" + "value": "export interface Storage {\n /**\n * Read and return a stored value by key.\n *\n * The stored data is deserialized from JSON and returned as\n * its original type.\n *\n * Returns the stored value for the given key, or `null` when no value\n * exists. Doesn't throw on a missing key.\n */\n read(key: string): Promise;\n\n /**\n * Write stored data for this key.\n *\n * The data must be serializable to JSON.\n */\n write(key: string, data: any): Promise;\n\n /**\n * Deletes a previously stored value by key.\n */\n delete(key: string): Promise;\n}" }, "Version": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -59299,7 +59299,7 @@ "syntaxKind": "MethodSignature", "name": "applyAttributeChange", "value": "(change: AttributeChange) => Promise", - "description": "Updates or removes an attribute on the cart and checkout. On success, the [`attributes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/attributes#standardapi-propertydetail-attributes) property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.", + "description": "Updates or removes an attribute on the cart and checkout. On success, the [`attributes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/attributes#properties-propertydetail-attributes) property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.", "deprecationMessage": "Use cart metafields instead." }, { @@ -59307,42 +59307,42 @@ "syntaxKind": "MethodSignature", "name": "applyCartLinesChange", "value": "(change: CartLineChange) => Promise", - "description": "Adds, removes, or updates line items in the cart. The returned promise resolves when the change has been applied by the server, and the [`lines`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-lines#standardapi-propertydetail-lines) property updates with the new state.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Adds, removes, or updates line items in the cart. The returned promise resolves when the change has been applied by the server, and the [`lines`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-lines#properties-propertydetail-lines) property updates with the new state.\n\nAccepts a single change per call. To make multiple changes, call this method separately for each one.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyDiscountCodeChange", "value": "(change: DiscountCodeChange) => Promise", - "description": "Adds or removes a discount code on the checkout. The returned promise resolves when the change has been applied by the server, and the [`discountCodes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/discounts#standardapi-propertydetail-discountcodes) property updates with the new state.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves discount codes through a network call.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Adds or removes a discount code on the checkout. The returned promise resolves when the change has been applied by the server, and the [`discountCodes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/discounts#properties-propertydetail-discountcodes) property updates with the new state.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves discount codes through a network call.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyGiftCardChange", "value": "(change: GiftCardChange) => Promise", - "description": "Adds or removes a gift card from the checkout. The returned promise resolves when the change has been applied by the server, and the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/gift-cards#standardapi-propertydetail-appliedgiftcards) property updates with the new state.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves gift card codes through a network call.\n\n> Note: This method returns an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Adds or removes a gift card from the checkout. The returned promise resolves when the change has been applied by the server, and the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/gift-cards#properties-propertydetail-appliedgiftcards) property updates with the new state.\n\nUnlike other write operations, gift card changes aren't gated by a cart instruction flag.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves gift card codes through a network call.\n\n> Note: This method returns an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyMetafieldChange", "value": "(change: MetafieldChange) => Promise", - "description": "Creates, updates, or removes a cart metafield on the checkout. On success, the [`metafields`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/metafields#standardapi-propertydetail-metafields) property updates to reflect the change.\n\nCart metafields are copied to order metafields at order creation time if there's a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n\n> Caution: `MetafieldRemoveChange` and `MetafieldUpdateChange` are deprecated. Use cart metafields with `MetafieldRemoveCartChange` and `MetafieldUpdateCartChange` instead. If `MetafieldUpdateChange` writes a metafield with the same namespace and key as a cart metafield that's configured to copy, the cart metafield won't be copied.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Creates, updates, or removes a cart metafield on the checkout. On success, the [`metafields`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/metafields#properties-propertydetail-metafields) property updates to reflect the change.\n\nCart metafields are copied to order metafields at order creation time if there's a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n\n> Caution: `MetafieldRemoveChange` and `MetafieldUpdateChange` are deprecated. Use cart metafields with `MetafieldRemoveCartChange` and `MetafieldUpdateCartChange` instead. If `MetafieldUpdateChange` writes a metafield with the same namespace and key as a cart metafield that's configured to copy, the cart metafield won't be copied.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyNoteChange", "value": "(change: NoteChange) => Promise", - "description": "Sets or removes the buyer's note on the checkout. On success, the [`note`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/note#standardapi-propertydetail-note) property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Sets or removes the buyer's note on the checkout. On success, the [`note`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/note#properties-propertydetail-note) property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyShippingAddressChange", "value": "(change: ShippingAddressUpdateChange) => Promise", - "description": "Updates the buyer's shipping address on the checkout. The provided fields are merged into the existing address without prompting the buyer. On success, the `shippingAddress` property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", + "description": "Updates the buyer's shipping address on the checkout. The provided fields are merged into the existing address without prompting the buyer. On success, the `shippingAddress` property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", "isOptional": true }, { @@ -59355,7 +59355,7 @@ "isPrivate": true } ], - "value": "export interface CheckoutApi {\n /**\n * Updates or removes an attribute on the cart and checkout. On success, the\n * [`attributes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/attributes#standardapi-propertydetail-attributes) property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * @deprecated Use cart metafields instead.\n */\n applyAttributeChange(change: AttributeChange): Promise;\n\n /**\n * Adds, removes, or updates line items in the cart. The returned promise resolves when the change has been applied by the server, and the [`lines`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-lines#standardapi-propertydetail-lines) property updates with the new state.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyCartLinesChange(change: CartLineChange): Promise;\n\n /**\n * Adds or removes a discount code on the checkout. The returned promise resolves when the change has been applied by the server, and the [`discountCodes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/discounts#standardapi-propertydetail-discountcodes) property updates with the new state.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves discount codes through a network call.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyDiscountCodeChange(\n change: DiscountCodeChange,\n ): Promise;\n\n /**\n * Adds or removes a gift card from the checkout. The returned promise resolves when the change has been applied by the server, and the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/gift-cards#standardapi-propertydetail-appliedgiftcards) property updates with the new state.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves gift card codes through a network call.\n *\n * > Note: This method returns an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyGiftCardChange(change: GiftCardChange): Promise;\n\n /**\n * Creates, updates, or removes a cart metafield on the checkout. On success, the\n * [`metafields`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/metafields#standardapi-propertydetail-metafields) property updates to reflect the change.\n *\n * Cart metafields are copied to order metafields at order creation time if there's a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n *\n * > Caution: `MetafieldRemoveChange` and `MetafieldUpdateChange` are deprecated. Use cart metafields with `MetafieldRemoveCartChange` and `MetafieldUpdateCartChange` instead. If `MetafieldUpdateChange` writes a metafield with the same namespace and key as a cart metafield that's configured to copy, the cart metafield won't be copied.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyMetafieldChange(change: MetafieldChange): Promise;\n\n /**\n * Sets or removes the buyer's note on the checkout. On success, the\n * [`note`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/note#standardapi-propertydetail-note)\n * property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyNoteChange(change: NoteChange): Promise;\n\n /**\n * @private\n */\n experimentalIsShopAppStyle?: boolean;\n\n /**\n * Updates the buyer's shipping address on the checkout. The provided fields\n * are merged into the existing address without prompting the buyer. On success,\n * the `shippingAddress` property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyShippingAddressChange?(\n change: ShippingAddressChange,\n ): Promise;\n}" + "value": "export interface CheckoutApi {\n /**\n * Updates or removes an attribute on the cart and checkout. On success, the\n * [`attributes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/attributes#properties-propertydetail-attributes) property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * @deprecated Use cart metafields instead.\n */\n applyAttributeChange(change: AttributeChange): Promise;\n\n /**\n * Adds, removes, or updates line items in the cart. The returned promise resolves when the change has been applied by the server, and the [`lines`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-lines#properties-propertydetail-lines) property updates with the new state.\n *\n * Accepts a single change per call. To make multiple changes, call this\n * method separately for each one.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyCartLinesChange(change: CartLineChange): Promise;\n\n /**\n * Adds or removes a discount code on the checkout. The returned promise resolves when the change has been applied by the server, and the [`discountCodes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/discounts#properties-propertydetail-discountcodes) property updates with the new state.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves discount codes through a network call.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyDiscountCodeChange(\n change: DiscountCodeChange,\n ): Promise;\n\n /**\n * Adds or removes a gift card from the checkout. The returned promise resolves when the change has been applied by the server, and the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/gift-cards#properties-propertydetail-appliedgiftcards) property updates with the new state.\n *\n * Unlike other write operations, gift card changes aren't gated by a cart\n * instruction flag.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves gift card codes through a network call.\n *\n * > Note: This method returns an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyGiftCardChange(change: GiftCardChange): Promise;\n\n /**\n * Creates, updates, or removes a cart metafield on the checkout. On success, the\n * [`metafields`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/metafields#properties-propertydetail-metafields) property updates to reflect the change.\n *\n * Cart metafields are copied to order metafields at order creation time if there's a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n *\n * > Caution: `MetafieldRemoveChange` and `MetafieldUpdateChange` are deprecated. Use cart metafields with `MetafieldRemoveCartChange` and `MetafieldUpdateCartChange` instead. If `MetafieldUpdateChange` writes a metafield with the same namespace and key as a cart metafield that's configured to copy, the cart metafield won't be copied.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyMetafieldChange(change: MetafieldChange): Promise;\n\n /**\n * Sets or removes the buyer's note on the checkout. On success, the\n * [`note`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/note#properties-propertydetail-note)\n * property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyNoteChange(change: NoteChange): Promise;\n\n /**\n * @private\n */\n experimentalIsShopAppStyle?: boolean;\n\n /**\n * Updates the buyer's shipping address on the checkout. The provided fields\n * are merged into the existing address without prompting the buyer. On success,\n * the `shippingAddress` property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyShippingAddressChange?(\n change: ShippingAddressChange,\n ): Promise;\n}" }, "AttributeChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -59422,7 +59422,7 @@ "syntaxKind": "PropertySignature", "name": "value", "value": "string", - "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.", + "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.\n\nAttribute values are always strings. To store structured data, serialize it to JSON and parse it when reading.", "examples": [ { "title": "Example", @@ -59437,7 +59437,7 @@ ] } ], - "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" + "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * Attribute values are always strings. To store structured data, serialize\n * it to JSON and parse it when reading.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" }, "AttributeRemoveChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -60290,7 +60290,7 @@ "syntaxKind": "PropertySignature", "name": "message", "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer." + "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer.\n\nRender your own localized error text rather than displaying this message to the buyer." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -60300,7 +60300,7 @@ "description": "Indicates that the line item wasn't changed successfully. Refer to the `message` property for details about the error." } ], - "value": "export interface CartLineChangeResultError {\n /**\n * Indicates that the line item wasn't changed successfully. Refer to the `message` property for details about the error.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface CartLineChangeResultError {\n /**\n * Indicates that the line item wasn't changed successfully. Refer to the `message` property for details about the error.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n *\n * Render your own localized error text rather than displaying this message\n * to the buyer.\n */\n message: string;\n}" }, "DiscountCodeChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -60480,7 +60480,7 @@ "syntaxKind": "PropertySignature", "name": "message", "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer." + "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer.\n\nRender your own localized error text rather than displaying this message to the buyer." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -60490,7 +60490,7 @@ "description": "Indicates that the gift card change couldn't be applied. Check the `message` property for details." } ], - "value": "export interface GiftCardChangeResultError {\n /**\n * Indicates that the gift card change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface GiftCardChangeResultError {\n /**\n * Indicates that the gift card change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n *\n * Render your own localized error text rather than displaying this message\n * to the buyer.\n */\n message: string;\n}" }, "MetafieldChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -60751,7 +60751,7 @@ "syntaxKind": "PropertySignature", "name": "message", "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer." + "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer.\n\nRender your own localized error text rather than displaying this message to the buyer." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -60761,7 +60761,7 @@ "description": "Indicates that the metafield change couldn't be applied. Check the `message` property for details." } ], - "value": "export interface MetafieldChangeResultError {\n /**\n * Indicates that the metafield change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface MetafieldChangeResultError {\n /**\n * Indicates that the metafield change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n *\n * Render your own localized error text rather than displaying this message\n * to the buyer.\n */\n message: string;\n}" }, "NoteChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -60839,7 +60839,7 @@ "syntaxKind": "PropertySignature", "name": "message", "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer." + "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer.\n\nRender your own localized error text rather than displaying this message to the buyer." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -60849,7 +60849,7 @@ "description": "Indicates that the note change couldn't be applied. Check the `message` property for details." } ], - "value": "export interface NoteChangeResultError {\n /**\n * Indicates that the note change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface NoteChangeResultError {\n /**\n * Indicates that the note change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n *\n * Render your own localized error text rather than displaying this message\n * to the buyer.\n */\n message: string;\n}" }, "ShippingAddressUpdateChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -61435,7 +61435,7 @@ "syntaxKind": "PropertySignature", "name": "analytics", "value": "Analytics", - "description": "The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event." + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -61449,7 +61449,7 @@ "syntaxKind": "PropertySignature", "name": "applyTrackingConsentChange", "value": "ApplyTrackingConsentChangeType", - "description": "Enables setting and updating customer privacy consent settings and tracking consent metafields.\n\n> Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent) to be set to `true`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." + "description": "Enables setting and updating customer privacy consent settings and tracking consent metafields.\n\n> Note: Requires the [`collect_buyer_consent` capability](/docs/apps/build/customer-accounts/capabilities#collect-buyer-consent) to be set to `true`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -61470,7 +61470,7 @@ "syntaxKind": "PropertySignature", "name": "availablePaymentOptions", "value": "SubscribableSignalLike", - "description": "All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region." + "description": "All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n\nThe set of payment options can change when the buyer updates their address or cart, so subscribe to changes rather than reading once during initialization. Each option exposes `handle` and `type` only. Provider names, logos, fees, and installment terms aren't available." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -61507,7 +61507,7 @@ "syntaxKind": "PropertySignature", "name": "checkoutToken", "value": "SubscribableSignalLike", - "description": "A stable ID that represents the current checkout.\n\nThe value is `undefined` when the checkout hasn't been created on the server yet.\n\nUse this to correlate checkout sessions across your extension, web pixels, and backend systems.\n\nThis matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data) and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object)." + "description": "A stable ID that represents the current checkout.\n\nThe value is `undefined` when the checkout hasn't been created on the server yet.\n\nUse this to correlate checkout sessions across your extension, web pixels, and backend systems.\n\nThis matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data) and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n\nCan be `undefined`. Handle the `undefined` state before using the value." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -61528,7 +61528,7 @@ "syntaxKind": "PropertySignature", "name": "deliveryGroups", "value": "SubscribableSignalLike", - "description": "The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items." + "description": "The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n\nEmpty until the buyer enters enough address information for Shopify to calculate shipping rates." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -61549,7 +61549,7 @@ "syntaxKind": "PropertySignature", "name": "extension", "value": "Extension", - "description": "The meta information about the extension." + "description": "Metadata about the running extension, including the current target, API version, capabilities, and editor context. Use this to conditionally render content based on where the extension is running." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -61557,7 +61557,7 @@ "name": "extensionPoint", "value": "Target", "description": "The identifier that specifies where in Shopify's UI your code is being injected. This is one of the targets you've included in your extension's configuration file.", - "deprecationMessage": "Deprecated as of version `2023-07`, use `extension.target` instead.", + "deprecationMessage": "Use `extension.target` instead.", "examples": [ { "title": "Example", @@ -61576,14 +61576,14 @@ "syntaxKind": "PropertySignature", "name": "i18n", "value": "I18n", - "description": "Utilities for translating content and formatting values according to the current [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) of the checkout.\n\nRefer to [`localization` examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples) for more information." + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use alongside [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) to build fully localized extensions." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "instructions", "value": "SubscribableSignalLike", - "description": "The cart instructions used to create the checkout and possibly limit extension capabilities.\n\nThese instructions should be checked before performing any actions that might be affected by them.\n\nFor example, if you intend to add a discount code via the `applyDiscountCodeChange` method, check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n\n> Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs aren't available. See the [update guide](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples) for more information." + "description": "The cart instructions used to create the checkout and possibly limit extension capabilities.\n\nThese instructions should be checked before performing any actions that might be affected by them.\n\nFor example, if you intend to add a discount code via the `applyDiscountCodeChange` method, check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n\n> Caution: Check cart instructions before calling select APIs, as > some may not be available. See the > [Cart Instructions API](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples) > for more information." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -61597,7 +61597,7 @@ "syntaxKind": "PropertySignature", "name": "localization", "value": "Localization", - "description": "The details about the location, language, and currency of the customer. For utilities to easily format and translate content based on these details, you can use the [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n) object instead." + "description": "The buyer's language, country, currency, and timezone context. For formatting and translation helpers, use the [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#properties-propertydetail-i18n) object instead." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -61627,21 +61627,21 @@ "syntaxKind": "PropertySignature", "name": "query", "value": ">(query: string, options?: { variables?: Variables; version?: StorefrontApiVersion; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>", - "description": "The method used to query the Storefront GraphQL API with a prefetched token.\n\nRefer to [Storefront API access examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/storefront-api) for more information." + "description": "The method used to query the Storefront GraphQL API with a prefetched token." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "selectedPaymentOptions", "value": "SubscribableSignalLike", - "description": "The payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card)." + "description": "The payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\n\nEach option exposes `handle` and `type` only. Provider names, logos, fees, and installment terms aren't available." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "sessionToken", "value": "SessionToken", - "description": "The session token providing a set of claims as a signed JSON Web Token (JWT).\n\nThe token has a TTL of five minutes.\n\nIf the previous token expires, this value reflects a new session token with a new signature and expiry.\n\nRefer to [session token examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/session-token) for more information." + "description": "The session token providing a set of claims as a signed JSON Web Token (JWT).\n\nThe token has a TTL of five minutes.\n\nIf the previous token expires, this value reflects a new session token with a new signature and expiry.\n\nLearn more about [session tokens](/docs/apps/build/authentication-authorization/session-tokens)." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -61663,14 +61663,14 @@ "syntaxKind": "PropertySignature", "name": "shop", "value": "Shop", - "description": "The shop where the checkout is taking place." + "description": "The store where the checkout is taking place, including the shop name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "storage", "value": "Storage", - "description": "The key-value storage for the extension.\n\nIt uses `localStorage` and should persist across the customer's current checkout session.\n\n> Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n\nData is shared across all activated extension targets of this extension. In versions 2023-07 and earlier, each activated extension target had its own storage." + "description": "Key-value storage that persists across page loads within the current checkout session. Data is shared across all activated targets associated with this extension.\n\n> Caution: Data persistence isn't guaranteed and storage is cleared when the buyer starts a new checkout." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -61692,29 +61692,29 @@ ] } ], - "value": "export interface StandardApi {\n /**\n * The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event.\n */\n analytics: Analytics;\n\n /**\n * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\n */\n appliedGiftCards: SubscribableSignalLike;\n\n /**\n * The cart instructions used to create the checkout and possibly limit extension capabilities.\n *\n * These instructions should be checked before performing any actions that might be affected by them.\n *\n * For example, if you intend to add a discount code via the `applyDiscountCodeChange` method,\n * check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n *\n * > Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs aren't available.\n * See the [update guide](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples) for more information.\n *\n */\n instructions: SubscribableSignalLike;\n\n /**\n * The metafields requested in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration)\n * file. These metafields are updated when there's a change in the merchandise items\n * being purchased by the customer.\n *\n * App owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` isn't supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n appMetafields: SubscribableSignalLike;\n\n /**\n * The custom key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n buyerIdentity?: BuyerIdentity;\n\n /**\n * Provides details on the buyer's progression through the checkout and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/buyer-journey#examples)\n * examples for more information.\n */\n buyerJourney: BuyerJourney;\n\n /**\n * Settings applied to the buyer's checkout.\n */\n checkoutSettings: SubscribableSignalLike;\n\n /**\n * A stable ID that represents the current checkout.\n *\n * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\n *\n * This matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data)\n * and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n */\n checkoutToken: SubscribableSignalLike;\n\n /**\n * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * The meta information about the extension.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n *\n * @deprecated Deprecated as of version `2023-07`, use `extension.target` instead.\n */\n extensionPoint: Target;\n\n /**\n * Utilities for translating content and formatting values according to the current\n * [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization)\n * of the checkout.\n *\n * Refer to [`localization` examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples)\n * for more information.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The details about the location, language, and currency of the customer. For utilities to easily\n * format and translate content based on these details, you can use the\n * [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n)\n * object instead.\n */\n localization: Localization;\n\n /**\n * The metafields that apply to the current checkout.\n *\n * Metafields are stored locally on the client and are applied to the order object after the checkout completes.\n *\n * These metafields are shared by all extensions running on checkout, and\n * persist for as long as the customer is working on this checkout.\n *\n * Once the order is created, you can query these metafields using the\n * [GraphQL Admin API](/docs/admin-api/graphql/reference/orders/order#metafield-2021-01)\n *\n * > Caution:\n * `metafields` is deprecated. Use `appMetafields` with cart metafields instead.\n *\n * @deprecated Use `appMetafields` with cart metafields instead.\n */\n metafields: SubscribableSignalLike;\n\n /**\n * A note left by the customer to the merchant, either in their cart or during checkout.\n *\n * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\n */\n note: SubscribableSignalLike;\n\n /**\n * The method used to query the Storefront GraphQL API with a prefetched token.\n *\n * Refer to [Storefront API access examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/storefront-api) for more information.\n */\n query: >(\n query: string,\n options?: {variables?: Variables; version?: StorefrontApiVersion},\n ) => Promise<{data?: Data; errors?: GraphQLError[]}>;\n\n /**\n * The payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\n */\n selectedPaymentOptions: SubscribableSignalLike;\n\n /**\n * The session token providing a set of claims as a signed JSON Web Token (JWT).\n *\n * The token has a TTL of five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/session-token) for more information.\n */\n sessionToken: SessionToken;\n\n /**\n * The settings matching the settings definition written in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates in real time as a merchant fills in the settings.\n */\n settings: SubscribableSignalLike;\n\n /**\n * The proposed customer shipping address. During the information step, the address\n * updates when the field is committed (on change) rather than every keystroke.\n * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n shippingAddress?: SubscribableSignalLike;\n\n /**\n * The proposed customer billing address. The address updates when the field is\n * committed (on change) rather than every keystroke. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided yet.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n billingAddress?: SubscribableSignalLike;\n\n /** The shop where the checkout is taking place. */\n shop: Shop;\n\n /**\n * The key-value storage for the extension.\n *\n * It uses `localStorage` and should persist across the customer's current checkout session.\n *\n * > Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n *\n * Data is shared across all activated extension targets of this extension. In versions 2023-07 and earlier,\n * each activated extension target had its own storage.\n */\n storage: Storage;\n\n /**\n * The renderer version being used for the extension.\n *\n * @example '2025-10'\n */\n version: Version;\n\n /**\n * Customer privacy consent settings and a flag denoting if consent has previously been collected.\n */\n customerPrivacy: SubscribableSignalLike;\n\n /**\n * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent) to be set to `true`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyTrackingConsentChange: ApplyTrackingConsentChangeType;\n\n /**\n * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" + "value": "export interface StandardApi {\n /**\n * Tracks custom events and sends visitor information to\n * [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events\n * and `visitor()` to submit buyer contact details.\n */\n analytics: Analytics;\n\n /**\n * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\n */\n appliedGiftCards: SubscribableSignalLike;\n\n /**\n * The cart instructions used to create the checkout and possibly limit extension capabilities.\n *\n * These instructions should be checked before performing any actions that might be affected by them.\n *\n * For example, if you intend to add a discount code via the `applyDiscountCodeChange` method,\n * check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n *\n * > Caution: Check cart instructions before calling select APIs, as\n * > some may not be available. See the\n * > [Cart Instructions API](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples)\n * > for more information.\n *\n */\n instructions: SubscribableSignalLike;\n\n /**\n * The metafields requested in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration)\n * file. These metafields are updated when there's a change in the merchandise items\n * being purchased by the customer.\n *\n * App owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` isn't supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n appMetafields: SubscribableSignalLike;\n\n /**\n * The custom key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as\n * credit cards, wallets, and local payment methods. The list depends on\n * the shop's payment configuration and the buyer's region.\n *\n * The set of payment options can change when the buyer updates their\n * address or cart, so subscribe to changes rather than reading once\n * during initialization. Each option exposes `handle` and `type` only.\n * Provider names, logos, fees, and installment terms aren't available.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n buyerIdentity?: BuyerIdentity;\n\n /**\n * Provides details on the buyer's progression through the checkout and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/buyer-journey#examples)\n * examples for more information.\n */\n buyerJourney: BuyerJourney;\n\n /**\n * Settings applied to the buyer's checkout.\n */\n checkoutSettings: SubscribableSignalLike;\n\n /**\n * A stable ID that represents the current checkout.\n *\n * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\n *\n * This matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data)\n * and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n *\n * Can be `undefined`. Handle the `undefined` state before using the value.\n */\n checkoutToken: SubscribableSignalLike;\n\n /**\n * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n *\n * Empty until the buyer enters enough address information for Shopify to\n * calculate shipping rates.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * Metadata about the running extension, including the current target, API version,\n * capabilities, and editor context. Use this to conditionally render content\n * based on where the extension is running.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n *\n * @deprecated Use `extension.target` instead.\n */\n extensionPoint: Target;\n\n /**\n * Utilities for translating strings, formatting currencies, numbers, and dates\n * according to the buyer's locale. Use alongside\n * [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization)\n * to build fully localized extensions.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The buyer's language, country, currency, and timezone context. For\n * formatting and translation helpers, use the\n * [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#properties-propertydetail-i18n)\n * object instead.\n */\n localization: Localization;\n\n /**\n * The metafields that apply to the current checkout.\n *\n * Metafields are stored locally on the client and are applied to the order object after the checkout completes.\n *\n * These metafields are shared by all extensions running on checkout, and\n * persist for as long as the customer is working on this checkout.\n *\n * Once the order is created, you can query these metafields using the\n * [GraphQL Admin API](/docs/admin-api/graphql/reference/orders/order#metafield-2021-01)\n *\n * > Caution:\n * `metafields` is deprecated. Use `appMetafields` with cart metafields instead.\n *\n * @deprecated Use `appMetafields` with cart metafields instead.\n */\n metafields: SubscribableSignalLike;\n\n /**\n * A note left by the customer to the merchant, either in their cart or during checkout.\n *\n * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\n */\n note: SubscribableSignalLike;\n\n /**\n * The method used to query the Storefront GraphQL API with a prefetched token.\n *\n */\n query: >(\n query: string,\n options?: {variables?: Variables; version?: StorefrontApiVersion},\n ) => Promise<{data?: Data; errors?: GraphQLError[]}>;\n\n /**\n * The payment options the buyer has currently selected. This updates as\n * the buyer changes their payment method. The array can contain multiple\n * entries when the buyer splits payment across methods (for example, a\n * gift card and a credit card).\n *\n * Each option exposes `handle` and `type` only. Provider names, logos,\n * fees, and installment terms aren't available.\n */\n selectedPaymentOptions: SubscribableSignalLike;\n\n /**\n * The session token providing a set of claims as a signed JSON Web Token (JWT).\n *\n * The token has a TTL of five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Learn more about [session tokens](/docs/apps/build/authentication-authorization/session-tokens).\n */\n sessionToken: SessionToken;\n\n /**\n * The settings matching the settings definition written in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates in real time as a merchant fills in the settings.\n */\n settings: SubscribableSignalLike;\n\n /**\n * The proposed customer shipping address. During the information step, the address\n * updates when the field is committed (on change) rather than every keystroke.\n * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n shippingAddress?: SubscribableSignalLike;\n\n /**\n * The proposed customer billing address. The address updates when the field is\n * committed (on change) rather than every keystroke. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided yet.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n billingAddress?: SubscribableSignalLike;\n\n /**\n * The store where the checkout is taking place, including the shop name,\n * storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.\n */\n shop: Shop;\n\n /**\n * Key-value storage that persists across page loads within the current checkout\n * session. Data is shared across all activated targets associated with\n * this extension.\n *\n * > Caution: Data persistence isn't guaranteed and storage is cleared when the\n * buyer starts a new checkout.\n */\n storage: Storage;\n\n /**\n * The renderer version being used for the extension.\n *\n * @example '2025-10'\n */\n version: Version;\n\n /**\n * Customer privacy consent settings and a flag denoting if consent has previously been collected.\n */\n customerPrivacy: SubscribableSignalLike;\n\n /**\n * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`collect_buyer_consent` capability](/docs/apps/build/customer-accounts/capabilities#collect-buyer-consent) to be set to `true`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyTrackingConsentChange: ApplyTrackingConsentChangeType;\n\n /**\n * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" }, "Analytics": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Analytics", - "description": "", + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "publish", "value": "(name: string, data: Record) => Promise", - "description": "Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing)." + "description": "Publishes a custom event to [Web Pixels](/docs/apps/marketing). Returns `true` when the event is successfully dispatched.\n\nThe Promise resolves to `true` when the event was dispatched. The boolean indicates dispatch confirmation only. It doesn't indicate whether any specific web pixel processed the event." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "visitor", "value": "(data: { email?: string; phone?: string; }) => Promise", - "description": "A method for capturing details about a visitor on the online store." + "description": "Submits buyer contact details for attribution and analytics purposes." } ], - "value": "export interface Analytics {\n /**\n * Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing).\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * A method for capturing details about a visitor on the online store.\n */\n visitor(data: {email?: string; phone?: string}): Promise;\n}" + "value": "export interface Analytics {\n /**\n * Publishes a custom event to [Web Pixels](/docs/apps/marketing).\n * Returns `true` when the event is successfully dispatched.\n *\n * The Promise resolves to `true` when the event was dispatched. The boolean\n * indicates dispatch confirmation only. It doesn't indicate whether any\n * specific web pixel processed the event.\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * Submits buyer contact details for attribution and analytics purposes.\n */\n visitor(data: {email?: string; phone?: string}): Promise;\n}" }, "VisitorResult": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -61755,10 +61755,10 @@ "syntaxKind": "PropertySignature", "name": "type", "value": "'error'", - "description": "Indicates that the visitor information is invalid and wasn't submitted. Examples are using the wrong data type or missing a required property." + "description": "Indicates that the visitor information is invalid and wasn't submitted. Common causes include using the wrong data type or omitting a required property." } ], - "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Examples are using the wrong data type or missing a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Common causes include using the wrong data type or omitting a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" }, "SubscribableSignalLike": { "filePath": "src/surfaces/checkout/shared.ts", @@ -61972,10 +61972,10 @@ "syntaxKind": "PropertySignature", "name": "value", "value": "string | null", - "description": "The new value to store in the metafield. Set to `null` to delete the metafield." + "description": "The new value to store in the metafield. Set to `null` to delete the metafield.\n\nConsent metafield values are strings, not booleans. Pass `null` to delete a tracking consent metafield." } ], - "value": "export interface TrackingConsentMetafieldChange {\n /**\n * The identifier for the tracking consent metafield to update.\n */\n key: string;\n /**\n * The new value to store in the metafield. Set to `null` to delete the metafield.\n */\n value: string | null;\n}" + "value": "export interface TrackingConsentMetafieldChange {\n /**\n * The identifier for the tracking consent metafield to update.\n */\n key: string;\n /**\n * The new value to store in the metafield. Set to `null` to delete the metafield.\n *\n * Consent metafield values are strings, not booleans. Pass `null` to delete\n * a tracking consent metafield.\n */\n value: string | null;\n}" }, "VisitorConsent": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -62189,7 +62189,7 @@ "syntaxKind": "PropertySignature", "name": "value", "value": "string", - "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.", + "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.\n\nAttribute values are always strings. To store structured data, serialize it to JSON and parse it when reading.", "examples": [ { "title": "Example", @@ -62204,7 +62204,7 @@ ] } ], - "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" + "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * Attribute values are always strings. To store structured data, serialize\n * it to JSON and parse it when reading.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" }, "PaymentOption": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -62555,7 +62555,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A globally-unique identifier for the customer in the format `gid://shopify/Customer/`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", + "description": "An identifier for the customer in the format `gid://shopify/Customer/`. This value is unique per shop.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", "examples": [ { "title": "Example", @@ -62608,7 +62608,7 @@ "isPrivate": true } ], - "value": "export interface Customer {\n /**\n * A globally-unique identifier for the customer in the format `gid://shopify/Customer/`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'gid://shopify/Customer/123'\n */\n id: string;\n /**\n * The email address associated with the customer's account. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email?: string;\n /**\n * The phone number associated with the customer's account. The value is `undefined` if no phone number is on file or the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone?: string;\n /**\n * The customer's full name, typically a combination of first and last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n fullName?: string;\n /**\n * The customer's first name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n firstName?: string;\n /**\n * The customer's last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n lastName?: string;\n /**\n * The customer's profile image, such as a Gravatar avatar. Use this to personalize the extension UI for the logged-in buyer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n image: ImageDetails;\n /**\n * Whether the customer has opted in to receiving marketing communications from the merchant, such as email campaigns and promotional offers.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * > Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n *\n * @deprecated Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n */\n acceptsMarketing: boolean;\n /**\n * Whether the customer has opted in to email marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsEmailMarketing: boolean;\n /**\n * Whether the customer has opted in to SMS marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsSmsMarketing: boolean;\n /**\n * The store credit accounts owned by this customer that can be used as payment during checkout. Each account has a balance representing available store credit.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @private\n */\n storeCreditAccounts: StoreCreditAccount[];\n /**\n * The number of orders the customer has previously placed with this shop.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n ordersCount: number;\n}" + "value": "export interface Customer {\n /**\n * An identifier for the customer in the format `gid://shopify/Customer/`. This value is unique per shop.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'gid://shopify/Customer/123'\n */\n id: string;\n /**\n * The email address associated with the customer's account. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email?: string;\n /**\n * The phone number associated with the customer's account. The value is `undefined` if no phone number is on file or the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone?: string;\n /**\n * The customer's full name, typically a combination of first and last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n fullName?: string;\n /**\n * The customer's first name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n firstName?: string;\n /**\n * The customer's last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n lastName?: string;\n /**\n * The customer's profile image, such as a Gravatar avatar. Use this to personalize the extension UI for the logged-in buyer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n image: ImageDetails;\n /**\n * Whether the customer has opted in to receiving marketing communications from the merchant, such as email campaigns and promotional offers.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * > Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n *\n * @deprecated Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n */\n acceptsMarketing: boolean;\n /**\n * Whether the customer has opted in to email marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsEmailMarketing: boolean;\n /**\n * Whether the customer has opted in to SMS marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsSmsMarketing: boolean;\n /**\n * The store credit accounts owned by this customer that can be used as payment during checkout. Each account has a balance representing available store credit.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @private\n */\n storeCreditAccounts: StoreCreditAccount[];\n /**\n * The number of orders the customer has previously placed with this shop.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n ordersCount: number;\n}" }, "ImageDetails": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -62890,11 +62890,11 @@ "syntaxKind": "MethodSignature", "name": "perform", "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", + "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.\n\nRuns after all intercept results are collected. Use it for local state updates such as setting an error flag. By the time it runs, the navigation decision is final, so blocking logic belongs in the intercept handler itself, not here.", "isOptional": true } ], - "value": "interface InterceptorRequestAllow {\n /**\n * Indicates that the interceptor allows the buyer's journey to continue.\n */\n behavior: 'allow';\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" + "value": "interface InterceptorRequestAllow {\n /**\n * Indicates that the interceptor allows the buyer's journey to continue.\n */\n behavior: 'allow';\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n *\n * Runs after all intercept results are collected. Use it for local state\n * updates such as setting an error flag. By the time it runs, the navigation\n * decision is final, so blocking logic belongs in the intercept handler\n * itself, not here.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" }, "InterceptorResult": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -62958,7 +62958,7 @@ "syntaxKind": "MethodSignature", "name": "perform", "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", + "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.\n\nRuns after all intercept results are collected. Use it for local state updates such as setting an error flag. By the time it runs, the navigation decision is final, so blocking logic belongs in the intercept handler itself, not here.", "isOptional": true }, { @@ -62969,7 +62969,7 @@ "description": "The reason for blocking the interceptor request. This value isn't presented to the buyer, so it doesn't need to be localized. The value is used only for Shopify's own internal debugging and metrics." } ], - "value": "interface InterceptorRequestBlock {\n /**\n * Indicates that the interceptor blocks the buyer's journey from continuing.\n */\n behavior: 'block';\n\n /**\n * The reason for blocking the interceptor request. This value isn't presented to\n * the buyer, so it doesn't need to be localized. The value is used only for Shopify's\n * own internal debugging and metrics.\n */\n reason: string;\n\n /**\n * Used to pass errors to the checkout UI, outside your extension's UI boundaries.\n */\n errors?: ValidationError[];\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" + "value": "interface InterceptorRequestBlock {\n /**\n * Indicates that the interceptor blocks the buyer's journey from continuing.\n */\n behavior: 'block';\n\n /**\n * The reason for blocking the interceptor request. This value isn't presented to\n * the buyer, so it doesn't need to be localized. The value is used only for Shopify's\n * own internal debugging and metrics.\n */\n reason: string;\n\n /**\n * Used to pass errors to the checkout UI, outside your extension's UI boundaries.\n */\n errors?: ValidationError[];\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n *\n * Runs after all intercept results are collected. Use it for local state\n * updates such as setting an error flag. By the time it runs, the navigation\n * decision is final, so blocking logic belongs in the intercept handler\n * itself, not here.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" }, "ValidationError": { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -63190,17 +63190,17 @@ "syntaxKind": "PropertySignature", "name": "totalShippingAmount", "value": "SubscribableSignalLike", - "description": "The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step." + "description": "The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step.\n\n`undefined` until the buyer selects a shipping method (typically after the information step)." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "totalTaxAmount", "value": "SubscribableSignalLike", - "description": "The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet." + "description": "The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet.\n\n`undefined` when taxes haven't been calculated or aren't available for the buyer's region." } ], - "value": "export interface CartCost {\n /**\n * The sum of all line item prices at the current step of checkout, before shipping and taxes are applied. Use this value to display the base cost of the items the buyer purchased.\n */\n subtotalAmount: SubscribableSignalLike;\n\n /**\n * The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step.\n */\n totalShippingAmount: SubscribableSignalLike;\n\n /**\n * The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet.\n */\n totalTaxAmount: SubscribableSignalLike;\n\n /**\n * The minimum total at the current step of checkout. Costs not yet calculated, such as shipping on the information step, aren't included. Gift cards and store credits are excluded from this total.\n */\n totalAmount: SubscribableSignalLike;\n}" + "value": "export interface CartCost {\n /**\n * The sum of all line item prices at the current step of checkout, before shipping and taxes are applied. Use this value to display the base cost of the items the buyer purchased.\n */\n subtotalAmount: SubscribableSignalLike;\n\n /**\n * The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step.\n *\n * `undefined` until the buyer selects a shipping method (typically after the\n * information step).\n */\n totalShippingAmount: SubscribableSignalLike;\n\n /**\n * The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet.\n *\n * `undefined` when taxes haven't been calculated or aren't available for the\n * buyer's region.\n */\n totalTaxAmount: SubscribableSignalLike;\n\n /**\n * The minimum total at the current step of checkout. Costs not yet calculated, such as shipping on the information step, aren't included. Gift cards and store credits are excluded from this total.\n */\n totalAmount: SubscribableSignalLike;\n}" }, "CustomerPrivacy": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -63287,31 +63287,31 @@ "syntaxKind": "PropertySignature", "name": "analytics", "value": "boolean", - "description": "Whether analytics data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Analytics data includes how the shop was used and what interactions occurred." + "description": "Whether analytics data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Analytics data includes how the shop was used and what interactions occurred.\n\nWhether analytics data can be collected right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.analytics`, before calling `shopify.analytics.publish()`." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "marketing", "value": "boolean", - "description": "Whether marketing data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Marketing data includes attribution and targeted advertising preferences." + "description": "Whether marketing data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Marketing data includes attribution and targeted advertising preferences.\n\nWhether marketing data can be collected right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.marketing`, before performing marketing-related data collection." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "preferences", "value": "boolean", - "description": "Whether preference data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Preference data includes language, currency, and sizing choices." + "description": "Whether preference data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Preference data includes language, currency, and sizing choices.\n\nWhether preference data can be collected right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.preferences`, before storing or reading buyer preference data." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "saleOfData", "value": "boolean", - "description": "Whether data can be shared with third parties based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. This typically applies to behavioral advertising data." + "description": "Whether data can be shared with third parties based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. This typically applies to behavioral advertising data.\n\nWhether buyer data can be shared with or sold to third parties right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.saleOfData`, before sharing or selling buyer data with third parties." } ], - "value": "export interface AllowedProcessing {\n /**\n * Whether analytics data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Analytics\n * data includes how the shop was used and what interactions occurred.\n */\n analytics: boolean;\n /**\n * Whether marketing data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Marketing\n * data includes attribution and targeted advertising preferences.\n */\n marketing: boolean;\n /**\n * Whether preference data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Preference\n * data includes language, currency, and sizing choices.\n */\n preferences: boolean;\n /**\n * Whether data can be shared with third parties based on the visitor's\n * consent, the merchant's privacy configuration, and the visitor's region.\n * This typically applies to behavioral advertising data.\n */\n saleOfData: boolean;\n}" + "value": "export interface AllowedProcessing {\n /**\n * Whether analytics data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Analytics\n * data includes how the shop was used and what interactions occurred.\n *\n * Whether analytics data can be collected right now. Combines the buyer's\n * consent, the merchant's privacy configuration, and the buyer's region into\n * a single boolean. Check this flag, not `visitorConsent.analytics`, before\n * calling `shopify.analytics.publish()`.\n */\n analytics: boolean;\n /**\n * Whether marketing data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Marketing\n * data includes attribution and targeted advertising preferences.\n *\n * Whether marketing data can be collected right now. Combines the buyer's\n * consent, the merchant's privacy configuration, and the buyer's region into\n * a single boolean. Check this flag, not `visitorConsent.marketing`, before\n * performing marketing-related data collection.\n */\n marketing: boolean;\n /**\n * Whether preference data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Preference\n * data includes language, currency, and sizing choices.\n *\n * Whether preference data can be collected right now. Combines the buyer's\n * consent, the merchant's privacy configuration, and the buyer's region into\n * a single boolean. Check this flag, not `visitorConsent.preferences`,\n * before storing or reading buyer preference data.\n */\n preferences: boolean;\n /**\n * Whether data can be shared with third parties based on the visitor's\n * consent, the merchant's privacy configuration, and the visitor's region.\n * This typically applies to behavioral advertising data.\n *\n * Whether buyer data can be shared with or sold to third parties right now.\n * Combines the buyer's consent, the merchant's privacy configuration, and\n * the buyer's region into a single boolean. Check this flag, not\n * `visitorConsent.saleOfData`, before sharing or selling buyer data with\n * third parties.\n */\n saleOfData: boolean;\n}" }, "TrackingConsentMetafield": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -64003,7 +64003,7 @@ "Extension": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Extension", - "description": "The meta information about an extension target.", + "description": "Metadata about the running extension, including its API version, target, capabilities, and editor context. Use this to read configuration details or conditionally render content based on where the extension is running.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -64029,7 +64029,7 @@ "syntaxKind": "PropertySignature", "name": "capabilities", "value": "SubscribableSignalLike", - "description": "The allowed capabilities of the extension, defined in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n\n* [`api_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#api-access): the extension can access the Storefront API.\n\n* [`network_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access): the extension can make external network calls.\n\n* [`block_progress`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n\n* [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n\n* [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can register customer consent decisions that are honored on Shopify-managed services.\n\n* [`iframe.sources`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#iframe): the extension can embed an external URL in an iframe." + "description": "The allowed capabilities of the extension, defined in your [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -64077,7 +64077,7 @@ "syntaxKind": "PropertySignature", "name": "version", "value": "string", - "description": "The published version of the running extension target.\n\nFor unpublished extensions, the value is `undefined`.", + "description": "The published version of the running extension target.\n\nFor unpublished extensions, the value is `undefined`.\n\nDon't use this property as a stable identifier in development environments. It becomes available only after the extension is published.", "isOptional": true, "examples": [ { @@ -64093,7 +64093,7 @@ ] } ], - "value": "export interface Extension {\n /**\n * The API version that was set in the extension config file.\n *\n * @example '2024-10', '2025-01', '2025-04', '2025-07', '2025-10'\n */\n apiVersion: ApiVersion;\n\n /**\n * The allowed capabilities of the extension, defined\n * in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n *\n * * [`api_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#api-access): the extension can access the Storefront API.\n *\n * * [`network_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access): the extension can make external network calls.\n *\n * * [`block_progress`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n *\n * * [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n *\n * * [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can register customer consent decisions that are honored on Shopify-managed services.\n *\n * * [`iframe.sources`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#iframe): the extension can embed an external URL in an iframe.\n */\n capabilities: SubscribableSignalLike;\n\n /**\n * Information about the editor where the extension is being rendered.\n *\n * If the value is undefined, then the extension isn't running in an editor.\n */\n editor?: Editor;\n\n /**\n * A Boolean to show whether your extension is currently rendered to the screen.\n *\n * Shopify might render your extension before it's visible in the UI,\n * typically to pre-render extensions that appear on a later step of the\n * checkout.\n *\n * Your extension might also continue to run after the customer has navigated away\n * from where it was rendered. The extension continues running so that\n * your extension is immediately available to render if the customer navigates back.\n */\n rendered: SubscribableSignalLike;\n\n /**\n * The URL to the script that started the extension target.\n */\n scriptUrl: string;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n */\n target: Target;\n\n /**\n * The published version of the running extension target.\n *\n * For unpublished extensions, the value is `undefined`.\n *\n * @example 3.0.10\n */\n version?: string;\n}" + "value": "export interface Extension {\n /**\n * The API version that was set in the extension config file.\n *\n * @example '2024-10', '2025-01', '2025-04', '2025-07', '2025-10'\n */\n apiVersion: ApiVersion;\n\n /**\n * The allowed capabilities of the extension, defined in your\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n */\n capabilities: SubscribableSignalLike;\n\n /**\n * Information about the editor where the extension is being rendered.\n *\n * If the value is undefined, then the extension isn't running in an editor.\n */\n editor?: Editor;\n\n /**\n * A Boolean to show whether your extension is currently rendered to the screen.\n *\n * Shopify might render your extension before it's visible in the UI,\n * typically to pre-render extensions that appear on a later step of the\n * checkout.\n *\n * Your extension might also continue to run after the customer has navigated away\n * from where it was rendered. The extension continues running so that\n * your extension is immediately available to render if the customer navigates back.\n */\n rendered: SubscribableSignalLike;\n\n /**\n * The URL to the script that started the extension target.\n */\n scriptUrl: string;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n */\n target: Target;\n\n /**\n * The published version of the running extension target.\n *\n * For unpublished extensions, the value is `undefined`.\n *\n * Don't use this property as a stable identifier in development environments.\n * It becomes available only after the extension is published.\n *\n * @example 3.0.10\n */\n version?: string;\n}" }, "ApiVersion": { "filePath": "src/shared.ts", @@ -64112,7 +64112,7 @@ "Editor": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Editor", - "description": "", + "description": "Information about the editor environment when an extension is rendered inside the checkout editor. The value is `undefined` when the extension is not rendering in an editor.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -64127,7 +64127,7 @@ "I18n": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18n", - "description": "", + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use the I18n API alongside the Localization API to build fully localized extensions.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -64163,7 +64163,7 @@ "I18nTranslate": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18nTranslate", - "description": "This returns a translated string matching a key in a locale file.", + "description": "Translates a key from your extension's locale files into a localized string. Supports interpolation with placeholder replacements and pluralization via the special `count` option.", "members": [], "value": "export interface I18nTranslate {\n (\n key: string,\n options?: Record,\n ): ReplacementType extends string | number\n ? string\n : (string | ReplacementType)[];\n}" }, @@ -64727,14 +64727,14 @@ "Localization": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Localization", - "description": "", + "description": "The buyer's language, country, currency, and timezone context. Use this to adapt your extension to the buyer's region and display localized content.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "country", "value": "SubscribableSignalLike", - "description": "The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown." + "description": "The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n\nDerived from the buyer's shipping address. Returns `undefined` until the buyer enters a shipping address." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -64762,18 +64762,18 @@ "syntaxKind": "PropertySignature", "name": "market", "value": "SubscribableSignalLike", - "description": "The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n\n> Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.", - "deprecationMessage": "Deprecated as of version `2025-04`" + "description": "The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. The market context updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.", + "deprecationMessage": "Merchants now manage which extensions load for each\nmarket, so extensions no longer need to check this value." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "timezone", "value": "SubscribableSignalLike", - "description": "The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time." + "description": "The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time." } ], - "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n *\n * > Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" + "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n *\n * Derived from the buyer's shipping address. Returns `undefined` until the\n * buyer enters a shipping address.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout,\n * carried over from the cart context. Markets group countries and\n * regions with shared pricing, languages, and domains. The market\n * context updates when the buyer changes the country of their\n * shipping address. The value is `undefined` if the market is unknown.\n *\n * @deprecated Merchants now manage which extensions load for each\n * market, so extensions no longer need to check this value.\n */\n market: SubscribableSignalLike;\n}" }, "Country": { "filePath": "src/shared.ts", @@ -64974,7 +64974,7 @@ "SessionToken": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SessionToken", - "description": "", + "description": "Authenticates requests between your extension and your app backend. Use session tokens to verify the identity of the buyer and the shop context when making server-side API calls. The token is a signed JWT that contains claims such as the customer ID, shop domain, and expiration.\n\nThe `sub` claim in the decoded token is present only when the buyer is logged in and the app has permission to read customer accounts. Absent for anonymous buyers.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -65233,7 +65233,7 @@ "Shop": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Shop", - "description": "", + "description": "Metadata about the merchant's store, including its name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -65273,30 +65273,30 @@ "syntaxKind": "PropertySignature", "name": "storefrontUrl", "value": "string", - "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n\n> Caution: > As of version `2024-04` this value no longer has a trailing slash.", + "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.", "isOptional": true } ], - "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n *\n * > Caution:\n * > As of version `2024-04` this value no longer has a trailing slash.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom domain.\n */\n myshopifyDomain: string;\n}" + "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom domain.\n */\n myshopifyDomain: string;\n}" }, "Storage": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Storage", - "description": "A key-value storage object for the extension.\n\nStored data is available only to this specific extension and any of its instances.\n\nThe storage backend is implemented with `localStorage` and should persist across the buyer's checkout session. However, data persistence isn't guaranteed.", + "description": "Key-value storage for a specific extension. Use storage to save preferences or cached data that should survive page reloads without requiring a backend call. Stored data is only available to this specific extension. The storage backend is implemented with `localStorage` and data persistence isn't guaranteed.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "delete", "value": "(key: string) => Promise", - "description": "Delete stored data by key." + "description": "Deletes a previously stored value by key." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "read", "value": "(key: string) => Promise", - "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original primitive.\n\nReturns `null` if no stored data exists." + "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original type.\n\nReturns the stored value for the given key, or `null` when no value exists. Doesn't throw on a missing key." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -65306,7 +65306,7 @@ "description": "Write stored data for this key.\n\nThe data must be serializable to JSON." } ], - "value": "export interface Storage {\n /**\n * Read and return a stored value by key.\n *\n * The stored data is deserialized from JSON and returned as\n * its original primitive.\n *\n * Returns `null` if no stored data exists.\n */\n read(key: string): Promise;\n\n /**\n * Write stored data for this key.\n *\n * The data must be serializable to JSON.\n */\n write(key: string, data: any): Promise;\n\n /**\n * Delete stored data by key.\n */\n delete(key: string): Promise;\n}" + "value": "export interface Storage {\n /**\n * Read and return a stored value by key.\n *\n * The stored data is deserialized from JSON and returned as\n * its original type.\n *\n * Returns the stored value for the given key, or `null` when no value\n * exists. Doesn't throw on a missing key.\n */\n read(key: string): Promise;\n\n /**\n * Write stored data for this key.\n *\n * The data must be serializable to JSON.\n */\n write(key: string, data: any): Promise;\n\n /**\n * Deletes a previously stored value by key.\n */\n delete(key: string): Promise;\n}" }, "Version": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -65382,7 +65382,7 @@ "syntaxKind": "MethodSignature", "name": "applyAttributeChange", "value": "(change: AttributeChange) => Promise", - "description": "Updates or removes an attribute on the cart and checkout. On success, the [`attributes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/attributes#standardapi-propertydetail-attributes) property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.", + "description": "Updates or removes an attribute on the cart and checkout. On success, the [`attributes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/attributes#properties-propertydetail-attributes) property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.", "deprecationMessage": "Use cart metafields instead." }, { @@ -65390,42 +65390,42 @@ "syntaxKind": "MethodSignature", "name": "applyCartLinesChange", "value": "(change: CartLineChange) => Promise", - "description": "Adds, removes, or updates line items in the cart. The returned promise resolves when the change has been applied by the server, and the [`lines`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-lines#standardapi-propertydetail-lines) property updates with the new state.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Adds, removes, or updates line items in the cart. The returned promise resolves when the change has been applied by the server, and the [`lines`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-lines#properties-propertydetail-lines) property updates with the new state.\n\nAccepts a single change per call. To make multiple changes, call this method separately for each one.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyDiscountCodeChange", "value": "(change: DiscountCodeChange) => Promise", - "description": "Adds or removes a discount code on the checkout. The returned promise resolves when the change has been applied by the server, and the [`discountCodes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/discounts#standardapi-propertydetail-discountcodes) property updates with the new state.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves discount codes through a network call.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Adds or removes a discount code on the checkout. The returned promise resolves when the change has been applied by the server, and the [`discountCodes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/discounts#properties-propertydetail-discountcodes) property updates with the new state.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves discount codes through a network call.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyGiftCardChange", "value": "(change: GiftCardChange) => Promise", - "description": "Adds or removes a gift card from the checkout. The returned promise resolves when the change has been applied by the server, and the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/gift-cards#standardapi-propertydetail-appliedgiftcards) property updates with the new state.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves gift card codes through a network call.\n\n> Note: This method returns an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Adds or removes a gift card from the checkout. The returned promise resolves when the change has been applied by the server, and the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/gift-cards#properties-propertydetail-appliedgiftcards) property updates with the new state.\n\nUnlike other write operations, gift card changes aren't gated by a cart instruction flag.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves gift card codes through a network call.\n\n> Note: This method returns an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyMetafieldChange", "value": "(change: MetafieldChange) => Promise", - "description": "Creates, updates, or removes a cart metafield on the checkout. On success, the [`metafields`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/metafields#standardapi-propertydetail-metafields) property updates to reflect the change.\n\nCart metafields are copied to order metafields at order creation time if there's a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n\n> Caution: `MetafieldRemoveChange` and `MetafieldUpdateChange` are deprecated. Use cart metafields with `MetafieldRemoveCartChange` and `MetafieldUpdateCartChange` instead. If `MetafieldUpdateChange` writes a metafield with the same namespace and key as a cart metafield that's configured to copy, the cart metafield won't be copied.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Creates, updates, or removes a cart metafield on the checkout. On success, the [`metafields`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/metafields#properties-propertydetail-metafields) property updates to reflect the change.\n\nCart metafields are copied to order metafields at order creation time if there's a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n\n> Caution: `MetafieldRemoveChange` and `MetafieldUpdateChange` are deprecated. Use cart metafields with `MetafieldRemoveCartChange` and `MetafieldUpdateCartChange` instead. If `MetafieldUpdateChange` writes a metafield with the same namespace and key as a cart metafield that's configured to copy, the cart metafield won't be copied.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyNoteChange", "value": "(change: NoteChange) => Promise", - "description": "Sets or removes the buyer's note on the checkout. On success, the [`note`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/note#standardapi-propertydetail-note) property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Sets or removes the buyer's note on the checkout. On success, the [`note`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/note#properties-propertydetail-note) property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyShippingAddressChange", "value": "(change: ShippingAddressUpdateChange) => Promise", - "description": "Updates the buyer's shipping address on the checkout. The provided fields are merged into the existing address without prompting the buyer. On success, the `shippingAddress` property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", + "description": "Updates the buyer's shipping address on the checkout. The provided fields are merged into the existing address without prompting the buyer. On success, the `shippingAddress` property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", "isOptional": true }, { @@ -65438,7 +65438,7 @@ "isPrivate": true } ], - "value": "export interface CheckoutApi {\n /**\n * Updates or removes an attribute on the cart and checkout. On success, the\n * [`attributes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/attributes#standardapi-propertydetail-attributes) property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * @deprecated Use cart metafields instead.\n */\n applyAttributeChange(change: AttributeChange): Promise;\n\n /**\n * Adds, removes, or updates line items in the cart. The returned promise resolves when the change has been applied by the server, and the [`lines`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-lines#standardapi-propertydetail-lines) property updates with the new state.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyCartLinesChange(change: CartLineChange): Promise;\n\n /**\n * Adds or removes a discount code on the checkout. The returned promise resolves when the change has been applied by the server, and the [`discountCodes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/discounts#standardapi-propertydetail-discountcodes) property updates with the new state.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves discount codes through a network call.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyDiscountCodeChange(\n change: DiscountCodeChange,\n ): Promise;\n\n /**\n * Adds or removes a gift card from the checkout. The returned promise resolves when the change has been applied by the server, and the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/gift-cards#standardapi-propertydetail-appliedgiftcards) property updates with the new state.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves gift card codes through a network call.\n *\n * > Note: This method returns an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyGiftCardChange(change: GiftCardChange): Promise;\n\n /**\n * Creates, updates, or removes a cart metafield on the checkout. On success, the\n * [`metafields`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/metafields#standardapi-propertydetail-metafields) property updates to reflect the change.\n *\n * Cart metafields are copied to order metafields at order creation time if there's a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n *\n * > Caution: `MetafieldRemoveChange` and `MetafieldUpdateChange` are deprecated. Use cart metafields with `MetafieldRemoveCartChange` and `MetafieldUpdateCartChange` instead. If `MetafieldUpdateChange` writes a metafield with the same namespace and key as a cart metafield that's configured to copy, the cart metafield won't be copied.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyMetafieldChange(change: MetafieldChange): Promise;\n\n /**\n * Sets or removes the buyer's note on the checkout. On success, the\n * [`note`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/note#standardapi-propertydetail-note)\n * property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyNoteChange(change: NoteChange): Promise;\n\n /**\n * @private\n */\n experimentalIsShopAppStyle?: boolean;\n\n /**\n * Updates the buyer's shipping address on the checkout. The provided fields\n * are merged into the existing address without prompting the buyer. On success,\n * the `shippingAddress` property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyShippingAddressChange?(\n change: ShippingAddressChange,\n ): Promise;\n}" + "value": "export interface CheckoutApi {\n /**\n * Updates or removes an attribute on the cart and checkout. On success, the\n * [`attributes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/attributes#properties-propertydetail-attributes) property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * @deprecated Use cart metafields instead.\n */\n applyAttributeChange(change: AttributeChange): Promise;\n\n /**\n * Adds, removes, or updates line items in the cart. The returned promise resolves when the change has been applied by the server, and the [`lines`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-lines#properties-propertydetail-lines) property updates with the new state.\n *\n * Accepts a single change per call. To make multiple changes, call this\n * method separately for each one.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyCartLinesChange(change: CartLineChange): Promise;\n\n /**\n * Adds or removes a discount code on the checkout. The returned promise resolves when the change has been applied by the server, and the [`discountCodes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/discounts#properties-propertydetail-discountcodes) property updates with the new state.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves discount codes through a network call.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyDiscountCodeChange(\n change: DiscountCodeChange,\n ): Promise;\n\n /**\n * Adds or removes a gift card from the checkout. The returned promise resolves when the change has been applied by the server, and the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/gift-cards#properties-propertydetail-appliedgiftcards) property updates with the new state.\n *\n * Unlike other write operations, gift card changes aren't gated by a cart\n * instruction flag.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves gift card codes through a network call.\n *\n * > Note: This method returns an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyGiftCardChange(change: GiftCardChange): Promise;\n\n /**\n * Creates, updates, or removes a cart metafield on the checkout. On success, the\n * [`metafields`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/metafields#properties-propertydetail-metafields) property updates to reflect the change.\n *\n * Cart metafields are copied to order metafields at order creation time if there's a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n *\n * > Caution: `MetafieldRemoveChange` and `MetafieldUpdateChange` are deprecated. Use cart metafields with `MetafieldRemoveCartChange` and `MetafieldUpdateCartChange` instead. If `MetafieldUpdateChange` writes a metafield with the same namespace and key as a cart metafield that's configured to copy, the cart metafield won't be copied.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyMetafieldChange(change: MetafieldChange): Promise;\n\n /**\n * Sets or removes the buyer's note on the checkout. On success, the\n * [`note`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/note#properties-propertydetail-note)\n * property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyNoteChange(change: NoteChange): Promise;\n\n /**\n * @private\n */\n experimentalIsShopAppStyle?: boolean;\n\n /**\n * Updates the buyer's shipping address on the checkout. The provided fields\n * are merged into the existing address without prompting the buyer. On success,\n * the `shippingAddress` property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyShippingAddressChange?(\n change: ShippingAddressChange,\n ): Promise;\n}" }, "AttributeChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -65505,7 +65505,7 @@ "syntaxKind": "PropertySignature", "name": "value", "value": "string", - "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.", + "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.\n\nAttribute values are always strings. To store structured data, serialize it to JSON and parse it when reading.", "examples": [ { "title": "Example", @@ -65520,7 +65520,7 @@ ] } ], - "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" + "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * Attribute values are always strings. To store structured data, serialize\n * it to JSON and parse it when reading.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" }, "AttributeRemoveChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -66373,7 +66373,7 @@ "syntaxKind": "PropertySignature", "name": "message", "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer." + "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer.\n\nRender your own localized error text rather than displaying this message to the buyer." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -66383,7 +66383,7 @@ "description": "Indicates that the line item wasn't changed successfully. Refer to the `message` property for details about the error." } ], - "value": "export interface CartLineChangeResultError {\n /**\n * Indicates that the line item wasn't changed successfully. Refer to the `message` property for details about the error.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface CartLineChangeResultError {\n /**\n * Indicates that the line item wasn't changed successfully. Refer to the `message` property for details about the error.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n *\n * Render your own localized error text rather than displaying this message\n * to the buyer.\n */\n message: string;\n}" }, "DiscountCodeChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -66563,7 +66563,7 @@ "syntaxKind": "PropertySignature", "name": "message", "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer." + "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer.\n\nRender your own localized error text rather than displaying this message to the buyer." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -66573,7 +66573,7 @@ "description": "Indicates that the gift card change couldn't be applied. Check the `message` property for details." } ], - "value": "export interface GiftCardChangeResultError {\n /**\n * Indicates that the gift card change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface GiftCardChangeResultError {\n /**\n * Indicates that the gift card change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n *\n * Render your own localized error text rather than displaying this message\n * to the buyer.\n */\n message: string;\n}" }, "MetafieldChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -66834,7 +66834,7 @@ "syntaxKind": "PropertySignature", "name": "message", "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer." + "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer.\n\nRender your own localized error text rather than displaying this message to the buyer." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -66844,7 +66844,7 @@ "description": "Indicates that the metafield change couldn't be applied. Check the `message` property for details." } ], - "value": "export interface MetafieldChangeResultError {\n /**\n * Indicates that the metafield change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface MetafieldChangeResultError {\n /**\n * Indicates that the metafield change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n *\n * Render your own localized error text rather than displaying this message\n * to the buyer.\n */\n message: string;\n}" }, "NoteChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -66922,7 +66922,7 @@ "syntaxKind": "PropertySignature", "name": "message", "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer." + "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer.\n\nRender your own localized error text rather than displaying this message to the buyer." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -66932,7 +66932,7 @@ "description": "Indicates that the note change couldn't be applied. Check the `message` property for details." } ], - "value": "export interface NoteChangeResultError {\n /**\n * Indicates that the note change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface NoteChangeResultError {\n /**\n * Indicates that the note change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n *\n * Render your own localized error text rather than displaying this message\n * to the buyer.\n */\n message: string;\n}" }, "ShippingAddressUpdateChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -67518,7 +67518,7 @@ "syntaxKind": "PropertySignature", "name": "analytics", "value": "Analytics", - "description": "The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event." + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -67532,7 +67532,7 @@ "syntaxKind": "PropertySignature", "name": "applyTrackingConsentChange", "value": "ApplyTrackingConsentChangeType", - "description": "Enables setting and updating customer privacy consent settings and tracking consent metafields.\n\n> Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent) to be set to `true`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." + "description": "Enables setting and updating customer privacy consent settings and tracking consent metafields.\n\n> Note: Requires the [`collect_buyer_consent` capability](/docs/apps/build/customer-accounts/capabilities#collect-buyer-consent) to be set to `true`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -67553,7 +67553,7 @@ "syntaxKind": "PropertySignature", "name": "availablePaymentOptions", "value": "SubscribableSignalLike", - "description": "All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region." + "description": "All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n\nThe set of payment options can change when the buyer updates their address or cart, so subscribe to changes rather than reading once during initialization. Each option exposes `handle` and `type` only. Provider names, logos, fees, and installment terms aren't available." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -67590,7 +67590,7 @@ "syntaxKind": "PropertySignature", "name": "checkoutToken", "value": "SubscribableSignalLike", - "description": "A stable ID that represents the current checkout.\n\nThe value is `undefined` when the checkout hasn't been created on the server yet.\n\nUse this to correlate checkout sessions across your extension, web pixels, and backend systems.\n\nThis matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data) and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object)." + "description": "A stable ID that represents the current checkout.\n\nThe value is `undefined` when the checkout hasn't been created on the server yet.\n\nUse this to correlate checkout sessions across your extension, web pixels, and backend systems.\n\nThis matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data) and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n\nCan be `undefined`. Handle the `undefined` state before using the value." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -67611,7 +67611,7 @@ "syntaxKind": "PropertySignature", "name": "deliveryGroups", "value": "SubscribableSignalLike", - "description": "The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items." + "description": "The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n\nEmpty until the buyer enters enough address information for Shopify to calculate shipping rates." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -67632,7 +67632,7 @@ "syntaxKind": "PropertySignature", "name": "extension", "value": "Extension", - "description": "The meta information about the extension." + "description": "Metadata about the running extension, including the current target, API version, capabilities, and editor context. Use this to conditionally render content based on where the extension is running." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -67640,7 +67640,7 @@ "name": "extensionPoint", "value": "Target", "description": "The identifier that specifies where in Shopify's UI your code is being injected. This is one of the targets you've included in your extension's configuration file.", - "deprecationMessage": "Deprecated as of version `2023-07`, use `extension.target` instead.", + "deprecationMessage": "Use `extension.target` instead.", "examples": [ { "title": "Example", @@ -67659,14 +67659,14 @@ "syntaxKind": "PropertySignature", "name": "i18n", "value": "I18n", - "description": "Utilities for translating content and formatting values according to the current [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) of the checkout.\n\nRefer to [`localization` examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples) for more information." + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use alongside [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) to build fully localized extensions." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "instructions", "value": "SubscribableSignalLike", - "description": "The cart instructions used to create the checkout and possibly limit extension capabilities.\n\nThese instructions should be checked before performing any actions that might be affected by them.\n\nFor example, if you intend to add a discount code via the `applyDiscountCodeChange` method, check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n\n> Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs aren't available. See the [update guide](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples) for more information." + "description": "The cart instructions used to create the checkout and possibly limit extension capabilities.\n\nThese instructions should be checked before performing any actions that might be affected by them.\n\nFor example, if you intend to add a discount code via the `applyDiscountCodeChange` method, check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n\n> Caution: Check cart instructions before calling select APIs, as > some may not be available. See the > [Cart Instructions API](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples) > for more information." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -67680,7 +67680,7 @@ "syntaxKind": "PropertySignature", "name": "localization", "value": "Localization", - "description": "The details about the location, language, and currency of the customer. For utilities to easily format and translate content based on these details, you can use the [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n) object instead." + "description": "The buyer's language, country, currency, and timezone context. For formatting and translation helpers, use the [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#properties-propertydetail-i18n) object instead." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -67710,21 +67710,21 @@ "syntaxKind": "PropertySignature", "name": "query", "value": ">(query: string, options?: { variables?: Variables; version?: StorefrontApiVersion; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>", - "description": "The method used to query the Storefront GraphQL API with a prefetched token.\n\nRefer to [Storefront API access examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/storefront-api) for more information." + "description": "The method used to query the Storefront GraphQL API with a prefetched token." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "selectedPaymentOptions", "value": "SubscribableSignalLike", - "description": "The payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card)." + "description": "The payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\n\nEach option exposes `handle` and `type` only. Provider names, logos, fees, and installment terms aren't available." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "sessionToken", "value": "SessionToken", - "description": "The session token providing a set of claims as a signed JSON Web Token (JWT).\n\nThe token has a TTL of five minutes.\n\nIf the previous token expires, this value reflects a new session token with a new signature and expiry.\n\nRefer to [session token examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/session-token) for more information." + "description": "The session token providing a set of claims as a signed JSON Web Token (JWT).\n\nThe token has a TTL of five minutes.\n\nIf the previous token expires, this value reflects a new session token with a new signature and expiry.\n\nLearn more about [session tokens](/docs/apps/build/authentication-authorization/session-tokens)." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -67746,14 +67746,14 @@ "syntaxKind": "PropertySignature", "name": "shop", "value": "Shop", - "description": "The shop where the checkout is taking place." + "description": "The store where the checkout is taking place, including the shop name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "storage", "value": "Storage", - "description": "The key-value storage for the extension.\n\nIt uses `localStorage` and should persist across the customer's current checkout session.\n\n> Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n\nData is shared across all activated extension targets of this extension. In versions 2023-07 and earlier, each activated extension target had its own storage." + "description": "Key-value storage that persists across page loads within the current checkout session. Data is shared across all activated targets associated with this extension.\n\n> Caution: Data persistence isn't guaranteed and storage is cleared when the buyer starts a new checkout." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -67775,29 +67775,29 @@ ] } ], - "value": "export interface StandardApi {\n /**\n * The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event.\n */\n analytics: Analytics;\n\n /**\n * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\n */\n appliedGiftCards: SubscribableSignalLike;\n\n /**\n * The cart instructions used to create the checkout and possibly limit extension capabilities.\n *\n * These instructions should be checked before performing any actions that might be affected by them.\n *\n * For example, if you intend to add a discount code via the `applyDiscountCodeChange` method,\n * check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n *\n * > Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs aren't available.\n * See the [update guide](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples) for more information.\n *\n */\n instructions: SubscribableSignalLike;\n\n /**\n * The metafields requested in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration)\n * file. These metafields are updated when there's a change in the merchandise items\n * being purchased by the customer.\n *\n * App owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` isn't supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n appMetafields: SubscribableSignalLike;\n\n /**\n * The custom key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n buyerIdentity?: BuyerIdentity;\n\n /**\n * Provides details on the buyer's progression through the checkout and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/buyer-journey#examples)\n * examples for more information.\n */\n buyerJourney: BuyerJourney;\n\n /**\n * Settings applied to the buyer's checkout.\n */\n checkoutSettings: SubscribableSignalLike;\n\n /**\n * A stable ID that represents the current checkout.\n *\n * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\n *\n * This matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data)\n * and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n */\n checkoutToken: SubscribableSignalLike;\n\n /**\n * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * The meta information about the extension.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n *\n * @deprecated Deprecated as of version `2023-07`, use `extension.target` instead.\n */\n extensionPoint: Target;\n\n /**\n * Utilities for translating content and formatting values according to the current\n * [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization)\n * of the checkout.\n *\n * Refer to [`localization` examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples)\n * for more information.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The details about the location, language, and currency of the customer. For utilities to easily\n * format and translate content based on these details, you can use the\n * [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n)\n * object instead.\n */\n localization: Localization;\n\n /**\n * The metafields that apply to the current checkout.\n *\n * Metafields are stored locally on the client and are applied to the order object after the checkout completes.\n *\n * These metafields are shared by all extensions running on checkout, and\n * persist for as long as the customer is working on this checkout.\n *\n * Once the order is created, you can query these metafields using the\n * [GraphQL Admin API](/docs/admin-api/graphql/reference/orders/order#metafield-2021-01)\n *\n * > Caution:\n * `metafields` is deprecated. Use `appMetafields` with cart metafields instead.\n *\n * @deprecated Use `appMetafields` with cart metafields instead.\n */\n metafields: SubscribableSignalLike;\n\n /**\n * A note left by the customer to the merchant, either in their cart or during checkout.\n *\n * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\n */\n note: SubscribableSignalLike;\n\n /**\n * The method used to query the Storefront GraphQL API with a prefetched token.\n *\n * Refer to [Storefront API access examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/storefront-api) for more information.\n */\n query: >(\n query: string,\n options?: {variables?: Variables; version?: StorefrontApiVersion},\n ) => Promise<{data?: Data; errors?: GraphQLError[]}>;\n\n /**\n * The payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\n */\n selectedPaymentOptions: SubscribableSignalLike;\n\n /**\n * The session token providing a set of claims as a signed JSON Web Token (JWT).\n *\n * The token has a TTL of five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/session-token) for more information.\n */\n sessionToken: SessionToken;\n\n /**\n * The settings matching the settings definition written in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates in real time as a merchant fills in the settings.\n */\n settings: SubscribableSignalLike;\n\n /**\n * The proposed customer shipping address. During the information step, the address\n * updates when the field is committed (on change) rather than every keystroke.\n * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n shippingAddress?: SubscribableSignalLike;\n\n /**\n * The proposed customer billing address. The address updates when the field is\n * committed (on change) rather than every keystroke. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided yet.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n billingAddress?: SubscribableSignalLike;\n\n /** The shop where the checkout is taking place. */\n shop: Shop;\n\n /**\n * The key-value storage for the extension.\n *\n * It uses `localStorage` and should persist across the customer's current checkout session.\n *\n * > Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n *\n * Data is shared across all activated extension targets of this extension. In versions 2023-07 and earlier,\n * each activated extension target had its own storage.\n */\n storage: Storage;\n\n /**\n * The renderer version being used for the extension.\n *\n * @example '2025-10'\n */\n version: Version;\n\n /**\n * Customer privacy consent settings and a flag denoting if consent has previously been collected.\n */\n customerPrivacy: SubscribableSignalLike;\n\n /**\n * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent) to be set to `true`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyTrackingConsentChange: ApplyTrackingConsentChangeType;\n\n /**\n * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" + "value": "export interface StandardApi {\n /**\n * Tracks custom events and sends visitor information to\n * [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events\n * and `visitor()` to submit buyer contact details.\n */\n analytics: Analytics;\n\n /**\n * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\n */\n appliedGiftCards: SubscribableSignalLike;\n\n /**\n * The cart instructions used to create the checkout and possibly limit extension capabilities.\n *\n * These instructions should be checked before performing any actions that might be affected by them.\n *\n * For example, if you intend to add a discount code via the `applyDiscountCodeChange` method,\n * check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n *\n * > Caution: Check cart instructions before calling select APIs, as\n * > some may not be available. See the\n * > [Cart Instructions API](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples)\n * > for more information.\n *\n */\n instructions: SubscribableSignalLike;\n\n /**\n * The metafields requested in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration)\n * file. These metafields are updated when there's a change in the merchandise items\n * being purchased by the customer.\n *\n * App owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` isn't supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n appMetafields: SubscribableSignalLike;\n\n /**\n * The custom key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as\n * credit cards, wallets, and local payment methods. The list depends on\n * the shop's payment configuration and the buyer's region.\n *\n * The set of payment options can change when the buyer updates their\n * address or cart, so subscribe to changes rather than reading once\n * during initialization. Each option exposes `handle` and `type` only.\n * Provider names, logos, fees, and installment terms aren't available.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n buyerIdentity?: BuyerIdentity;\n\n /**\n * Provides details on the buyer's progression through the checkout and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/buyer-journey#examples)\n * examples for more information.\n */\n buyerJourney: BuyerJourney;\n\n /**\n * Settings applied to the buyer's checkout.\n */\n checkoutSettings: SubscribableSignalLike;\n\n /**\n * A stable ID that represents the current checkout.\n *\n * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\n *\n * This matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data)\n * and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n *\n * Can be `undefined`. Handle the `undefined` state before using the value.\n */\n checkoutToken: SubscribableSignalLike;\n\n /**\n * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n *\n * Empty until the buyer enters enough address information for Shopify to\n * calculate shipping rates.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * Metadata about the running extension, including the current target, API version,\n * capabilities, and editor context. Use this to conditionally render content\n * based on where the extension is running.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n *\n * @deprecated Use `extension.target` instead.\n */\n extensionPoint: Target;\n\n /**\n * Utilities for translating strings, formatting currencies, numbers, and dates\n * according to the buyer's locale. Use alongside\n * [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization)\n * to build fully localized extensions.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The buyer's language, country, currency, and timezone context. For\n * formatting and translation helpers, use the\n * [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#properties-propertydetail-i18n)\n * object instead.\n */\n localization: Localization;\n\n /**\n * The metafields that apply to the current checkout.\n *\n * Metafields are stored locally on the client and are applied to the order object after the checkout completes.\n *\n * These metafields are shared by all extensions running on checkout, and\n * persist for as long as the customer is working on this checkout.\n *\n * Once the order is created, you can query these metafields using the\n * [GraphQL Admin API](/docs/admin-api/graphql/reference/orders/order#metafield-2021-01)\n *\n * > Caution:\n * `metafields` is deprecated. Use `appMetafields` with cart metafields instead.\n *\n * @deprecated Use `appMetafields` with cart metafields instead.\n */\n metafields: SubscribableSignalLike;\n\n /**\n * A note left by the customer to the merchant, either in their cart or during checkout.\n *\n * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\n */\n note: SubscribableSignalLike;\n\n /**\n * The method used to query the Storefront GraphQL API with a prefetched token.\n *\n */\n query: >(\n query: string,\n options?: {variables?: Variables; version?: StorefrontApiVersion},\n ) => Promise<{data?: Data; errors?: GraphQLError[]}>;\n\n /**\n * The payment options the buyer has currently selected. This updates as\n * the buyer changes their payment method. The array can contain multiple\n * entries when the buyer splits payment across methods (for example, a\n * gift card and a credit card).\n *\n * Each option exposes `handle` and `type` only. Provider names, logos,\n * fees, and installment terms aren't available.\n */\n selectedPaymentOptions: SubscribableSignalLike;\n\n /**\n * The session token providing a set of claims as a signed JSON Web Token (JWT).\n *\n * The token has a TTL of five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Learn more about [session tokens](/docs/apps/build/authentication-authorization/session-tokens).\n */\n sessionToken: SessionToken;\n\n /**\n * The settings matching the settings definition written in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates in real time as a merchant fills in the settings.\n */\n settings: SubscribableSignalLike;\n\n /**\n * The proposed customer shipping address. During the information step, the address\n * updates when the field is committed (on change) rather than every keystroke.\n * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n shippingAddress?: SubscribableSignalLike;\n\n /**\n * The proposed customer billing address. The address updates when the field is\n * committed (on change) rather than every keystroke. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided yet.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n billingAddress?: SubscribableSignalLike;\n\n /**\n * The store where the checkout is taking place, including the shop name,\n * storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.\n */\n shop: Shop;\n\n /**\n * Key-value storage that persists across page loads within the current checkout\n * session. Data is shared across all activated targets associated with\n * this extension.\n *\n * > Caution: Data persistence isn't guaranteed and storage is cleared when the\n * buyer starts a new checkout.\n */\n storage: Storage;\n\n /**\n * The renderer version being used for the extension.\n *\n * @example '2025-10'\n */\n version: Version;\n\n /**\n * Customer privacy consent settings and a flag denoting if consent has previously been collected.\n */\n customerPrivacy: SubscribableSignalLike;\n\n /**\n * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`collect_buyer_consent` capability](/docs/apps/build/customer-accounts/capabilities#collect-buyer-consent) to be set to `true`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyTrackingConsentChange: ApplyTrackingConsentChangeType;\n\n /**\n * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" }, "Analytics": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Analytics", - "description": "", + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "publish", "value": "(name: string, data: Record) => Promise", - "description": "Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing)." + "description": "Publishes a custom event to [Web Pixels](/docs/apps/marketing). Returns `true` when the event is successfully dispatched.\n\nThe Promise resolves to `true` when the event was dispatched. The boolean indicates dispatch confirmation only. It doesn't indicate whether any specific web pixel processed the event." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "visitor", "value": "(data: { email?: string; phone?: string; }) => Promise", - "description": "A method for capturing details about a visitor on the online store." + "description": "Submits buyer contact details for attribution and analytics purposes." } ], - "value": "export interface Analytics {\n /**\n * Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing).\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * A method for capturing details about a visitor on the online store.\n */\n visitor(data: {email?: string; phone?: string}): Promise;\n}" + "value": "export interface Analytics {\n /**\n * Publishes a custom event to [Web Pixels](/docs/apps/marketing).\n * Returns `true` when the event is successfully dispatched.\n *\n * The Promise resolves to `true` when the event was dispatched. The boolean\n * indicates dispatch confirmation only. It doesn't indicate whether any\n * specific web pixel processed the event.\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * Submits buyer contact details for attribution and analytics purposes.\n */\n visitor(data: {email?: string; phone?: string}): Promise;\n}" }, "VisitorResult": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -67838,10 +67838,10 @@ "syntaxKind": "PropertySignature", "name": "type", "value": "'error'", - "description": "Indicates that the visitor information is invalid and wasn't submitted. Examples are using the wrong data type or missing a required property." + "description": "Indicates that the visitor information is invalid and wasn't submitted. Common causes include using the wrong data type or omitting a required property." } ], - "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Examples are using the wrong data type or missing a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Common causes include using the wrong data type or omitting a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" }, "SubscribableSignalLike": { "filePath": "src/surfaces/checkout/shared.ts", @@ -68055,10 +68055,10 @@ "syntaxKind": "PropertySignature", "name": "value", "value": "string | null", - "description": "The new value to store in the metafield. Set to `null` to delete the metafield." + "description": "The new value to store in the metafield. Set to `null` to delete the metafield.\n\nConsent metafield values are strings, not booleans. Pass `null` to delete a tracking consent metafield." } ], - "value": "export interface TrackingConsentMetafieldChange {\n /**\n * The identifier for the tracking consent metafield to update.\n */\n key: string;\n /**\n * The new value to store in the metafield. Set to `null` to delete the metafield.\n */\n value: string | null;\n}" + "value": "export interface TrackingConsentMetafieldChange {\n /**\n * The identifier for the tracking consent metafield to update.\n */\n key: string;\n /**\n * The new value to store in the metafield. Set to `null` to delete the metafield.\n *\n * Consent metafield values are strings, not booleans. Pass `null` to delete\n * a tracking consent metafield.\n */\n value: string | null;\n}" }, "VisitorConsent": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -68272,7 +68272,7 @@ "syntaxKind": "PropertySignature", "name": "value", "value": "string", - "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.", + "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.\n\nAttribute values are always strings. To store structured data, serialize it to JSON and parse it when reading.", "examples": [ { "title": "Example", @@ -68287,7 +68287,7 @@ ] } ], - "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" + "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * Attribute values are always strings. To store structured data, serialize\n * it to JSON and parse it when reading.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" }, "PaymentOption": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -68638,7 +68638,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A globally-unique identifier for the customer in the format `gid://shopify/Customer/`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", + "description": "An identifier for the customer in the format `gid://shopify/Customer/`. This value is unique per shop.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", "examples": [ { "title": "Example", @@ -68691,7 +68691,7 @@ "isPrivate": true } ], - "value": "export interface Customer {\n /**\n * A globally-unique identifier for the customer in the format `gid://shopify/Customer/`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'gid://shopify/Customer/123'\n */\n id: string;\n /**\n * The email address associated with the customer's account. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email?: string;\n /**\n * The phone number associated with the customer's account. The value is `undefined` if no phone number is on file or the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone?: string;\n /**\n * The customer's full name, typically a combination of first and last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n fullName?: string;\n /**\n * The customer's first name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n firstName?: string;\n /**\n * The customer's last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n lastName?: string;\n /**\n * The customer's profile image, such as a Gravatar avatar. Use this to personalize the extension UI for the logged-in buyer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n image: ImageDetails;\n /**\n * Whether the customer has opted in to receiving marketing communications from the merchant, such as email campaigns and promotional offers.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * > Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n *\n * @deprecated Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n */\n acceptsMarketing: boolean;\n /**\n * Whether the customer has opted in to email marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsEmailMarketing: boolean;\n /**\n * Whether the customer has opted in to SMS marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsSmsMarketing: boolean;\n /**\n * The store credit accounts owned by this customer that can be used as payment during checkout. Each account has a balance representing available store credit.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @private\n */\n storeCreditAccounts: StoreCreditAccount[];\n /**\n * The number of orders the customer has previously placed with this shop.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n ordersCount: number;\n}" + "value": "export interface Customer {\n /**\n * An identifier for the customer in the format `gid://shopify/Customer/`. This value is unique per shop.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'gid://shopify/Customer/123'\n */\n id: string;\n /**\n * The email address associated with the customer's account. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email?: string;\n /**\n * The phone number associated with the customer's account. The value is `undefined` if no phone number is on file or the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone?: string;\n /**\n * The customer's full name, typically a combination of first and last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n fullName?: string;\n /**\n * The customer's first name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n firstName?: string;\n /**\n * The customer's last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n lastName?: string;\n /**\n * The customer's profile image, such as a Gravatar avatar. Use this to personalize the extension UI for the logged-in buyer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n image: ImageDetails;\n /**\n * Whether the customer has opted in to receiving marketing communications from the merchant, such as email campaigns and promotional offers.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * > Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n *\n * @deprecated Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n */\n acceptsMarketing: boolean;\n /**\n * Whether the customer has opted in to email marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsEmailMarketing: boolean;\n /**\n * Whether the customer has opted in to SMS marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsSmsMarketing: boolean;\n /**\n * The store credit accounts owned by this customer that can be used as payment during checkout. Each account has a balance representing available store credit.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @private\n */\n storeCreditAccounts: StoreCreditAccount[];\n /**\n * The number of orders the customer has previously placed with this shop.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n ordersCount: number;\n}" }, "ImageDetails": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -68973,11 +68973,11 @@ "syntaxKind": "MethodSignature", "name": "perform", "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", + "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.\n\nRuns after all intercept results are collected. Use it for local state updates such as setting an error flag. By the time it runs, the navigation decision is final, so blocking logic belongs in the intercept handler itself, not here.", "isOptional": true } ], - "value": "interface InterceptorRequestAllow {\n /**\n * Indicates that the interceptor allows the buyer's journey to continue.\n */\n behavior: 'allow';\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" + "value": "interface InterceptorRequestAllow {\n /**\n * Indicates that the interceptor allows the buyer's journey to continue.\n */\n behavior: 'allow';\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n *\n * Runs after all intercept results are collected. Use it for local state\n * updates such as setting an error flag. By the time it runs, the navigation\n * decision is final, so blocking logic belongs in the intercept handler\n * itself, not here.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" }, "InterceptorResult": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -69041,7 +69041,7 @@ "syntaxKind": "MethodSignature", "name": "perform", "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", + "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.\n\nRuns after all intercept results are collected. Use it for local state updates such as setting an error flag. By the time it runs, the navigation decision is final, so blocking logic belongs in the intercept handler itself, not here.", "isOptional": true }, { @@ -69052,7 +69052,7 @@ "description": "The reason for blocking the interceptor request. This value isn't presented to the buyer, so it doesn't need to be localized. The value is used only for Shopify's own internal debugging and metrics." } ], - "value": "interface InterceptorRequestBlock {\n /**\n * Indicates that the interceptor blocks the buyer's journey from continuing.\n */\n behavior: 'block';\n\n /**\n * The reason for blocking the interceptor request. This value isn't presented to\n * the buyer, so it doesn't need to be localized. The value is used only for Shopify's\n * own internal debugging and metrics.\n */\n reason: string;\n\n /**\n * Used to pass errors to the checkout UI, outside your extension's UI boundaries.\n */\n errors?: ValidationError[];\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" + "value": "interface InterceptorRequestBlock {\n /**\n * Indicates that the interceptor blocks the buyer's journey from continuing.\n */\n behavior: 'block';\n\n /**\n * The reason for blocking the interceptor request. This value isn't presented to\n * the buyer, so it doesn't need to be localized. The value is used only for Shopify's\n * own internal debugging and metrics.\n */\n reason: string;\n\n /**\n * Used to pass errors to the checkout UI, outside your extension's UI boundaries.\n */\n errors?: ValidationError[];\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n *\n * Runs after all intercept results are collected. Use it for local state\n * updates such as setting an error flag. By the time it runs, the navigation\n * decision is final, so blocking logic belongs in the intercept handler\n * itself, not here.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" }, "ValidationError": { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -69273,17 +69273,17 @@ "syntaxKind": "PropertySignature", "name": "totalShippingAmount", "value": "SubscribableSignalLike", - "description": "The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step." + "description": "The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step.\n\n`undefined` until the buyer selects a shipping method (typically after the information step)." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "totalTaxAmount", "value": "SubscribableSignalLike", - "description": "The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet." + "description": "The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet.\n\n`undefined` when taxes haven't been calculated or aren't available for the buyer's region." } ], - "value": "export interface CartCost {\n /**\n * The sum of all line item prices at the current step of checkout, before shipping and taxes are applied. Use this value to display the base cost of the items the buyer purchased.\n */\n subtotalAmount: SubscribableSignalLike;\n\n /**\n * The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step.\n */\n totalShippingAmount: SubscribableSignalLike;\n\n /**\n * The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet.\n */\n totalTaxAmount: SubscribableSignalLike;\n\n /**\n * The minimum total at the current step of checkout. Costs not yet calculated, such as shipping on the information step, aren't included. Gift cards and store credits are excluded from this total.\n */\n totalAmount: SubscribableSignalLike;\n}" + "value": "export interface CartCost {\n /**\n * The sum of all line item prices at the current step of checkout, before shipping and taxes are applied. Use this value to display the base cost of the items the buyer purchased.\n */\n subtotalAmount: SubscribableSignalLike;\n\n /**\n * The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step.\n *\n * `undefined` until the buyer selects a shipping method (typically after the\n * information step).\n */\n totalShippingAmount: SubscribableSignalLike;\n\n /**\n * The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet.\n *\n * `undefined` when taxes haven't been calculated or aren't available for the\n * buyer's region.\n */\n totalTaxAmount: SubscribableSignalLike;\n\n /**\n * The minimum total at the current step of checkout. Costs not yet calculated, such as shipping on the information step, aren't included. Gift cards and store credits are excluded from this total.\n */\n totalAmount: SubscribableSignalLike;\n}" }, "CustomerPrivacy": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -69370,31 +69370,31 @@ "syntaxKind": "PropertySignature", "name": "analytics", "value": "boolean", - "description": "Whether analytics data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Analytics data includes how the shop was used and what interactions occurred." + "description": "Whether analytics data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Analytics data includes how the shop was used and what interactions occurred.\n\nWhether analytics data can be collected right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.analytics`, before calling `shopify.analytics.publish()`." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "marketing", "value": "boolean", - "description": "Whether marketing data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Marketing data includes attribution and targeted advertising preferences." + "description": "Whether marketing data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Marketing data includes attribution and targeted advertising preferences.\n\nWhether marketing data can be collected right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.marketing`, before performing marketing-related data collection." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "preferences", "value": "boolean", - "description": "Whether preference data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Preference data includes language, currency, and sizing choices." + "description": "Whether preference data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Preference data includes language, currency, and sizing choices.\n\nWhether preference data can be collected right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.preferences`, before storing or reading buyer preference data." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "saleOfData", "value": "boolean", - "description": "Whether data can be shared with third parties based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. This typically applies to behavioral advertising data." + "description": "Whether data can be shared with third parties based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. This typically applies to behavioral advertising data.\n\nWhether buyer data can be shared with or sold to third parties right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.saleOfData`, before sharing or selling buyer data with third parties." } ], - "value": "export interface AllowedProcessing {\n /**\n * Whether analytics data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Analytics\n * data includes how the shop was used and what interactions occurred.\n */\n analytics: boolean;\n /**\n * Whether marketing data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Marketing\n * data includes attribution and targeted advertising preferences.\n */\n marketing: boolean;\n /**\n * Whether preference data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Preference\n * data includes language, currency, and sizing choices.\n */\n preferences: boolean;\n /**\n * Whether data can be shared with third parties based on the visitor's\n * consent, the merchant's privacy configuration, and the visitor's region.\n * This typically applies to behavioral advertising data.\n */\n saleOfData: boolean;\n}" + "value": "export interface AllowedProcessing {\n /**\n * Whether analytics data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Analytics\n * data includes how the shop was used and what interactions occurred.\n *\n * Whether analytics data can be collected right now. Combines the buyer's\n * consent, the merchant's privacy configuration, and the buyer's region into\n * a single boolean. Check this flag, not `visitorConsent.analytics`, before\n * calling `shopify.analytics.publish()`.\n */\n analytics: boolean;\n /**\n * Whether marketing data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Marketing\n * data includes attribution and targeted advertising preferences.\n *\n * Whether marketing data can be collected right now. Combines the buyer's\n * consent, the merchant's privacy configuration, and the buyer's region into\n * a single boolean. Check this flag, not `visitorConsent.marketing`, before\n * performing marketing-related data collection.\n */\n marketing: boolean;\n /**\n * Whether preference data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Preference\n * data includes language, currency, and sizing choices.\n *\n * Whether preference data can be collected right now. Combines the buyer's\n * consent, the merchant's privacy configuration, and the buyer's region into\n * a single boolean. Check this flag, not `visitorConsent.preferences`,\n * before storing or reading buyer preference data.\n */\n preferences: boolean;\n /**\n * Whether data can be shared with third parties based on the visitor's\n * consent, the merchant's privacy configuration, and the visitor's region.\n * This typically applies to behavioral advertising data.\n *\n * Whether buyer data can be shared with or sold to third parties right now.\n * Combines the buyer's consent, the merchant's privacy configuration, and\n * the buyer's region into a single boolean. Check this flag, not\n * `visitorConsent.saleOfData`, before sharing or selling buyer data with\n * third parties.\n */\n saleOfData: boolean;\n}" }, "TrackingConsentMetafield": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -70086,7 +70086,7 @@ "Extension": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Extension", - "description": "The meta information about an extension target.", + "description": "Metadata about the running extension, including its API version, target, capabilities, and editor context. Use this to read configuration details or conditionally render content based on where the extension is running.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -70112,7 +70112,7 @@ "syntaxKind": "PropertySignature", "name": "capabilities", "value": "SubscribableSignalLike", - "description": "The allowed capabilities of the extension, defined in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n\n* [`api_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#api-access): the extension can access the Storefront API.\n\n* [`network_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access): the extension can make external network calls.\n\n* [`block_progress`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n\n* [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n\n* [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can register customer consent decisions that are honored on Shopify-managed services.\n\n* [`iframe.sources`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#iframe): the extension can embed an external URL in an iframe." + "description": "The allowed capabilities of the extension, defined in your [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -70160,7 +70160,7 @@ "syntaxKind": "PropertySignature", "name": "version", "value": "string", - "description": "The published version of the running extension target.\n\nFor unpublished extensions, the value is `undefined`.", + "description": "The published version of the running extension target.\n\nFor unpublished extensions, the value is `undefined`.\n\nDon't use this property as a stable identifier in development environments. It becomes available only after the extension is published.", "isOptional": true, "examples": [ { @@ -70176,7 +70176,7 @@ ] } ], - "value": "export interface Extension {\n /**\n * The API version that was set in the extension config file.\n *\n * @example '2024-10', '2025-01', '2025-04', '2025-07', '2025-10'\n */\n apiVersion: ApiVersion;\n\n /**\n * The allowed capabilities of the extension, defined\n * in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n *\n * * [`api_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#api-access): the extension can access the Storefront API.\n *\n * * [`network_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access): the extension can make external network calls.\n *\n * * [`block_progress`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n *\n * * [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n *\n * * [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can register customer consent decisions that are honored on Shopify-managed services.\n *\n * * [`iframe.sources`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#iframe): the extension can embed an external URL in an iframe.\n */\n capabilities: SubscribableSignalLike;\n\n /**\n * Information about the editor where the extension is being rendered.\n *\n * If the value is undefined, then the extension isn't running in an editor.\n */\n editor?: Editor;\n\n /**\n * A Boolean to show whether your extension is currently rendered to the screen.\n *\n * Shopify might render your extension before it's visible in the UI,\n * typically to pre-render extensions that appear on a later step of the\n * checkout.\n *\n * Your extension might also continue to run after the customer has navigated away\n * from where it was rendered. The extension continues running so that\n * your extension is immediately available to render if the customer navigates back.\n */\n rendered: SubscribableSignalLike;\n\n /**\n * The URL to the script that started the extension target.\n */\n scriptUrl: string;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n */\n target: Target;\n\n /**\n * The published version of the running extension target.\n *\n * For unpublished extensions, the value is `undefined`.\n *\n * @example 3.0.10\n */\n version?: string;\n}" + "value": "export interface Extension {\n /**\n * The API version that was set in the extension config file.\n *\n * @example '2024-10', '2025-01', '2025-04', '2025-07', '2025-10'\n */\n apiVersion: ApiVersion;\n\n /**\n * The allowed capabilities of the extension, defined in your\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n */\n capabilities: SubscribableSignalLike;\n\n /**\n * Information about the editor where the extension is being rendered.\n *\n * If the value is undefined, then the extension isn't running in an editor.\n */\n editor?: Editor;\n\n /**\n * A Boolean to show whether your extension is currently rendered to the screen.\n *\n * Shopify might render your extension before it's visible in the UI,\n * typically to pre-render extensions that appear on a later step of the\n * checkout.\n *\n * Your extension might also continue to run after the customer has navigated away\n * from where it was rendered. The extension continues running so that\n * your extension is immediately available to render if the customer navigates back.\n */\n rendered: SubscribableSignalLike;\n\n /**\n * The URL to the script that started the extension target.\n */\n scriptUrl: string;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n */\n target: Target;\n\n /**\n * The published version of the running extension target.\n *\n * For unpublished extensions, the value is `undefined`.\n *\n * Don't use this property as a stable identifier in development environments.\n * It becomes available only after the extension is published.\n *\n * @example 3.0.10\n */\n version?: string;\n}" }, "ApiVersion": { "filePath": "src/shared.ts", @@ -70195,7 +70195,7 @@ "Editor": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Editor", - "description": "", + "description": "Information about the editor environment when an extension is rendered inside the checkout editor. The value is `undefined` when the extension is not rendering in an editor.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -70210,7 +70210,7 @@ "I18n": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18n", - "description": "", + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use the I18n API alongside the Localization API to build fully localized extensions.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -70246,7 +70246,7 @@ "I18nTranslate": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18nTranslate", - "description": "This returns a translated string matching a key in a locale file.", + "description": "Translates a key from your extension's locale files into a localized string. Supports interpolation with placeholder replacements and pluralization via the special `count` option.", "members": [], "value": "export interface I18nTranslate {\n (\n key: string,\n options?: Record,\n ): ReplacementType extends string | number\n ? string\n : (string | ReplacementType)[];\n}" }, @@ -70810,14 +70810,14 @@ "Localization": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Localization", - "description": "", + "description": "The buyer's language, country, currency, and timezone context. Use this to adapt your extension to the buyer's region and display localized content.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "country", "value": "SubscribableSignalLike", - "description": "The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown." + "description": "The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n\nDerived from the buyer's shipping address. Returns `undefined` until the buyer enters a shipping address." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -70845,18 +70845,18 @@ "syntaxKind": "PropertySignature", "name": "market", "value": "SubscribableSignalLike", - "description": "The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n\n> Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.", - "deprecationMessage": "Deprecated as of version `2025-04`" + "description": "The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. The market context updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.", + "deprecationMessage": "Merchants now manage which extensions load for each\nmarket, so extensions no longer need to check this value." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "timezone", "value": "SubscribableSignalLike", - "description": "The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time." + "description": "The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time." } ], - "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n *\n * > Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" + "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n *\n * Derived from the buyer's shipping address. Returns `undefined` until the\n * buyer enters a shipping address.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout,\n * carried over from the cart context. Markets group countries and\n * regions with shared pricing, languages, and domains. The market\n * context updates when the buyer changes the country of their\n * shipping address. The value is `undefined` if the market is unknown.\n *\n * @deprecated Merchants now manage which extensions load for each\n * market, so extensions no longer need to check this value.\n */\n market: SubscribableSignalLike;\n}" }, "Country": { "filePath": "src/shared.ts", @@ -71057,7 +71057,7 @@ "SessionToken": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SessionToken", - "description": "", + "description": "Authenticates requests between your extension and your app backend. Use session tokens to verify the identity of the buyer and the shop context when making server-side API calls. The token is a signed JWT that contains claims such as the customer ID, shop domain, and expiration.\n\nThe `sub` claim in the decoded token is present only when the buyer is logged in and the app has permission to read customer accounts. Absent for anonymous buyers.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -71316,7 +71316,7 @@ "Shop": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Shop", - "description": "", + "description": "Metadata about the merchant's store, including its name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -71356,30 +71356,30 @@ "syntaxKind": "PropertySignature", "name": "storefrontUrl", "value": "string", - "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n\n> Caution: > As of version `2024-04` this value no longer has a trailing slash.", + "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.", "isOptional": true } ], - "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n *\n * > Caution:\n * > As of version `2024-04` this value no longer has a trailing slash.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom domain.\n */\n myshopifyDomain: string;\n}" + "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom domain.\n */\n myshopifyDomain: string;\n}" }, "Storage": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Storage", - "description": "A key-value storage object for the extension.\n\nStored data is available only to this specific extension and any of its instances.\n\nThe storage backend is implemented with `localStorage` and should persist across the buyer's checkout session. However, data persistence isn't guaranteed.", + "description": "Key-value storage for a specific extension. Use storage to save preferences or cached data that should survive page reloads without requiring a backend call. Stored data is only available to this specific extension. The storage backend is implemented with `localStorage` and data persistence isn't guaranteed.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "delete", "value": "(key: string) => Promise", - "description": "Delete stored data by key." + "description": "Deletes a previously stored value by key." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "read", "value": "(key: string) => Promise", - "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original primitive.\n\nReturns `null` if no stored data exists." + "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original type.\n\nReturns the stored value for the given key, or `null` when no value exists. Doesn't throw on a missing key." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -71389,7 +71389,7 @@ "description": "Write stored data for this key.\n\nThe data must be serializable to JSON." } ], - "value": "export interface Storage {\n /**\n * Read and return a stored value by key.\n *\n * The stored data is deserialized from JSON and returned as\n * its original primitive.\n *\n * Returns `null` if no stored data exists.\n */\n read(key: string): Promise;\n\n /**\n * Write stored data for this key.\n *\n * The data must be serializable to JSON.\n */\n write(key: string, data: any): Promise;\n\n /**\n * Delete stored data by key.\n */\n delete(key: string): Promise;\n}" + "value": "export interface Storage {\n /**\n * Read and return a stored value by key.\n *\n * The stored data is deserialized from JSON and returned as\n * its original type.\n *\n * Returns the stored value for the given key, or `null` when no value\n * exists. Doesn't throw on a missing key.\n */\n read(key: string): Promise;\n\n /**\n * Write stored data for this key.\n *\n * The data must be serializable to JSON.\n */\n write(key: string, data: any): Promise;\n\n /**\n * Deletes a previously stored value by key.\n */\n delete(key: string): Promise;\n}" }, "Version": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -71465,7 +71465,7 @@ "syntaxKind": "MethodSignature", "name": "applyAttributeChange", "value": "(change: AttributeChange) => Promise", - "description": "Updates or removes an attribute on the cart and checkout. On success, the [`attributes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/attributes#standardapi-propertydetail-attributes) property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.", + "description": "Updates or removes an attribute on the cart and checkout. On success, the [`attributes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/attributes#properties-propertydetail-attributes) property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.", "deprecationMessage": "Use cart metafields instead." }, { @@ -71473,42 +71473,42 @@ "syntaxKind": "MethodSignature", "name": "applyCartLinesChange", "value": "(change: CartLineChange) => Promise", - "description": "Adds, removes, or updates line items in the cart. The returned promise resolves when the change has been applied by the server, and the [`lines`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-lines#standardapi-propertydetail-lines) property updates with the new state.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Adds, removes, or updates line items in the cart. The returned promise resolves when the change has been applied by the server, and the [`lines`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-lines#properties-propertydetail-lines) property updates with the new state.\n\nAccepts a single change per call. To make multiple changes, call this method separately for each one.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyDiscountCodeChange", "value": "(change: DiscountCodeChange) => Promise", - "description": "Adds or removes a discount code on the checkout. The returned promise resolves when the change has been applied by the server, and the [`discountCodes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/discounts#standardapi-propertydetail-discountcodes) property updates with the new state.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves discount codes through a network call.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Adds or removes a discount code on the checkout. The returned promise resolves when the change has been applied by the server, and the [`discountCodes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/discounts#properties-propertydetail-discountcodes) property updates with the new state.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves discount codes through a network call.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyGiftCardChange", "value": "(change: GiftCardChange) => Promise", - "description": "Adds or removes a gift card from the checkout. The returned promise resolves when the change has been applied by the server, and the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/gift-cards#standardapi-propertydetail-appliedgiftcards) property updates with the new state.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves gift card codes through a network call.\n\n> Note: This method returns an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Adds or removes a gift card from the checkout. The returned promise resolves when the change has been applied by the server, and the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/gift-cards#properties-propertydetail-appliedgiftcards) property updates with the new state.\n\nUnlike other write operations, gift card changes aren't gated by a cart instruction flag.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves gift card codes through a network call.\n\n> Note: This method returns an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyMetafieldChange", "value": "(change: MetafieldChange) => Promise", - "description": "Creates, updates, or removes a cart metafield on the checkout. On success, the [`metafields`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/metafields#standardapi-propertydetail-metafields) property updates to reflect the change.\n\nCart metafields are copied to order metafields at order creation time if there's a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n\n> Caution: `MetafieldRemoveChange` and `MetafieldUpdateChange` are deprecated. Use cart metafields with `MetafieldRemoveCartChange` and `MetafieldUpdateCartChange` instead. If `MetafieldUpdateChange` writes a metafield with the same namespace and key as a cart metafield that's configured to copy, the cart metafield won't be copied.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Creates, updates, or removes a cart metafield on the checkout. On success, the [`metafields`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/metafields#properties-propertydetail-metafields) property updates to reflect the change.\n\nCart metafields are copied to order metafields at order creation time if there's a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n\n> Caution: `MetafieldRemoveChange` and `MetafieldUpdateChange` are deprecated. Use cart metafields with `MetafieldRemoveCartChange` and `MetafieldUpdateCartChange` instead. If `MetafieldUpdateChange` writes a metafield with the same namespace and key as a cart metafield that's configured to copy, the cart metafield won't be copied.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyNoteChange", "value": "(change: NoteChange) => Promise", - "description": "Sets or removes the buyer's note on the checkout. On success, the [`note`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/note#standardapi-propertydetail-note) property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Sets or removes the buyer's note on the checkout. On success, the [`note`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/note#properties-propertydetail-note) property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyShippingAddressChange", "value": "(change: ShippingAddressUpdateChange) => Promise", - "description": "Updates the buyer's shipping address on the checkout. The provided fields are merged into the existing address without prompting the buyer. On success, the `shippingAddress` property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", + "description": "Updates the buyer's shipping address on the checkout. The provided fields are merged into the existing address without prompting the buyer. On success, the `shippingAddress` property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", "isOptional": true }, { @@ -71521,7 +71521,7 @@ "isPrivate": true } ], - "value": "export interface CheckoutApi {\n /**\n * Updates or removes an attribute on the cart and checkout. On success, the\n * [`attributes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/attributes#standardapi-propertydetail-attributes) property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * @deprecated Use cart metafields instead.\n */\n applyAttributeChange(change: AttributeChange): Promise;\n\n /**\n * Adds, removes, or updates line items in the cart. The returned promise resolves when the change has been applied by the server, and the [`lines`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-lines#standardapi-propertydetail-lines) property updates with the new state.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyCartLinesChange(change: CartLineChange): Promise;\n\n /**\n * Adds or removes a discount code on the checkout. The returned promise resolves when the change has been applied by the server, and the [`discountCodes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/discounts#standardapi-propertydetail-discountcodes) property updates with the new state.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves discount codes through a network call.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyDiscountCodeChange(\n change: DiscountCodeChange,\n ): Promise;\n\n /**\n * Adds or removes a gift card from the checkout. The returned promise resolves when the change has been applied by the server, and the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/gift-cards#standardapi-propertydetail-appliedgiftcards) property updates with the new state.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves gift card codes through a network call.\n *\n * > Note: This method returns an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyGiftCardChange(change: GiftCardChange): Promise;\n\n /**\n * Creates, updates, or removes a cart metafield on the checkout. On success, the\n * [`metafields`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/metafields#standardapi-propertydetail-metafields) property updates to reflect the change.\n *\n * Cart metafields are copied to order metafields at order creation time if there's a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n *\n * > Caution: `MetafieldRemoveChange` and `MetafieldUpdateChange` are deprecated. Use cart metafields with `MetafieldRemoveCartChange` and `MetafieldUpdateCartChange` instead. If `MetafieldUpdateChange` writes a metafield with the same namespace and key as a cart metafield that's configured to copy, the cart metafield won't be copied.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyMetafieldChange(change: MetafieldChange): Promise;\n\n /**\n * Sets or removes the buyer's note on the checkout. On success, the\n * [`note`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/note#standardapi-propertydetail-note)\n * property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyNoteChange(change: NoteChange): Promise;\n\n /**\n * @private\n */\n experimentalIsShopAppStyle?: boolean;\n\n /**\n * Updates the buyer's shipping address on the checkout. The provided fields\n * are merged into the existing address without prompting the buyer. On success,\n * the `shippingAddress` property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyShippingAddressChange?(\n change: ShippingAddressChange,\n ): Promise;\n}" + "value": "export interface CheckoutApi {\n /**\n * Updates or removes an attribute on the cart and checkout. On success, the\n * [`attributes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/attributes#properties-propertydetail-attributes) property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * @deprecated Use cart metafields instead.\n */\n applyAttributeChange(change: AttributeChange): Promise;\n\n /**\n * Adds, removes, or updates line items in the cart. The returned promise resolves when the change has been applied by the server, and the [`lines`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-lines#properties-propertydetail-lines) property updates with the new state.\n *\n * Accepts a single change per call. To make multiple changes, call this\n * method separately for each one.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyCartLinesChange(change: CartLineChange): Promise;\n\n /**\n * Adds or removes a discount code on the checkout. The returned promise resolves when the change has been applied by the server, and the [`discountCodes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/discounts#properties-propertydetail-discountcodes) property updates with the new state.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves discount codes through a network call.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyDiscountCodeChange(\n change: DiscountCodeChange,\n ): Promise;\n\n /**\n * Adds or removes a gift card from the checkout. The returned promise resolves when the change has been applied by the server, and the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/gift-cards#properties-propertydetail-appliedgiftcards) property updates with the new state.\n *\n * Unlike other write operations, gift card changes aren't gated by a cart\n * instruction flag.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves gift card codes through a network call.\n *\n * > Note: This method returns an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyGiftCardChange(change: GiftCardChange): Promise;\n\n /**\n * Creates, updates, or removes a cart metafield on the checkout. On success, the\n * [`metafields`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/metafields#properties-propertydetail-metafields) property updates to reflect the change.\n *\n * Cart metafields are copied to order metafields at order creation time if there's a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n *\n * > Caution: `MetafieldRemoveChange` and `MetafieldUpdateChange` are deprecated. Use cart metafields with `MetafieldRemoveCartChange` and `MetafieldUpdateCartChange` instead. If `MetafieldUpdateChange` writes a metafield with the same namespace and key as a cart metafield that's configured to copy, the cart metafield won't be copied.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyMetafieldChange(change: MetafieldChange): Promise;\n\n /**\n * Sets or removes the buyer's note on the checkout. On success, the\n * [`note`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/note#properties-propertydetail-note)\n * property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyNoteChange(change: NoteChange): Promise;\n\n /**\n * @private\n */\n experimentalIsShopAppStyle?: boolean;\n\n /**\n * Updates the buyer's shipping address on the checkout. The provided fields\n * are merged into the existing address without prompting the buyer. On success,\n * the `shippingAddress` property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyShippingAddressChange?(\n change: ShippingAddressChange,\n ): Promise;\n}" }, "AttributeChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -71588,7 +71588,7 @@ "syntaxKind": "PropertySignature", "name": "value", "value": "string", - "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.", + "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.\n\nAttribute values are always strings. To store structured data, serialize it to JSON and parse it when reading.", "examples": [ { "title": "Example", @@ -71603,7 +71603,7 @@ ] } ], - "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" + "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * Attribute values are always strings. To store structured data, serialize\n * it to JSON and parse it when reading.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" }, "AttributeRemoveChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -72456,7 +72456,7 @@ "syntaxKind": "PropertySignature", "name": "message", "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer." + "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer.\n\nRender your own localized error text rather than displaying this message to the buyer." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -72466,7 +72466,7 @@ "description": "Indicates that the line item wasn't changed successfully. Refer to the `message` property for details about the error." } ], - "value": "export interface CartLineChangeResultError {\n /**\n * Indicates that the line item wasn't changed successfully. Refer to the `message` property for details about the error.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface CartLineChangeResultError {\n /**\n * Indicates that the line item wasn't changed successfully. Refer to the `message` property for details about the error.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n *\n * Render your own localized error text rather than displaying this message\n * to the buyer.\n */\n message: string;\n}" }, "DiscountCodeChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -72646,7 +72646,7 @@ "syntaxKind": "PropertySignature", "name": "message", "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer." + "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer.\n\nRender your own localized error text rather than displaying this message to the buyer." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -72656,7 +72656,7 @@ "description": "Indicates that the gift card change couldn't be applied. Check the `message` property for details." } ], - "value": "export interface GiftCardChangeResultError {\n /**\n * Indicates that the gift card change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface GiftCardChangeResultError {\n /**\n * Indicates that the gift card change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n *\n * Render your own localized error text rather than displaying this message\n * to the buyer.\n */\n message: string;\n}" }, "MetafieldChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -72917,7 +72917,7 @@ "syntaxKind": "PropertySignature", "name": "message", "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer." + "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer.\n\nRender your own localized error text rather than displaying this message to the buyer." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -72927,7 +72927,7 @@ "description": "Indicates that the metafield change couldn't be applied. Check the `message` property for details." } ], - "value": "export interface MetafieldChangeResultError {\n /**\n * Indicates that the metafield change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface MetafieldChangeResultError {\n /**\n * Indicates that the metafield change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n *\n * Render your own localized error text rather than displaying this message\n * to the buyer.\n */\n message: string;\n}" }, "NoteChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -73005,7 +73005,7 @@ "syntaxKind": "PropertySignature", "name": "message", "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer." + "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer.\n\nRender your own localized error text rather than displaying this message to the buyer." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -73015,7 +73015,7 @@ "description": "Indicates that the note change couldn't be applied. Check the `message` property for details." } ], - "value": "export interface NoteChangeResultError {\n /**\n * Indicates that the note change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface NoteChangeResultError {\n /**\n * Indicates that the note change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n *\n * Render your own localized error text rather than displaying this message\n * to the buyer.\n */\n message: string;\n}" }, "ShippingAddressUpdateChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -73601,7 +73601,7 @@ "syntaxKind": "PropertySignature", "name": "analytics", "value": "Analytics", - "description": "The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event." + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -73615,7 +73615,7 @@ "syntaxKind": "PropertySignature", "name": "applyTrackingConsentChange", "value": "ApplyTrackingConsentChangeType", - "description": "Enables setting and updating customer privacy consent settings and tracking consent metafields.\n\n> Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent) to be set to `true`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." + "description": "Enables setting and updating customer privacy consent settings and tracking consent metafields.\n\n> Note: Requires the [`collect_buyer_consent` capability](/docs/apps/build/customer-accounts/capabilities#collect-buyer-consent) to be set to `true`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -73636,7 +73636,7 @@ "syntaxKind": "PropertySignature", "name": "availablePaymentOptions", "value": "SubscribableSignalLike", - "description": "All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region." + "description": "All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n\nThe set of payment options can change when the buyer updates their address or cart, so subscribe to changes rather than reading once during initialization. Each option exposes `handle` and `type` only. Provider names, logos, fees, and installment terms aren't available." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -73673,7 +73673,7 @@ "syntaxKind": "PropertySignature", "name": "checkoutToken", "value": "SubscribableSignalLike", - "description": "A stable ID that represents the current checkout.\n\nThe value is `undefined` when the checkout hasn't been created on the server yet.\n\nUse this to correlate checkout sessions across your extension, web pixels, and backend systems.\n\nThis matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data) and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object)." + "description": "A stable ID that represents the current checkout.\n\nThe value is `undefined` when the checkout hasn't been created on the server yet.\n\nUse this to correlate checkout sessions across your extension, web pixels, and backend systems.\n\nThis matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data) and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n\nCan be `undefined`. Handle the `undefined` state before using the value." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -73694,7 +73694,7 @@ "syntaxKind": "PropertySignature", "name": "deliveryGroups", "value": "SubscribableSignalLike", - "description": "The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items." + "description": "The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n\nEmpty until the buyer enters enough address information for Shopify to calculate shipping rates." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -73715,7 +73715,7 @@ "syntaxKind": "PropertySignature", "name": "extension", "value": "Extension", - "description": "The meta information about the extension." + "description": "Metadata about the running extension, including the current target, API version, capabilities, and editor context. Use this to conditionally render content based on where the extension is running." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -73723,7 +73723,7 @@ "name": "extensionPoint", "value": "Target", "description": "The identifier that specifies where in Shopify's UI your code is being injected. This is one of the targets you've included in your extension's configuration file.", - "deprecationMessage": "Deprecated as of version `2023-07`, use `extension.target` instead.", + "deprecationMessage": "Use `extension.target` instead.", "examples": [ { "title": "Example", @@ -73742,14 +73742,14 @@ "syntaxKind": "PropertySignature", "name": "i18n", "value": "I18n", - "description": "Utilities for translating content and formatting values according to the current [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) of the checkout.\n\nRefer to [`localization` examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples) for more information." + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use alongside [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) to build fully localized extensions." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "instructions", "value": "SubscribableSignalLike", - "description": "The cart instructions used to create the checkout and possibly limit extension capabilities.\n\nThese instructions should be checked before performing any actions that might be affected by them.\n\nFor example, if you intend to add a discount code via the `applyDiscountCodeChange` method, check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n\n> Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs aren't available. See the [update guide](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples) for more information." + "description": "The cart instructions used to create the checkout and possibly limit extension capabilities.\n\nThese instructions should be checked before performing any actions that might be affected by them.\n\nFor example, if you intend to add a discount code via the `applyDiscountCodeChange` method, check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n\n> Caution: Check cart instructions before calling select APIs, as > some may not be available. See the > [Cart Instructions API](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples) > for more information." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -73763,7 +73763,7 @@ "syntaxKind": "PropertySignature", "name": "localization", "value": "Localization", - "description": "The details about the location, language, and currency of the customer. For utilities to easily format and translate content based on these details, you can use the [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n) object instead." + "description": "The buyer's language, country, currency, and timezone context. For formatting and translation helpers, use the [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#properties-propertydetail-i18n) object instead." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -73793,21 +73793,21 @@ "syntaxKind": "PropertySignature", "name": "query", "value": ">(query: string, options?: { variables?: Variables; version?: StorefrontApiVersion; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>", - "description": "The method used to query the Storefront GraphQL API with a prefetched token.\n\nRefer to [Storefront API access examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/storefront-api) for more information." + "description": "The method used to query the Storefront GraphQL API with a prefetched token." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "selectedPaymentOptions", "value": "SubscribableSignalLike", - "description": "The payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card)." + "description": "The payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\n\nEach option exposes `handle` and `type` only. Provider names, logos, fees, and installment terms aren't available." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "sessionToken", "value": "SessionToken", - "description": "The session token providing a set of claims as a signed JSON Web Token (JWT).\n\nThe token has a TTL of five minutes.\n\nIf the previous token expires, this value reflects a new session token with a new signature and expiry.\n\nRefer to [session token examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/session-token) for more information." + "description": "The session token providing a set of claims as a signed JSON Web Token (JWT).\n\nThe token has a TTL of five minutes.\n\nIf the previous token expires, this value reflects a new session token with a new signature and expiry.\n\nLearn more about [session tokens](/docs/apps/build/authentication-authorization/session-tokens)." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -73829,14 +73829,14 @@ "syntaxKind": "PropertySignature", "name": "shop", "value": "Shop", - "description": "The shop where the checkout is taking place." + "description": "The store where the checkout is taking place, including the shop name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "storage", "value": "Storage", - "description": "The key-value storage for the extension.\n\nIt uses `localStorage` and should persist across the customer's current checkout session.\n\n> Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n\nData is shared across all activated extension targets of this extension. In versions 2023-07 and earlier, each activated extension target had its own storage." + "description": "Key-value storage that persists across page loads within the current checkout session. Data is shared across all activated targets associated with this extension.\n\n> Caution: Data persistence isn't guaranteed and storage is cleared when the buyer starts a new checkout." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -73858,29 +73858,29 @@ ] } ], - "value": "export interface StandardApi {\n /**\n * The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event.\n */\n analytics: Analytics;\n\n /**\n * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\n */\n appliedGiftCards: SubscribableSignalLike;\n\n /**\n * The cart instructions used to create the checkout and possibly limit extension capabilities.\n *\n * These instructions should be checked before performing any actions that might be affected by them.\n *\n * For example, if you intend to add a discount code via the `applyDiscountCodeChange` method,\n * check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n *\n * > Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs aren't available.\n * See the [update guide](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples) for more information.\n *\n */\n instructions: SubscribableSignalLike;\n\n /**\n * The metafields requested in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration)\n * file. These metafields are updated when there's a change in the merchandise items\n * being purchased by the customer.\n *\n * App owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` isn't supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n appMetafields: SubscribableSignalLike;\n\n /**\n * The custom key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n buyerIdentity?: BuyerIdentity;\n\n /**\n * Provides details on the buyer's progression through the checkout and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/buyer-journey#examples)\n * examples for more information.\n */\n buyerJourney: BuyerJourney;\n\n /**\n * Settings applied to the buyer's checkout.\n */\n checkoutSettings: SubscribableSignalLike;\n\n /**\n * A stable ID that represents the current checkout.\n *\n * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\n *\n * This matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data)\n * and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n */\n checkoutToken: SubscribableSignalLike;\n\n /**\n * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * The meta information about the extension.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n *\n * @deprecated Deprecated as of version `2023-07`, use `extension.target` instead.\n */\n extensionPoint: Target;\n\n /**\n * Utilities for translating content and formatting values according to the current\n * [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization)\n * of the checkout.\n *\n * Refer to [`localization` examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples)\n * for more information.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The details about the location, language, and currency of the customer. For utilities to easily\n * format and translate content based on these details, you can use the\n * [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n)\n * object instead.\n */\n localization: Localization;\n\n /**\n * The metafields that apply to the current checkout.\n *\n * Metafields are stored locally on the client and are applied to the order object after the checkout completes.\n *\n * These metafields are shared by all extensions running on checkout, and\n * persist for as long as the customer is working on this checkout.\n *\n * Once the order is created, you can query these metafields using the\n * [GraphQL Admin API](/docs/admin-api/graphql/reference/orders/order#metafield-2021-01)\n *\n * > Caution:\n * `metafields` is deprecated. Use `appMetafields` with cart metafields instead.\n *\n * @deprecated Use `appMetafields` with cart metafields instead.\n */\n metafields: SubscribableSignalLike;\n\n /**\n * A note left by the customer to the merchant, either in their cart or during checkout.\n *\n * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\n */\n note: SubscribableSignalLike;\n\n /**\n * The method used to query the Storefront GraphQL API with a prefetched token.\n *\n * Refer to [Storefront API access examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/storefront-api) for more information.\n */\n query: >(\n query: string,\n options?: {variables?: Variables; version?: StorefrontApiVersion},\n ) => Promise<{data?: Data; errors?: GraphQLError[]}>;\n\n /**\n * The payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\n */\n selectedPaymentOptions: SubscribableSignalLike;\n\n /**\n * The session token providing a set of claims as a signed JSON Web Token (JWT).\n *\n * The token has a TTL of five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/session-token) for more information.\n */\n sessionToken: SessionToken;\n\n /**\n * The settings matching the settings definition written in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates in real time as a merchant fills in the settings.\n */\n settings: SubscribableSignalLike;\n\n /**\n * The proposed customer shipping address. During the information step, the address\n * updates when the field is committed (on change) rather than every keystroke.\n * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n shippingAddress?: SubscribableSignalLike;\n\n /**\n * The proposed customer billing address. The address updates when the field is\n * committed (on change) rather than every keystroke. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided yet.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n billingAddress?: SubscribableSignalLike;\n\n /** The shop where the checkout is taking place. */\n shop: Shop;\n\n /**\n * The key-value storage for the extension.\n *\n * It uses `localStorage` and should persist across the customer's current checkout session.\n *\n * > Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n *\n * Data is shared across all activated extension targets of this extension. In versions 2023-07 and earlier,\n * each activated extension target had its own storage.\n */\n storage: Storage;\n\n /**\n * The renderer version being used for the extension.\n *\n * @example '2025-10'\n */\n version: Version;\n\n /**\n * Customer privacy consent settings and a flag denoting if consent has previously been collected.\n */\n customerPrivacy: SubscribableSignalLike;\n\n /**\n * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent) to be set to `true`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyTrackingConsentChange: ApplyTrackingConsentChangeType;\n\n /**\n * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" + "value": "export interface StandardApi {\n /**\n * Tracks custom events and sends visitor information to\n * [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events\n * and `visitor()` to submit buyer contact details.\n */\n analytics: Analytics;\n\n /**\n * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\n */\n appliedGiftCards: SubscribableSignalLike;\n\n /**\n * The cart instructions used to create the checkout and possibly limit extension capabilities.\n *\n * These instructions should be checked before performing any actions that might be affected by them.\n *\n * For example, if you intend to add a discount code via the `applyDiscountCodeChange` method,\n * check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n *\n * > Caution: Check cart instructions before calling select APIs, as\n * > some may not be available. See the\n * > [Cart Instructions API](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples)\n * > for more information.\n *\n */\n instructions: SubscribableSignalLike;\n\n /**\n * The metafields requested in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration)\n * file. These metafields are updated when there's a change in the merchandise items\n * being purchased by the customer.\n *\n * App owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` isn't supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n appMetafields: SubscribableSignalLike;\n\n /**\n * The custom key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as\n * credit cards, wallets, and local payment methods. The list depends on\n * the shop's payment configuration and the buyer's region.\n *\n * The set of payment options can change when the buyer updates their\n * address or cart, so subscribe to changes rather than reading once\n * during initialization. Each option exposes `handle` and `type` only.\n * Provider names, logos, fees, and installment terms aren't available.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n buyerIdentity?: BuyerIdentity;\n\n /**\n * Provides details on the buyer's progression through the checkout and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/buyer-journey#examples)\n * examples for more information.\n */\n buyerJourney: BuyerJourney;\n\n /**\n * Settings applied to the buyer's checkout.\n */\n checkoutSettings: SubscribableSignalLike;\n\n /**\n * A stable ID that represents the current checkout.\n *\n * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\n *\n * This matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data)\n * and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n *\n * Can be `undefined`. Handle the `undefined` state before using the value.\n */\n checkoutToken: SubscribableSignalLike;\n\n /**\n * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n *\n * Empty until the buyer enters enough address information for Shopify to\n * calculate shipping rates.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * Metadata about the running extension, including the current target, API version,\n * capabilities, and editor context. Use this to conditionally render content\n * based on where the extension is running.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n *\n * @deprecated Use `extension.target` instead.\n */\n extensionPoint: Target;\n\n /**\n * Utilities for translating strings, formatting currencies, numbers, and dates\n * according to the buyer's locale. Use alongside\n * [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization)\n * to build fully localized extensions.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The buyer's language, country, currency, and timezone context. For\n * formatting and translation helpers, use the\n * [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#properties-propertydetail-i18n)\n * object instead.\n */\n localization: Localization;\n\n /**\n * The metafields that apply to the current checkout.\n *\n * Metafields are stored locally on the client and are applied to the order object after the checkout completes.\n *\n * These metafields are shared by all extensions running on checkout, and\n * persist for as long as the customer is working on this checkout.\n *\n * Once the order is created, you can query these metafields using the\n * [GraphQL Admin API](/docs/admin-api/graphql/reference/orders/order#metafield-2021-01)\n *\n * > Caution:\n * `metafields` is deprecated. Use `appMetafields` with cart metafields instead.\n *\n * @deprecated Use `appMetafields` with cart metafields instead.\n */\n metafields: SubscribableSignalLike;\n\n /**\n * A note left by the customer to the merchant, either in their cart or during checkout.\n *\n * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\n */\n note: SubscribableSignalLike;\n\n /**\n * The method used to query the Storefront GraphQL API with a prefetched token.\n *\n */\n query: >(\n query: string,\n options?: {variables?: Variables; version?: StorefrontApiVersion},\n ) => Promise<{data?: Data; errors?: GraphQLError[]}>;\n\n /**\n * The payment options the buyer has currently selected. This updates as\n * the buyer changes their payment method. The array can contain multiple\n * entries when the buyer splits payment across methods (for example, a\n * gift card and a credit card).\n *\n * Each option exposes `handle` and `type` only. Provider names, logos,\n * fees, and installment terms aren't available.\n */\n selectedPaymentOptions: SubscribableSignalLike;\n\n /**\n * The session token providing a set of claims as a signed JSON Web Token (JWT).\n *\n * The token has a TTL of five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Learn more about [session tokens](/docs/apps/build/authentication-authorization/session-tokens).\n */\n sessionToken: SessionToken;\n\n /**\n * The settings matching the settings definition written in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates in real time as a merchant fills in the settings.\n */\n settings: SubscribableSignalLike;\n\n /**\n * The proposed customer shipping address. During the information step, the address\n * updates when the field is committed (on change) rather than every keystroke.\n * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n shippingAddress?: SubscribableSignalLike;\n\n /**\n * The proposed customer billing address. The address updates when the field is\n * committed (on change) rather than every keystroke. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided yet.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n billingAddress?: SubscribableSignalLike;\n\n /**\n * The store where the checkout is taking place, including the shop name,\n * storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.\n */\n shop: Shop;\n\n /**\n * Key-value storage that persists across page loads within the current checkout\n * session. Data is shared across all activated targets associated with\n * this extension.\n *\n * > Caution: Data persistence isn't guaranteed and storage is cleared when the\n * buyer starts a new checkout.\n */\n storage: Storage;\n\n /**\n * The renderer version being used for the extension.\n *\n * @example '2025-10'\n */\n version: Version;\n\n /**\n * Customer privacy consent settings and a flag denoting if consent has previously been collected.\n */\n customerPrivacy: SubscribableSignalLike;\n\n /**\n * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`collect_buyer_consent` capability](/docs/apps/build/customer-accounts/capabilities#collect-buyer-consent) to be set to `true`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyTrackingConsentChange: ApplyTrackingConsentChangeType;\n\n /**\n * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" }, "Analytics": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Analytics", - "description": "", + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "publish", "value": "(name: string, data: Record) => Promise", - "description": "Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing)." + "description": "Publishes a custom event to [Web Pixels](/docs/apps/marketing). Returns `true` when the event is successfully dispatched.\n\nThe Promise resolves to `true` when the event was dispatched. The boolean indicates dispatch confirmation only. It doesn't indicate whether any specific web pixel processed the event." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "visitor", "value": "(data: { email?: string; phone?: string; }) => Promise", - "description": "A method for capturing details about a visitor on the online store." + "description": "Submits buyer contact details for attribution and analytics purposes." } ], - "value": "export interface Analytics {\n /**\n * Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing).\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * A method for capturing details about a visitor on the online store.\n */\n visitor(data: {email?: string; phone?: string}): Promise;\n}" + "value": "export interface Analytics {\n /**\n * Publishes a custom event to [Web Pixels](/docs/apps/marketing).\n * Returns `true` when the event is successfully dispatched.\n *\n * The Promise resolves to `true` when the event was dispatched. The boolean\n * indicates dispatch confirmation only. It doesn't indicate whether any\n * specific web pixel processed the event.\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * Submits buyer contact details for attribution and analytics purposes.\n */\n visitor(data: {email?: string; phone?: string}): Promise;\n}" }, "VisitorResult": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -73921,10 +73921,10 @@ "syntaxKind": "PropertySignature", "name": "type", "value": "'error'", - "description": "Indicates that the visitor information is invalid and wasn't submitted. Examples are using the wrong data type or missing a required property." + "description": "Indicates that the visitor information is invalid and wasn't submitted. Common causes include using the wrong data type or omitting a required property." } ], - "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Examples are using the wrong data type or missing a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Common causes include using the wrong data type or omitting a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" }, "SubscribableSignalLike": { "filePath": "src/surfaces/checkout/shared.ts", @@ -74138,10 +74138,10 @@ "syntaxKind": "PropertySignature", "name": "value", "value": "string | null", - "description": "The new value to store in the metafield. Set to `null` to delete the metafield." + "description": "The new value to store in the metafield. Set to `null` to delete the metafield.\n\nConsent metafield values are strings, not booleans. Pass `null` to delete a tracking consent metafield." } ], - "value": "export interface TrackingConsentMetafieldChange {\n /**\n * The identifier for the tracking consent metafield to update.\n */\n key: string;\n /**\n * The new value to store in the metafield. Set to `null` to delete the metafield.\n */\n value: string | null;\n}" + "value": "export interface TrackingConsentMetafieldChange {\n /**\n * The identifier for the tracking consent metafield to update.\n */\n key: string;\n /**\n * The new value to store in the metafield. Set to `null` to delete the metafield.\n *\n * Consent metafield values are strings, not booleans. Pass `null` to delete\n * a tracking consent metafield.\n */\n value: string | null;\n}" }, "VisitorConsent": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -74355,7 +74355,7 @@ "syntaxKind": "PropertySignature", "name": "value", "value": "string", - "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.", + "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.\n\nAttribute values are always strings. To store structured data, serialize it to JSON and parse it when reading.", "examples": [ { "title": "Example", @@ -74370,7 +74370,7 @@ ] } ], - "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" + "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * Attribute values are always strings. To store structured data, serialize\n * it to JSON and parse it when reading.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" }, "PaymentOption": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -74721,7 +74721,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A globally-unique identifier for the customer in the format `gid://shopify/Customer/`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", + "description": "An identifier for the customer in the format `gid://shopify/Customer/`. This value is unique per shop.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", "examples": [ { "title": "Example", @@ -74774,7 +74774,7 @@ "isPrivate": true } ], - "value": "export interface Customer {\n /**\n * A globally-unique identifier for the customer in the format `gid://shopify/Customer/`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'gid://shopify/Customer/123'\n */\n id: string;\n /**\n * The email address associated with the customer's account. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email?: string;\n /**\n * The phone number associated with the customer's account. The value is `undefined` if no phone number is on file or the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone?: string;\n /**\n * The customer's full name, typically a combination of first and last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n fullName?: string;\n /**\n * The customer's first name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n firstName?: string;\n /**\n * The customer's last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n lastName?: string;\n /**\n * The customer's profile image, such as a Gravatar avatar. Use this to personalize the extension UI for the logged-in buyer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n image: ImageDetails;\n /**\n * Whether the customer has opted in to receiving marketing communications from the merchant, such as email campaigns and promotional offers.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * > Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n *\n * @deprecated Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n */\n acceptsMarketing: boolean;\n /**\n * Whether the customer has opted in to email marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsEmailMarketing: boolean;\n /**\n * Whether the customer has opted in to SMS marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsSmsMarketing: boolean;\n /**\n * The store credit accounts owned by this customer that can be used as payment during checkout. Each account has a balance representing available store credit.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @private\n */\n storeCreditAccounts: StoreCreditAccount[];\n /**\n * The number of orders the customer has previously placed with this shop.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n ordersCount: number;\n}" + "value": "export interface Customer {\n /**\n * An identifier for the customer in the format `gid://shopify/Customer/`. This value is unique per shop.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'gid://shopify/Customer/123'\n */\n id: string;\n /**\n * The email address associated with the customer's account. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email?: string;\n /**\n * The phone number associated with the customer's account. The value is `undefined` if no phone number is on file or the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone?: string;\n /**\n * The customer's full name, typically a combination of first and last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n fullName?: string;\n /**\n * The customer's first name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n firstName?: string;\n /**\n * The customer's last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n lastName?: string;\n /**\n * The customer's profile image, such as a Gravatar avatar. Use this to personalize the extension UI for the logged-in buyer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n image: ImageDetails;\n /**\n * Whether the customer has opted in to receiving marketing communications from the merchant, such as email campaigns and promotional offers.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * > Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n *\n * @deprecated Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n */\n acceptsMarketing: boolean;\n /**\n * Whether the customer has opted in to email marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsEmailMarketing: boolean;\n /**\n * Whether the customer has opted in to SMS marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsSmsMarketing: boolean;\n /**\n * The store credit accounts owned by this customer that can be used as payment during checkout. Each account has a balance representing available store credit.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @private\n */\n storeCreditAccounts: StoreCreditAccount[];\n /**\n * The number of orders the customer has previously placed with this shop.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n ordersCount: number;\n}" }, "ImageDetails": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -75056,11 +75056,11 @@ "syntaxKind": "MethodSignature", "name": "perform", "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", + "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.\n\nRuns after all intercept results are collected. Use it for local state updates such as setting an error flag. By the time it runs, the navigation decision is final, so blocking logic belongs in the intercept handler itself, not here.", "isOptional": true } ], - "value": "interface InterceptorRequestAllow {\n /**\n * Indicates that the interceptor allows the buyer's journey to continue.\n */\n behavior: 'allow';\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" + "value": "interface InterceptorRequestAllow {\n /**\n * Indicates that the interceptor allows the buyer's journey to continue.\n */\n behavior: 'allow';\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n *\n * Runs after all intercept results are collected. Use it for local state\n * updates such as setting an error flag. By the time it runs, the navigation\n * decision is final, so blocking logic belongs in the intercept handler\n * itself, not here.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" }, "InterceptorResult": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -75124,7 +75124,7 @@ "syntaxKind": "MethodSignature", "name": "perform", "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", + "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.\n\nRuns after all intercept results are collected. Use it for local state updates such as setting an error flag. By the time it runs, the navigation decision is final, so blocking logic belongs in the intercept handler itself, not here.", "isOptional": true }, { @@ -75135,7 +75135,7 @@ "description": "The reason for blocking the interceptor request. This value isn't presented to the buyer, so it doesn't need to be localized. The value is used only for Shopify's own internal debugging and metrics." } ], - "value": "interface InterceptorRequestBlock {\n /**\n * Indicates that the interceptor blocks the buyer's journey from continuing.\n */\n behavior: 'block';\n\n /**\n * The reason for blocking the interceptor request. This value isn't presented to\n * the buyer, so it doesn't need to be localized. The value is used only for Shopify's\n * own internal debugging and metrics.\n */\n reason: string;\n\n /**\n * Used to pass errors to the checkout UI, outside your extension's UI boundaries.\n */\n errors?: ValidationError[];\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" + "value": "interface InterceptorRequestBlock {\n /**\n * Indicates that the interceptor blocks the buyer's journey from continuing.\n */\n behavior: 'block';\n\n /**\n * The reason for blocking the interceptor request. This value isn't presented to\n * the buyer, so it doesn't need to be localized. The value is used only for Shopify's\n * own internal debugging and metrics.\n */\n reason: string;\n\n /**\n * Used to pass errors to the checkout UI, outside your extension's UI boundaries.\n */\n errors?: ValidationError[];\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n *\n * Runs after all intercept results are collected. Use it for local state\n * updates such as setting an error flag. By the time it runs, the navigation\n * decision is final, so blocking logic belongs in the intercept handler\n * itself, not here.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" }, "ValidationError": { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -75356,17 +75356,17 @@ "syntaxKind": "PropertySignature", "name": "totalShippingAmount", "value": "SubscribableSignalLike", - "description": "The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step." + "description": "The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step.\n\n`undefined` until the buyer selects a shipping method (typically after the information step)." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "totalTaxAmount", "value": "SubscribableSignalLike", - "description": "The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet." + "description": "The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet.\n\n`undefined` when taxes haven't been calculated or aren't available for the buyer's region." } ], - "value": "export interface CartCost {\n /**\n * The sum of all line item prices at the current step of checkout, before shipping and taxes are applied. Use this value to display the base cost of the items the buyer purchased.\n */\n subtotalAmount: SubscribableSignalLike;\n\n /**\n * The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step.\n */\n totalShippingAmount: SubscribableSignalLike;\n\n /**\n * The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet.\n */\n totalTaxAmount: SubscribableSignalLike;\n\n /**\n * The minimum total at the current step of checkout. Costs not yet calculated, such as shipping on the information step, aren't included. Gift cards and store credits are excluded from this total.\n */\n totalAmount: SubscribableSignalLike;\n}" + "value": "export interface CartCost {\n /**\n * The sum of all line item prices at the current step of checkout, before shipping and taxes are applied. Use this value to display the base cost of the items the buyer purchased.\n */\n subtotalAmount: SubscribableSignalLike;\n\n /**\n * The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step.\n *\n * `undefined` until the buyer selects a shipping method (typically after the\n * information step).\n */\n totalShippingAmount: SubscribableSignalLike;\n\n /**\n * The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet.\n *\n * `undefined` when taxes haven't been calculated or aren't available for the\n * buyer's region.\n */\n totalTaxAmount: SubscribableSignalLike;\n\n /**\n * The minimum total at the current step of checkout. Costs not yet calculated, such as shipping on the information step, aren't included. Gift cards and store credits are excluded from this total.\n */\n totalAmount: SubscribableSignalLike;\n}" }, "CustomerPrivacy": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -75453,31 +75453,31 @@ "syntaxKind": "PropertySignature", "name": "analytics", "value": "boolean", - "description": "Whether analytics data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Analytics data includes how the shop was used and what interactions occurred." + "description": "Whether analytics data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Analytics data includes how the shop was used and what interactions occurred.\n\nWhether analytics data can be collected right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.analytics`, before calling `shopify.analytics.publish()`." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "marketing", "value": "boolean", - "description": "Whether marketing data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Marketing data includes attribution and targeted advertising preferences." + "description": "Whether marketing data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Marketing data includes attribution and targeted advertising preferences.\n\nWhether marketing data can be collected right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.marketing`, before performing marketing-related data collection." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "preferences", "value": "boolean", - "description": "Whether preference data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Preference data includes language, currency, and sizing choices." + "description": "Whether preference data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Preference data includes language, currency, and sizing choices.\n\nWhether preference data can be collected right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.preferences`, before storing or reading buyer preference data." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "saleOfData", "value": "boolean", - "description": "Whether data can be shared with third parties based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. This typically applies to behavioral advertising data." + "description": "Whether data can be shared with third parties based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. This typically applies to behavioral advertising data.\n\nWhether buyer data can be shared with or sold to third parties right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.saleOfData`, before sharing or selling buyer data with third parties." } ], - "value": "export interface AllowedProcessing {\n /**\n * Whether analytics data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Analytics\n * data includes how the shop was used and what interactions occurred.\n */\n analytics: boolean;\n /**\n * Whether marketing data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Marketing\n * data includes attribution and targeted advertising preferences.\n */\n marketing: boolean;\n /**\n * Whether preference data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Preference\n * data includes language, currency, and sizing choices.\n */\n preferences: boolean;\n /**\n * Whether data can be shared with third parties based on the visitor's\n * consent, the merchant's privacy configuration, and the visitor's region.\n * This typically applies to behavioral advertising data.\n */\n saleOfData: boolean;\n}" + "value": "export interface AllowedProcessing {\n /**\n * Whether analytics data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Analytics\n * data includes how the shop was used and what interactions occurred.\n *\n * Whether analytics data can be collected right now. Combines the buyer's\n * consent, the merchant's privacy configuration, and the buyer's region into\n * a single boolean. Check this flag, not `visitorConsent.analytics`, before\n * calling `shopify.analytics.publish()`.\n */\n analytics: boolean;\n /**\n * Whether marketing data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Marketing\n * data includes attribution and targeted advertising preferences.\n *\n * Whether marketing data can be collected right now. Combines the buyer's\n * consent, the merchant's privacy configuration, and the buyer's region into\n * a single boolean. Check this flag, not `visitorConsent.marketing`, before\n * performing marketing-related data collection.\n */\n marketing: boolean;\n /**\n * Whether preference data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Preference\n * data includes language, currency, and sizing choices.\n *\n * Whether preference data can be collected right now. Combines the buyer's\n * consent, the merchant's privacy configuration, and the buyer's region into\n * a single boolean. Check this flag, not `visitorConsent.preferences`,\n * before storing or reading buyer preference data.\n */\n preferences: boolean;\n /**\n * Whether data can be shared with third parties based on the visitor's\n * consent, the merchant's privacy configuration, and the visitor's region.\n * This typically applies to behavioral advertising data.\n *\n * Whether buyer data can be shared with or sold to third parties right now.\n * Combines the buyer's consent, the merchant's privacy configuration, and\n * the buyer's region into a single boolean. Check this flag, not\n * `visitorConsent.saleOfData`, before sharing or selling buyer data with\n * third parties.\n */\n saleOfData: boolean;\n}" }, "TrackingConsentMetafield": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -76169,7 +76169,7 @@ "Extension": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Extension", - "description": "The meta information about an extension target.", + "description": "Metadata about the running extension, including its API version, target, capabilities, and editor context. Use this to read configuration details or conditionally render content based on where the extension is running.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -76195,7 +76195,7 @@ "syntaxKind": "PropertySignature", "name": "capabilities", "value": "SubscribableSignalLike", - "description": "The allowed capabilities of the extension, defined in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n\n* [`api_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#api-access): the extension can access the Storefront API.\n\n* [`network_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access): the extension can make external network calls.\n\n* [`block_progress`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n\n* [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n\n* [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can register customer consent decisions that are honored on Shopify-managed services.\n\n* [`iframe.sources`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#iframe): the extension can embed an external URL in an iframe." + "description": "The allowed capabilities of the extension, defined in your [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -76243,7 +76243,7 @@ "syntaxKind": "PropertySignature", "name": "version", "value": "string", - "description": "The published version of the running extension target.\n\nFor unpublished extensions, the value is `undefined`.", + "description": "The published version of the running extension target.\n\nFor unpublished extensions, the value is `undefined`.\n\nDon't use this property as a stable identifier in development environments. It becomes available only after the extension is published.", "isOptional": true, "examples": [ { @@ -76259,7 +76259,7 @@ ] } ], - "value": "export interface Extension {\n /**\n * The API version that was set in the extension config file.\n *\n * @example '2024-10', '2025-01', '2025-04', '2025-07', '2025-10'\n */\n apiVersion: ApiVersion;\n\n /**\n * The allowed capabilities of the extension, defined\n * in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n *\n * * [`api_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#api-access): the extension can access the Storefront API.\n *\n * * [`network_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access): the extension can make external network calls.\n *\n * * [`block_progress`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n *\n * * [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n *\n * * [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can register customer consent decisions that are honored on Shopify-managed services.\n *\n * * [`iframe.sources`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#iframe): the extension can embed an external URL in an iframe.\n */\n capabilities: SubscribableSignalLike;\n\n /**\n * Information about the editor where the extension is being rendered.\n *\n * If the value is undefined, then the extension isn't running in an editor.\n */\n editor?: Editor;\n\n /**\n * A Boolean to show whether your extension is currently rendered to the screen.\n *\n * Shopify might render your extension before it's visible in the UI,\n * typically to pre-render extensions that appear on a later step of the\n * checkout.\n *\n * Your extension might also continue to run after the customer has navigated away\n * from where it was rendered. The extension continues running so that\n * your extension is immediately available to render if the customer navigates back.\n */\n rendered: SubscribableSignalLike;\n\n /**\n * The URL to the script that started the extension target.\n */\n scriptUrl: string;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n */\n target: Target;\n\n /**\n * The published version of the running extension target.\n *\n * For unpublished extensions, the value is `undefined`.\n *\n * @example 3.0.10\n */\n version?: string;\n}" + "value": "export interface Extension {\n /**\n * The API version that was set in the extension config file.\n *\n * @example '2024-10', '2025-01', '2025-04', '2025-07', '2025-10'\n */\n apiVersion: ApiVersion;\n\n /**\n * The allowed capabilities of the extension, defined in your\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n */\n capabilities: SubscribableSignalLike;\n\n /**\n * Information about the editor where the extension is being rendered.\n *\n * If the value is undefined, then the extension isn't running in an editor.\n */\n editor?: Editor;\n\n /**\n * A Boolean to show whether your extension is currently rendered to the screen.\n *\n * Shopify might render your extension before it's visible in the UI,\n * typically to pre-render extensions that appear on a later step of the\n * checkout.\n *\n * Your extension might also continue to run after the customer has navigated away\n * from where it was rendered. The extension continues running so that\n * your extension is immediately available to render if the customer navigates back.\n */\n rendered: SubscribableSignalLike;\n\n /**\n * The URL to the script that started the extension target.\n */\n scriptUrl: string;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n */\n target: Target;\n\n /**\n * The published version of the running extension target.\n *\n * For unpublished extensions, the value is `undefined`.\n *\n * Don't use this property as a stable identifier in development environments.\n * It becomes available only after the extension is published.\n *\n * @example 3.0.10\n */\n version?: string;\n}" }, "ApiVersion": { "filePath": "src/shared.ts", @@ -76278,7 +76278,7 @@ "Editor": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Editor", - "description": "", + "description": "Information about the editor environment when an extension is rendered inside the checkout editor. The value is `undefined` when the extension is not rendering in an editor.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -76293,7 +76293,7 @@ "I18n": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18n", - "description": "", + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use the I18n API alongside the Localization API to build fully localized extensions.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -76329,7 +76329,7 @@ "I18nTranslate": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18nTranslate", - "description": "This returns a translated string matching a key in a locale file.", + "description": "Translates a key from your extension's locale files into a localized string. Supports interpolation with placeholder replacements and pluralization via the special `count` option.", "members": [], "value": "export interface I18nTranslate {\n (\n key: string,\n options?: Record,\n ): ReplacementType extends string | number\n ? string\n : (string | ReplacementType)[];\n}" }, @@ -76893,14 +76893,14 @@ "Localization": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Localization", - "description": "", + "description": "The buyer's language, country, currency, and timezone context. Use this to adapt your extension to the buyer's region and display localized content.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "country", "value": "SubscribableSignalLike", - "description": "The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown." + "description": "The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n\nDerived from the buyer's shipping address. Returns `undefined` until the buyer enters a shipping address." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -76928,18 +76928,18 @@ "syntaxKind": "PropertySignature", "name": "market", "value": "SubscribableSignalLike", - "description": "The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n\n> Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.", - "deprecationMessage": "Deprecated as of version `2025-04`" + "description": "The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. The market context updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.", + "deprecationMessage": "Merchants now manage which extensions load for each\nmarket, so extensions no longer need to check this value." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "timezone", "value": "SubscribableSignalLike", - "description": "The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time." + "description": "The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time." } ], - "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n *\n * > Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" + "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n *\n * Derived from the buyer's shipping address. Returns `undefined` until the\n * buyer enters a shipping address.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout,\n * carried over from the cart context. Markets group countries and\n * regions with shared pricing, languages, and domains. The market\n * context updates when the buyer changes the country of their\n * shipping address. The value is `undefined` if the market is unknown.\n *\n * @deprecated Merchants now manage which extensions load for each\n * market, so extensions no longer need to check this value.\n */\n market: SubscribableSignalLike;\n}" }, "Country": { "filePath": "src/shared.ts", @@ -77140,7 +77140,7 @@ "SessionToken": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SessionToken", - "description": "", + "description": "Authenticates requests between your extension and your app backend. Use session tokens to verify the identity of the buyer and the shop context when making server-side API calls. The token is a signed JWT that contains claims such as the customer ID, shop domain, and expiration.\n\nThe `sub` claim in the decoded token is present only when the buyer is logged in and the app has permission to read customer accounts. Absent for anonymous buyers.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -77399,7 +77399,7 @@ "Shop": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Shop", - "description": "", + "description": "Metadata about the merchant's store, including its name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -77439,30 +77439,30 @@ "syntaxKind": "PropertySignature", "name": "storefrontUrl", "value": "string", - "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n\n> Caution: > As of version `2024-04` this value no longer has a trailing slash.", + "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.", "isOptional": true } ], - "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n *\n * > Caution:\n * > As of version `2024-04` this value no longer has a trailing slash.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom domain.\n */\n myshopifyDomain: string;\n}" + "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom domain.\n */\n myshopifyDomain: string;\n}" }, "Storage": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Storage", - "description": "A key-value storage object for the extension.\n\nStored data is available only to this specific extension and any of its instances.\n\nThe storage backend is implemented with `localStorage` and should persist across the buyer's checkout session. However, data persistence isn't guaranteed.", + "description": "Key-value storage for a specific extension. Use storage to save preferences or cached data that should survive page reloads without requiring a backend call. Stored data is only available to this specific extension. The storage backend is implemented with `localStorage` and data persistence isn't guaranteed.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "delete", "value": "(key: string) => Promise", - "description": "Delete stored data by key." + "description": "Deletes a previously stored value by key." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "read", "value": "(key: string) => Promise", - "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original primitive.\n\nReturns `null` if no stored data exists." + "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original type.\n\nReturns the stored value for the given key, or `null` when no value exists. Doesn't throw on a missing key." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -77472,7 +77472,7 @@ "description": "Write stored data for this key.\n\nThe data must be serializable to JSON." } ], - "value": "export interface Storage {\n /**\n * Read and return a stored value by key.\n *\n * The stored data is deserialized from JSON and returned as\n * its original primitive.\n *\n * Returns `null` if no stored data exists.\n */\n read(key: string): Promise;\n\n /**\n * Write stored data for this key.\n *\n * The data must be serializable to JSON.\n */\n write(key: string, data: any): Promise;\n\n /**\n * Delete stored data by key.\n */\n delete(key: string): Promise;\n}" + "value": "export interface Storage {\n /**\n * Read and return a stored value by key.\n *\n * The stored data is deserialized from JSON and returned as\n * its original type.\n *\n * Returns the stored value for the given key, or `null` when no value\n * exists. Doesn't throw on a missing key.\n */\n read(key: string): Promise;\n\n /**\n * Write stored data for this key.\n *\n * The data must be serializable to JSON.\n */\n write(key: string, data: any): Promise;\n\n /**\n * Deletes a previously stored value by key.\n */\n delete(key: string): Promise;\n}" }, "Version": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -77548,7 +77548,7 @@ "syntaxKind": "MethodSignature", "name": "applyAttributeChange", "value": "(change: AttributeChange) => Promise", - "description": "Updates or removes an attribute on the cart and checkout. On success, the [`attributes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/attributes#standardapi-propertydetail-attributes) property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.", + "description": "Updates or removes an attribute on the cart and checkout. On success, the [`attributes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/attributes#properties-propertydetail-attributes) property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.", "deprecationMessage": "Use cart metafields instead." }, { @@ -77556,42 +77556,42 @@ "syntaxKind": "MethodSignature", "name": "applyCartLinesChange", "value": "(change: CartLineChange) => Promise", - "description": "Adds, removes, or updates line items in the cart. The returned promise resolves when the change has been applied by the server, and the [`lines`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-lines#standardapi-propertydetail-lines) property updates with the new state.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Adds, removes, or updates line items in the cart. The returned promise resolves when the change has been applied by the server, and the [`lines`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-lines#properties-propertydetail-lines) property updates with the new state.\n\nAccepts a single change per call. To make multiple changes, call this method separately for each one.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyDiscountCodeChange", "value": "(change: DiscountCodeChange) => Promise", - "description": "Adds or removes a discount code on the checkout. The returned promise resolves when the change has been applied by the server, and the [`discountCodes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/discounts#standardapi-propertydetail-discountcodes) property updates with the new state.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves discount codes through a network call.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Adds or removes a discount code on the checkout. The returned promise resolves when the change has been applied by the server, and the [`discountCodes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/discounts#properties-propertydetail-discountcodes) property updates with the new state.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves discount codes through a network call.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyGiftCardChange", "value": "(change: GiftCardChange) => Promise", - "description": "Adds or removes a gift card from the checkout. The returned promise resolves when the change has been applied by the server, and the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/gift-cards#standardapi-propertydetail-appliedgiftcards) property updates with the new state.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves gift card codes through a network call.\n\n> Note: This method returns an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Adds or removes a gift card from the checkout. The returned promise resolves when the change has been applied by the server, and the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/gift-cards#properties-propertydetail-appliedgiftcards) property updates with the new state.\n\nUnlike other write operations, gift card changes aren't gated by a cart instruction flag.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves gift card codes through a network call.\n\n> Note: This method returns an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyMetafieldChange", "value": "(change: MetafieldChange) => Promise", - "description": "Creates, updates, or removes a cart metafield on the checkout. On success, the [`metafields`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/metafields#standardapi-propertydetail-metafields) property updates to reflect the change.\n\nCart metafields are copied to order metafields at order creation time if there's a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n\n> Caution: `MetafieldRemoveChange` and `MetafieldUpdateChange` are deprecated. Use cart metafields with `MetafieldRemoveCartChange` and `MetafieldUpdateCartChange` instead. If `MetafieldUpdateChange` writes a metafield with the same namespace and key as a cart metafield that's configured to copy, the cart metafield won't be copied.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Creates, updates, or removes a cart metafield on the checkout. On success, the [`metafields`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/metafields#properties-propertydetail-metafields) property updates to reflect the change.\n\nCart metafields are copied to order metafields at order creation time if there's a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n\n> Caution: `MetafieldRemoveChange` and `MetafieldUpdateChange` are deprecated. Use cart metafields with `MetafieldRemoveCartChange` and `MetafieldUpdateCartChange` instead. If `MetafieldUpdateChange` writes a metafield with the same namespace and key as a cart metafield that's configured to copy, the cart metafield won't be copied.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyNoteChange", "value": "(change: NoteChange) => Promise", - "description": "Sets or removes the buyer's note on the checkout. On success, the [`note`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/note#standardapi-propertydetail-note) property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Sets or removes the buyer's note on the checkout. On success, the [`note`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/note#properties-propertydetail-note) property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyShippingAddressChange", "value": "(change: ShippingAddressUpdateChange) => Promise", - "description": "Updates the buyer's shipping address on the checkout. The provided fields are merged into the existing address without prompting the buyer. On success, the `shippingAddress` property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", + "description": "Updates the buyer's shipping address on the checkout. The provided fields are merged into the existing address without prompting the buyer. On success, the `shippingAddress` property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", "isOptional": true }, { @@ -77604,7 +77604,7 @@ "isPrivate": true } ], - "value": "export interface CheckoutApi {\n /**\n * Updates or removes an attribute on the cart and checkout. On success, the\n * [`attributes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/attributes#standardapi-propertydetail-attributes) property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * @deprecated Use cart metafields instead.\n */\n applyAttributeChange(change: AttributeChange): Promise;\n\n /**\n * Adds, removes, or updates line items in the cart. The returned promise resolves when the change has been applied by the server, and the [`lines`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-lines#standardapi-propertydetail-lines) property updates with the new state.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyCartLinesChange(change: CartLineChange): Promise;\n\n /**\n * Adds or removes a discount code on the checkout. The returned promise resolves when the change has been applied by the server, and the [`discountCodes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/discounts#standardapi-propertydetail-discountcodes) property updates with the new state.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves discount codes through a network call.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyDiscountCodeChange(\n change: DiscountCodeChange,\n ): Promise;\n\n /**\n * Adds or removes a gift card from the checkout. The returned promise resolves when the change has been applied by the server, and the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/gift-cards#standardapi-propertydetail-appliedgiftcards) property updates with the new state.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves gift card codes through a network call.\n *\n * > Note: This method returns an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyGiftCardChange(change: GiftCardChange): Promise;\n\n /**\n * Creates, updates, or removes a cart metafield on the checkout. On success, the\n * [`metafields`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/metafields#standardapi-propertydetail-metafields) property updates to reflect the change.\n *\n * Cart metafields are copied to order metafields at order creation time if there's a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n *\n * > Caution: `MetafieldRemoveChange` and `MetafieldUpdateChange` are deprecated. Use cart metafields with `MetafieldRemoveCartChange` and `MetafieldUpdateCartChange` instead. If `MetafieldUpdateChange` writes a metafield with the same namespace and key as a cart metafield that's configured to copy, the cart metafield won't be copied.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyMetafieldChange(change: MetafieldChange): Promise;\n\n /**\n * Sets or removes the buyer's note on the checkout. On success, the\n * [`note`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/note#standardapi-propertydetail-note)\n * property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyNoteChange(change: NoteChange): Promise;\n\n /**\n * @private\n */\n experimentalIsShopAppStyle?: boolean;\n\n /**\n * Updates the buyer's shipping address on the checkout. The provided fields\n * are merged into the existing address without prompting the buyer. On success,\n * the `shippingAddress` property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyShippingAddressChange?(\n change: ShippingAddressChange,\n ): Promise;\n}" + "value": "export interface CheckoutApi {\n /**\n * Updates or removes an attribute on the cart and checkout. On success, the\n * [`attributes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/attributes#properties-propertydetail-attributes) property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * @deprecated Use cart metafields instead.\n */\n applyAttributeChange(change: AttributeChange): Promise;\n\n /**\n * Adds, removes, or updates line items in the cart. The returned promise resolves when the change has been applied by the server, and the [`lines`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-lines#properties-propertydetail-lines) property updates with the new state.\n *\n * Accepts a single change per call. To make multiple changes, call this\n * method separately for each one.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyCartLinesChange(change: CartLineChange): Promise;\n\n /**\n * Adds or removes a discount code on the checkout. The returned promise resolves when the change has been applied by the server, and the [`discountCodes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/discounts#properties-propertydetail-discountcodes) property updates with the new state.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves discount codes through a network call.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyDiscountCodeChange(\n change: DiscountCodeChange,\n ): Promise;\n\n /**\n * Adds or removes a gift card from the checkout. The returned promise resolves when the change has been applied by the server, and the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/gift-cards#properties-propertydetail-appliedgiftcards) property updates with the new state.\n *\n * Unlike other write operations, gift card changes aren't gated by a cart\n * instruction flag.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves gift card codes through a network call.\n *\n * > Note: This method returns an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyGiftCardChange(change: GiftCardChange): Promise;\n\n /**\n * Creates, updates, or removes a cart metafield on the checkout. On success, the\n * [`metafields`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/metafields#properties-propertydetail-metafields) property updates to reflect the change.\n *\n * Cart metafields are copied to order metafields at order creation time if there's a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n *\n * > Caution: `MetafieldRemoveChange` and `MetafieldUpdateChange` are deprecated. Use cart metafields with `MetafieldRemoveCartChange` and `MetafieldUpdateCartChange` instead. If `MetafieldUpdateChange` writes a metafield with the same namespace and key as a cart metafield that's configured to copy, the cart metafield won't be copied.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyMetafieldChange(change: MetafieldChange): Promise;\n\n /**\n * Sets or removes the buyer's note on the checkout. On success, the\n * [`note`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/note#properties-propertydetail-note)\n * property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyNoteChange(change: NoteChange): Promise;\n\n /**\n * @private\n */\n experimentalIsShopAppStyle?: boolean;\n\n /**\n * Updates the buyer's shipping address on the checkout. The provided fields\n * are merged into the existing address without prompting the buyer. On success,\n * the `shippingAddress` property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyShippingAddressChange?(\n change: ShippingAddressChange,\n ): Promise;\n}" }, "AttributeChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -77671,7 +77671,7 @@ "syntaxKind": "PropertySignature", "name": "value", "value": "string", - "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.", + "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.\n\nAttribute values are always strings. To store structured data, serialize it to JSON and parse it when reading.", "examples": [ { "title": "Example", @@ -77686,7 +77686,7 @@ ] } ], - "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" + "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * Attribute values are always strings. To store structured data, serialize\n * it to JSON and parse it when reading.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" }, "AttributeRemoveChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -78539,7 +78539,7 @@ "syntaxKind": "PropertySignature", "name": "message", "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer." + "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer.\n\nRender your own localized error text rather than displaying this message to the buyer." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -78549,7 +78549,7 @@ "description": "Indicates that the line item wasn't changed successfully. Refer to the `message` property for details about the error." } ], - "value": "export interface CartLineChangeResultError {\n /**\n * Indicates that the line item wasn't changed successfully. Refer to the `message` property for details about the error.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface CartLineChangeResultError {\n /**\n * Indicates that the line item wasn't changed successfully. Refer to the `message` property for details about the error.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n *\n * Render your own localized error text rather than displaying this message\n * to the buyer.\n */\n message: string;\n}" }, "DiscountCodeChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -78729,7 +78729,7 @@ "syntaxKind": "PropertySignature", "name": "message", "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer." + "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer.\n\nRender your own localized error text rather than displaying this message to the buyer." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -78739,7 +78739,7 @@ "description": "Indicates that the gift card change couldn't be applied. Check the `message` property for details." } ], - "value": "export interface GiftCardChangeResultError {\n /**\n * Indicates that the gift card change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface GiftCardChangeResultError {\n /**\n * Indicates that the gift card change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n *\n * Render your own localized error text rather than displaying this message\n * to the buyer.\n */\n message: string;\n}" }, "MetafieldChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -79000,7 +79000,7 @@ "syntaxKind": "PropertySignature", "name": "message", "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer." + "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer.\n\nRender your own localized error text rather than displaying this message to the buyer." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -79010,7 +79010,7 @@ "description": "Indicates that the metafield change couldn't be applied. Check the `message` property for details." } ], - "value": "export interface MetafieldChangeResultError {\n /**\n * Indicates that the metafield change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface MetafieldChangeResultError {\n /**\n * Indicates that the metafield change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n *\n * Render your own localized error text rather than displaying this message\n * to the buyer.\n */\n message: string;\n}" }, "NoteChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -79088,7 +79088,7 @@ "syntaxKind": "PropertySignature", "name": "message", "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer." + "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer.\n\nRender your own localized error text rather than displaying this message to the buyer." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -79098,7 +79098,7 @@ "description": "Indicates that the note change couldn't be applied. Check the `message` property for details." } ], - "value": "export interface NoteChangeResultError {\n /**\n * Indicates that the note change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface NoteChangeResultError {\n /**\n * Indicates that the note change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n *\n * Render your own localized error text rather than displaying this message\n * to the buyer.\n */\n message: string;\n}" }, "ShippingAddressUpdateChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -79684,7 +79684,7 @@ "syntaxKind": "PropertySignature", "name": "analytics", "value": "Analytics", - "description": "The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event." + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -79698,7 +79698,7 @@ "syntaxKind": "PropertySignature", "name": "applyTrackingConsentChange", "value": "ApplyTrackingConsentChangeType", - "description": "Enables setting and updating customer privacy consent settings and tracking consent metafields.\n\n> Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent) to be set to `true`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." + "description": "Enables setting and updating customer privacy consent settings and tracking consent metafields.\n\n> Note: Requires the [`collect_buyer_consent` capability](/docs/apps/build/customer-accounts/capabilities#collect-buyer-consent) to be set to `true`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -79719,7 +79719,7 @@ "syntaxKind": "PropertySignature", "name": "availablePaymentOptions", "value": "SubscribableSignalLike", - "description": "All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region." + "description": "All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n\nThe set of payment options can change when the buyer updates their address or cart, so subscribe to changes rather than reading once during initialization. Each option exposes `handle` and `type` only. Provider names, logos, fees, and installment terms aren't available." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -79756,7 +79756,7 @@ "syntaxKind": "PropertySignature", "name": "checkoutToken", "value": "SubscribableSignalLike", - "description": "A stable ID that represents the current checkout.\n\nThe value is `undefined` when the checkout hasn't been created on the server yet.\n\nUse this to correlate checkout sessions across your extension, web pixels, and backend systems.\n\nThis matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data) and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object)." + "description": "A stable ID that represents the current checkout.\n\nThe value is `undefined` when the checkout hasn't been created on the server yet.\n\nUse this to correlate checkout sessions across your extension, web pixels, and backend systems.\n\nThis matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data) and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n\nCan be `undefined`. Handle the `undefined` state before using the value." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -79777,7 +79777,7 @@ "syntaxKind": "PropertySignature", "name": "deliveryGroups", "value": "SubscribableSignalLike", - "description": "The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items." + "description": "The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n\nEmpty until the buyer enters enough address information for Shopify to calculate shipping rates." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -79798,7 +79798,7 @@ "syntaxKind": "PropertySignature", "name": "extension", "value": "Extension", - "description": "The meta information about the extension." + "description": "Metadata about the running extension, including the current target, API version, capabilities, and editor context. Use this to conditionally render content based on where the extension is running." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -79806,7 +79806,7 @@ "name": "extensionPoint", "value": "Target", "description": "The identifier that specifies where in Shopify's UI your code is being injected. This is one of the targets you've included in your extension's configuration file.", - "deprecationMessage": "Deprecated as of version `2023-07`, use `extension.target` instead.", + "deprecationMessage": "Use `extension.target` instead.", "examples": [ { "title": "Example", @@ -79825,14 +79825,14 @@ "syntaxKind": "PropertySignature", "name": "i18n", "value": "I18n", - "description": "Utilities for translating content and formatting values according to the current [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) of the checkout.\n\nRefer to [`localization` examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples) for more information." + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use alongside [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) to build fully localized extensions." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "instructions", "value": "SubscribableSignalLike", - "description": "The cart instructions used to create the checkout and possibly limit extension capabilities.\n\nThese instructions should be checked before performing any actions that might be affected by them.\n\nFor example, if you intend to add a discount code via the `applyDiscountCodeChange` method, check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n\n> Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs aren't available. See the [update guide](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples) for more information." + "description": "The cart instructions used to create the checkout and possibly limit extension capabilities.\n\nThese instructions should be checked before performing any actions that might be affected by them.\n\nFor example, if you intend to add a discount code via the `applyDiscountCodeChange` method, check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n\n> Caution: Check cart instructions before calling select APIs, as > some may not be available. See the > [Cart Instructions API](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples) > for more information." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -79846,7 +79846,7 @@ "syntaxKind": "PropertySignature", "name": "localization", "value": "Localization", - "description": "The details about the location, language, and currency of the customer. For utilities to easily format and translate content based on these details, you can use the [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n) object instead." + "description": "The buyer's language, country, currency, and timezone context. For formatting and translation helpers, use the [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#properties-propertydetail-i18n) object instead." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -79876,21 +79876,21 @@ "syntaxKind": "PropertySignature", "name": "query", "value": ">(query: string, options?: { variables?: Variables; version?: StorefrontApiVersion; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>", - "description": "The method used to query the Storefront GraphQL API with a prefetched token.\n\nRefer to [Storefront API access examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/storefront-api) for more information." + "description": "The method used to query the Storefront GraphQL API with a prefetched token." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "selectedPaymentOptions", "value": "SubscribableSignalLike", - "description": "The payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card)." + "description": "The payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\n\nEach option exposes `handle` and `type` only. Provider names, logos, fees, and installment terms aren't available." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "sessionToken", "value": "SessionToken", - "description": "The session token providing a set of claims as a signed JSON Web Token (JWT).\n\nThe token has a TTL of five minutes.\n\nIf the previous token expires, this value reflects a new session token with a new signature and expiry.\n\nRefer to [session token examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/session-token) for more information." + "description": "The session token providing a set of claims as a signed JSON Web Token (JWT).\n\nThe token has a TTL of five minutes.\n\nIf the previous token expires, this value reflects a new session token with a new signature and expiry.\n\nLearn more about [session tokens](/docs/apps/build/authentication-authorization/session-tokens)." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -79912,14 +79912,14 @@ "syntaxKind": "PropertySignature", "name": "shop", "value": "Shop", - "description": "The shop where the checkout is taking place." + "description": "The store where the checkout is taking place, including the shop name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "storage", "value": "Storage", - "description": "The key-value storage for the extension.\n\nIt uses `localStorage` and should persist across the customer's current checkout session.\n\n> Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n\nData is shared across all activated extension targets of this extension. In versions 2023-07 and earlier, each activated extension target had its own storage." + "description": "Key-value storage that persists across page loads within the current checkout session. Data is shared across all activated targets associated with this extension.\n\n> Caution: Data persistence isn't guaranteed and storage is cleared when the buyer starts a new checkout." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -79941,29 +79941,29 @@ ] } ], - "value": "export interface StandardApi {\n /**\n * The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event.\n */\n analytics: Analytics;\n\n /**\n * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\n */\n appliedGiftCards: SubscribableSignalLike;\n\n /**\n * The cart instructions used to create the checkout and possibly limit extension capabilities.\n *\n * These instructions should be checked before performing any actions that might be affected by them.\n *\n * For example, if you intend to add a discount code via the `applyDiscountCodeChange` method,\n * check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n *\n * > Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs aren't available.\n * See the [update guide](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples) for more information.\n *\n */\n instructions: SubscribableSignalLike;\n\n /**\n * The metafields requested in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration)\n * file. These metafields are updated when there's a change in the merchandise items\n * being purchased by the customer.\n *\n * App owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` isn't supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n appMetafields: SubscribableSignalLike;\n\n /**\n * The custom key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n buyerIdentity?: BuyerIdentity;\n\n /**\n * Provides details on the buyer's progression through the checkout and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/buyer-journey#examples)\n * examples for more information.\n */\n buyerJourney: BuyerJourney;\n\n /**\n * Settings applied to the buyer's checkout.\n */\n checkoutSettings: SubscribableSignalLike;\n\n /**\n * A stable ID that represents the current checkout.\n *\n * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\n *\n * This matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data)\n * and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n */\n checkoutToken: SubscribableSignalLike;\n\n /**\n * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * The meta information about the extension.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n *\n * @deprecated Deprecated as of version `2023-07`, use `extension.target` instead.\n */\n extensionPoint: Target;\n\n /**\n * Utilities for translating content and formatting values according to the current\n * [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization)\n * of the checkout.\n *\n * Refer to [`localization` examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples)\n * for more information.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The details about the location, language, and currency of the customer. For utilities to easily\n * format and translate content based on these details, you can use the\n * [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n)\n * object instead.\n */\n localization: Localization;\n\n /**\n * The metafields that apply to the current checkout.\n *\n * Metafields are stored locally on the client and are applied to the order object after the checkout completes.\n *\n * These metafields are shared by all extensions running on checkout, and\n * persist for as long as the customer is working on this checkout.\n *\n * Once the order is created, you can query these metafields using the\n * [GraphQL Admin API](/docs/admin-api/graphql/reference/orders/order#metafield-2021-01)\n *\n * > Caution:\n * `metafields` is deprecated. Use `appMetafields` with cart metafields instead.\n *\n * @deprecated Use `appMetafields` with cart metafields instead.\n */\n metafields: SubscribableSignalLike;\n\n /**\n * A note left by the customer to the merchant, either in their cart or during checkout.\n *\n * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\n */\n note: SubscribableSignalLike;\n\n /**\n * The method used to query the Storefront GraphQL API with a prefetched token.\n *\n * Refer to [Storefront API access examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/storefront-api) for more information.\n */\n query: >(\n query: string,\n options?: {variables?: Variables; version?: StorefrontApiVersion},\n ) => Promise<{data?: Data; errors?: GraphQLError[]}>;\n\n /**\n * The payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\n */\n selectedPaymentOptions: SubscribableSignalLike;\n\n /**\n * The session token providing a set of claims as a signed JSON Web Token (JWT).\n *\n * The token has a TTL of five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/session-token) for more information.\n */\n sessionToken: SessionToken;\n\n /**\n * The settings matching the settings definition written in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates in real time as a merchant fills in the settings.\n */\n settings: SubscribableSignalLike;\n\n /**\n * The proposed customer shipping address. During the information step, the address\n * updates when the field is committed (on change) rather than every keystroke.\n * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n shippingAddress?: SubscribableSignalLike;\n\n /**\n * The proposed customer billing address. The address updates when the field is\n * committed (on change) rather than every keystroke. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided yet.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n billingAddress?: SubscribableSignalLike;\n\n /** The shop where the checkout is taking place. */\n shop: Shop;\n\n /**\n * The key-value storage for the extension.\n *\n * It uses `localStorage` and should persist across the customer's current checkout session.\n *\n * > Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n *\n * Data is shared across all activated extension targets of this extension. In versions 2023-07 and earlier,\n * each activated extension target had its own storage.\n */\n storage: Storage;\n\n /**\n * The renderer version being used for the extension.\n *\n * @example '2025-10'\n */\n version: Version;\n\n /**\n * Customer privacy consent settings and a flag denoting if consent has previously been collected.\n */\n customerPrivacy: SubscribableSignalLike;\n\n /**\n * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent) to be set to `true`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyTrackingConsentChange: ApplyTrackingConsentChangeType;\n\n /**\n * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" + "value": "export interface StandardApi {\n /**\n * Tracks custom events and sends visitor information to\n * [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events\n * and `visitor()` to submit buyer contact details.\n */\n analytics: Analytics;\n\n /**\n * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\n */\n appliedGiftCards: SubscribableSignalLike;\n\n /**\n * The cart instructions used to create the checkout and possibly limit extension capabilities.\n *\n * These instructions should be checked before performing any actions that might be affected by them.\n *\n * For example, if you intend to add a discount code via the `applyDiscountCodeChange` method,\n * check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n *\n * > Caution: Check cart instructions before calling select APIs, as\n * > some may not be available. See the\n * > [Cart Instructions API](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples)\n * > for more information.\n *\n */\n instructions: SubscribableSignalLike;\n\n /**\n * The metafields requested in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration)\n * file. These metafields are updated when there's a change in the merchandise items\n * being purchased by the customer.\n *\n * App owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` isn't supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n appMetafields: SubscribableSignalLike;\n\n /**\n * The custom key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as\n * credit cards, wallets, and local payment methods. The list depends on\n * the shop's payment configuration and the buyer's region.\n *\n * The set of payment options can change when the buyer updates their\n * address or cart, so subscribe to changes rather than reading once\n * during initialization. Each option exposes `handle` and `type` only.\n * Provider names, logos, fees, and installment terms aren't available.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n buyerIdentity?: BuyerIdentity;\n\n /**\n * Provides details on the buyer's progression through the checkout and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/buyer-journey#examples)\n * examples for more information.\n */\n buyerJourney: BuyerJourney;\n\n /**\n * Settings applied to the buyer's checkout.\n */\n checkoutSettings: SubscribableSignalLike;\n\n /**\n * A stable ID that represents the current checkout.\n *\n * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\n *\n * This matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data)\n * and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n *\n * Can be `undefined`. Handle the `undefined` state before using the value.\n */\n checkoutToken: SubscribableSignalLike;\n\n /**\n * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n *\n * Empty until the buyer enters enough address information for Shopify to\n * calculate shipping rates.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * Metadata about the running extension, including the current target, API version,\n * capabilities, and editor context. Use this to conditionally render content\n * based on where the extension is running.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n *\n * @deprecated Use `extension.target` instead.\n */\n extensionPoint: Target;\n\n /**\n * Utilities for translating strings, formatting currencies, numbers, and dates\n * according to the buyer's locale. Use alongside\n * [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization)\n * to build fully localized extensions.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The buyer's language, country, currency, and timezone context. For\n * formatting and translation helpers, use the\n * [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#properties-propertydetail-i18n)\n * object instead.\n */\n localization: Localization;\n\n /**\n * The metafields that apply to the current checkout.\n *\n * Metafields are stored locally on the client and are applied to the order object after the checkout completes.\n *\n * These metafields are shared by all extensions running on checkout, and\n * persist for as long as the customer is working on this checkout.\n *\n * Once the order is created, you can query these metafields using the\n * [GraphQL Admin API](/docs/admin-api/graphql/reference/orders/order#metafield-2021-01)\n *\n * > Caution:\n * `metafields` is deprecated. Use `appMetafields` with cart metafields instead.\n *\n * @deprecated Use `appMetafields` with cart metafields instead.\n */\n metafields: SubscribableSignalLike;\n\n /**\n * A note left by the customer to the merchant, either in their cart or during checkout.\n *\n * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\n */\n note: SubscribableSignalLike;\n\n /**\n * The method used to query the Storefront GraphQL API with a prefetched token.\n *\n */\n query: >(\n query: string,\n options?: {variables?: Variables; version?: StorefrontApiVersion},\n ) => Promise<{data?: Data; errors?: GraphQLError[]}>;\n\n /**\n * The payment options the buyer has currently selected. This updates as\n * the buyer changes their payment method. The array can contain multiple\n * entries when the buyer splits payment across methods (for example, a\n * gift card and a credit card).\n *\n * Each option exposes `handle` and `type` only. Provider names, logos,\n * fees, and installment terms aren't available.\n */\n selectedPaymentOptions: SubscribableSignalLike;\n\n /**\n * The session token providing a set of claims as a signed JSON Web Token (JWT).\n *\n * The token has a TTL of five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Learn more about [session tokens](/docs/apps/build/authentication-authorization/session-tokens).\n */\n sessionToken: SessionToken;\n\n /**\n * The settings matching the settings definition written in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates in real time as a merchant fills in the settings.\n */\n settings: SubscribableSignalLike;\n\n /**\n * The proposed customer shipping address. During the information step, the address\n * updates when the field is committed (on change) rather than every keystroke.\n * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n shippingAddress?: SubscribableSignalLike;\n\n /**\n * The proposed customer billing address. The address updates when the field is\n * committed (on change) rather than every keystroke. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided yet.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n billingAddress?: SubscribableSignalLike;\n\n /**\n * The store where the checkout is taking place, including the shop name,\n * storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.\n */\n shop: Shop;\n\n /**\n * Key-value storage that persists across page loads within the current checkout\n * session. Data is shared across all activated targets associated with\n * this extension.\n *\n * > Caution: Data persistence isn't guaranteed and storage is cleared when the\n * buyer starts a new checkout.\n */\n storage: Storage;\n\n /**\n * The renderer version being used for the extension.\n *\n * @example '2025-10'\n */\n version: Version;\n\n /**\n * Customer privacy consent settings and a flag denoting if consent has previously been collected.\n */\n customerPrivacy: SubscribableSignalLike;\n\n /**\n * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`collect_buyer_consent` capability](/docs/apps/build/customer-accounts/capabilities#collect-buyer-consent) to be set to `true`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyTrackingConsentChange: ApplyTrackingConsentChangeType;\n\n /**\n * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" }, "Analytics": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Analytics", - "description": "", + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "publish", "value": "(name: string, data: Record) => Promise", - "description": "Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing)." + "description": "Publishes a custom event to [Web Pixels](/docs/apps/marketing). Returns `true` when the event is successfully dispatched.\n\nThe Promise resolves to `true` when the event was dispatched. The boolean indicates dispatch confirmation only. It doesn't indicate whether any specific web pixel processed the event." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "visitor", "value": "(data: { email?: string; phone?: string; }) => Promise", - "description": "A method for capturing details about a visitor on the online store." + "description": "Submits buyer contact details for attribution and analytics purposes." } ], - "value": "export interface Analytics {\n /**\n * Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing).\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * A method for capturing details about a visitor on the online store.\n */\n visitor(data: {email?: string; phone?: string}): Promise;\n}" + "value": "export interface Analytics {\n /**\n * Publishes a custom event to [Web Pixels](/docs/apps/marketing).\n * Returns `true` when the event is successfully dispatched.\n *\n * The Promise resolves to `true` when the event was dispatched. The boolean\n * indicates dispatch confirmation only. It doesn't indicate whether any\n * specific web pixel processed the event.\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * Submits buyer contact details for attribution and analytics purposes.\n */\n visitor(data: {email?: string; phone?: string}): Promise;\n}" }, "VisitorResult": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -80004,10 +80004,10 @@ "syntaxKind": "PropertySignature", "name": "type", "value": "'error'", - "description": "Indicates that the visitor information is invalid and wasn't submitted. Examples are using the wrong data type or missing a required property." + "description": "Indicates that the visitor information is invalid and wasn't submitted. Common causes include using the wrong data type or omitting a required property." } ], - "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Examples are using the wrong data type or missing a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Common causes include using the wrong data type or omitting a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" }, "SubscribableSignalLike": { "filePath": "src/surfaces/checkout/shared.ts", @@ -80221,10 +80221,10 @@ "syntaxKind": "PropertySignature", "name": "value", "value": "string | null", - "description": "The new value to store in the metafield. Set to `null` to delete the metafield." + "description": "The new value to store in the metafield. Set to `null` to delete the metafield.\n\nConsent metafield values are strings, not booleans. Pass `null` to delete a tracking consent metafield." } ], - "value": "export interface TrackingConsentMetafieldChange {\n /**\n * The identifier for the tracking consent metafield to update.\n */\n key: string;\n /**\n * The new value to store in the metafield. Set to `null` to delete the metafield.\n */\n value: string | null;\n}" + "value": "export interface TrackingConsentMetafieldChange {\n /**\n * The identifier for the tracking consent metafield to update.\n */\n key: string;\n /**\n * The new value to store in the metafield. Set to `null` to delete the metafield.\n *\n * Consent metafield values are strings, not booleans. Pass `null` to delete\n * a tracking consent metafield.\n */\n value: string | null;\n}" }, "VisitorConsent": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -80438,7 +80438,7 @@ "syntaxKind": "PropertySignature", "name": "value", "value": "string", - "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.", + "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.\n\nAttribute values are always strings. To store structured data, serialize it to JSON and parse it when reading.", "examples": [ { "title": "Example", @@ -80453,7 +80453,7 @@ ] } ], - "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" + "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * Attribute values are always strings. To store structured data, serialize\n * it to JSON and parse it when reading.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" }, "PaymentOption": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -80804,7 +80804,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A globally-unique identifier for the customer in the format `gid://shopify/Customer/`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", + "description": "An identifier for the customer in the format `gid://shopify/Customer/`. This value is unique per shop.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", "examples": [ { "title": "Example", @@ -80857,7 +80857,7 @@ "isPrivate": true } ], - "value": "export interface Customer {\n /**\n * A globally-unique identifier for the customer in the format `gid://shopify/Customer/`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'gid://shopify/Customer/123'\n */\n id: string;\n /**\n * The email address associated with the customer's account. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email?: string;\n /**\n * The phone number associated with the customer's account. The value is `undefined` if no phone number is on file or the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone?: string;\n /**\n * The customer's full name, typically a combination of first and last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n fullName?: string;\n /**\n * The customer's first name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n firstName?: string;\n /**\n * The customer's last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n lastName?: string;\n /**\n * The customer's profile image, such as a Gravatar avatar. Use this to personalize the extension UI for the logged-in buyer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n image: ImageDetails;\n /**\n * Whether the customer has opted in to receiving marketing communications from the merchant, such as email campaigns and promotional offers.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * > Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n *\n * @deprecated Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n */\n acceptsMarketing: boolean;\n /**\n * Whether the customer has opted in to email marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsEmailMarketing: boolean;\n /**\n * Whether the customer has opted in to SMS marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsSmsMarketing: boolean;\n /**\n * The store credit accounts owned by this customer that can be used as payment during checkout. Each account has a balance representing available store credit.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @private\n */\n storeCreditAccounts: StoreCreditAccount[];\n /**\n * The number of orders the customer has previously placed with this shop.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n ordersCount: number;\n}" + "value": "export interface Customer {\n /**\n * An identifier for the customer in the format `gid://shopify/Customer/`. This value is unique per shop.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'gid://shopify/Customer/123'\n */\n id: string;\n /**\n * The email address associated with the customer's account. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email?: string;\n /**\n * The phone number associated with the customer's account. The value is `undefined` if no phone number is on file or the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone?: string;\n /**\n * The customer's full name, typically a combination of first and last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n fullName?: string;\n /**\n * The customer's first name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n firstName?: string;\n /**\n * The customer's last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n lastName?: string;\n /**\n * The customer's profile image, such as a Gravatar avatar. Use this to personalize the extension UI for the logged-in buyer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n image: ImageDetails;\n /**\n * Whether the customer has opted in to receiving marketing communications from the merchant, such as email campaigns and promotional offers.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * > Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n *\n * @deprecated Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n */\n acceptsMarketing: boolean;\n /**\n * Whether the customer has opted in to email marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsEmailMarketing: boolean;\n /**\n * Whether the customer has opted in to SMS marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsSmsMarketing: boolean;\n /**\n * The store credit accounts owned by this customer that can be used as payment during checkout. Each account has a balance representing available store credit.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @private\n */\n storeCreditAccounts: StoreCreditAccount[];\n /**\n * The number of orders the customer has previously placed with this shop.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n ordersCount: number;\n}" }, "ImageDetails": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -81139,11 +81139,11 @@ "syntaxKind": "MethodSignature", "name": "perform", "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", + "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.\n\nRuns after all intercept results are collected. Use it for local state updates such as setting an error flag. By the time it runs, the navigation decision is final, so blocking logic belongs in the intercept handler itself, not here.", "isOptional": true } ], - "value": "interface InterceptorRequestAllow {\n /**\n * Indicates that the interceptor allows the buyer's journey to continue.\n */\n behavior: 'allow';\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" + "value": "interface InterceptorRequestAllow {\n /**\n * Indicates that the interceptor allows the buyer's journey to continue.\n */\n behavior: 'allow';\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n *\n * Runs after all intercept results are collected. Use it for local state\n * updates such as setting an error flag. By the time it runs, the navigation\n * decision is final, so blocking logic belongs in the intercept handler\n * itself, not here.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" }, "InterceptorResult": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -81207,7 +81207,7 @@ "syntaxKind": "MethodSignature", "name": "perform", "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", + "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.\n\nRuns after all intercept results are collected. Use it for local state updates such as setting an error flag. By the time it runs, the navigation decision is final, so blocking logic belongs in the intercept handler itself, not here.", "isOptional": true }, { @@ -81218,7 +81218,7 @@ "description": "The reason for blocking the interceptor request. This value isn't presented to the buyer, so it doesn't need to be localized. The value is used only for Shopify's own internal debugging and metrics." } ], - "value": "interface InterceptorRequestBlock {\n /**\n * Indicates that the interceptor blocks the buyer's journey from continuing.\n */\n behavior: 'block';\n\n /**\n * The reason for blocking the interceptor request. This value isn't presented to\n * the buyer, so it doesn't need to be localized. The value is used only for Shopify's\n * own internal debugging and metrics.\n */\n reason: string;\n\n /**\n * Used to pass errors to the checkout UI, outside your extension's UI boundaries.\n */\n errors?: ValidationError[];\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" + "value": "interface InterceptorRequestBlock {\n /**\n * Indicates that the interceptor blocks the buyer's journey from continuing.\n */\n behavior: 'block';\n\n /**\n * The reason for blocking the interceptor request. This value isn't presented to\n * the buyer, so it doesn't need to be localized. The value is used only for Shopify's\n * own internal debugging and metrics.\n */\n reason: string;\n\n /**\n * Used to pass errors to the checkout UI, outside your extension's UI boundaries.\n */\n errors?: ValidationError[];\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n *\n * Runs after all intercept results are collected. Use it for local state\n * updates such as setting an error flag. By the time it runs, the navigation\n * decision is final, so blocking logic belongs in the intercept handler\n * itself, not here.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" }, "ValidationError": { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -81439,17 +81439,17 @@ "syntaxKind": "PropertySignature", "name": "totalShippingAmount", "value": "SubscribableSignalLike", - "description": "The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step." + "description": "The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step.\n\n`undefined` until the buyer selects a shipping method (typically after the information step)." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "totalTaxAmount", "value": "SubscribableSignalLike", - "description": "The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet." + "description": "The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet.\n\n`undefined` when taxes haven't been calculated or aren't available for the buyer's region." } ], - "value": "export interface CartCost {\n /**\n * The sum of all line item prices at the current step of checkout, before shipping and taxes are applied. Use this value to display the base cost of the items the buyer purchased.\n */\n subtotalAmount: SubscribableSignalLike;\n\n /**\n * The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step.\n */\n totalShippingAmount: SubscribableSignalLike;\n\n /**\n * The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet.\n */\n totalTaxAmount: SubscribableSignalLike;\n\n /**\n * The minimum total at the current step of checkout. Costs not yet calculated, such as shipping on the information step, aren't included. Gift cards and store credits are excluded from this total.\n */\n totalAmount: SubscribableSignalLike;\n}" + "value": "export interface CartCost {\n /**\n * The sum of all line item prices at the current step of checkout, before shipping and taxes are applied. Use this value to display the base cost of the items the buyer purchased.\n */\n subtotalAmount: SubscribableSignalLike;\n\n /**\n * The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step.\n *\n * `undefined` until the buyer selects a shipping method (typically after the\n * information step).\n */\n totalShippingAmount: SubscribableSignalLike;\n\n /**\n * The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet.\n *\n * `undefined` when taxes haven't been calculated or aren't available for the\n * buyer's region.\n */\n totalTaxAmount: SubscribableSignalLike;\n\n /**\n * The minimum total at the current step of checkout. Costs not yet calculated, such as shipping on the information step, aren't included. Gift cards and store credits are excluded from this total.\n */\n totalAmount: SubscribableSignalLike;\n}" }, "CustomerPrivacy": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -81536,31 +81536,31 @@ "syntaxKind": "PropertySignature", "name": "analytics", "value": "boolean", - "description": "Whether analytics data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Analytics data includes how the shop was used and what interactions occurred." + "description": "Whether analytics data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Analytics data includes how the shop was used and what interactions occurred.\n\nWhether analytics data can be collected right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.analytics`, before calling `shopify.analytics.publish()`." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "marketing", "value": "boolean", - "description": "Whether marketing data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Marketing data includes attribution and targeted advertising preferences." + "description": "Whether marketing data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Marketing data includes attribution and targeted advertising preferences.\n\nWhether marketing data can be collected right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.marketing`, before performing marketing-related data collection." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "preferences", "value": "boolean", - "description": "Whether preference data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Preference data includes language, currency, and sizing choices." + "description": "Whether preference data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Preference data includes language, currency, and sizing choices.\n\nWhether preference data can be collected right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.preferences`, before storing or reading buyer preference data." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "saleOfData", "value": "boolean", - "description": "Whether data can be shared with third parties based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. This typically applies to behavioral advertising data." + "description": "Whether data can be shared with third parties based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. This typically applies to behavioral advertising data.\n\nWhether buyer data can be shared with or sold to third parties right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.saleOfData`, before sharing or selling buyer data with third parties." } ], - "value": "export interface AllowedProcessing {\n /**\n * Whether analytics data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Analytics\n * data includes how the shop was used and what interactions occurred.\n */\n analytics: boolean;\n /**\n * Whether marketing data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Marketing\n * data includes attribution and targeted advertising preferences.\n */\n marketing: boolean;\n /**\n * Whether preference data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Preference\n * data includes language, currency, and sizing choices.\n */\n preferences: boolean;\n /**\n * Whether data can be shared with third parties based on the visitor's\n * consent, the merchant's privacy configuration, and the visitor's region.\n * This typically applies to behavioral advertising data.\n */\n saleOfData: boolean;\n}" + "value": "export interface AllowedProcessing {\n /**\n * Whether analytics data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Analytics\n * data includes how the shop was used and what interactions occurred.\n *\n * Whether analytics data can be collected right now. Combines the buyer's\n * consent, the merchant's privacy configuration, and the buyer's region into\n * a single boolean. Check this flag, not `visitorConsent.analytics`, before\n * calling `shopify.analytics.publish()`.\n */\n analytics: boolean;\n /**\n * Whether marketing data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Marketing\n * data includes attribution and targeted advertising preferences.\n *\n * Whether marketing data can be collected right now. Combines the buyer's\n * consent, the merchant's privacy configuration, and the buyer's region into\n * a single boolean. Check this flag, not `visitorConsent.marketing`, before\n * performing marketing-related data collection.\n */\n marketing: boolean;\n /**\n * Whether preference data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Preference\n * data includes language, currency, and sizing choices.\n *\n * Whether preference data can be collected right now. Combines the buyer's\n * consent, the merchant's privacy configuration, and the buyer's region into\n * a single boolean. Check this flag, not `visitorConsent.preferences`,\n * before storing or reading buyer preference data.\n */\n preferences: boolean;\n /**\n * Whether data can be shared with third parties based on the visitor's\n * consent, the merchant's privacy configuration, and the visitor's region.\n * This typically applies to behavioral advertising data.\n *\n * Whether buyer data can be shared with or sold to third parties right now.\n * Combines the buyer's consent, the merchant's privacy configuration, and\n * the buyer's region into a single boolean. Check this flag, not\n * `visitorConsent.saleOfData`, before sharing or selling buyer data with\n * third parties.\n */\n saleOfData: boolean;\n}" }, "TrackingConsentMetafield": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -82252,7 +82252,7 @@ "Extension": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Extension", - "description": "The meta information about an extension target.", + "description": "Metadata about the running extension, including its API version, target, capabilities, and editor context. Use this to read configuration details or conditionally render content based on where the extension is running.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -82278,7 +82278,7 @@ "syntaxKind": "PropertySignature", "name": "capabilities", "value": "SubscribableSignalLike", - "description": "The allowed capabilities of the extension, defined in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n\n* [`api_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#api-access): the extension can access the Storefront API.\n\n* [`network_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access): the extension can make external network calls.\n\n* [`block_progress`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n\n* [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n\n* [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can register customer consent decisions that are honored on Shopify-managed services.\n\n* [`iframe.sources`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#iframe): the extension can embed an external URL in an iframe." + "description": "The allowed capabilities of the extension, defined in your [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -82326,7 +82326,7 @@ "syntaxKind": "PropertySignature", "name": "version", "value": "string", - "description": "The published version of the running extension target.\n\nFor unpublished extensions, the value is `undefined`.", + "description": "The published version of the running extension target.\n\nFor unpublished extensions, the value is `undefined`.\n\nDon't use this property as a stable identifier in development environments. It becomes available only after the extension is published.", "isOptional": true, "examples": [ { @@ -82342,7 +82342,7 @@ ] } ], - "value": "export interface Extension {\n /**\n * The API version that was set in the extension config file.\n *\n * @example '2024-10', '2025-01', '2025-04', '2025-07', '2025-10'\n */\n apiVersion: ApiVersion;\n\n /**\n * The allowed capabilities of the extension, defined\n * in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n *\n * * [`api_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#api-access): the extension can access the Storefront API.\n *\n * * [`network_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access): the extension can make external network calls.\n *\n * * [`block_progress`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n *\n * * [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n *\n * * [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can register customer consent decisions that are honored on Shopify-managed services.\n *\n * * [`iframe.sources`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#iframe): the extension can embed an external URL in an iframe.\n */\n capabilities: SubscribableSignalLike;\n\n /**\n * Information about the editor where the extension is being rendered.\n *\n * If the value is undefined, then the extension isn't running in an editor.\n */\n editor?: Editor;\n\n /**\n * A Boolean to show whether your extension is currently rendered to the screen.\n *\n * Shopify might render your extension before it's visible in the UI,\n * typically to pre-render extensions that appear on a later step of the\n * checkout.\n *\n * Your extension might also continue to run after the customer has navigated away\n * from where it was rendered. The extension continues running so that\n * your extension is immediately available to render if the customer navigates back.\n */\n rendered: SubscribableSignalLike;\n\n /**\n * The URL to the script that started the extension target.\n */\n scriptUrl: string;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n */\n target: Target;\n\n /**\n * The published version of the running extension target.\n *\n * For unpublished extensions, the value is `undefined`.\n *\n * @example 3.0.10\n */\n version?: string;\n}" + "value": "export interface Extension {\n /**\n * The API version that was set in the extension config file.\n *\n * @example '2024-10', '2025-01', '2025-04', '2025-07', '2025-10'\n */\n apiVersion: ApiVersion;\n\n /**\n * The allowed capabilities of the extension, defined in your\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n */\n capabilities: SubscribableSignalLike;\n\n /**\n * Information about the editor where the extension is being rendered.\n *\n * If the value is undefined, then the extension isn't running in an editor.\n */\n editor?: Editor;\n\n /**\n * A Boolean to show whether your extension is currently rendered to the screen.\n *\n * Shopify might render your extension before it's visible in the UI,\n * typically to pre-render extensions that appear on a later step of the\n * checkout.\n *\n * Your extension might also continue to run after the customer has navigated away\n * from where it was rendered. The extension continues running so that\n * your extension is immediately available to render if the customer navigates back.\n */\n rendered: SubscribableSignalLike;\n\n /**\n * The URL to the script that started the extension target.\n */\n scriptUrl: string;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n */\n target: Target;\n\n /**\n * The published version of the running extension target.\n *\n * For unpublished extensions, the value is `undefined`.\n *\n * Don't use this property as a stable identifier in development environments.\n * It becomes available only after the extension is published.\n *\n * @example 3.0.10\n */\n version?: string;\n}" }, "ApiVersion": { "filePath": "src/shared.ts", @@ -82361,7 +82361,7 @@ "Editor": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Editor", - "description": "", + "description": "Information about the editor environment when an extension is rendered inside the checkout editor. The value is `undefined` when the extension is not rendering in an editor.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -82376,7 +82376,7 @@ "I18n": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18n", - "description": "", + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use the I18n API alongside the Localization API to build fully localized extensions.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -82412,7 +82412,7 @@ "I18nTranslate": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18nTranslate", - "description": "This returns a translated string matching a key in a locale file.", + "description": "Translates a key from your extension's locale files into a localized string. Supports interpolation with placeholder replacements and pluralization via the special `count` option.", "members": [], "value": "export interface I18nTranslate {\n (\n key: string,\n options?: Record,\n ): ReplacementType extends string | number\n ? string\n : (string | ReplacementType)[];\n}" }, @@ -82976,14 +82976,14 @@ "Localization": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Localization", - "description": "", + "description": "The buyer's language, country, currency, and timezone context. Use this to adapt your extension to the buyer's region and display localized content.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "country", "value": "SubscribableSignalLike", - "description": "The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown." + "description": "The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n\nDerived from the buyer's shipping address. Returns `undefined` until the buyer enters a shipping address." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -83011,18 +83011,18 @@ "syntaxKind": "PropertySignature", "name": "market", "value": "SubscribableSignalLike", - "description": "The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n\n> Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.", - "deprecationMessage": "Deprecated as of version `2025-04`" + "description": "The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. The market context updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.", + "deprecationMessage": "Merchants now manage which extensions load for each\nmarket, so extensions no longer need to check this value." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "timezone", "value": "SubscribableSignalLike", - "description": "The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time." + "description": "The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time." } ], - "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n *\n * > Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" + "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n *\n * Derived from the buyer's shipping address. Returns `undefined` until the\n * buyer enters a shipping address.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout,\n * carried over from the cart context. Markets group countries and\n * regions with shared pricing, languages, and domains. The market\n * context updates when the buyer changes the country of their\n * shipping address. The value is `undefined` if the market is unknown.\n *\n * @deprecated Merchants now manage which extensions load for each\n * market, so extensions no longer need to check this value.\n */\n market: SubscribableSignalLike;\n}" }, "Country": { "filePath": "src/shared.ts", @@ -83223,7 +83223,7 @@ "SessionToken": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SessionToken", - "description": "", + "description": "Authenticates requests between your extension and your app backend. Use session tokens to verify the identity of the buyer and the shop context when making server-side API calls. The token is a signed JWT that contains claims such as the customer ID, shop domain, and expiration.\n\nThe `sub` claim in the decoded token is present only when the buyer is logged in and the app has permission to read customer accounts. Absent for anonymous buyers.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -83482,7 +83482,7 @@ "Shop": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Shop", - "description": "", + "description": "Metadata about the merchant's store, including its name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -83522,30 +83522,30 @@ "syntaxKind": "PropertySignature", "name": "storefrontUrl", "value": "string", - "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n\n> Caution: > As of version `2024-04` this value no longer has a trailing slash.", + "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.", "isOptional": true } ], - "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n *\n * > Caution:\n * > As of version `2024-04` this value no longer has a trailing slash.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom domain.\n */\n myshopifyDomain: string;\n}" + "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom domain.\n */\n myshopifyDomain: string;\n}" }, "Storage": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Storage", - "description": "A key-value storage object for the extension.\n\nStored data is available only to this specific extension and any of its instances.\n\nThe storage backend is implemented with `localStorage` and should persist across the buyer's checkout session. However, data persistence isn't guaranteed.", + "description": "Key-value storage for a specific extension. Use storage to save preferences or cached data that should survive page reloads without requiring a backend call. Stored data is only available to this specific extension. The storage backend is implemented with `localStorage` and data persistence isn't guaranteed.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "delete", "value": "(key: string) => Promise", - "description": "Delete stored data by key." + "description": "Deletes a previously stored value by key." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "read", "value": "(key: string) => Promise", - "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original primitive.\n\nReturns `null` if no stored data exists." + "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original type.\n\nReturns the stored value for the given key, or `null` when no value exists. Doesn't throw on a missing key." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -83555,7 +83555,7 @@ "description": "Write stored data for this key.\n\nThe data must be serializable to JSON." } ], - "value": "export interface Storage {\n /**\n * Read and return a stored value by key.\n *\n * The stored data is deserialized from JSON and returned as\n * its original primitive.\n *\n * Returns `null` if no stored data exists.\n */\n read(key: string): Promise;\n\n /**\n * Write stored data for this key.\n *\n * The data must be serializable to JSON.\n */\n write(key: string, data: any): Promise;\n\n /**\n * Delete stored data by key.\n */\n delete(key: string): Promise;\n}" + "value": "export interface Storage {\n /**\n * Read and return a stored value by key.\n *\n * The stored data is deserialized from JSON and returned as\n * its original type.\n *\n * Returns the stored value for the given key, or `null` when no value\n * exists. Doesn't throw on a missing key.\n */\n read(key: string): Promise;\n\n /**\n * Write stored data for this key.\n *\n * The data must be serializable to JSON.\n */\n write(key: string, data: any): Promise;\n\n /**\n * Deletes a previously stored value by key.\n */\n delete(key: string): Promise;\n}" }, "Version": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -83631,7 +83631,7 @@ "syntaxKind": "MethodSignature", "name": "applyAttributeChange", "value": "(change: AttributeChange) => Promise", - "description": "Updates or removes an attribute on the cart and checkout. On success, the [`attributes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/attributes#standardapi-propertydetail-attributes) property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.", + "description": "Updates or removes an attribute on the cart and checkout. On success, the [`attributes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/attributes#properties-propertydetail-attributes) property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.", "deprecationMessage": "Use cart metafields instead." }, { @@ -83639,42 +83639,42 @@ "syntaxKind": "MethodSignature", "name": "applyCartLinesChange", "value": "(change: CartLineChange) => Promise", - "description": "Adds, removes, or updates line items in the cart. The returned promise resolves when the change has been applied by the server, and the [`lines`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-lines#standardapi-propertydetail-lines) property updates with the new state.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Adds, removes, or updates line items in the cart. The returned promise resolves when the change has been applied by the server, and the [`lines`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-lines#properties-propertydetail-lines) property updates with the new state.\n\nAccepts a single change per call. To make multiple changes, call this method separately for each one.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyDiscountCodeChange", "value": "(change: DiscountCodeChange) => Promise", - "description": "Adds or removes a discount code on the checkout. The returned promise resolves when the change has been applied by the server, and the [`discountCodes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/discounts#standardapi-propertydetail-discountcodes) property updates with the new state.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves discount codes through a network call.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Adds or removes a discount code on the checkout. The returned promise resolves when the change has been applied by the server, and the [`discountCodes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/discounts#properties-propertydetail-discountcodes) property updates with the new state.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves discount codes through a network call.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyGiftCardChange", "value": "(change: GiftCardChange) => Promise", - "description": "Adds or removes a gift card from the checkout. The returned promise resolves when the change has been applied by the server, and the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/gift-cards#standardapi-propertydetail-appliedgiftcards) property updates with the new state.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves gift card codes through a network call.\n\n> Note: This method returns an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Adds or removes a gift card from the checkout. The returned promise resolves when the change has been applied by the server, and the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/gift-cards#properties-propertydetail-appliedgiftcards) property updates with the new state.\n\nUnlike other write operations, gift card changes aren't gated by a cart instruction flag.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves gift card codes through a network call.\n\n> Note: This method returns an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyMetafieldChange", "value": "(change: MetafieldChange) => Promise", - "description": "Creates, updates, or removes a cart metafield on the checkout. On success, the [`metafields`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/metafields#standardapi-propertydetail-metafields) property updates to reflect the change.\n\nCart metafields are copied to order metafields at order creation time if there's a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n\n> Caution: `MetafieldRemoveChange` and `MetafieldUpdateChange` are deprecated. Use cart metafields with `MetafieldRemoveCartChange` and `MetafieldUpdateCartChange` instead. If `MetafieldUpdateChange` writes a metafield with the same namespace and key as a cart metafield that's configured to copy, the cart metafield won't be copied.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Creates, updates, or removes a cart metafield on the checkout. On success, the [`metafields`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/metafields#properties-propertydetail-metafields) property updates to reflect the change.\n\nCart metafields are copied to order metafields at order creation time if there's a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n\n> Caution: `MetafieldRemoveChange` and `MetafieldUpdateChange` are deprecated. Use cart metafields with `MetafieldRemoveCartChange` and `MetafieldUpdateCartChange` instead. If `MetafieldUpdateChange` writes a metafield with the same namespace and key as a cart metafield that's configured to copy, the cart metafield won't be copied.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyNoteChange", "value": "(change: NoteChange) => Promise", - "description": "Sets or removes the buyer's note on the checkout. On success, the [`note`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/note#standardapi-propertydetail-note) property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Sets or removes the buyer's note on the checkout. On success, the [`note`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/note#properties-propertydetail-note) property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyShippingAddressChange", "value": "(change: ShippingAddressUpdateChange) => Promise", - "description": "Updates the buyer's shipping address on the checkout. The provided fields are merged into the existing address without prompting the buyer. On success, the `shippingAddress` property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", + "description": "Updates the buyer's shipping address on the checkout. The provided fields are merged into the existing address without prompting the buyer. On success, the `shippingAddress` property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", "isOptional": true }, { @@ -83687,7 +83687,7 @@ "isPrivate": true } ], - "value": "export interface CheckoutApi {\n /**\n * Updates or removes an attribute on the cart and checkout. On success, the\n * [`attributes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/attributes#standardapi-propertydetail-attributes) property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * @deprecated Use cart metafields instead.\n */\n applyAttributeChange(change: AttributeChange): Promise;\n\n /**\n * Adds, removes, or updates line items in the cart. The returned promise resolves when the change has been applied by the server, and the [`lines`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-lines#standardapi-propertydetail-lines) property updates with the new state.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyCartLinesChange(change: CartLineChange): Promise;\n\n /**\n * Adds or removes a discount code on the checkout. The returned promise resolves when the change has been applied by the server, and the [`discountCodes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/discounts#standardapi-propertydetail-discountcodes) property updates with the new state.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves discount codes through a network call.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyDiscountCodeChange(\n change: DiscountCodeChange,\n ): Promise;\n\n /**\n * Adds or removes a gift card from the checkout. The returned promise resolves when the change has been applied by the server, and the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/gift-cards#standardapi-propertydetail-appliedgiftcards) property updates with the new state.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves gift card codes through a network call.\n *\n * > Note: This method returns an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyGiftCardChange(change: GiftCardChange): Promise;\n\n /**\n * Creates, updates, or removes a cart metafield on the checkout. On success, the\n * [`metafields`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/metafields#standardapi-propertydetail-metafields) property updates to reflect the change.\n *\n * Cart metafields are copied to order metafields at order creation time if there's a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n *\n * > Caution: `MetafieldRemoveChange` and `MetafieldUpdateChange` are deprecated. Use cart metafields with `MetafieldRemoveCartChange` and `MetafieldUpdateCartChange` instead. If `MetafieldUpdateChange` writes a metafield with the same namespace and key as a cart metafield that's configured to copy, the cart metafield won't be copied.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyMetafieldChange(change: MetafieldChange): Promise;\n\n /**\n * Sets or removes the buyer's note on the checkout. On success, the\n * [`note`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/note#standardapi-propertydetail-note)\n * property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyNoteChange(change: NoteChange): Promise;\n\n /**\n * @private\n */\n experimentalIsShopAppStyle?: boolean;\n\n /**\n * Updates the buyer's shipping address on the checkout. The provided fields\n * are merged into the existing address without prompting the buyer. On success,\n * the `shippingAddress` property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyShippingAddressChange?(\n change: ShippingAddressChange,\n ): Promise;\n}" + "value": "export interface CheckoutApi {\n /**\n * Updates or removes an attribute on the cart and checkout. On success, the\n * [`attributes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/attributes#properties-propertydetail-attributes) property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * @deprecated Use cart metafields instead.\n */\n applyAttributeChange(change: AttributeChange): Promise;\n\n /**\n * Adds, removes, or updates line items in the cart. The returned promise resolves when the change has been applied by the server, and the [`lines`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-lines#properties-propertydetail-lines) property updates with the new state.\n *\n * Accepts a single change per call. To make multiple changes, call this\n * method separately for each one.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyCartLinesChange(change: CartLineChange): Promise;\n\n /**\n * Adds or removes a discount code on the checkout. The returned promise resolves when the change has been applied by the server, and the [`discountCodes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/discounts#properties-propertydetail-discountcodes) property updates with the new state.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves discount codes through a network call.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyDiscountCodeChange(\n change: DiscountCodeChange,\n ): Promise;\n\n /**\n * Adds or removes a gift card from the checkout. The returned promise resolves when the change has been applied by the server, and the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/gift-cards#properties-propertydetail-appliedgiftcards) property updates with the new state.\n *\n * Unlike other write operations, gift card changes aren't gated by a cart\n * instruction flag.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves gift card codes through a network call.\n *\n * > Note: This method returns an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyGiftCardChange(change: GiftCardChange): Promise;\n\n /**\n * Creates, updates, or removes a cart metafield on the checkout. On success, the\n * [`metafields`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/metafields#properties-propertydetail-metafields) property updates to reflect the change.\n *\n * Cart metafields are copied to order metafields at order creation time if there's a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n *\n * > Caution: `MetafieldRemoveChange` and `MetafieldUpdateChange` are deprecated. Use cart metafields with `MetafieldRemoveCartChange` and `MetafieldUpdateCartChange` instead. If `MetafieldUpdateChange` writes a metafield with the same namespace and key as a cart metafield that's configured to copy, the cart metafield won't be copied.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyMetafieldChange(change: MetafieldChange): Promise;\n\n /**\n * Sets or removes the buyer's note on the checkout. On success, the\n * [`note`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/note#properties-propertydetail-note)\n * property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyNoteChange(change: NoteChange): Promise;\n\n /**\n * @private\n */\n experimentalIsShopAppStyle?: boolean;\n\n /**\n * Updates the buyer's shipping address on the checkout. The provided fields\n * are merged into the existing address without prompting the buyer. On success,\n * the `shippingAddress` property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyShippingAddressChange?(\n change: ShippingAddressChange,\n ): Promise;\n}" }, "AttributeChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -83754,7 +83754,7 @@ "syntaxKind": "PropertySignature", "name": "value", "value": "string", - "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.", + "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.\n\nAttribute values are always strings. To store structured data, serialize it to JSON and parse it when reading.", "examples": [ { "title": "Example", @@ -83769,7 +83769,7 @@ ] } ], - "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" + "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * Attribute values are always strings. To store structured data, serialize\n * it to JSON and parse it when reading.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" }, "AttributeRemoveChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -84622,7 +84622,7 @@ "syntaxKind": "PropertySignature", "name": "message", "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer." + "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer.\n\nRender your own localized error text rather than displaying this message to the buyer." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -84632,7 +84632,7 @@ "description": "Indicates that the line item wasn't changed successfully. Refer to the `message` property for details about the error." } ], - "value": "export interface CartLineChangeResultError {\n /**\n * Indicates that the line item wasn't changed successfully. Refer to the `message` property for details about the error.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface CartLineChangeResultError {\n /**\n * Indicates that the line item wasn't changed successfully. Refer to the `message` property for details about the error.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n *\n * Render your own localized error text rather than displaying this message\n * to the buyer.\n */\n message: string;\n}" }, "DiscountCodeChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -84812,7 +84812,7 @@ "syntaxKind": "PropertySignature", "name": "message", "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer." + "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer.\n\nRender your own localized error text rather than displaying this message to the buyer." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -84822,7 +84822,7 @@ "description": "Indicates that the gift card change couldn't be applied. Check the `message` property for details." } ], - "value": "export interface GiftCardChangeResultError {\n /**\n * Indicates that the gift card change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface GiftCardChangeResultError {\n /**\n * Indicates that the gift card change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n *\n * Render your own localized error text rather than displaying this message\n * to the buyer.\n */\n message: string;\n}" }, "MetafieldChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -85083,7 +85083,7 @@ "syntaxKind": "PropertySignature", "name": "message", "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer." + "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer.\n\nRender your own localized error text rather than displaying this message to the buyer." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -85093,7 +85093,7 @@ "description": "Indicates that the metafield change couldn't be applied. Check the `message` property for details." } ], - "value": "export interface MetafieldChangeResultError {\n /**\n * Indicates that the metafield change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface MetafieldChangeResultError {\n /**\n * Indicates that the metafield change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n *\n * Render your own localized error text rather than displaying this message\n * to the buyer.\n */\n message: string;\n}" }, "NoteChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -85171,7 +85171,7 @@ "syntaxKind": "PropertySignature", "name": "message", "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer." + "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer.\n\nRender your own localized error text rather than displaying this message to the buyer." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -85181,7 +85181,7 @@ "description": "Indicates that the note change couldn't be applied. Check the `message` property for details." } ], - "value": "export interface NoteChangeResultError {\n /**\n * Indicates that the note change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface NoteChangeResultError {\n /**\n * Indicates that the note change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n *\n * Render your own localized error text rather than displaying this message\n * to the buyer.\n */\n message: string;\n}" }, "ShippingAddressUpdateChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -85767,7 +85767,7 @@ "syntaxKind": "PropertySignature", "name": "analytics", "value": "Analytics", - "description": "The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event." + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -85781,7 +85781,7 @@ "syntaxKind": "PropertySignature", "name": "applyTrackingConsentChange", "value": "ApplyTrackingConsentChangeType", - "description": "Enables setting and updating customer privacy consent settings and tracking consent metafields.\n\n> Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent) to be set to `true`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." + "description": "Enables setting and updating customer privacy consent settings and tracking consent metafields.\n\n> Note: Requires the [`collect_buyer_consent` capability](/docs/apps/build/customer-accounts/capabilities#collect-buyer-consent) to be set to `true`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -85802,7 +85802,7 @@ "syntaxKind": "PropertySignature", "name": "availablePaymentOptions", "value": "SubscribableSignalLike", - "description": "All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region." + "description": "All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n\nThe set of payment options can change when the buyer updates their address or cart, so subscribe to changes rather than reading once during initialization. Each option exposes `handle` and `type` only. Provider names, logos, fees, and installment terms aren't available." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -85839,7 +85839,7 @@ "syntaxKind": "PropertySignature", "name": "checkoutToken", "value": "SubscribableSignalLike", - "description": "A stable ID that represents the current checkout.\n\nThe value is `undefined` when the checkout hasn't been created on the server yet.\n\nUse this to correlate checkout sessions across your extension, web pixels, and backend systems.\n\nThis matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data) and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object)." + "description": "A stable ID that represents the current checkout.\n\nThe value is `undefined` when the checkout hasn't been created on the server yet.\n\nUse this to correlate checkout sessions across your extension, web pixels, and backend systems.\n\nThis matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data) and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n\nCan be `undefined`. Handle the `undefined` state before using the value." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -85860,7 +85860,7 @@ "syntaxKind": "PropertySignature", "name": "deliveryGroups", "value": "SubscribableSignalLike", - "description": "The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items." + "description": "The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n\nEmpty until the buyer enters enough address information for Shopify to calculate shipping rates." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -85881,7 +85881,7 @@ "syntaxKind": "PropertySignature", "name": "extension", "value": "Extension", - "description": "The meta information about the extension." + "description": "Metadata about the running extension, including the current target, API version, capabilities, and editor context. Use this to conditionally render content based on where the extension is running." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -85889,7 +85889,7 @@ "name": "extensionPoint", "value": "Target", "description": "The identifier that specifies where in Shopify's UI your code is being injected. This is one of the targets you've included in your extension's configuration file.", - "deprecationMessage": "Deprecated as of version `2023-07`, use `extension.target` instead.", + "deprecationMessage": "Use `extension.target` instead.", "examples": [ { "title": "Example", @@ -85908,14 +85908,14 @@ "syntaxKind": "PropertySignature", "name": "i18n", "value": "I18n", - "description": "Utilities for translating content and formatting values according to the current [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) of the checkout.\n\nRefer to [`localization` examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples) for more information." + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use alongside [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) to build fully localized extensions." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "instructions", "value": "SubscribableSignalLike", - "description": "The cart instructions used to create the checkout and possibly limit extension capabilities.\n\nThese instructions should be checked before performing any actions that might be affected by them.\n\nFor example, if you intend to add a discount code via the `applyDiscountCodeChange` method, check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n\n> Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs aren't available. See the [update guide](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples) for more information." + "description": "The cart instructions used to create the checkout and possibly limit extension capabilities.\n\nThese instructions should be checked before performing any actions that might be affected by them.\n\nFor example, if you intend to add a discount code via the `applyDiscountCodeChange` method, check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n\n> Caution: Check cart instructions before calling select APIs, as > some may not be available. See the > [Cart Instructions API](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples) > for more information." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -85929,7 +85929,7 @@ "syntaxKind": "PropertySignature", "name": "localization", "value": "Localization", - "description": "The details about the location, language, and currency of the customer. For utilities to easily format and translate content based on these details, you can use the [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n) object instead." + "description": "The buyer's language, country, currency, and timezone context. For formatting and translation helpers, use the [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#properties-propertydetail-i18n) object instead." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -85959,21 +85959,21 @@ "syntaxKind": "PropertySignature", "name": "query", "value": ">(query: string, options?: { variables?: Variables; version?: StorefrontApiVersion; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>", - "description": "The method used to query the Storefront GraphQL API with a prefetched token.\n\nRefer to [Storefront API access examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/storefront-api) for more information." + "description": "The method used to query the Storefront GraphQL API with a prefetched token." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "selectedPaymentOptions", "value": "SubscribableSignalLike", - "description": "The payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card)." + "description": "The payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\n\nEach option exposes `handle` and `type` only. Provider names, logos, fees, and installment terms aren't available." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "sessionToken", "value": "SessionToken", - "description": "The session token providing a set of claims as a signed JSON Web Token (JWT).\n\nThe token has a TTL of five minutes.\n\nIf the previous token expires, this value reflects a new session token with a new signature and expiry.\n\nRefer to [session token examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/session-token) for more information." + "description": "The session token providing a set of claims as a signed JSON Web Token (JWT).\n\nThe token has a TTL of five minutes.\n\nIf the previous token expires, this value reflects a new session token with a new signature and expiry.\n\nLearn more about [session tokens](/docs/apps/build/authentication-authorization/session-tokens)." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -85995,14 +85995,14 @@ "syntaxKind": "PropertySignature", "name": "shop", "value": "Shop", - "description": "The shop where the checkout is taking place." + "description": "The store where the checkout is taking place, including the shop name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "storage", "value": "Storage", - "description": "The key-value storage for the extension.\n\nIt uses `localStorage` and should persist across the customer's current checkout session.\n\n> Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n\nData is shared across all activated extension targets of this extension. In versions 2023-07 and earlier, each activated extension target had its own storage." + "description": "Key-value storage that persists across page loads within the current checkout session. Data is shared across all activated targets associated with this extension.\n\n> Caution: Data persistence isn't guaranteed and storage is cleared when the buyer starts a new checkout." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -86024,29 +86024,29 @@ ] } ], - "value": "export interface StandardApi {\n /**\n * The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event.\n */\n analytics: Analytics;\n\n /**\n * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\n */\n appliedGiftCards: SubscribableSignalLike;\n\n /**\n * The cart instructions used to create the checkout and possibly limit extension capabilities.\n *\n * These instructions should be checked before performing any actions that might be affected by them.\n *\n * For example, if you intend to add a discount code via the `applyDiscountCodeChange` method,\n * check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n *\n * > Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs aren't available.\n * See the [update guide](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples) for more information.\n *\n */\n instructions: SubscribableSignalLike;\n\n /**\n * The metafields requested in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration)\n * file. These metafields are updated when there's a change in the merchandise items\n * being purchased by the customer.\n *\n * App owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` isn't supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n appMetafields: SubscribableSignalLike;\n\n /**\n * The custom key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n buyerIdentity?: BuyerIdentity;\n\n /**\n * Provides details on the buyer's progression through the checkout and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/buyer-journey#examples)\n * examples for more information.\n */\n buyerJourney: BuyerJourney;\n\n /**\n * Settings applied to the buyer's checkout.\n */\n checkoutSettings: SubscribableSignalLike;\n\n /**\n * A stable ID that represents the current checkout.\n *\n * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\n *\n * This matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data)\n * and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n */\n checkoutToken: SubscribableSignalLike;\n\n /**\n * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * The meta information about the extension.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n *\n * @deprecated Deprecated as of version `2023-07`, use `extension.target` instead.\n */\n extensionPoint: Target;\n\n /**\n * Utilities for translating content and formatting values according to the current\n * [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization)\n * of the checkout.\n *\n * Refer to [`localization` examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples)\n * for more information.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The details about the location, language, and currency of the customer. For utilities to easily\n * format and translate content based on these details, you can use the\n * [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n)\n * object instead.\n */\n localization: Localization;\n\n /**\n * The metafields that apply to the current checkout.\n *\n * Metafields are stored locally on the client and are applied to the order object after the checkout completes.\n *\n * These metafields are shared by all extensions running on checkout, and\n * persist for as long as the customer is working on this checkout.\n *\n * Once the order is created, you can query these metafields using the\n * [GraphQL Admin API](/docs/admin-api/graphql/reference/orders/order#metafield-2021-01)\n *\n * > Caution:\n * `metafields` is deprecated. Use `appMetafields` with cart metafields instead.\n *\n * @deprecated Use `appMetafields` with cart metafields instead.\n */\n metafields: SubscribableSignalLike;\n\n /**\n * A note left by the customer to the merchant, either in their cart or during checkout.\n *\n * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\n */\n note: SubscribableSignalLike;\n\n /**\n * The method used to query the Storefront GraphQL API with a prefetched token.\n *\n * Refer to [Storefront API access examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/storefront-api) for more information.\n */\n query: >(\n query: string,\n options?: {variables?: Variables; version?: StorefrontApiVersion},\n ) => Promise<{data?: Data; errors?: GraphQLError[]}>;\n\n /**\n * The payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\n */\n selectedPaymentOptions: SubscribableSignalLike;\n\n /**\n * The session token providing a set of claims as a signed JSON Web Token (JWT).\n *\n * The token has a TTL of five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/session-token) for more information.\n */\n sessionToken: SessionToken;\n\n /**\n * The settings matching the settings definition written in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates in real time as a merchant fills in the settings.\n */\n settings: SubscribableSignalLike;\n\n /**\n * The proposed customer shipping address. During the information step, the address\n * updates when the field is committed (on change) rather than every keystroke.\n * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n shippingAddress?: SubscribableSignalLike;\n\n /**\n * The proposed customer billing address. The address updates when the field is\n * committed (on change) rather than every keystroke. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided yet.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n billingAddress?: SubscribableSignalLike;\n\n /** The shop where the checkout is taking place. */\n shop: Shop;\n\n /**\n * The key-value storage for the extension.\n *\n * It uses `localStorage` and should persist across the customer's current checkout session.\n *\n * > Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n *\n * Data is shared across all activated extension targets of this extension. In versions 2023-07 and earlier,\n * each activated extension target had its own storage.\n */\n storage: Storage;\n\n /**\n * The renderer version being used for the extension.\n *\n * @example '2025-10'\n */\n version: Version;\n\n /**\n * Customer privacy consent settings and a flag denoting if consent has previously been collected.\n */\n customerPrivacy: SubscribableSignalLike;\n\n /**\n * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent) to be set to `true`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyTrackingConsentChange: ApplyTrackingConsentChangeType;\n\n /**\n * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" + "value": "export interface StandardApi {\n /**\n * Tracks custom events and sends visitor information to\n * [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events\n * and `visitor()` to submit buyer contact details.\n */\n analytics: Analytics;\n\n /**\n * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\n */\n appliedGiftCards: SubscribableSignalLike;\n\n /**\n * The cart instructions used to create the checkout and possibly limit extension capabilities.\n *\n * These instructions should be checked before performing any actions that might be affected by them.\n *\n * For example, if you intend to add a discount code via the `applyDiscountCodeChange` method,\n * check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n *\n * > Caution: Check cart instructions before calling select APIs, as\n * > some may not be available. See the\n * > [Cart Instructions API](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples)\n * > for more information.\n *\n */\n instructions: SubscribableSignalLike;\n\n /**\n * The metafields requested in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration)\n * file. These metafields are updated when there's a change in the merchandise items\n * being purchased by the customer.\n *\n * App owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` isn't supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n appMetafields: SubscribableSignalLike;\n\n /**\n * The custom key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as\n * credit cards, wallets, and local payment methods. The list depends on\n * the shop's payment configuration and the buyer's region.\n *\n * The set of payment options can change when the buyer updates their\n * address or cart, so subscribe to changes rather than reading once\n * during initialization. Each option exposes `handle` and `type` only.\n * Provider names, logos, fees, and installment terms aren't available.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n buyerIdentity?: BuyerIdentity;\n\n /**\n * Provides details on the buyer's progression through the checkout and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/buyer-journey#examples)\n * examples for more information.\n */\n buyerJourney: BuyerJourney;\n\n /**\n * Settings applied to the buyer's checkout.\n */\n checkoutSettings: SubscribableSignalLike;\n\n /**\n * A stable ID that represents the current checkout.\n *\n * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\n *\n * This matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data)\n * and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n *\n * Can be `undefined`. Handle the `undefined` state before using the value.\n */\n checkoutToken: SubscribableSignalLike;\n\n /**\n * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n *\n * Empty until the buyer enters enough address information for Shopify to\n * calculate shipping rates.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * Metadata about the running extension, including the current target, API version,\n * capabilities, and editor context. Use this to conditionally render content\n * based on where the extension is running.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n *\n * @deprecated Use `extension.target` instead.\n */\n extensionPoint: Target;\n\n /**\n * Utilities for translating strings, formatting currencies, numbers, and dates\n * according to the buyer's locale. Use alongside\n * [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization)\n * to build fully localized extensions.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The buyer's language, country, currency, and timezone context. For\n * formatting and translation helpers, use the\n * [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#properties-propertydetail-i18n)\n * object instead.\n */\n localization: Localization;\n\n /**\n * The metafields that apply to the current checkout.\n *\n * Metafields are stored locally on the client and are applied to the order object after the checkout completes.\n *\n * These metafields are shared by all extensions running on checkout, and\n * persist for as long as the customer is working on this checkout.\n *\n * Once the order is created, you can query these metafields using the\n * [GraphQL Admin API](/docs/admin-api/graphql/reference/orders/order#metafield-2021-01)\n *\n * > Caution:\n * `metafields` is deprecated. Use `appMetafields` with cart metafields instead.\n *\n * @deprecated Use `appMetafields` with cart metafields instead.\n */\n metafields: SubscribableSignalLike;\n\n /**\n * A note left by the customer to the merchant, either in their cart or during checkout.\n *\n * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\n */\n note: SubscribableSignalLike;\n\n /**\n * The method used to query the Storefront GraphQL API with a prefetched token.\n *\n */\n query: >(\n query: string,\n options?: {variables?: Variables; version?: StorefrontApiVersion},\n ) => Promise<{data?: Data; errors?: GraphQLError[]}>;\n\n /**\n * The payment options the buyer has currently selected. This updates as\n * the buyer changes their payment method. The array can contain multiple\n * entries when the buyer splits payment across methods (for example, a\n * gift card and a credit card).\n *\n * Each option exposes `handle` and `type` only. Provider names, logos,\n * fees, and installment terms aren't available.\n */\n selectedPaymentOptions: SubscribableSignalLike;\n\n /**\n * The session token providing a set of claims as a signed JSON Web Token (JWT).\n *\n * The token has a TTL of five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Learn more about [session tokens](/docs/apps/build/authentication-authorization/session-tokens).\n */\n sessionToken: SessionToken;\n\n /**\n * The settings matching the settings definition written in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates in real time as a merchant fills in the settings.\n */\n settings: SubscribableSignalLike;\n\n /**\n * The proposed customer shipping address. During the information step, the address\n * updates when the field is committed (on change) rather than every keystroke.\n * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n shippingAddress?: SubscribableSignalLike;\n\n /**\n * The proposed customer billing address. The address updates when the field is\n * committed (on change) rather than every keystroke. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided yet.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n billingAddress?: SubscribableSignalLike;\n\n /**\n * The store where the checkout is taking place, including the shop name,\n * storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.\n */\n shop: Shop;\n\n /**\n * Key-value storage that persists across page loads within the current checkout\n * session. Data is shared across all activated targets associated with\n * this extension.\n *\n * > Caution: Data persistence isn't guaranteed and storage is cleared when the\n * buyer starts a new checkout.\n */\n storage: Storage;\n\n /**\n * The renderer version being used for the extension.\n *\n * @example '2025-10'\n */\n version: Version;\n\n /**\n * Customer privacy consent settings and a flag denoting if consent has previously been collected.\n */\n customerPrivacy: SubscribableSignalLike;\n\n /**\n * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`collect_buyer_consent` capability](/docs/apps/build/customer-accounts/capabilities#collect-buyer-consent) to be set to `true`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyTrackingConsentChange: ApplyTrackingConsentChangeType;\n\n /**\n * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" }, "Analytics": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Analytics", - "description": "", + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "publish", "value": "(name: string, data: Record) => Promise", - "description": "Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing)." + "description": "Publishes a custom event to [Web Pixels](/docs/apps/marketing). Returns `true` when the event is successfully dispatched.\n\nThe Promise resolves to `true` when the event was dispatched. The boolean indicates dispatch confirmation only. It doesn't indicate whether any specific web pixel processed the event." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "visitor", "value": "(data: { email?: string; phone?: string; }) => Promise", - "description": "A method for capturing details about a visitor on the online store." + "description": "Submits buyer contact details for attribution and analytics purposes." } ], - "value": "export interface Analytics {\n /**\n * Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing).\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * A method for capturing details about a visitor on the online store.\n */\n visitor(data: {email?: string; phone?: string}): Promise;\n}" + "value": "export interface Analytics {\n /**\n * Publishes a custom event to [Web Pixels](/docs/apps/marketing).\n * Returns `true` when the event is successfully dispatched.\n *\n * The Promise resolves to `true` when the event was dispatched. The boolean\n * indicates dispatch confirmation only. It doesn't indicate whether any\n * specific web pixel processed the event.\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * Submits buyer contact details for attribution and analytics purposes.\n */\n visitor(data: {email?: string; phone?: string}): Promise;\n}" }, "VisitorResult": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -86087,10 +86087,10 @@ "syntaxKind": "PropertySignature", "name": "type", "value": "'error'", - "description": "Indicates that the visitor information is invalid and wasn't submitted. Examples are using the wrong data type or missing a required property." + "description": "Indicates that the visitor information is invalid and wasn't submitted. Common causes include using the wrong data type or omitting a required property." } ], - "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Examples are using the wrong data type or missing a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Common causes include using the wrong data type or omitting a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" }, "SubscribableSignalLike": { "filePath": "src/surfaces/checkout/shared.ts", @@ -86304,10 +86304,10 @@ "syntaxKind": "PropertySignature", "name": "value", "value": "string | null", - "description": "The new value to store in the metafield. Set to `null` to delete the metafield." + "description": "The new value to store in the metafield. Set to `null` to delete the metafield.\n\nConsent metafield values are strings, not booleans. Pass `null` to delete a tracking consent metafield." } ], - "value": "export interface TrackingConsentMetafieldChange {\n /**\n * The identifier for the tracking consent metafield to update.\n */\n key: string;\n /**\n * The new value to store in the metafield. Set to `null` to delete the metafield.\n */\n value: string | null;\n}" + "value": "export interface TrackingConsentMetafieldChange {\n /**\n * The identifier for the tracking consent metafield to update.\n */\n key: string;\n /**\n * The new value to store in the metafield. Set to `null` to delete the metafield.\n *\n * Consent metafield values are strings, not booleans. Pass `null` to delete\n * a tracking consent metafield.\n */\n value: string | null;\n}" }, "VisitorConsent": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -86521,7 +86521,7 @@ "syntaxKind": "PropertySignature", "name": "value", "value": "string", - "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.", + "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.\n\nAttribute values are always strings. To store structured data, serialize it to JSON and parse it when reading.", "examples": [ { "title": "Example", @@ -86536,7 +86536,7 @@ ] } ], - "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" + "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * Attribute values are always strings. To store structured data, serialize\n * it to JSON and parse it when reading.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" }, "PaymentOption": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -86887,7 +86887,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A globally-unique identifier for the customer in the format `gid://shopify/Customer/`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", + "description": "An identifier for the customer in the format `gid://shopify/Customer/`. This value is unique per shop.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", "examples": [ { "title": "Example", @@ -86940,7 +86940,7 @@ "isPrivate": true } ], - "value": "export interface Customer {\n /**\n * A globally-unique identifier for the customer in the format `gid://shopify/Customer/`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'gid://shopify/Customer/123'\n */\n id: string;\n /**\n * The email address associated with the customer's account. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email?: string;\n /**\n * The phone number associated with the customer's account. The value is `undefined` if no phone number is on file or the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone?: string;\n /**\n * The customer's full name, typically a combination of first and last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n fullName?: string;\n /**\n * The customer's first name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n firstName?: string;\n /**\n * The customer's last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n lastName?: string;\n /**\n * The customer's profile image, such as a Gravatar avatar. Use this to personalize the extension UI for the logged-in buyer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n image: ImageDetails;\n /**\n * Whether the customer has opted in to receiving marketing communications from the merchant, such as email campaigns and promotional offers.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * > Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n *\n * @deprecated Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n */\n acceptsMarketing: boolean;\n /**\n * Whether the customer has opted in to email marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsEmailMarketing: boolean;\n /**\n * Whether the customer has opted in to SMS marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsSmsMarketing: boolean;\n /**\n * The store credit accounts owned by this customer that can be used as payment during checkout. Each account has a balance representing available store credit.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @private\n */\n storeCreditAccounts: StoreCreditAccount[];\n /**\n * The number of orders the customer has previously placed with this shop.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n ordersCount: number;\n}" + "value": "export interface Customer {\n /**\n * An identifier for the customer in the format `gid://shopify/Customer/`. This value is unique per shop.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'gid://shopify/Customer/123'\n */\n id: string;\n /**\n * The email address associated with the customer's account. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email?: string;\n /**\n * The phone number associated with the customer's account. The value is `undefined` if no phone number is on file or the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone?: string;\n /**\n * The customer's full name, typically a combination of first and last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n fullName?: string;\n /**\n * The customer's first name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n firstName?: string;\n /**\n * The customer's last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n lastName?: string;\n /**\n * The customer's profile image, such as a Gravatar avatar. Use this to personalize the extension UI for the logged-in buyer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n image: ImageDetails;\n /**\n * Whether the customer has opted in to receiving marketing communications from the merchant, such as email campaigns and promotional offers.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * > Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n *\n * @deprecated Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n */\n acceptsMarketing: boolean;\n /**\n * Whether the customer has opted in to email marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsEmailMarketing: boolean;\n /**\n * Whether the customer has opted in to SMS marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsSmsMarketing: boolean;\n /**\n * The store credit accounts owned by this customer that can be used as payment during checkout. Each account has a balance representing available store credit.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @private\n */\n storeCreditAccounts: StoreCreditAccount[];\n /**\n * The number of orders the customer has previously placed with this shop.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n ordersCount: number;\n}" }, "ImageDetails": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -87222,11 +87222,11 @@ "syntaxKind": "MethodSignature", "name": "perform", "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", + "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.\n\nRuns after all intercept results are collected. Use it for local state updates such as setting an error flag. By the time it runs, the navigation decision is final, so blocking logic belongs in the intercept handler itself, not here.", "isOptional": true } ], - "value": "interface InterceptorRequestAllow {\n /**\n * Indicates that the interceptor allows the buyer's journey to continue.\n */\n behavior: 'allow';\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" + "value": "interface InterceptorRequestAllow {\n /**\n * Indicates that the interceptor allows the buyer's journey to continue.\n */\n behavior: 'allow';\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n *\n * Runs after all intercept results are collected. Use it for local state\n * updates such as setting an error flag. By the time it runs, the navigation\n * decision is final, so blocking logic belongs in the intercept handler\n * itself, not here.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" }, "InterceptorResult": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -87290,7 +87290,7 @@ "syntaxKind": "MethodSignature", "name": "perform", "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", + "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.\n\nRuns after all intercept results are collected. Use it for local state updates such as setting an error flag. By the time it runs, the navigation decision is final, so blocking logic belongs in the intercept handler itself, not here.", "isOptional": true }, { @@ -87301,7 +87301,7 @@ "description": "The reason for blocking the interceptor request. This value isn't presented to the buyer, so it doesn't need to be localized. The value is used only for Shopify's own internal debugging and metrics." } ], - "value": "interface InterceptorRequestBlock {\n /**\n * Indicates that the interceptor blocks the buyer's journey from continuing.\n */\n behavior: 'block';\n\n /**\n * The reason for blocking the interceptor request. This value isn't presented to\n * the buyer, so it doesn't need to be localized. The value is used only for Shopify's\n * own internal debugging and metrics.\n */\n reason: string;\n\n /**\n * Used to pass errors to the checkout UI, outside your extension's UI boundaries.\n */\n errors?: ValidationError[];\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" + "value": "interface InterceptorRequestBlock {\n /**\n * Indicates that the interceptor blocks the buyer's journey from continuing.\n */\n behavior: 'block';\n\n /**\n * The reason for blocking the interceptor request. This value isn't presented to\n * the buyer, so it doesn't need to be localized. The value is used only for Shopify's\n * own internal debugging and metrics.\n */\n reason: string;\n\n /**\n * Used to pass errors to the checkout UI, outside your extension's UI boundaries.\n */\n errors?: ValidationError[];\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n *\n * Runs after all intercept results are collected. Use it for local state\n * updates such as setting an error flag. By the time it runs, the navigation\n * decision is final, so blocking logic belongs in the intercept handler\n * itself, not here.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" }, "ValidationError": { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -87522,17 +87522,17 @@ "syntaxKind": "PropertySignature", "name": "totalShippingAmount", "value": "SubscribableSignalLike", - "description": "The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step." + "description": "The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step.\n\n`undefined` until the buyer selects a shipping method (typically after the information step)." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "totalTaxAmount", "value": "SubscribableSignalLike", - "description": "The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet." + "description": "The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet.\n\n`undefined` when taxes haven't been calculated or aren't available for the buyer's region." } ], - "value": "export interface CartCost {\n /**\n * The sum of all line item prices at the current step of checkout, before shipping and taxes are applied. Use this value to display the base cost of the items the buyer purchased.\n */\n subtotalAmount: SubscribableSignalLike;\n\n /**\n * The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step.\n */\n totalShippingAmount: SubscribableSignalLike;\n\n /**\n * The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet.\n */\n totalTaxAmount: SubscribableSignalLike;\n\n /**\n * The minimum total at the current step of checkout. Costs not yet calculated, such as shipping on the information step, aren't included. Gift cards and store credits are excluded from this total.\n */\n totalAmount: SubscribableSignalLike;\n}" + "value": "export interface CartCost {\n /**\n * The sum of all line item prices at the current step of checkout, before shipping and taxes are applied. Use this value to display the base cost of the items the buyer purchased.\n */\n subtotalAmount: SubscribableSignalLike;\n\n /**\n * The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step.\n *\n * `undefined` until the buyer selects a shipping method (typically after the\n * information step).\n */\n totalShippingAmount: SubscribableSignalLike;\n\n /**\n * The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet.\n *\n * `undefined` when taxes haven't been calculated or aren't available for the\n * buyer's region.\n */\n totalTaxAmount: SubscribableSignalLike;\n\n /**\n * The minimum total at the current step of checkout. Costs not yet calculated, such as shipping on the information step, aren't included. Gift cards and store credits are excluded from this total.\n */\n totalAmount: SubscribableSignalLike;\n}" }, "CustomerPrivacy": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -87619,31 +87619,31 @@ "syntaxKind": "PropertySignature", "name": "analytics", "value": "boolean", - "description": "Whether analytics data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Analytics data includes how the shop was used and what interactions occurred." + "description": "Whether analytics data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Analytics data includes how the shop was used and what interactions occurred.\n\nWhether analytics data can be collected right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.analytics`, before calling `shopify.analytics.publish()`." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "marketing", "value": "boolean", - "description": "Whether marketing data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Marketing data includes attribution and targeted advertising preferences." + "description": "Whether marketing data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Marketing data includes attribution and targeted advertising preferences.\n\nWhether marketing data can be collected right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.marketing`, before performing marketing-related data collection." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "preferences", "value": "boolean", - "description": "Whether preference data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Preference data includes language, currency, and sizing choices." + "description": "Whether preference data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Preference data includes language, currency, and sizing choices.\n\nWhether preference data can be collected right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.preferences`, before storing or reading buyer preference data." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "saleOfData", "value": "boolean", - "description": "Whether data can be shared with third parties based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. This typically applies to behavioral advertising data." + "description": "Whether data can be shared with third parties based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. This typically applies to behavioral advertising data.\n\nWhether buyer data can be shared with or sold to third parties right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.saleOfData`, before sharing or selling buyer data with third parties." } ], - "value": "export interface AllowedProcessing {\n /**\n * Whether analytics data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Analytics\n * data includes how the shop was used and what interactions occurred.\n */\n analytics: boolean;\n /**\n * Whether marketing data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Marketing\n * data includes attribution and targeted advertising preferences.\n */\n marketing: boolean;\n /**\n * Whether preference data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Preference\n * data includes language, currency, and sizing choices.\n */\n preferences: boolean;\n /**\n * Whether data can be shared with third parties based on the visitor's\n * consent, the merchant's privacy configuration, and the visitor's region.\n * This typically applies to behavioral advertising data.\n */\n saleOfData: boolean;\n}" + "value": "export interface AllowedProcessing {\n /**\n * Whether analytics data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Analytics\n * data includes how the shop was used and what interactions occurred.\n *\n * Whether analytics data can be collected right now. Combines the buyer's\n * consent, the merchant's privacy configuration, and the buyer's region into\n * a single boolean. Check this flag, not `visitorConsent.analytics`, before\n * calling `shopify.analytics.publish()`.\n */\n analytics: boolean;\n /**\n * Whether marketing data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Marketing\n * data includes attribution and targeted advertising preferences.\n *\n * Whether marketing data can be collected right now. Combines the buyer's\n * consent, the merchant's privacy configuration, and the buyer's region into\n * a single boolean. Check this flag, not `visitorConsent.marketing`, before\n * performing marketing-related data collection.\n */\n marketing: boolean;\n /**\n * Whether preference data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Preference\n * data includes language, currency, and sizing choices.\n *\n * Whether preference data can be collected right now. Combines the buyer's\n * consent, the merchant's privacy configuration, and the buyer's region into\n * a single boolean. Check this flag, not `visitorConsent.preferences`,\n * before storing or reading buyer preference data.\n */\n preferences: boolean;\n /**\n * Whether data can be shared with third parties based on the visitor's\n * consent, the merchant's privacy configuration, and the visitor's region.\n * This typically applies to behavioral advertising data.\n *\n * Whether buyer data can be shared with or sold to third parties right now.\n * Combines the buyer's consent, the merchant's privacy configuration, and\n * the buyer's region into a single boolean. Check this flag, not\n * `visitorConsent.saleOfData`, before sharing or selling buyer data with\n * third parties.\n */\n saleOfData: boolean;\n}" }, "TrackingConsentMetafield": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -88335,7 +88335,7 @@ "Extension": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Extension", - "description": "The meta information about an extension target.", + "description": "Metadata about the running extension, including its API version, target, capabilities, and editor context. Use this to read configuration details or conditionally render content based on where the extension is running.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -88361,7 +88361,7 @@ "syntaxKind": "PropertySignature", "name": "capabilities", "value": "SubscribableSignalLike", - "description": "The allowed capabilities of the extension, defined in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n\n* [`api_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#api-access): the extension can access the Storefront API.\n\n* [`network_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access): the extension can make external network calls.\n\n* [`block_progress`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n\n* [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n\n* [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can register customer consent decisions that are honored on Shopify-managed services.\n\n* [`iframe.sources`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#iframe): the extension can embed an external URL in an iframe." + "description": "The allowed capabilities of the extension, defined in your [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -88409,7 +88409,7 @@ "syntaxKind": "PropertySignature", "name": "version", "value": "string", - "description": "The published version of the running extension target.\n\nFor unpublished extensions, the value is `undefined`.", + "description": "The published version of the running extension target.\n\nFor unpublished extensions, the value is `undefined`.\n\nDon't use this property as a stable identifier in development environments. It becomes available only after the extension is published.", "isOptional": true, "examples": [ { @@ -88425,7 +88425,7 @@ ] } ], - "value": "export interface Extension {\n /**\n * The API version that was set in the extension config file.\n *\n * @example '2024-10', '2025-01', '2025-04', '2025-07', '2025-10'\n */\n apiVersion: ApiVersion;\n\n /**\n * The allowed capabilities of the extension, defined\n * in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n *\n * * [`api_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#api-access): the extension can access the Storefront API.\n *\n * * [`network_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access): the extension can make external network calls.\n *\n * * [`block_progress`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n *\n * * [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n *\n * * [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can register customer consent decisions that are honored on Shopify-managed services.\n *\n * * [`iframe.sources`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#iframe): the extension can embed an external URL in an iframe.\n */\n capabilities: SubscribableSignalLike;\n\n /**\n * Information about the editor where the extension is being rendered.\n *\n * If the value is undefined, then the extension isn't running in an editor.\n */\n editor?: Editor;\n\n /**\n * A Boolean to show whether your extension is currently rendered to the screen.\n *\n * Shopify might render your extension before it's visible in the UI,\n * typically to pre-render extensions that appear on a later step of the\n * checkout.\n *\n * Your extension might also continue to run after the customer has navigated away\n * from where it was rendered. The extension continues running so that\n * your extension is immediately available to render if the customer navigates back.\n */\n rendered: SubscribableSignalLike;\n\n /**\n * The URL to the script that started the extension target.\n */\n scriptUrl: string;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n */\n target: Target;\n\n /**\n * The published version of the running extension target.\n *\n * For unpublished extensions, the value is `undefined`.\n *\n * @example 3.0.10\n */\n version?: string;\n}" + "value": "export interface Extension {\n /**\n * The API version that was set in the extension config file.\n *\n * @example '2024-10', '2025-01', '2025-04', '2025-07', '2025-10'\n */\n apiVersion: ApiVersion;\n\n /**\n * The allowed capabilities of the extension, defined in your\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n */\n capabilities: SubscribableSignalLike;\n\n /**\n * Information about the editor where the extension is being rendered.\n *\n * If the value is undefined, then the extension isn't running in an editor.\n */\n editor?: Editor;\n\n /**\n * A Boolean to show whether your extension is currently rendered to the screen.\n *\n * Shopify might render your extension before it's visible in the UI,\n * typically to pre-render extensions that appear on a later step of the\n * checkout.\n *\n * Your extension might also continue to run after the customer has navigated away\n * from where it was rendered. The extension continues running so that\n * your extension is immediately available to render if the customer navigates back.\n */\n rendered: SubscribableSignalLike;\n\n /**\n * The URL to the script that started the extension target.\n */\n scriptUrl: string;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n */\n target: Target;\n\n /**\n * The published version of the running extension target.\n *\n * For unpublished extensions, the value is `undefined`.\n *\n * Don't use this property as a stable identifier in development environments.\n * It becomes available only after the extension is published.\n *\n * @example 3.0.10\n */\n version?: string;\n}" }, "ApiVersion": { "filePath": "src/shared.ts", @@ -88444,7 +88444,7 @@ "Editor": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Editor", - "description": "", + "description": "Information about the editor environment when an extension is rendered inside the checkout editor. The value is `undefined` when the extension is not rendering in an editor.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -88459,7 +88459,7 @@ "I18n": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18n", - "description": "", + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use the I18n API alongside the Localization API to build fully localized extensions.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -88495,7 +88495,7 @@ "I18nTranslate": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18nTranslate", - "description": "This returns a translated string matching a key in a locale file.", + "description": "Translates a key from your extension's locale files into a localized string. Supports interpolation with placeholder replacements and pluralization via the special `count` option.", "members": [], "value": "export interface I18nTranslate {\n (\n key: string,\n options?: Record,\n ): ReplacementType extends string | number\n ? string\n : (string | ReplacementType)[];\n}" }, @@ -89059,14 +89059,14 @@ "Localization": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Localization", - "description": "", + "description": "The buyer's language, country, currency, and timezone context. Use this to adapt your extension to the buyer's region and display localized content.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "country", "value": "SubscribableSignalLike", - "description": "The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown." + "description": "The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n\nDerived from the buyer's shipping address. Returns `undefined` until the buyer enters a shipping address." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -89094,18 +89094,18 @@ "syntaxKind": "PropertySignature", "name": "market", "value": "SubscribableSignalLike", - "description": "The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n\n> Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.", - "deprecationMessage": "Deprecated as of version `2025-04`" + "description": "The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. The market context updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.", + "deprecationMessage": "Merchants now manage which extensions load for each\nmarket, so extensions no longer need to check this value." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "timezone", "value": "SubscribableSignalLike", - "description": "The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time." + "description": "The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time." } ], - "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n *\n * > Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" + "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n *\n * Derived from the buyer's shipping address. Returns `undefined` until the\n * buyer enters a shipping address.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout,\n * carried over from the cart context. Markets group countries and\n * regions with shared pricing, languages, and domains. The market\n * context updates when the buyer changes the country of their\n * shipping address. The value is `undefined` if the market is unknown.\n *\n * @deprecated Merchants now manage which extensions load for each\n * market, so extensions no longer need to check this value.\n */\n market: SubscribableSignalLike;\n}" }, "Country": { "filePath": "src/shared.ts", @@ -89306,7 +89306,7 @@ "SessionToken": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SessionToken", - "description": "", + "description": "Authenticates requests between your extension and your app backend. Use session tokens to verify the identity of the buyer and the shop context when making server-side API calls. The token is a signed JWT that contains claims such as the customer ID, shop domain, and expiration.\n\nThe `sub` claim in the decoded token is present only when the buyer is logged in and the app has permission to read customer accounts. Absent for anonymous buyers.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -89565,7 +89565,7 @@ "Shop": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Shop", - "description": "", + "description": "Metadata about the merchant's store, including its name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -89605,30 +89605,30 @@ "syntaxKind": "PropertySignature", "name": "storefrontUrl", "value": "string", - "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n\n> Caution: > As of version `2024-04` this value no longer has a trailing slash.", + "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.", "isOptional": true } ], - "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n *\n * > Caution:\n * > As of version `2024-04` this value no longer has a trailing slash.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom domain.\n */\n myshopifyDomain: string;\n}" + "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom domain.\n */\n myshopifyDomain: string;\n}" }, "Storage": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Storage", - "description": "A key-value storage object for the extension.\n\nStored data is available only to this specific extension and any of its instances.\n\nThe storage backend is implemented with `localStorage` and should persist across the buyer's checkout session. However, data persistence isn't guaranteed.", + "description": "Key-value storage for a specific extension. Use storage to save preferences or cached data that should survive page reloads without requiring a backend call. Stored data is only available to this specific extension. The storage backend is implemented with `localStorage` and data persistence isn't guaranteed.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "delete", "value": "(key: string) => Promise", - "description": "Delete stored data by key." + "description": "Deletes a previously stored value by key." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "read", "value": "(key: string) => Promise", - "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original primitive.\n\nReturns `null` if no stored data exists." + "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original type.\n\nReturns the stored value for the given key, or `null` when no value exists. Doesn't throw on a missing key." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -89638,7 +89638,7 @@ "description": "Write stored data for this key.\n\nThe data must be serializable to JSON." } ], - "value": "export interface Storage {\n /**\n * Read and return a stored value by key.\n *\n * The stored data is deserialized from JSON and returned as\n * its original primitive.\n *\n * Returns `null` if no stored data exists.\n */\n read(key: string): Promise;\n\n /**\n * Write stored data for this key.\n *\n * The data must be serializable to JSON.\n */\n write(key: string, data: any): Promise;\n\n /**\n * Delete stored data by key.\n */\n delete(key: string): Promise;\n}" + "value": "export interface Storage {\n /**\n * Read and return a stored value by key.\n *\n * The stored data is deserialized from JSON and returned as\n * its original type.\n *\n * Returns the stored value for the given key, or `null` when no value\n * exists. Doesn't throw on a missing key.\n */\n read(key: string): Promise;\n\n /**\n * Write stored data for this key.\n *\n * The data must be serializable to JSON.\n */\n write(key: string, data: any): Promise;\n\n /**\n * Deletes a previously stored value by key.\n */\n delete(key: string): Promise;\n}" }, "Version": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -89714,7 +89714,7 @@ "syntaxKind": "MethodSignature", "name": "applyAttributeChange", "value": "(change: AttributeChange) => Promise", - "description": "Updates or removes an attribute on the cart and checkout. On success, the [`attributes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/attributes#standardapi-propertydetail-attributes) property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.", + "description": "Updates or removes an attribute on the cart and checkout. On success, the [`attributes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/attributes#properties-propertydetail-attributes) property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.", "deprecationMessage": "Use cart metafields instead." }, { @@ -89722,42 +89722,42 @@ "syntaxKind": "MethodSignature", "name": "applyCartLinesChange", "value": "(change: CartLineChange) => Promise", - "description": "Adds, removes, or updates line items in the cart. The returned promise resolves when the change has been applied by the server, and the [`lines`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-lines#standardapi-propertydetail-lines) property updates with the new state.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Adds, removes, or updates line items in the cart. The returned promise resolves when the change has been applied by the server, and the [`lines`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-lines#properties-propertydetail-lines) property updates with the new state.\n\nAccepts a single change per call. To make multiple changes, call this method separately for each one.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyDiscountCodeChange", "value": "(change: DiscountCodeChange) => Promise", - "description": "Adds or removes a discount code on the checkout. The returned promise resolves when the change has been applied by the server, and the [`discountCodes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/discounts#standardapi-propertydetail-discountcodes) property updates with the new state.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves discount codes through a network call.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Adds or removes a discount code on the checkout. The returned promise resolves when the change has been applied by the server, and the [`discountCodes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/discounts#properties-propertydetail-discountcodes) property updates with the new state.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves discount codes through a network call.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyGiftCardChange", "value": "(change: GiftCardChange) => Promise", - "description": "Adds or removes a gift card from the checkout. The returned promise resolves when the change has been applied by the server, and the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/gift-cards#standardapi-propertydetail-appliedgiftcards) property updates with the new state.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves gift card codes through a network call.\n\n> Note: This method returns an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Adds or removes a gift card from the checkout. The returned promise resolves when the change has been applied by the server, and the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/gift-cards#properties-propertydetail-appliedgiftcards) property updates with the new state.\n\nUnlike other write operations, gift card changes aren't gated by a cart instruction flag.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves gift card codes through a network call.\n\n> Note: This method returns an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyMetafieldChange", "value": "(change: MetafieldChange) => Promise", - "description": "Creates, updates, or removes a cart metafield on the checkout. On success, the [`metafields`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/metafields#standardapi-propertydetail-metafields) property updates to reflect the change.\n\nCart metafields are copied to order metafields at order creation time if there's a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n\n> Caution: `MetafieldRemoveChange` and `MetafieldUpdateChange` are deprecated. Use cart metafields with `MetafieldRemoveCartChange` and `MetafieldUpdateCartChange` instead. If `MetafieldUpdateChange` writes a metafield with the same namespace and key as a cart metafield that's configured to copy, the cart metafield won't be copied.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Creates, updates, or removes a cart metafield on the checkout. On success, the [`metafields`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/metafields#properties-propertydetail-metafields) property updates to reflect the change.\n\nCart metafields are copied to order metafields at order creation time if there's a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n\n> Caution: `MetafieldRemoveChange` and `MetafieldUpdateChange` are deprecated. Use cart metafields with `MetafieldRemoveCartChange` and `MetafieldUpdateCartChange` instead. If `MetafieldUpdateChange` writes a metafield with the same namespace and key as a cart metafield that's configured to copy, the cart metafield won't be copied.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyNoteChange", "value": "(change: NoteChange) => Promise", - "description": "Sets or removes the buyer's note on the checkout. On success, the [`note`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/note#standardapi-propertydetail-note) property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Sets or removes the buyer's note on the checkout. On success, the [`note`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/note#properties-propertydetail-note) property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyShippingAddressChange", "value": "(change: ShippingAddressUpdateChange) => Promise", - "description": "Updates the buyer's shipping address on the checkout. The provided fields are merged into the existing address without prompting the buyer. On success, the `shippingAddress` property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", + "description": "Updates the buyer's shipping address on the checkout. The provided fields are merged into the existing address without prompting the buyer. On success, the `shippingAddress` property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", "isOptional": true }, { @@ -89770,7 +89770,7 @@ "isPrivate": true } ], - "value": "export interface CheckoutApi {\n /**\n * Updates or removes an attribute on the cart and checkout. On success, the\n * [`attributes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/attributes#standardapi-propertydetail-attributes) property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * @deprecated Use cart metafields instead.\n */\n applyAttributeChange(change: AttributeChange): Promise;\n\n /**\n * Adds, removes, or updates line items in the cart. The returned promise resolves when the change has been applied by the server, and the [`lines`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-lines#standardapi-propertydetail-lines) property updates with the new state.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyCartLinesChange(change: CartLineChange): Promise;\n\n /**\n * Adds or removes a discount code on the checkout. The returned promise resolves when the change has been applied by the server, and the [`discountCodes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/discounts#standardapi-propertydetail-discountcodes) property updates with the new state.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves discount codes through a network call.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyDiscountCodeChange(\n change: DiscountCodeChange,\n ): Promise;\n\n /**\n * Adds or removes a gift card from the checkout. The returned promise resolves when the change has been applied by the server, and the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/gift-cards#standardapi-propertydetail-appliedgiftcards) property updates with the new state.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves gift card codes through a network call.\n *\n * > Note: This method returns an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyGiftCardChange(change: GiftCardChange): Promise;\n\n /**\n * Creates, updates, or removes a cart metafield on the checkout. On success, the\n * [`metafields`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/metafields#standardapi-propertydetail-metafields) property updates to reflect the change.\n *\n * Cart metafields are copied to order metafields at order creation time if there's a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n *\n * > Caution: `MetafieldRemoveChange` and `MetafieldUpdateChange` are deprecated. Use cart metafields with `MetafieldRemoveCartChange` and `MetafieldUpdateCartChange` instead. If `MetafieldUpdateChange` writes a metafield with the same namespace and key as a cart metafield that's configured to copy, the cart metafield won't be copied.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyMetafieldChange(change: MetafieldChange): Promise;\n\n /**\n * Sets or removes the buyer's note on the checkout. On success, the\n * [`note`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/note#standardapi-propertydetail-note)\n * property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyNoteChange(change: NoteChange): Promise;\n\n /**\n * @private\n */\n experimentalIsShopAppStyle?: boolean;\n\n /**\n * Updates the buyer's shipping address on the checkout. The provided fields\n * are merged into the existing address without prompting the buyer. On success,\n * the `shippingAddress` property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyShippingAddressChange?(\n change: ShippingAddressChange,\n ): Promise;\n}" + "value": "export interface CheckoutApi {\n /**\n * Updates or removes an attribute on the cart and checkout. On success, the\n * [`attributes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/attributes#properties-propertydetail-attributes) property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * @deprecated Use cart metafields instead.\n */\n applyAttributeChange(change: AttributeChange): Promise;\n\n /**\n * Adds, removes, or updates line items in the cart. The returned promise resolves when the change has been applied by the server, and the [`lines`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-lines#properties-propertydetail-lines) property updates with the new state.\n *\n * Accepts a single change per call. To make multiple changes, call this\n * method separately for each one.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyCartLinesChange(change: CartLineChange): Promise;\n\n /**\n * Adds or removes a discount code on the checkout. The returned promise resolves when the change has been applied by the server, and the [`discountCodes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/discounts#properties-propertydetail-discountcodes) property updates with the new state.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves discount codes through a network call.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyDiscountCodeChange(\n change: DiscountCodeChange,\n ): Promise;\n\n /**\n * Adds or removes a gift card from the checkout. The returned promise resolves when the change has been applied by the server, and the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/gift-cards#properties-propertydetail-appliedgiftcards) property updates with the new state.\n *\n * Unlike other write operations, gift card changes aren't gated by a cart\n * instruction flag.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves gift card codes through a network call.\n *\n * > Note: This method returns an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyGiftCardChange(change: GiftCardChange): Promise;\n\n /**\n * Creates, updates, or removes a cart metafield on the checkout. On success, the\n * [`metafields`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/metafields#properties-propertydetail-metafields) property updates to reflect the change.\n *\n * Cart metafields are copied to order metafields at order creation time if there's a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n *\n * > Caution: `MetafieldRemoveChange` and `MetafieldUpdateChange` are deprecated. Use cart metafields with `MetafieldRemoveCartChange` and `MetafieldUpdateCartChange` instead. If `MetafieldUpdateChange` writes a metafield with the same namespace and key as a cart metafield that's configured to copy, the cart metafield won't be copied.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyMetafieldChange(change: MetafieldChange): Promise;\n\n /**\n * Sets or removes the buyer's note on the checkout. On success, the\n * [`note`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/note#properties-propertydetail-note)\n * property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyNoteChange(change: NoteChange): Promise;\n\n /**\n * @private\n */\n experimentalIsShopAppStyle?: boolean;\n\n /**\n * Updates the buyer's shipping address on the checkout. The provided fields\n * are merged into the existing address without prompting the buyer. On success,\n * the `shippingAddress` property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyShippingAddressChange?(\n change: ShippingAddressChange,\n ): Promise;\n}" }, "AttributeChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -89837,7 +89837,7 @@ "syntaxKind": "PropertySignature", "name": "value", "value": "string", - "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.", + "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.\n\nAttribute values are always strings. To store structured data, serialize it to JSON and parse it when reading.", "examples": [ { "title": "Example", @@ -89852,7 +89852,7 @@ ] } ], - "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" + "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * Attribute values are always strings. To store structured data, serialize\n * it to JSON and parse it when reading.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" }, "AttributeRemoveChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -90705,7 +90705,7 @@ "syntaxKind": "PropertySignature", "name": "message", "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer." + "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer.\n\nRender your own localized error text rather than displaying this message to the buyer." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -90715,7 +90715,7 @@ "description": "Indicates that the line item wasn't changed successfully. Refer to the `message` property for details about the error." } ], - "value": "export interface CartLineChangeResultError {\n /**\n * Indicates that the line item wasn't changed successfully. Refer to the `message` property for details about the error.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface CartLineChangeResultError {\n /**\n * Indicates that the line item wasn't changed successfully. Refer to the `message` property for details about the error.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n *\n * Render your own localized error text rather than displaying this message\n * to the buyer.\n */\n message: string;\n}" }, "DiscountCodeChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -90895,7 +90895,7 @@ "syntaxKind": "PropertySignature", "name": "message", "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer." + "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer.\n\nRender your own localized error text rather than displaying this message to the buyer." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -90905,7 +90905,7 @@ "description": "Indicates that the gift card change couldn't be applied. Check the `message` property for details." } ], - "value": "export interface GiftCardChangeResultError {\n /**\n * Indicates that the gift card change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface GiftCardChangeResultError {\n /**\n * Indicates that the gift card change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n *\n * Render your own localized error text rather than displaying this message\n * to the buyer.\n */\n message: string;\n}" }, "MetafieldChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -91166,7 +91166,7 @@ "syntaxKind": "PropertySignature", "name": "message", "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer." + "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer.\n\nRender your own localized error text rather than displaying this message to the buyer." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -91176,7 +91176,7 @@ "description": "Indicates that the metafield change couldn't be applied. Check the `message` property for details." } ], - "value": "export interface MetafieldChangeResultError {\n /**\n * Indicates that the metafield change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface MetafieldChangeResultError {\n /**\n * Indicates that the metafield change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n *\n * Render your own localized error text rather than displaying this message\n * to the buyer.\n */\n message: string;\n}" }, "NoteChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -91254,7 +91254,7 @@ "syntaxKind": "PropertySignature", "name": "message", "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer." + "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer.\n\nRender your own localized error text rather than displaying this message to the buyer." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -91264,7 +91264,7 @@ "description": "Indicates that the note change couldn't be applied. Check the `message` property for details." } ], - "value": "export interface NoteChangeResultError {\n /**\n * Indicates that the note change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface NoteChangeResultError {\n /**\n * Indicates that the note change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n *\n * Render your own localized error text rather than displaying this message\n * to the buyer.\n */\n message: string;\n}" }, "ShippingAddressUpdateChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -91850,7 +91850,7 @@ "syntaxKind": "PropertySignature", "name": "analytics", "value": "Analytics", - "description": "The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event." + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -91864,7 +91864,7 @@ "syntaxKind": "PropertySignature", "name": "applyTrackingConsentChange", "value": "ApplyTrackingConsentChangeType", - "description": "Enables setting and updating customer privacy consent settings and tracking consent metafields.\n\n> Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent) to be set to `true`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." + "description": "Enables setting and updating customer privacy consent settings and tracking consent metafields.\n\n> Note: Requires the [`collect_buyer_consent` capability](/docs/apps/build/customer-accounts/capabilities#collect-buyer-consent) to be set to `true`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -91885,7 +91885,7 @@ "syntaxKind": "PropertySignature", "name": "availablePaymentOptions", "value": "SubscribableSignalLike", - "description": "All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region." + "description": "All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n\nThe set of payment options can change when the buyer updates their address or cart, so subscribe to changes rather than reading once during initialization. Each option exposes `handle` and `type` only. Provider names, logos, fees, and installment terms aren't available." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -91922,7 +91922,7 @@ "syntaxKind": "PropertySignature", "name": "checkoutToken", "value": "SubscribableSignalLike", - "description": "A stable ID that represents the current checkout.\n\nThe value is `undefined` when the checkout hasn't been created on the server yet.\n\nUse this to correlate checkout sessions across your extension, web pixels, and backend systems.\n\nThis matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data) and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object)." + "description": "A stable ID that represents the current checkout.\n\nThe value is `undefined` when the checkout hasn't been created on the server yet.\n\nUse this to correlate checkout sessions across your extension, web pixels, and backend systems.\n\nThis matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data) and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n\nCan be `undefined`. Handle the `undefined` state before using the value." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -91943,7 +91943,7 @@ "syntaxKind": "PropertySignature", "name": "deliveryGroups", "value": "SubscribableSignalLike", - "description": "The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items." + "description": "The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n\nEmpty until the buyer enters enough address information for Shopify to calculate shipping rates." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -91964,7 +91964,7 @@ "syntaxKind": "PropertySignature", "name": "extension", "value": "Extension", - "description": "The meta information about the extension." + "description": "Metadata about the running extension, including the current target, API version, capabilities, and editor context. Use this to conditionally render content based on where the extension is running." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -91972,7 +91972,7 @@ "name": "extensionPoint", "value": "Target", "description": "The identifier that specifies where in Shopify's UI your code is being injected. This is one of the targets you've included in your extension's configuration file.", - "deprecationMessage": "Deprecated as of version `2023-07`, use `extension.target` instead.", + "deprecationMessage": "Use `extension.target` instead.", "examples": [ { "title": "Example", @@ -91991,14 +91991,14 @@ "syntaxKind": "PropertySignature", "name": "i18n", "value": "I18n", - "description": "Utilities for translating content and formatting values according to the current [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) of the checkout.\n\nRefer to [`localization` examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples) for more information." + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use alongside [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) to build fully localized extensions." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "instructions", "value": "SubscribableSignalLike", - "description": "The cart instructions used to create the checkout and possibly limit extension capabilities.\n\nThese instructions should be checked before performing any actions that might be affected by them.\n\nFor example, if you intend to add a discount code via the `applyDiscountCodeChange` method, check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n\n> Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs aren't available. See the [update guide](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples) for more information." + "description": "The cart instructions used to create the checkout and possibly limit extension capabilities.\n\nThese instructions should be checked before performing any actions that might be affected by them.\n\nFor example, if you intend to add a discount code via the `applyDiscountCodeChange` method, check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n\n> Caution: Check cart instructions before calling select APIs, as > some may not be available. See the > [Cart Instructions API](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples) > for more information." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -92012,7 +92012,7 @@ "syntaxKind": "PropertySignature", "name": "localization", "value": "Localization", - "description": "The details about the location, language, and currency of the customer. For utilities to easily format and translate content based on these details, you can use the [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n) object instead." + "description": "The buyer's language, country, currency, and timezone context. For formatting and translation helpers, use the [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#properties-propertydetail-i18n) object instead." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -92042,21 +92042,21 @@ "syntaxKind": "PropertySignature", "name": "query", "value": ">(query: string, options?: { variables?: Variables; version?: StorefrontApiVersion; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>", - "description": "The method used to query the Storefront GraphQL API with a prefetched token.\n\nRefer to [Storefront API access examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/storefront-api) for more information." + "description": "The method used to query the Storefront GraphQL API with a prefetched token." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "selectedPaymentOptions", "value": "SubscribableSignalLike", - "description": "The payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card)." + "description": "The payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\n\nEach option exposes `handle` and `type` only. Provider names, logos, fees, and installment terms aren't available." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "sessionToken", "value": "SessionToken", - "description": "The session token providing a set of claims as a signed JSON Web Token (JWT).\n\nThe token has a TTL of five minutes.\n\nIf the previous token expires, this value reflects a new session token with a new signature and expiry.\n\nRefer to [session token examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/session-token) for more information." + "description": "The session token providing a set of claims as a signed JSON Web Token (JWT).\n\nThe token has a TTL of five minutes.\n\nIf the previous token expires, this value reflects a new session token with a new signature and expiry.\n\nLearn more about [session tokens](/docs/apps/build/authentication-authorization/session-tokens)." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -92078,14 +92078,14 @@ "syntaxKind": "PropertySignature", "name": "shop", "value": "Shop", - "description": "The shop where the checkout is taking place." + "description": "The store where the checkout is taking place, including the shop name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "storage", "value": "Storage", - "description": "The key-value storage for the extension.\n\nIt uses `localStorage` and should persist across the customer's current checkout session.\n\n> Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n\nData is shared across all activated extension targets of this extension. In versions 2023-07 and earlier, each activated extension target had its own storage." + "description": "Key-value storage that persists across page loads within the current checkout session. Data is shared across all activated targets associated with this extension.\n\n> Caution: Data persistence isn't guaranteed and storage is cleared when the buyer starts a new checkout." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -92107,29 +92107,29 @@ ] } ], - "value": "export interface StandardApi {\n /**\n * The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event.\n */\n analytics: Analytics;\n\n /**\n * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\n */\n appliedGiftCards: SubscribableSignalLike;\n\n /**\n * The cart instructions used to create the checkout and possibly limit extension capabilities.\n *\n * These instructions should be checked before performing any actions that might be affected by them.\n *\n * For example, if you intend to add a discount code via the `applyDiscountCodeChange` method,\n * check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n *\n * > Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs aren't available.\n * See the [update guide](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples) for more information.\n *\n */\n instructions: SubscribableSignalLike;\n\n /**\n * The metafields requested in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration)\n * file. These metafields are updated when there's a change in the merchandise items\n * being purchased by the customer.\n *\n * App owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` isn't supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n appMetafields: SubscribableSignalLike;\n\n /**\n * The custom key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n buyerIdentity?: BuyerIdentity;\n\n /**\n * Provides details on the buyer's progression through the checkout and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/buyer-journey#examples)\n * examples for more information.\n */\n buyerJourney: BuyerJourney;\n\n /**\n * Settings applied to the buyer's checkout.\n */\n checkoutSettings: SubscribableSignalLike;\n\n /**\n * A stable ID that represents the current checkout.\n *\n * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\n *\n * This matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data)\n * and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n */\n checkoutToken: SubscribableSignalLike;\n\n /**\n * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * The meta information about the extension.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n *\n * @deprecated Deprecated as of version `2023-07`, use `extension.target` instead.\n */\n extensionPoint: Target;\n\n /**\n * Utilities for translating content and formatting values according to the current\n * [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization)\n * of the checkout.\n *\n * Refer to [`localization` examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples)\n * for more information.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The details about the location, language, and currency of the customer. For utilities to easily\n * format and translate content based on these details, you can use the\n * [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n)\n * object instead.\n */\n localization: Localization;\n\n /**\n * The metafields that apply to the current checkout.\n *\n * Metafields are stored locally on the client and are applied to the order object after the checkout completes.\n *\n * These metafields are shared by all extensions running on checkout, and\n * persist for as long as the customer is working on this checkout.\n *\n * Once the order is created, you can query these metafields using the\n * [GraphQL Admin API](/docs/admin-api/graphql/reference/orders/order#metafield-2021-01)\n *\n * > Caution:\n * `metafields` is deprecated. Use `appMetafields` with cart metafields instead.\n *\n * @deprecated Use `appMetafields` with cart metafields instead.\n */\n metafields: SubscribableSignalLike;\n\n /**\n * A note left by the customer to the merchant, either in their cart or during checkout.\n *\n * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\n */\n note: SubscribableSignalLike;\n\n /**\n * The method used to query the Storefront GraphQL API with a prefetched token.\n *\n * Refer to [Storefront API access examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/storefront-api) for more information.\n */\n query: >(\n query: string,\n options?: {variables?: Variables; version?: StorefrontApiVersion},\n ) => Promise<{data?: Data; errors?: GraphQLError[]}>;\n\n /**\n * The payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\n */\n selectedPaymentOptions: SubscribableSignalLike;\n\n /**\n * The session token providing a set of claims as a signed JSON Web Token (JWT).\n *\n * The token has a TTL of five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/session-token) for more information.\n */\n sessionToken: SessionToken;\n\n /**\n * The settings matching the settings definition written in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates in real time as a merchant fills in the settings.\n */\n settings: SubscribableSignalLike;\n\n /**\n * The proposed customer shipping address. During the information step, the address\n * updates when the field is committed (on change) rather than every keystroke.\n * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n shippingAddress?: SubscribableSignalLike;\n\n /**\n * The proposed customer billing address. The address updates when the field is\n * committed (on change) rather than every keystroke. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided yet.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n billingAddress?: SubscribableSignalLike;\n\n /** The shop where the checkout is taking place. */\n shop: Shop;\n\n /**\n * The key-value storage for the extension.\n *\n * It uses `localStorage` and should persist across the customer's current checkout session.\n *\n * > Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n *\n * Data is shared across all activated extension targets of this extension. In versions 2023-07 and earlier,\n * each activated extension target had its own storage.\n */\n storage: Storage;\n\n /**\n * The renderer version being used for the extension.\n *\n * @example '2025-10'\n */\n version: Version;\n\n /**\n * Customer privacy consent settings and a flag denoting if consent has previously been collected.\n */\n customerPrivacy: SubscribableSignalLike;\n\n /**\n * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent) to be set to `true`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyTrackingConsentChange: ApplyTrackingConsentChangeType;\n\n /**\n * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" + "value": "export interface StandardApi {\n /**\n * Tracks custom events and sends visitor information to\n * [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events\n * and `visitor()` to submit buyer contact details.\n */\n analytics: Analytics;\n\n /**\n * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\n */\n appliedGiftCards: SubscribableSignalLike;\n\n /**\n * The cart instructions used to create the checkout and possibly limit extension capabilities.\n *\n * These instructions should be checked before performing any actions that might be affected by them.\n *\n * For example, if you intend to add a discount code via the `applyDiscountCodeChange` method,\n * check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n *\n * > Caution: Check cart instructions before calling select APIs, as\n * > some may not be available. See the\n * > [Cart Instructions API](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples)\n * > for more information.\n *\n */\n instructions: SubscribableSignalLike;\n\n /**\n * The metafields requested in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration)\n * file. These metafields are updated when there's a change in the merchandise items\n * being purchased by the customer.\n *\n * App owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` isn't supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n appMetafields: SubscribableSignalLike;\n\n /**\n * The custom key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as\n * credit cards, wallets, and local payment methods. The list depends on\n * the shop's payment configuration and the buyer's region.\n *\n * The set of payment options can change when the buyer updates their\n * address or cart, so subscribe to changes rather than reading once\n * during initialization. Each option exposes `handle` and `type` only.\n * Provider names, logos, fees, and installment terms aren't available.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n buyerIdentity?: BuyerIdentity;\n\n /**\n * Provides details on the buyer's progression through the checkout and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/buyer-journey#examples)\n * examples for more information.\n */\n buyerJourney: BuyerJourney;\n\n /**\n * Settings applied to the buyer's checkout.\n */\n checkoutSettings: SubscribableSignalLike;\n\n /**\n * A stable ID that represents the current checkout.\n *\n * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\n *\n * This matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data)\n * and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n *\n * Can be `undefined`. Handle the `undefined` state before using the value.\n */\n checkoutToken: SubscribableSignalLike;\n\n /**\n * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n *\n * Empty until the buyer enters enough address information for Shopify to\n * calculate shipping rates.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * Metadata about the running extension, including the current target, API version,\n * capabilities, and editor context. Use this to conditionally render content\n * based on where the extension is running.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n *\n * @deprecated Use `extension.target` instead.\n */\n extensionPoint: Target;\n\n /**\n * Utilities for translating strings, formatting currencies, numbers, and dates\n * according to the buyer's locale. Use alongside\n * [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization)\n * to build fully localized extensions.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The buyer's language, country, currency, and timezone context. For\n * formatting and translation helpers, use the\n * [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#properties-propertydetail-i18n)\n * object instead.\n */\n localization: Localization;\n\n /**\n * The metafields that apply to the current checkout.\n *\n * Metafields are stored locally on the client and are applied to the order object after the checkout completes.\n *\n * These metafields are shared by all extensions running on checkout, and\n * persist for as long as the customer is working on this checkout.\n *\n * Once the order is created, you can query these metafields using the\n * [GraphQL Admin API](/docs/admin-api/graphql/reference/orders/order#metafield-2021-01)\n *\n * > Caution:\n * `metafields` is deprecated. Use `appMetafields` with cart metafields instead.\n *\n * @deprecated Use `appMetafields` with cart metafields instead.\n */\n metafields: SubscribableSignalLike;\n\n /**\n * A note left by the customer to the merchant, either in their cart or during checkout.\n *\n * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\n */\n note: SubscribableSignalLike;\n\n /**\n * The method used to query the Storefront GraphQL API with a prefetched token.\n *\n */\n query: >(\n query: string,\n options?: {variables?: Variables; version?: StorefrontApiVersion},\n ) => Promise<{data?: Data; errors?: GraphQLError[]}>;\n\n /**\n * The payment options the buyer has currently selected. This updates as\n * the buyer changes their payment method. The array can contain multiple\n * entries when the buyer splits payment across methods (for example, a\n * gift card and a credit card).\n *\n * Each option exposes `handle` and `type` only. Provider names, logos,\n * fees, and installment terms aren't available.\n */\n selectedPaymentOptions: SubscribableSignalLike;\n\n /**\n * The session token providing a set of claims as a signed JSON Web Token (JWT).\n *\n * The token has a TTL of five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Learn more about [session tokens](/docs/apps/build/authentication-authorization/session-tokens).\n */\n sessionToken: SessionToken;\n\n /**\n * The settings matching the settings definition written in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates in real time as a merchant fills in the settings.\n */\n settings: SubscribableSignalLike;\n\n /**\n * The proposed customer shipping address. During the information step, the address\n * updates when the field is committed (on change) rather than every keystroke.\n * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n shippingAddress?: SubscribableSignalLike;\n\n /**\n * The proposed customer billing address. The address updates when the field is\n * committed (on change) rather than every keystroke. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided yet.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n billingAddress?: SubscribableSignalLike;\n\n /**\n * The store where the checkout is taking place, including the shop name,\n * storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.\n */\n shop: Shop;\n\n /**\n * Key-value storage that persists across page loads within the current checkout\n * session. Data is shared across all activated targets associated with\n * this extension.\n *\n * > Caution: Data persistence isn't guaranteed and storage is cleared when the\n * buyer starts a new checkout.\n */\n storage: Storage;\n\n /**\n * The renderer version being used for the extension.\n *\n * @example '2025-10'\n */\n version: Version;\n\n /**\n * Customer privacy consent settings and a flag denoting if consent has previously been collected.\n */\n customerPrivacy: SubscribableSignalLike;\n\n /**\n * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`collect_buyer_consent` capability](/docs/apps/build/customer-accounts/capabilities#collect-buyer-consent) to be set to `true`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyTrackingConsentChange: ApplyTrackingConsentChangeType;\n\n /**\n * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" }, "Analytics": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Analytics", - "description": "", + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "publish", "value": "(name: string, data: Record) => Promise", - "description": "Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing)." + "description": "Publishes a custom event to [Web Pixels](/docs/apps/marketing). Returns `true` when the event is successfully dispatched.\n\nThe Promise resolves to `true` when the event was dispatched. The boolean indicates dispatch confirmation only. It doesn't indicate whether any specific web pixel processed the event." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "visitor", "value": "(data: { email?: string; phone?: string; }) => Promise", - "description": "A method for capturing details about a visitor on the online store." + "description": "Submits buyer contact details for attribution and analytics purposes." } ], - "value": "export interface Analytics {\n /**\n * Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing).\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * A method for capturing details about a visitor on the online store.\n */\n visitor(data: {email?: string; phone?: string}): Promise;\n}" + "value": "export interface Analytics {\n /**\n * Publishes a custom event to [Web Pixels](/docs/apps/marketing).\n * Returns `true` when the event is successfully dispatched.\n *\n * The Promise resolves to `true` when the event was dispatched. The boolean\n * indicates dispatch confirmation only. It doesn't indicate whether any\n * specific web pixel processed the event.\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * Submits buyer contact details for attribution and analytics purposes.\n */\n visitor(data: {email?: string; phone?: string}): Promise;\n}" }, "VisitorResult": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -92170,10 +92170,10 @@ "syntaxKind": "PropertySignature", "name": "type", "value": "'error'", - "description": "Indicates that the visitor information is invalid and wasn't submitted. Examples are using the wrong data type or missing a required property." + "description": "Indicates that the visitor information is invalid and wasn't submitted. Common causes include using the wrong data type or omitting a required property." } ], - "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Examples are using the wrong data type or missing a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Common causes include using the wrong data type or omitting a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" }, "SubscribableSignalLike": { "filePath": "src/surfaces/checkout/shared.ts", @@ -92387,10 +92387,10 @@ "syntaxKind": "PropertySignature", "name": "value", "value": "string | null", - "description": "The new value to store in the metafield. Set to `null` to delete the metafield." + "description": "The new value to store in the metafield. Set to `null` to delete the metafield.\n\nConsent metafield values are strings, not booleans. Pass `null` to delete a tracking consent metafield." } ], - "value": "export interface TrackingConsentMetafieldChange {\n /**\n * The identifier for the tracking consent metafield to update.\n */\n key: string;\n /**\n * The new value to store in the metafield. Set to `null` to delete the metafield.\n */\n value: string | null;\n}" + "value": "export interface TrackingConsentMetafieldChange {\n /**\n * The identifier for the tracking consent metafield to update.\n */\n key: string;\n /**\n * The new value to store in the metafield. Set to `null` to delete the metafield.\n *\n * Consent metafield values are strings, not booleans. Pass `null` to delete\n * a tracking consent metafield.\n */\n value: string | null;\n}" }, "VisitorConsent": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -92604,7 +92604,7 @@ "syntaxKind": "PropertySignature", "name": "value", "value": "string", - "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.", + "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.\n\nAttribute values are always strings. To store structured data, serialize it to JSON and parse it when reading.", "examples": [ { "title": "Example", @@ -92619,7 +92619,7 @@ ] } ], - "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" + "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * Attribute values are always strings. To store structured data, serialize\n * it to JSON and parse it when reading.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" }, "PaymentOption": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -92970,7 +92970,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A globally-unique identifier for the customer in the format `gid://shopify/Customer/`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", + "description": "An identifier for the customer in the format `gid://shopify/Customer/`. This value is unique per shop.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", "examples": [ { "title": "Example", @@ -93023,7 +93023,7 @@ "isPrivate": true } ], - "value": "export interface Customer {\n /**\n * A globally-unique identifier for the customer in the format `gid://shopify/Customer/`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'gid://shopify/Customer/123'\n */\n id: string;\n /**\n * The email address associated with the customer's account. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email?: string;\n /**\n * The phone number associated with the customer's account. The value is `undefined` if no phone number is on file or the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone?: string;\n /**\n * The customer's full name, typically a combination of first and last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n fullName?: string;\n /**\n * The customer's first name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n firstName?: string;\n /**\n * The customer's last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n lastName?: string;\n /**\n * The customer's profile image, such as a Gravatar avatar. Use this to personalize the extension UI for the logged-in buyer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n image: ImageDetails;\n /**\n * Whether the customer has opted in to receiving marketing communications from the merchant, such as email campaigns and promotional offers.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * > Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n *\n * @deprecated Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n */\n acceptsMarketing: boolean;\n /**\n * Whether the customer has opted in to email marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsEmailMarketing: boolean;\n /**\n * Whether the customer has opted in to SMS marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsSmsMarketing: boolean;\n /**\n * The store credit accounts owned by this customer that can be used as payment during checkout. Each account has a balance representing available store credit.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @private\n */\n storeCreditAccounts: StoreCreditAccount[];\n /**\n * The number of orders the customer has previously placed with this shop.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n ordersCount: number;\n}" + "value": "export interface Customer {\n /**\n * An identifier for the customer in the format `gid://shopify/Customer/`. This value is unique per shop.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'gid://shopify/Customer/123'\n */\n id: string;\n /**\n * The email address associated with the customer's account. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email?: string;\n /**\n * The phone number associated with the customer's account. The value is `undefined` if no phone number is on file or the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone?: string;\n /**\n * The customer's full name, typically a combination of first and last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n fullName?: string;\n /**\n * The customer's first name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n firstName?: string;\n /**\n * The customer's last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n lastName?: string;\n /**\n * The customer's profile image, such as a Gravatar avatar. Use this to personalize the extension UI for the logged-in buyer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n image: ImageDetails;\n /**\n * Whether the customer has opted in to receiving marketing communications from the merchant, such as email campaigns and promotional offers.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * > Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n *\n * @deprecated Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n */\n acceptsMarketing: boolean;\n /**\n * Whether the customer has opted in to email marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsEmailMarketing: boolean;\n /**\n * Whether the customer has opted in to SMS marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsSmsMarketing: boolean;\n /**\n * The store credit accounts owned by this customer that can be used as payment during checkout. Each account has a balance representing available store credit.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @private\n */\n storeCreditAccounts: StoreCreditAccount[];\n /**\n * The number of orders the customer has previously placed with this shop.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n ordersCount: number;\n}" }, "ImageDetails": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -93305,11 +93305,11 @@ "syntaxKind": "MethodSignature", "name": "perform", "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", + "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.\n\nRuns after all intercept results are collected. Use it for local state updates such as setting an error flag. By the time it runs, the navigation decision is final, so blocking logic belongs in the intercept handler itself, not here.", "isOptional": true } ], - "value": "interface InterceptorRequestAllow {\n /**\n * Indicates that the interceptor allows the buyer's journey to continue.\n */\n behavior: 'allow';\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" + "value": "interface InterceptorRequestAllow {\n /**\n * Indicates that the interceptor allows the buyer's journey to continue.\n */\n behavior: 'allow';\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n *\n * Runs after all intercept results are collected. Use it for local state\n * updates such as setting an error flag. By the time it runs, the navigation\n * decision is final, so blocking logic belongs in the intercept handler\n * itself, not here.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" }, "InterceptorResult": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -93373,7 +93373,7 @@ "syntaxKind": "MethodSignature", "name": "perform", "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", + "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.\n\nRuns after all intercept results are collected. Use it for local state updates such as setting an error flag. By the time it runs, the navigation decision is final, so blocking logic belongs in the intercept handler itself, not here.", "isOptional": true }, { @@ -93384,7 +93384,7 @@ "description": "The reason for blocking the interceptor request. This value isn't presented to the buyer, so it doesn't need to be localized. The value is used only for Shopify's own internal debugging and metrics." } ], - "value": "interface InterceptorRequestBlock {\n /**\n * Indicates that the interceptor blocks the buyer's journey from continuing.\n */\n behavior: 'block';\n\n /**\n * The reason for blocking the interceptor request. This value isn't presented to\n * the buyer, so it doesn't need to be localized. The value is used only for Shopify's\n * own internal debugging and metrics.\n */\n reason: string;\n\n /**\n * Used to pass errors to the checkout UI, outside your extension's UI boundaries.\n */\n errors?: ValidationError[];\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" + "value": "interface InterceptorRequestBlock {\n /**\n * Indicates that the interceptor blocks the buyer's journey from continuing.\n */\n behavior: 'block';\n\n /**\n * The reason for blocking the interceptor request. This value isn't presented to\n * the buyer, so it doesn't need to be localized. The value is used only for Shopify's\n * own internal debugging and metrics.\n */\n reason: string;\n\n /**\n * Used to pass errors to the checkout UI, outside your extension's UI boundaries.\n */\n errors?: ValidationError[];\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n *\n * Runs after all intercept results are collected. Use it for local state\n * updates such as setting an error flag. By the time it runs, the navigation\n * decision is final, so blocking logic belongs in the intercept handler\n * itself, not here.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" }, "ValidationError": { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -93605,17 +93605,17 @@ "syntaxKind": "PropertySignature", "name": "totalShippingAmount", "value": "SubscribableSignalLike", - "description": "The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step." + "description": "The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step.\n\n`undefined` until the buyer selects a shipping method (typically after the information step)." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "totalTaxAmount", "value": "SubscribableSignalLike", - "description": "The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet." + "description": "The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet.\n\n`undefined` when taxes haven't been calculated or aren't available for the buyer's region." } ], - "value": "export interface CartCost {\n /**\n * The sum of all line item prices at the current step of checkout, before shipping and taxes are applied. Use this value to display the base cost of the items the buyer purchased.\n */\n subtotalAmount: SubscribableSignalLike;\n\n /**\n * The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step.\n */\n totalShippingAmount: SubscribableSignalLike;\n\n /**\n * The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet.\n */\n totalTaxAmount: SubscribableSignalLike;\n\n /**\n * The minimum total at the current step of checkout. Costs not yet calculated, such as shipping on the information step, aren't included. Gift cards and store credits are excluded from this total.\n */\n totalAmount: SubscribableSignalLike;\n}" + "value": "export interface CartCost {\n /**\n * The sum of all line item prices at the current step of checkout, before shipping and taxes are applied. Use this value to display the base cost of the items the buyer purchased.\n */\n subtotalAmount: SubscribableSignalLike;\n\n /**\n * The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step.\n *\n * `undefined` until the buyer selects a shipping method (typically after the\n * information step).\n */\n totalShippingAmount: SubscribableSignalLike;\n\n /**\n * The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet.\n *\n * `undefined` when taxes haven't been calculated or aren't available for the\n * buyer's region.\n */\n totalTaxAmount: SubscribableSignalLike;\n\n /**\n * The minimum total at the current step of checkout. Costs not yet calculated, such as shipping on the information step, aren't included. Gift cards and store credits are excluded from this total.\n */\n totalAmount: SubscribableSignalLike;\n}" }, "CustomerPrivacy": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -93702,31 +93702,31 @@ "syntaxKind": "PropertySignature", "name": "analytics", "value": "boolean", - "description": "Whether analytics data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Analytics data includes how the shop was used and what interactions occurred." + "description": "Whether analytics data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Analytics data includes how the shop was used and what interactions occurred.\n\nWhether analytics data can be collected right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.analytics`, before calling `shopify.analytics.publish()`." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "marketing", "value": "boolean", - "description": "Whether marketing data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Marketing data includes attribution and targeted advertising preferences." + "description": "Whether marketing data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Marketing data includes attribution and targeted advertising preferences.\n\nWhether marketing data can be collected right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.marketing`, before performing marketing-related data collection." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "preferences", "value": "boolean", - "description": "Whether preference data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Preference data includes language, currency, and sizing choices." + "description": "Whether preference data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Preference data includes language, currency, and sizing choices.\n\nWhether preference data can be collected right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.preferences`, before storing or reading buyer preference data." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "saleOfData", "value": "boolean", - "description": "Whether data can be shared with third parties based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. This typically applies to behavioral advertising data." + "description": "Whether data can be shared with third parties based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. This typically applies to behavioral advertising data.\n\nWhether buyer data can be shared with or sold to third parties right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.saleOfData`, before sharing or selling buyer data with third parties." } ], - "value": "export interface AllowedProcessing {\n /**\n * Whether analytics data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Analytics\n * data includes how the shop was used and what interactions occurred.\n */\n analytics: boolean;\n /**\n * Whether marketing data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Marketing\n * data includes attribution and targeted advertising preferences.\n */\n marketing: boolean;\n /**\n * Whether preference data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Preference\n * data includes language, currency, and sizing choices.\n */\n preferences: boolean;\n /**\n * Whether data can be shared with third parties based on the visitor's\n * consent, the merchant's privacy configuration, and the visitor's region.\n * This typically applies to behavioral advertising data.\n */\n saleOfData: boolean;\n}" + "value": "export interface AllowedProcessing {\n /**\n * Whether analytics data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Analytics\n * data includes how the shop was used and what interactions occurred.\n *\n * Whether analytics data can be collected right now. Combines the buyer's\n * consent, the merchant's privacy configuration, and the buyer's region into\n * a single boolean. Check this flag, not `visitorConsent.analytics`, before\n * calling `shopify.analytics.publish()`.\n */\n analytics: boolean;\n /**\n * Whether marketing data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Marketing\n * data includes attribution and targeted advertising preferences.\n *\n * Whether marketing data can be collected right now. Combines the buyer's\n * consent, the merchant's privacy configuration, and the buyer's region into\n * a single boolean. Check this flag, not `visitorConsent.marketing`, before\n * performing marketing-related data collection.\n */\n marketing: boolean;\n /**\n * Whether preference data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Preference\n * data includes language, currency, and sizing choices.\n *\n * Whether preference data can be collected right now. Combines the buyer's\n * consent, the merchant's privacy configuration, and the buyer's region into\n * a single boolean. Check this flag, not `visitorConsent.preferences`,\n * before storing or reading buyer preference data.\n */\n preferences: boolean;\n /**\n * Whether data can be shared with third parties based on the visitor's\n * consent, the merchant's privacy configuration, and the visitor's region.\n * This typically applies to behavioral advertising data.\n *\n * Whether buyer data can be shared with or sold to third parties right now.\n * Combines the buyer's consent, the merchant's privacy configuration, and\n * the buyer's region into a single boolean. Check this flag, not\n * `visitorConsent.saleOfData`, before sharing or selling buyer data with\n * third parties.\n */\n saleOfData: boolean;\n}" }, "TrackingConsentMetafield": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -94418,7 +94418,7 @@ "Extension": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Extension", - "description": "The meta information about an extension target.", + "description": "Metadata about the running extension, including its API version, target, capabilities, and editor context. Use this to read configuration details or conditionally render content based on where the extension is running.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -94444,7 +94444,7 @@ "syntaxKind": "PropertySignature", "name": "capabilities", "value": "SubscribableSignalLike", - "description": "The allowed capabilities of the extension, defined in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n\n* [`api_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#api-access): the extension can access the Storefront API.\n\n* [`network_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access): the extension can make external network calls.\n\n* [`block_progress`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n\n* [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n\n* [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can register customer consent decisions that are honored on Shopify-managed services.\n\n* [`iframe.sources`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#iframe): the extension can embed an external URL in an iframe." + "description": "The allowed capabilities of the extension, defined in your [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -94492,7 +94492,7 @@ "syntaxKind": "PropertySignature", "name": "version", "value": "string", - "description": "The published version of the running extension target.\n\nFor unpublished extensions, the value is `undefined`.", + "description": "The published version of the running extension target.\n\nFor unpublished extensions, the value is `undefined`.\n\nDon't use this property as a stable identifier in development environments. It becomes available only after the extension is published.", "isOptional": true, "examples": [ { @@ -94508,7 +94508,7 @@ ] } ], - "value": "export interface Extension {\n /**\n * The API version that was set in the extension config file.\n *\n * @example '2024-10', '2025-01', '2025-04', '2025-07', '2025-10'\n */\n apiVersion: ApiVersion;\n\n /**\n * The allowed capabilities of the extension, defined\n * in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n *\n * * [`api_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#api-access): the extension can access the Storefront API.\n *\n * * [`network_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access): the extension can make external network calls.\n *\n * * [`block_progress`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n *\n * * [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n *\n * * [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can register customer consent decisions that are honored on Shopify-managed services.\n *\n * * [`iframe.sources`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#iframe): the extension can embed an external URL in an iframe.\n */\n capabilities: SubscribableSignalLike;\n\n /**\n * Information about the editor where the extension is being rendered.\n *\n * If the value is undefined, then the extension isn't running in an editor.\n */\n editor?: Editor;\n\n /**\n * A Boolean to show whether your extension is currently rendered to the screen.\n *\n * Shopify might render your extension before it's visible in the UI,\n * typically to pre-render extensions that appear on a later step of the\n * checkout.\n *\n * Your extension might also continue to run after the customer has navigated away\n * from where it was rendered. The extension continues running so that\n * your extension is immediately available to render if the customer navigates back.\n */\n rendered: SubscribableSignalLike;\n\n /**\n * The URL to the script that started the extension target.\n */\n scriptUrl: string;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n */\n target: Target;\n\n /**\n * The published version of the running extension target.\n *\n * For unpublished extensions, the value is `undefined`.\n *\n * @example 3.0.10\n */\n version?: string;\n}" + "value": "export interface Extension {\n /**\n * The API version that was set in the extension config file.\n *\n * @example '2024-10', '2025-01', '2025-04', '2025-07', '2025-10'\n */\n apiVersion: ApiVersion;\n\n /**\n * The allowed capabilities of the extension, defined in your\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n */\n capabilities: SubscribableSignalLike;\n\n /**\n * Information about the editor where the extension is being rendered.\n *\n * If the value is undefined, then the extension isn't running in an editor.\n */\n editor?: Editor;\n\n /**\n * A Boolean to show whether your extension is currently rendered to the screen.\n *\n * Shopify might render your extension before it's visible in the UI,\n * typically to pre-render extensions that appear on a later step of the\n * checkout.\n *\n * Your extension might also continue to run after the customer has navigated away\n * from where it was rendered. The extension continues running so that\n * your extension is immediately available to render if the customer navigates back.\n */\n rendered: SubscribableSignalLike;\n\n /**\n * The URL to the script that started the extension target.\n */\n scriptUrl: string;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n */\n target: Target;\n\n /**\n * The published version of the running extension target.\n *\n * For unpublished extensions, the value is `undefined`.\n *\n * Don't use this property as a stable identifier in development environments.\n * It becomes available only after the extension is published.\n *\n * @example 3.0.10\n */\n version?: string;\n}" }, "ApiVersion": { "filePath": "src/shared.ts", @@ -94527,7 +94527,7 @@ "Editor": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Editor", - "description": "", + "description": "Information about the editor environment when an extension is rendered inside the checkout editor. The value is `undefined` when the extension is not rendering in an editor.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -94542,7 +94542,7 @@ "I18n": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18n", - "description": "", + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use the I18n API alongside the Localization API to build fully localized extensions.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -94578,7 +94578,7 @@ "I18nTranslate": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18nTranslate", - "description": "This returns a translated string matching a key in a locale file.", + "description": "Translates a key from your extension's locale files into a localized string. Supports interpolation with placeholder replacements and pluralization via the special `count` option.", "members": [], "value": "export interface I18nTranslate {\n (\n key: string,\n options?: Record,\n ): ReplacementType extends string | number\n ? string\n : (string | ReplacementType)[];\n}" }, @@ -95142,14 +95142,14 @@ "Localization": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Localization", - "description": "", + "description": "The buyer's language, country, currency, and timezone context. Use this to adapt your extension to the buyer's region and display localized content.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "country", "value": "SubscribableSignalLike", - "description": "The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown." + "description": "The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n\nDerived from the buyer's shipping address. Returns `undefined` until the buyer enters a shipping address." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -95177,18 +95177,18 @@ "syntaxKind": "PropertySignature", "name": "market", "value": "SubscribableSignalLike", - "description": "The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n\n> Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.", - "deprecationMessage": "Deprecated as of version `2025-04`" + "description": "The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. The market context updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.", + "deprecationMessage": "Merchants now manage which extensions load for each\nmarket, so extensions no longer need to check this value." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "timezone", "value": "SubscribableSignalLike", - "description": "The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time." + "description": "The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time." } ], - "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n *\n * > Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" + "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n *\n * Derived from the buyer's shipping address. Returns `undefined` until the\n * buyer enters a shipping address.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout,\n * carried over from the cart context. Markets group countries and\n * regions with shared pricing, languages, and domains. The market\n * context updates when the buyer changes the country of their\n * shipping address. The value is `undefined` if the market is unknown.\n *\n * @deprecated Merchants now manage which extensions load for each\n * market, so extensions no longer need to check this value.\n */\n market: SubscribableSignalLike;\n}" }, "Country": { "filePath": "src/shared.ts", @@ -95389,7 +95389,7 @@ "SessionToken": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SessionToken", - "description": "", + "description": "Authenticates requests between your extension and your app backend. Use session tokens to verify the identity of the buyer and the shop context when making server-side API calls. The token is a signed JWT that contains claims such as the customer ID, shop domain, and expiration.\n\nThe `sub` claim in the decoded token is present only when the buyer is logged in and the app has permission to read customer accounts. Absent for anonymous buyers.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -95648,7 +95648,7 @@ "Shop": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Shop", - "description": "", + "description": "Metadata about the merchant's store, including its name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -95688,30 +95688,30 @@ "syntaxKind": "PropertySignature", "name": "storefrontUrl", "value": "string", - "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n\n> Caution: > As of version `2024-04` this value no longer has a trailing slash.", + "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.", "isOptional": true } ], - "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n *\n * > Caution:\n * > As of version `2024-04` this value no longer has a trailing slash.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom domain.\n */\n myshopifyDomain: string;\n}" + "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom domain.\n */\n myshopifyDomain: string;\n}" }, "Storage": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Storage", - "description": "A key-value storage object for the extension.\n\nStored data is available only to this specific extension and any of its instances.\n\nThe storage backend is implemented with `localStorage` and should persist across the buyer's checkout session. However, data persistence isn't guaranteed.", + "description": "Key-value storage for a specific extension. Use storage to save preferences or cached data that should survive page reloads without requiring a backend call. Stored data is only available to this specific extension. The storage backend is implemented with `localStorage` and data persistence isn't guaranteed.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "delete", "value": "(key: string) => Promise", - "description": "Delete stored data by key." + "description": "Deletes a previously stored value by key." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "read", "value": "(key: string) => Promise", - "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original primitive.\n\nReturns `null` if no stored data exists." + "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original type.\n\nReturns the stored value for the given key, or `null` when no value exists. Doesn't throw on a missing key." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -95721,7 +95721,7 @@ "description": "Write stored data for this key.\n\nThe data must be serializable to JSON." } ], - "value": "export interface Storage {\n /**\n * Read and return a stored value by key.\n *\n * The stored data is deserialized from JSON and returned as\n * its original primitive.\n *\n * Returns `null` if no stored data exists.\n */\n read(key: string): Promise;\n\n /**\n * Write stored data for this key.\n *\n * The data must be serializable to JSON.\n */\n write(key: string, data: any): Promise;\n\n /**\n * Delete stored data by key.\n */\n delete(key: string): Promise;\n}" + "value": "export interface Storage {\n /**\n * Read and return a stored value by key.\n *\n * The stored data is deserialized from JSON and returned as\n * its original type.\n *\n * Returns the stored value for the given key, or `null` when no value\n * exists. Doesn't throw on a missing key.\n */\n read(key: string): Promise;\n\n /**\n * Write stored data for this key.\n *\n * The data must be serializable to JSON.\n */\n write(key: string, data: any): Promise;\n\n /**\n * Deletes a previously stored value by key.\n */\n delete(key: string): Promise;\n}" }, "Version": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -95797,7 +95797,7 @@ "syntaxKind": "MethodSignature", "name": "applyAttributeChange", "value": "(change: AttributeChange) => Promise", - "description": "Updates or removes an attribute on the cart and checkout. On success, the [`attributes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/attributes#standardapi-propertydetail-attributes) property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.", + "description": "Updates or removes an attribute on the cart and checkout. On success, the [`attributes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/attributes#properties-propertydetail-attributes) property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.", "deprecationMessage": "Use cart metafields instead." }, { @@ -95805,42 +95805,42 @@ "syntaxKind": "MethodSignature", "name": "applyCartLinesChange", "value": "(change: CartLineChange) => Promise", - "description": "Adds, removes, or updates line items in the cart. The returned promise resolves when the change has been applied by the server, and the [`lines`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-lines#standardapi-propertydetail-lines) property updates with the new state.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Adds, removes, or updates line items in the cart. The returned promise resolves when the change has been applied by the server, and the [`lines`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-lines#properties-propertydetail-lines) property updates with the new state.\n\nAccepts a single change per call. To make multiple changes, call this method separately for each one.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyDiscountCodeChange", "value": "(change: DiscountCodeChange) => Promise", - "description": "Adds or removes a discount code on the checkout. The returned promise resolves when the change has been applied by the server, and the [`discountCodes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/discounts#standardapi-propertydetail-discountcodes) property updates with the new state.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves discount codes through a network call.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Adds or removes a discount code on the checkout. The returned promise resolves when the change has been applied by the server, and the [`discountCodes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/discounts#properties-propertydetail-discountcodes) property updates with the new state.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves discount codes through a network call.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyGiftCardChange", "value": "(change: GiftCardChange) => Promise", - "description": "Adds or removes a gift card from the checkout. The returned promise resolves when the change has been applied by the server, and the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/gift-cards#standardapi-propertydetail-appliedgiftcards) property updates with the new state.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves gift card codes through a network call.\n\n> Note: This method returns an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Adds or removes a gift card from the checkout. The returned promise resolves when the change has been applied by the server, and the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/gift-cards#properties-propertydetail-appliedgiftcards) property updates with the new state.\n\nUnlike other write operations, gift card changes aren't gated by a cart instruction flag.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves gift card codes through a network call.\n\n> Note: This method returns an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyMetafieldChange", "value": "(change: MetafieldChange) => Promise", - "description": "Creates, updates, or removes a cart metafield on the checkout. On success, the [`metafields`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/metafields#standardapi-propertydetail-metafields) property updates to reflect the change.\n\nCart metafields are copied to order metafields at order creation time if there's a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n\n> Caution: `MetafieldRemoveChange` and `MetafieldUpdateChange` are deprecated. Use cart metafields with `MetafieldRemoveCartChange` and `MetafieldUpdateCartChange` instead. If `MetafieldUpdateChange` writes a metafield with the same namespace and key as a cart metafield that's configured to copy, the cart metafield won't be copied.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Creates, updates, or removes a cart metafield on the checkout. On success, the [`metafields`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/metafields#properties-propertydetail-metafields) property updates to reflect the change.\n\nCart metafields are copied to order metafields at order creation time if there's a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n\n> Caution: `MetafieldRemoveChange` and `MetafieldUpdateChange` are deprecated. Use cart metafields with `MetafieldRemoveCartChange` and `MetafieldUpdateCartChange` instead. If `MetafieldUpdateChange` writes a metafield with the same namespace and key as a cart metafield that's configured to copy, the cart metafield won't be copied.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyNoteChange", "value": "(change: NoteChange) => Promise", - "description": "Sets or removes the buyer's note on the checkout. On success, the [`note`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/note#standardapi-propertydetail-note) property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Sets or removes the buyer's note on the checkout. On success, the [`note`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/note#properties-propertydetail-note) property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyShippingAddressChange", "value": "(change: ShippingAddressUpdateChange) => Promise", - "description": "Updates the buyer's shipping address on the checkout. The provided fields are merged into the existing address without prompting the buyer. On success, the `shippingAddress` property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", + "description": "Updates the buyer's shipping address on the checkout. The provided fields are merged into the existing address without prompting the buyer. On success, the `shippingAddress` property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", "isOptional": true }, { @@ -95853,7 +95853,7 @@ "isPrivate": true } ], - "value": "export interface CheckoutApi {\n /**\n * Updates or removes an attribute on the cart and checkout. On success, the\n * [`attributes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/attributes#standardapi-propertydetail-attributes) property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * @deprecated Use cart metafields instead.\n */\n applyAttributeChange(change: AttributeChange): Promise;\n\n /**\n * Adds, removes, or updates line items in the cart. The returned promise resolves when the change has been applied by the server, and the [`lines`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-lines#standardapi-propertydetail-lines) property updates with the new state.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyCartLinesChange(change: CartLineChange): Promise;\n\n /**\n * Adds or removes a discount code on the checkout. The returned promise resolves when the change has been applied by the server, and the [`discountCodes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/discounts#standardapi-propertydetail-discountcodes) property updates with the new state.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves discount codes through a network call.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyDiscountCodeChange(\n change: DiscountCodeChange,\n ): Promise;\n\n /**\n * Adds or removes a gift card from the checkout. The returned promise resolves when the change has been applied by the server, and the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/gift-cards#standardapi-propertydetail-appliedgiftcards) property updates with the new state.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves gift card codes through a network call.\n *\n * > Note: This method returns an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyGiftCardChange(change: GiftCardChange): Promise;\n\n /**\n * Creates, updates, or removes a cart metafield on the checkout. On success, the\n * [`metafields`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/metafields#standardapi-propertydetail-metafields) property updates to reflect the change.\n *\n * Cart metafields are copied to order metafields at order creation time if there's a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n *\n * > Caution: `MetafieldRemoveChange` and `MetafieldUpdateChange` are deprecated. Use cart metafields with `MetafieldRemoveCartChange` and `MetafieldUpdateCartChange` instead. If `MetafieldUpdateChange` writes a metafield with the same namespace and key as a cart metafield that's configured to copy, the cart metafield won't be copied.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyMetafieldChange(change: MetafieldChange): Promise;\n\n /**\n * Sets or removes the buyer's note on the checkout. On success, the\n * [`note`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/note#standardapi-propertydetail-note)\n * property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyNoteChange(change: NoteChange): Promise;\n\n /**\n * @private\n */\n experimentalIsShopAppStyle?: boolean;\n\n /**\n * Updates the buyer's shipping address on the checkout. The provided fields\n * are merged into the existing address without prompting the buyer. On success,\n * the `shippingAddress` property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyShippingAddressChange?(\n change: ShippingAddressChange,\n ): Promise;\n}" + "value": "export interface CheckoutApi {\n /**\n * Updates or removes an attribute on the cart and checkout. On success, the\n * [`attributes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/attributes#properties-propertydetail-attributes) property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * @deprecated Use cart metafields instead.\n */\n applyAttributeChange(change: AttributeChange): Promise;\n\n /**\n * Adds, removes, or updates line items in the cart. The returned promise resolves when the change has been applied by the server, and the [`lines`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-lines#properties-propertydetail-lines) property updates with the new state.\n *\n * Accepts a single change per call. To make multiple changes, call this\n * method separately for each one.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyCartLinesChange(change: CartLineChange): Promise;\n\n /**\n * Adds or removes a discount code on the checkout. The returned promise resolves when the change has been applied by the server, and the [`discountCodes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/discounts#properties-propertydetail-discountcodes) property updates with the new state.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves discount codes through a network call.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyDiscountCodeChange(\n change: DiscountCodeChange,\n ): Promise;\n\n /**\n * Adds or removes a gift card from the checkout. The returned promise resolves when the change has been applied by the server, and the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/gift-cards#properties-propertydetail-appliedgiftcards) property updates with the new state.\n *\n * Unlike other write operations, gift card changes aren't gated by a cart\n * instruction flag.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves gift card codes through a network call.\n *\n * > Note: This method returns an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyGiftCardChange(change: GiftCardChange): Promise;\n\n /**\n * Creates, updates, or removes a cart metafield on the checkout. On success, the\n * [`metafields`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/metafields#properties-propertydetail-metafields) property updates to reflect the change.\n *\n * Cart metafields are copied to order metafields at order creation time if there's a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n *\n * > Caution: `MetafieldRemoveChange` and `MetafieldUpdateChange` are deprecated. Use cart metafields with `MetafieldRemoveCartChange` and `MetafieldUpdateCartChange` instead. If `MetafieldUpdateChange` writes a metafield with the same namespace and key as a cart metafield that's configured to copy, the cart metafield won't be copied.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyMetafieldChange(change: MetafieldChange): Promise;\n\n /**\n * Sets or removes the buyer's note on the checkout. On success, the\n * [`note`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/note#properties-propertydetail-note)\n * property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyNoteChange(change: NoteChange): Promise;\n\n /**\n * @private\n */\n experimentalIsShopAppStyle?: boolean;\n\n /**\n * Updates the buyer's shipping address on the checkout. The provided fields\n * are merged into the existing address without prompting the buyer. On success,\n * the `shippingAddress` property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyShippingAddressChange?(\n change: ShippingAddressChange,\n ): Promise;\n}" }, "AttributeChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -95920,7 +95920,7 @@ "syntaxKind": "PropertySignature", "name": "value", "value": "string", - "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.", + "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.\n\nAttribute values are always strings. To store structured data, serialize it to JSON and parse it when reading.", "examples": [ { "title": "Example", @@ -95935,7 +95935,7 @@ ] } ], - "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" + "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * Attribute values are always strings. To store structured data, serialize\n * it to JSON and parse it when reading.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" }, "AttributeRemoveChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -96788,7 +96788,7 @@ "syntaxKind": "PropertySignature", "name": "message", "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer." + "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer.\n\nRender your own localized error text rather than displaying this message to the buyer." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -96798,7 +96798,7 @@ "description": "Indicates that the line item wasn't changed successfully. Refer to the `message` property for details about the error." } ], - "value": "export interface CartLineChangeResultError {\n /**\n * Indicates that the line item wasn't changed successfully. Refer to the `message` property for details about the error.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface CartLineChangeResultError {\n /**\n * Indicates that the line item wasn't changed successfully. Refer to the `message` property for details about the error.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n *\n * Render your own localized error text rather than displaying this message\n * to the buyer.\n */\n message: string;\n}" }, "DiscountCodeChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -96978,7 +96978,7 @@ "syntaxKind": "PropertySignature", "name": "message", "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer." + "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer.\n\nRender your own localized error text rather than displaying this message to the buyer." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -96988,7 +96988,7 @@ "description": "Indicates that the gift card change couldn't be applied. Check the `message` property for details." } ], - "value": "export interface GiftCardChangeResultError {\n /**\n * Indicates that the gift card change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface GiftCardChangeResultError {\n /**\n * Indicates that the gift card change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n *\n * Render your own localized error text rather than displaying this message\n * to the buyer.\n */\n message: string;\n}" }, "MetafieldChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -97249,7 +97249,7 @@ "syntaxKind": "PropertySignature", "name": "message", "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer." + "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer.\n\nRender your own localized error text rather than displaying this message to the buyer." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -97259,7 +97259,7 @@ "description": "Indicates that the metafield change couldn't be applied. Check the `message` property for details." } ], - "value": "export interface MetafieldChangeResultError {\n /**\n * Indicates that the metafield change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface MetafieldChangeResultError {\n /**\n * Indicates that the metafield change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n *\n * Render your own localized error text rather than displaying this message\n * to the buyer.\n */\n message: string;\n}" }, "NoteChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -97337,7 +97337,7 @@ "syntaxKind": "PropertySignature", "name": "message", "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer." + "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer.\n\nRender your own localized error text rather than displaying this message to the buyer." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -97347,7 +97347,7 @@ "description": "Indicates that the note change couldn't be applied. Check the `message` property for details." } ], - "value": "export interface NoteChangeResultError {\n /**\n * Indicates that the note change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface NoteChangeResultError {\n /**\n * Indicates that the note change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n *\n * Render your own localized error text rather than displaying this message\n * to the buyer.\n */\n message: string;\n}" }, "ShippingAddressUpdateChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -97933,7 +97933,7 @@ "syntaxKind": "PropertySignature", "name": "analytics", "value": "Analytics", - "description": "The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event." + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -97947,7 +97947,7 @@ "syntaxKind": "PropertySignature", "name": "applyTrackingConsentChange", "value": "ApplyTrackingConsentChangeType", - "description": "Enables setting and updating customer privacy consent settings and tracking consent metafields.\n\n> Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent) to be set to `true`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." + "description": "Enables setting and updating customer privacy consent settings and tracking consent metafields.\n\n> Note: Requires the [`collect_buyer_consent` capability](/docs/apps/build/customer-accounts/capabilities#collect-buyer-consent) to be set to `true`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -97968,7 +97968,7 @@ "syntaxKind": "PropertySignature", "name": "availablePaymentOptions", "value": "SubscribableSignalLike", - "description": "All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region." + "description": "All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n\nThe set of payment options can change when the buyer updates their address or cart, so subscribe to changes rather than reading once during initialization. Each option exposes `handle` and `type` only. Provider names, logos, fees, and installment terms aren't available." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -98005,7 +98005,7 @@ "syntaxKind": "PropertySignature", "name": "checkoutToken", "value": "SubscribableSignalLike", - "description": "A stable ID that represents the current checkout.\n\nThe value is `undefined` when the checkout hasn't been created on the server yet.\n\nUse this to correlate checkout sessions across your extension, web pixels, and backend systems.\n\nThis matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data) and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object)." + "description": "A stable ID that represents the current checkout.\n\nThe value is `undefined` when the checkout hasn't been created on the server yet.\n\nUse this to correlate checkout sessions across your extension, web pixels, and backend systems.\n\nThis matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data) and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n\nCan be `undefined`. Handle the `undefined` state before using the value." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -98026,7 +98026,7 @@ "syntaxKind": "PropertySignature", "name": "deliveryGroups", "value": "SubscribableSignalLike", - "description": "The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items." + "description": "The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n\nEmpty until the buyer enters enough address information for Shopify to calculate shipping rates." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -98047,7 +98047,7 @@ "syntaxKind": "PropertySignature", "name": "extension", "value": "Extension", - "description": "The meta information about the extension." + "description": "Metadata about the running extension, including the current target, API version, capabilities, and editor context. Use this to conditionally render content based on where the extension is running." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -98055,7 +98055,7 @@ "name": "extensionPoint", "value": "Target", "description": "The identifier that specifies where in Shopify's UI your code is being injected. This is one of the targets you've included in your extension's configuration file.", - "deprecationMessage": "Deprecated as of version `2023-07`, use `extension.target` instead.", + "deprecationMessage": "Use `extension.target` instead.", "examples": [ { "title": "Example", @@ -98074,14 +98074,14 @@ "syntaxKind": "PropertySignature", "name": "i18n", "value": "I18n", - "description": "Utilities for translating content and formatting values according to the current [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) of the checkout.\n\nRefer to [`localization` examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples) for more information." + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use alongside [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) to build fully localized extensions." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "instructions", "value": "SubscribableSignalLike", - "description": "The cart instructions used to create the checkout and possibly limit extension capabilities.\n\nThese instructions should be checked before performing any actions that might be affected by them.\n\nFor example, if you intend to add a discount code via the `applyDiscountCodeChange` method, check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n\n> Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs aren't available. See the [update guide](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples) for more information." + "description": "The cart instructions used to create the checkout and possibly limit extension capabilities.\n\nThese instructions should be checked before performing any actions that might be affected by them.\n\nFor example, if you intend to add a discount code via the `applyDiscountCodeChange` method, check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n\n> Caution: Check cart instructions before calling select APIs, as > some may not be available. See the > [Cart Instructions API](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples) > for more information." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -98095,7 +98095,7 @@ "syntaxKind": "PropertySignature", "name": "localization", "value": "Localization", - "description": "The details about the location, language, and currency of the customer. For utilities to easily format and translate content based on these details, you can use the [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n) object instead." + "description": "The buyer's language, country, currency, and timezone context. For formatting and translation helpers, use the [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#properties-propertydetail-i18n) object instead." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -98125,21 +98125,21 @@ "syntaxKind": "PropertySignature", "name": "query", "value": ">(query: string, options?: { variables?: Variables; version?: StorefrontApiVersion; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>", - "description": "The method used to query the Storefront GraphQL API with a prefetched token.\n\nRefer to [Storefront API access examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/storefront-api) for more information." + "description": "The method used to query the Storefront GraphQL API with a prefetched token." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "selectedPaymentOptions", "value": "SubscribableSignalLike", - "description": "The payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card)." + "description": "The payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\n\nEach option exposes `handle` and `type` only. Provider names, logos, fees, and installment terms aren't available." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "sessionToken", "value": "SessionToken", - "description": "The session token providing a set of claims as a signed JSON Web Token (JWT).\n\nThe token has a TTL of five minutes.\n\nIf the previous token expires, this value reflects a new session token with a new signature and expiry.\n\nRefer to [session token examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/session-token) for more information." + "description": "The session token providing a set of claims as a signed JSON Web Token (JWT).\n\nThe token has a TTL of five minutes.\n\nIf the previous token expires, this value reflects a new session token with a new signature and expiry.\n\nLearn more about [session tokens](/docs/apps/build/authentication-authorization/session-tokens)." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -98161,14 +98161,14 @@ "syntaxKind": "PropertySignature", "name": "shop", "value": "Shop", - "description": "The shop where the checkout is taking place." + "description": "The store where the checkout is taking place, including the shop name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "storage", "value": "Storage", - "description": "The key-value storage for the extension.\n\nIt uses `localStorage` and should persist across the customer's current checkout session.\n\n> Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n\nData is shared across all activated extension targets of this extension. In versions 2023-07 and earlier, each activated extension target had its own storage." + "description": "Key-value storage that persists across page loads within the current checkout session. Data is shared across all activated targets associated with this extension.\n\n> Caution: Data persistence isn't guaranteed and storage is cleared when the buyer starts a new checkout." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -98190,29 +98190,29 @@ ] } ], - "value": "export interface StandardApi {\n /**\n * The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event.\n */\n analytics: Analytics;\n\n /**\n * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\n */\n appliedGiftCards: SubscribableSignalLike;\n\n /**\n * The cart instructions used to create the checkout and possibly limit extension capabilities.\n *\n * These instructions should be checked before performing any actions that might be affected by them.\n *\n * For example, if you intend to add a discount code via the `applyDiscountCodeChange` method,\n * check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n *\n * > Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs aren't available.\n * See the [update guide](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples) for more information.\n *\n */\n instructions: SubscribableSignalLike;\n\n /**\n * The metafields requested in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration)\n * file. These metafields are updated when there's a change in the merchandise items\n * being purchased by the customer.\n *\n * App owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` isn't supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n appMetafields: SubscribableSignalLike;\n\n /**\n * The custom key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n buyerIdentity?: BuyerIdentity;\n\n /**\n * Provides details on the buyer's progression through the checkout and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/buyer-journey#examples)\n * examples for more information.\n */\n buyerJourney: BuyerJourney;\n\n /**\n * Settings applied to the buyer's checkout.\n */\n checkoutSettings: SubscribableSignalLike;\n\n /**\n * A stable ID that represents the current checkout.\n *\n * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\n *\n * This matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data)\n * and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n */\n checkoutToken: SubscribableSignalLike;\n\n /**\n * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * The meta information about the extension.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n *\n * @deprecated Deprecated as of version `2023-07`, use `extension.target` instead.\n */\n extensionPoint: Target;\n\n /**\n * Utilities for translating content and formatting values according to the current\n * [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization)\n * of the checkout.\n *\n * Refer to [`localization` examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples)\n * for more information.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The details about the location, language, and currency of the customer. For utilities to easily\n * format and translate content based on these details, you can use the\n * [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n)\n * object instead.\n */\n localization: Localization;\n\n /**\n * The metafields that apply to the current checkout.\n *\n * Metafields are stored locally on the client and are applied to the order object after the checkout completes.\n *\n * These metafields are shared by all extensions running on checkout, and\n * persist for as long as the customer is working on this checkout.\n *\n * Once the order is created, you can query these metafields using the\n * [GraphQL Admin API](/docs/admin-api/graphql/reference/orders/order#metafield-2021-01)\n *\n * > Caution:\n * `metafields` is deprecated. Use `appMetafields` with cart metafields instead.\n *\n * @deprecated Use `appMetafields` with cart metafields instead.\n */\n metafields: SubscribableSignalLike;\n\n /**\n * A note left by the customer to the merchant, either in their cart or during checkout.\n *\n * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\n */\n note: SubscribableSignalLike;\n\n /**\n * The method used to query the Storefront GraphQL API with a prefetched token.\n *\n * Refer to [Storefront API access examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/storefront-api) for more information.\n */\n query: >(\n query: string,\n options?: {variables?: Variables; version?: StorefrontApiVersion},\n ) => Promise<{data?: Data; errors?: GraphQLError[]}>;\n\n /**\n * The payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\n */\n selectedPaymentOptions: SubscribableSignalLike;\n\n /**\n * The session token providing a set of claims as a signed JSON Web Token (JWT).\n *\n * The token has a TTL of five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/session-token) for more information.\n */\n sessionToken: SessionToken;\n\n /**\n * The settings matching the settings definition written in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates in real time as a merchant fills in the settings.\n */\n settings: SubscribableSignalLike;\n\n /**\n * The proposed customer shipping address. During the information step, the address\n * updates when the field is committed (on change) rather than every keystroke.\n * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n shippingAddress?: SubscribableSignalLike;\n\n /**\n * The proposed customer billing address. The address updates when the field is\n * committed (on change) rather than every keystroke. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided yet.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n billingAddress?: SubscribableSignalLike;\n\n /** The shop where the checkout is taking place. */\n shop: Shop;\n\n /**\n * The key-value storage for the extension.\n *\n * It uses `localStorage` and should persist across the customer's current checkout session.\n *\n * > Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n *\n * Data is shared across all activated extension targets of this extension. In versions 2023-07 and earlier,\n * each activated extension target had its own storage.\n */\n storage: Storage;\n\n /**\n * The renderer version being used for the extension.\n *\n * @example '2025-10'\n */\n version: Version;\n\n /**\n * Customer privacy consent settings and a flag denoting if consent has previously been collected.\n */\n customerPrivacy: SubscribableSignalLike;\n\n /**\n * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent) to be set to `true`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyTrackingConsentChange: ApplyTrackingConsentChangeType;\n\n /**\n * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" + "value": "export interface StandardApi {\n /**\n * Tracks custom events and sends visitor information to\n * [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events\n * and `visitor()` to submit buyer contact details.\n */\n analytics: Analytics;\n\n /**\n * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\n */\n appliedGiftCards: SubscribableSignalLike;\n\n /**\n * The cart instructions used to create the checkout and possibly limit extension capabilities.\n *\n * These instructions should be checked before performing any actions that might be affected by them.\n *\n * For example, if you intend to add a discount code via the `applyDiscountCodeChange` method,\n * check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n *\n * > Caution: Check cart instructions before calling select APIs, as\n * > some may not be available. See the\n * > [Cart Instructions API](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples)\n * > for more information.\n *\n */\n instructions: SubscribableSignalLike;\n\n /**\n * The metafields requested in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration)\n * file. These metafields are updated when there's a change in the merchandise items\n * being purchased by the customer.\n *\n * App owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` isn't supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n appMetafields: SubscribableSignalLike;\n\n /**\n * The custom key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as\n * credit cards, wallets, and local payment methods. The list depends on\n * the shop's payment configuration and the buyer's region.\n *\n * The set of payment options can change when the buyer updates their\n * address or cart, so subscribe to changes rather than reading once\n * during initialization. Each option exposes `handle` and `type` only.\n * Provider names, logos, fees, and installment terms aren't available.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n buyerIdentity?: BuyerIdentity;\n\n /**\n * Provides details on the buyer's progression through the checkout and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/buyer-journey#examples)\n * examples for more information.\n */\n buyerJourney: BuyerJourney;\n\n /**\n * Settings applied to the buyer's checkout.\n */\n checkoutSettings: SubscribableSignalLike;\n\n /**\n * A stable ID that represents the current checkout.\n *\n * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\n *\n * This matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data)\n * and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n *\n * Can be `undefined`. Handle the `undefined` state before using the value.\n */\n checkoutToken: SubscribableSignalLike;\n\n /**\n * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n *\n * Empty until the buyer enters enough address information for Shopify to\n * calculate shipping rates.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * Metadata about the running extension, including the current target, API version,\n * capabilities, and editor context. Use this to conditionally render content\n * based on where the extension is running.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n *\n * @deprecated Use `extension.target` instead.\n */\n extensionPoint: Target;\n\n /**\n * Utilities for translating strings, formatting currencies, numbers, and dates\n * according to the buyer's locale. Use alongside\n * [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization)\n * to build fully localized extensions.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The buyer's language, country, currency, and timezone context. For\n * formatting and translation helpers, use the\n * [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#properties-propertydetail-i18n)\n * object instead.\n */\n localization: Localization;\n\n /**\n * The metafields that apply to the current checkout.\n *\n * Metafields are stored locally on the client and are applied to the order object after the checkout completes.\n *\n * These metafields are shared by all extensions running on checkout, and\n * persist for as long as the customer is working on this checkout.\n *\n * Once the order is created, you can query these metafields using the\n * [GraphQL Admin API](/docs/admin-api/graphql/reference/orders/order#metafield-2021-01)\n *\n * > Caution:\n * `metafields` is deprecated. Use `appMetafields` with cart metafields instead.\n *\n * @deprecated Use `appMetafields` with cart metafields instead.\n */\n metafields: SubscribableSignalLike;\n\n /**\n * A note left by the customer to the merchant, either in their cart or during checkout.\n *\n * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\n */\n note: SubscribableSignalLike;\n\n /**\n * The method used to query the Storefront GraphQL API with a prefetched token.\n *\n */\n query: >(\n query: string,\n options?: {variables?: Variables; version?: StorefrontApiVersion},\n ) => Promise<{data?: Data; errors?: GraphQLError[]}>;\n\n /**\n * The payment options the buyer has currently selected. This updates as\n * the buyer changes their payment method. The array can contain multiple\n * entries when the buyer splits payment across methods (for example, a\n * gift card and a credit card).\n *\n * Each option exposes `handle` and `type` only. Provider names, logos,\n * fees, and installment terms aren't available.\n */\n selectedPaymentOptions: SubscribableSignalLike;\n\n /**\n * The session token providing a set of claims as a signed JSON Web Token (JWT).\n *\n * The token has a TTL of five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Learn more about [session tokens](/docs/apps/build/authentication-authorization/session-tokens).\n */\n sessionToken: SessionToken;\n\n /**\n * The settings matching the settings definition written in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates in real time as a merchant fills in the settings.\n */\n settings: SubscribableSignalLike;\n\n /**\n * The proposed customer shipping address. During the information step, the address\n * updates when the field is committed (on change) rather than every keystroke.\n * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n shippingAddress?: SubscribableSignalLike;\n\n /**\n * The proposed customer billing address. The address updates when the field is\n * committed (on change) rather than every keystroke. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided yet.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n billingAddress?: SubscribableSignalLike;\n\n /**\n * The store where the checkout is taking place, including the shop name,\n * storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.\n */\n shop: Shop;\n\n /**\n * Key-value storage that persists across page loads within the current checkout\n * session. Data is shared across all activated targets associated with\n * this extension.\n *\n * > Caution: Data persistence isn't guaranteed and storage is cleared when the\n * buyer starts a new checkout.\n */\n storage: Storage;\n\n /**\n * The renderer version being used for the extension.\n *\n * @example '2025-10'\n */\n version: Version;\n\n /**\n * Customer privacy consent settings and a flag denoting if consent has previously been collected.\n */\n customerPrivacy: SubscribableSignalLike;\n\n /**\n * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`collect_buyer_consent` capability](/docs/apps/build/customer-accounts/capabilities#collect-buyer-consent) to be set to `true`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyTrackingConsentChange: ApplyTrackingConsentChangeType;\n\n /**\n * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" }, "Analytics": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Analytics", - "description": "", + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "publish", "value": "(name: string, data: Record) => Promise", - "description": "Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing)." + "description": "Publishes a custom event to [Web Pixels](/docs/apps/marketing). Returns `true` when the event is successfully dispatched.\n\nThe Promise resolves to `true` when the event was dispatched. The boolean indicates dispatch confirmation only. It doesn't indicate whether any specific web pixel processed the event." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "visitor", "value": "(data: { email?: string; phone?: string; }) => Promise", - "description": "A method for capturing details about a visitor on the online store." + "description": "Submits buyer contact details for attribution and analytics purposes." } ], - "value": "export interface Analytics {\n /**\n * Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing).\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * A method for capturing details about a visitor on the online store.\n */\n visitor(data: {email?: string; phone?: string}): Promise;\n}" + "value": "export interface Analytics {\n /**\n * Publishes a custom event to [Web Pixels](/docs/apps/marketing).\n * Returns `true` when the event is successfully dispatched.\n *\n * The Promise resolves to `true` when the event was dispatched. The boolean\n * indicates dispatch confirmation only. It doesn't indicate whether any\n * specific web pixel processed the event.\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * Submits buyer contact details for attribution and analytics purposes.\n */\n visitor(data: {email?: string; phone?: string}): Promise;\n}" }, "VisitorResult": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -98253,10 +98253,10 @@ "syntaxKind": "PropertySignature", "name": "type", "value": "'error'", - "description": "Indicates that the visitor information is invalid and wasn't submitted. Examples are using the wrong data type or missing a required property." + "description": "Indicates that the visitor information is invalid and wasn't submitted. Common causes include using the wrong data type or omitting a required property." } ], - "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Examples are using the wrong data type or missing a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Common causes include using the wrong data type or omitting a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" }, "SubscribableSignalLike": { "filePath": "src/surfaces/checkout/shared.ts", @@ -98470,10 +98470,10 @@ "syntaxKind": "PropertySignature", "name": "value", "value": "string | null", - "description": "The new value to store in the metafield. Set to `null` to delete the metafield." + "description": "The new value to store in the metafield. Set to `null` to delete the metafield.\n\nConsent metafield values are strings, not booleans. Pass `null` to delete a tracking consent metafield." } ], - "value": "export interface TrackingConsentMetafieldChange {\n /**\n * The identifier for the tracking consent metafield to update.\n */\n key: string;\n /**\n * The new value to store in the metafield. Set to `null` to delete the metafield.\n */\n value: string | null;\n}" + "value": "export interface TrackingConsentMetafieldChange {\n /**\n * The identifier for the tracking consent metafield to update.\n */\n key: string;\n /**\n * The new value to store in the metafield. Set to `null` to delete the metafield.\n *\n * Consent metafield values are strings, not booleans. Pass `null` to delete\n * a tracking consent metafield.\n */\n value: string | null;\n}" }, "VisitorConsent": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -98687,7 +98687,7 @@ "syntaxKind": "PropertySignature", "name": "value", "value": "string", - "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.", + "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.\n\nAttribute values are always strings. To store structured data, serialize it to JSON and parse it when reading.", "examples": [ { "title": "Example", @@ -98702,7 +98702,7 @@ ] } ], - "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" + "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * Attribute values are always strings. To store structured data, serialize\n * it to JSON and parse it when reading.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" }, "PaymentOption": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -99053,7 +99053,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A globally-unique identifier for the customer in the format `gid://shopify/Customer/`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", + "description": "An identifier for the customer in the format `gid://shopify/Customer/`. This value is unique per shop.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", "examples": [ { "title": "Example", @@ -99106,7 +99106,7 @@ "isPrivate": true } ], - "value": "export interface Customer {\n /**\n * A globally-unique identifier for the customer in the format `gid://shopify/Customer/`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'gid://shopify/Customer/123'\n */\n id: string;\n /**\n * The email address associated with the customer's account. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email?: string;\n /**\n * The phone number associated with the customer's account. The value is `undefined` if no phone number is on file or the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone?: string;\n /**\n * The customer's full name, typically a combination of first and last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n fullName?: string;\n /**\n * The customer's first name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n firstName?: string;\n /**\n * The customer's last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n lastName?: string;\n /**\n * The customer's profile image, such as a Gravatar avatar. Use this to personalize the extension UI for the logged-in buyer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n image: ImageDetails;\n /**\n * Whether the customer has opted in to receiving marketing communications from the merchant, such as email campaigns and promotional offers.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * > Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n *\n * @deprecated Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n */\n acceptsMarketing: boolean;\n /**\n * Whether the customer has opted in to email marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsEmailMarketing: boolean;\n /**\n * Whether the customer has opted in to SMS marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsSmsMarketing: boolean;\n /**\n * The store credit accounts owned by this customer that can be used as payment during checkout. Each account has a balance representing available store credit.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @private\n */\n storeCreditAccounts: StoreCreditAccount[];\n /**\n * The number of orders the customer has previously placed with this shop.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n ordersCount: number;\n}" + "value": "export interface Customer {\n /**\n * An identifier for the customer in the format `gid://shopify/Customer/`. This value is unique per shop.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'gid://shopify/Customer/123'\n */\n id: string;\n /**\n * The email address associated with the customer's account. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email?: string;\n /**\n * The phone number associated with the customer's account. The value is `undefined` if no phone number is on file or the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone?: string;\n /**\n * The customer's full name, typically a combination of first and last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n fullName?: string;\n /**\n * The customer's first name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n firstName?: string;\n /**\n * The customer's last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n lastName?: string;\n /**\n * The customer's profile image, such as a Gravatar avatar. Use this to personalize the extension UI for the logged-in buyer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n image: ImageDetails;\n /**\n * Whether the customer has opted in to receiving marketing communications from the merchant, such as email campaigns and promotional offers.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * > Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n *\n * @deprecated Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n */\n acceptsMarketing: boolean;\n /**\n * Whether the customer has opted in to email marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsEmailMarketing: boolean;\n /**\n * Whether the customer has opted in to SMS marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsSmsMarketing: boolean;\n /**\n * The store credit accounts owned by this customer that can be used as payment during checkout. Each account has a balance representing available store credit.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @private\n */\n storeCreditAccounts: StoreCreditAccount[];\n /**\n * The number of orders the customer has previously placed with this shop.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n ordersCount: number;\n}" }, "ImageDetails": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -99388,11 +99388,11 @@ "syntaxKind": "MethodSignature", "name": "perform", "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", + "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.\n\nRuns after all intercept results are collected. Use it for local state updates such as setting an error flag. By the time it runs, the navigation decision is final, so blocking logic belongs in the intercept handler itself, not here.", "isOptional": true } ], - "value": "interface InterceptorRequestAllow {\n /**\n * Indicates that the interceptor allows the buyer's journey to continue.\n */\n behavior: 'allow';\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" + "value": "interface InterceptorRequestAllow {\n /**\n * Indicates that the interceptor allows the buyer's journey to continue.\n */\n behavior: 'allow';\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n *\n * Runs after all intercept results are collected. Use it for local state\n * updates such as setting an error flag. By the time it runs, the navigation\n * decision is final, so blocking logic belongs in the intercept handler\n * itself, not here.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" }, "InterceptorResult": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -99456,7 +99456,7 @@ "syntaxKind": "MethodSignature", "name": "perform", "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", + "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.\n\nRuns after all intercept results are collected. Use it for local state updates such as setting an error flag. By the time it runs, the navigation decision is final, so blocking logic belongs in the intercept handler itself, not here.", "isOptional": true }, { @@ -99467,7 +99467,7 @@ "description": "The reason for blocking the interceptor request. This value isn't presented to the buyer, so it doesn't need to be localized. The value is used only for Shopify's own internal debugging and metrics." } ], - "value": "interface InterceptorRequestBlock {\n /**\n * Indicates that the interceptor blocks the buyer's journey from continuing.\n */\n behavior: 'block';\n\n /**\n * The reason for blocking the interceptor request. This value isn't presented to\n * the buyer, so it doesn't need to be localized. The value is used only for Shopify's\n * own internal debugging and metrics.\n */\n reason: string;\n\n /**\n * Used to pass errors to the checkout UI, outside your extension's UI boundaries.\n */\n errors?: ValidationError[];\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" + "value": "interface InterceptorRequestBlock {\n /**\n * Indicates that the interceptor blocks the buyer's journey from continuing.\n */\n behavior: 'block';\n\n /**\n * The reason for blocking the interceptor request. This value isn't presented to\n * the buyer, so it doesn't need to be localized. The value is used only for Shopify's\n * own internal debugging and metrics.\n */\n reason: string;\n\n /**\n * Used to pass errors to the checkout UI, outside your extension's UI boundaries.\n */\n errors?: ValidationError[];\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n *\n * Runs after all intercept results are collected. Use it for local state\n * updates such as setting an error flag. By the time it runs, the navigation\n * decision is final, so blocking logic belongs in the intercept handler\n * itself, not here.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" }, "ValidationError": { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -99688,17 +99688,17 @@ "syntaxKind": "PropertySignature", "name": "totalShippingAmount", "value": "SubscribableSignalLike", - "description": "The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step." + "description": "The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step.\n\n`undefined` until the buyer selects a shipping method (typically after the information step)." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "totalTaxAmount", "value": "SubscribableSignalLike", - "description": "The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet." + "description": "The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet.\n\n`undefined` when taxes haven't been calculated or aren't available for the buyer's region." } ], - "value": "export interface CartCost {\n /**\n * The sum of all line item prices at the current step of checkout, before shipping and taxes are applied. Use this value to display the base cost of the items the buyer purchased.\n */\n subtotalAmount: SubscribableSignalLike;\n\n /**\n * The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step.\n */\n totalShippingAmount: SubscribableSignalLike;\n\n /**\n * The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet.\n */\n totalTaxAmount: SubscribableSignalLike;\n\n /**\n * The minimum total at the current step of checkout. Costs not yet calculated, such as shipping on the information step, aren't included. Gift cards and store credits are excluded from this total.\n */\n totalAmount: SubscribableSignalLike;\n}" + "value": "export interface CartCost {\n /**\n * The sum of all line item prices at the current step of checkout, before shipping and taxes are applied. Use this value to display the base cost of the items the buyer purchased.\n */\n subtotalAmount: SubscribableSignalLike;\n\n /**\n * The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step.\n *\n * `undefined` until the buyer selects a shipping method (typically after the\n * information step).\n */\n totalShippingAmount: SubscribableSignalLike;\n\n /**\n * The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet.\n *\n * `undefined` when taxes haven't been calculated or aren't available for the\n * buyer's region.\n */\n totalTaxAmount: SubscribableSignalLike;\n\n /**\n * The minimum total at the current step of checkout. Costs not yet calculated, such as shipping on the information step, aren't included. Gift cards and store credits are excluded from this total.\n */\n totalAmount: SubscribableSignalLike;\n}" }, "CustomerPrivacy": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -99785,31 +99785,31 @@ "syntaxKind": "PropertySignature", "name": "analytics", "value": "boolean", - "description": "Whether analytics data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Analytics data includes how the shop was used and what interactions occurred." + "description": "Whether analytics data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Analytics data includes how the shop was used and what interactions occurred.\n\nWhether analytics data can be collected right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.analytics`, before calling `shopify.analytics.publish()`." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "marketing", "value": "boolean", - "description": "Whether marketing data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Marketing data includes attribution and targeted advertising preferences." + "description": "Whether marketing data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Marketing data includes attribution and targeted advertising preferences.\n\nWhether marketing data can be collected right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.marketing`, before performing marketing-related data collection." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "preferences", "value": "boolean", - "description": "Whether preference data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Preference data includes language, currency, and sizing choices." + "description": "Whether preference data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Preference data includes language, currency, and sizing choices.\n\nWhether preference data can be collected right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.preferences`, before storing or reading buyer preference data." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "saleOfData", "value": "boolean", - "description": "Whether data can be shared with third parties based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. This typically applies to behavioral advertising data." + "description": "Whether data can be shared with third parties based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. This typically applies to behavioral advertising data.\n\nWhether buyer data can be shared with or sold to third parties right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.saleOfData`, before sharing or selling buyer data with third parties." } ], - "value": "export interface AllowedProcessing {\n /**\n * Whether analytics data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Analytics\n * data includes how the shop was used and what interactions occurred.\n */\n analytics: boolean;\n /**\n * Whether marketing data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Marketing\n * data includes attribution and targeted advertising preferences.\n */\n marketing: boolean;\n /**\n * Whether preference data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Preference\n * data includes language, currency, and sizing choices.\n */\n preferences: boolean;\n /**\n * Whether data can be shared with third parties based on the visitor's\n * consent, the merchant's privacy configuration, and the visitor's region.\n * This typically applies to behavioral advertising data.\n */\n saleOfData: boolean;\n}" + "value": "export interface AllowedProcessing {\n /**\n * Whether analytics data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Analytics\n * data includes how the shop was used and what interactions occurred.\n *\n * Whether analytics data can be collected right now. Combines the buyer's\n * consent, the merchant's privacy configuration, and the buyer's region into\n * a single boolean. Check this flag, not `visitorConsent.analytics`, before\n * calling `shopify.analytics.publish()`.\n */\n analytics: boolean;\n /**\n * Whether marketing data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Marketing\n * data includes attribution and targeted advertising preferences.\n *\n * Whether marketing data can be collected right now. Combines the buyer's\n * consent, the merchant's privacy configuration, and the buyer's region into\n * a single boolean. Check this flag, not `visitorConsent.marketing`, before\n * performing marketing-related data collection.\n */\n marketing: boolean;\n /**\n * Whether preference data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Preference\n * data includes language, currency, and sizing choices.\n *\n * Whether preference data can be collected right now. Combines the buyer's\n * consent, the merchant's privacy configuration, and the buyer's region into\n * a single boolean. Check this flag, not `visitorConsent.preferences`,\n * before storing or reading buyer preference data.\n */\n preferences: boolean;\n /**\n * Whether data can be shared with third parties based on the visitor's\n * consent, the merchant's privacy configuration, and the visitor's region.\n * This typically applies to behavioral advertising data.\n *\n * Whether buyer data can be shared with or sold to third parties right now.\n * Combines the buyer's consent, the merchant's privacy configuration, and\n * the buyer's region into a single boolean. Check this flag, not\n * `visitorConsent.saleOfData`, before sharing or selling buyer data with\n * third parties.\n */\n saleOfData: boolean;\n}" }, "TrackingConsentMetafield": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -100501,7 +100501,7 @@ "Extension": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Extension", - "description": "The meta information about an extension target.", + "description": "Metadata about the running extension, including its API version, target, capabilities, and editor context. Use this to read configuration details or conditionally render content based on where the extension is running.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -100527,7 +100527,7 @@ "syntaxKind": "PropertySignature", "name": "capabilities", "value": "SubscribableSignalLike", - "description": "The allowed capabilities of the extension, defined in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n\n* [`api_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#api-access): the extension can access the Storefront API.\n\n* [`network_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access): the extension can make external network calls.\n\n* [`block_progress`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n\n* [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n\n* [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can register customer consent decisions that are honored on Shopify-managed services.\n\n* [`iframe.sources`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#iframe): the extension can embed an external URL in an iframe." + "description": "The allowed capabilities of the extension, defined in your [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -100575,7 +100575,7 @@ "syntaxKind": "PropertySignature", "name": "version", "value": "string", - "description": "The published version of the running extension target.\n\nFor unpublished extensions, the value is `undefined`.", + "description": "The published version of the running extension target.\n\nFor unpublished extensions, the value is `undefined`.\n\nDon't use this property as a stable identifier in development environments. It becomes available only after the extension is published.", "isOptional": true, "examples": [ { @@ -100591,7 +100591,7 @@ ] } ], - "value": "export interface Extension {\n /**\n * The API version that was set in the extension config file.\n *\n * @example '2024-10', '2025-01', '2025-04', '2025-07', '2025-10'\n */\n apiVersion: ApiVersion;\n\n /**\n * The allowed capabilities of the extension, defined\n * in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n *\n * * [`api_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#api-access): the extension can access the Storefront API.\n *\n * * [`network_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access): the extension can make external network calls.\n *\n * * [`block_progress`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n *\n * * [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n *\n * * [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can register customer consent decisions that are honored on Shopify-managed services.\n *\n * * [`iframe.sources`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#iframe): the extension can embed an external URL in an iframe.\n */\n capabilities: SubscribableSignalLike;\n\n /**\n * Information about the editor where the extension is being rendered.\n *\n * If the value is undefined, then the extension isn't running in an editor.\n */\n editor?: Editor;\n\n /**\n * A Boolean to show whether your extension is currently rendered to the screen.\n *\n * Shopify might render your extension before it's visible in the UI,\n * typically to pre-render extensions that appear on a later step of the\n * checkout.\n *\n * Your extension might also continue to run after the customer has navigated away\n * from where it was rendered. The extension continues running so that\n * your extension is immediately available to render if the customer navigates back.\n */\n rendered: SubscribableSignalLike;\n\n /**\n * The URL to the script that started the extension target.\n */\n scriptUrl: string;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n */\n target: Target;\n\n /**\n * The published version of the running extension target.\n *\n * For unpublished extensions, the value is `undefined`.\n *\n * @example 3.0.10\n */\n version?: string;\n}" + "value": "export interface Extension {\n /**\n * The API version that was set in the extension config file.\n *\n * @example '2024-10', '2025-01', '2025-04', '2025-07', '2025-10'\n */\n apiVersion: ApiVersion;\n\n /**\n * The allowed capabilities of the extension, defined in your\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n */\n capabilities: SubscribableSignalLike;\n\n /**\n * Information about the editor where the extension is being rendered.\n *\n * If the value is undefined, then the extension isn't running in an editor.\n */\n editor?: Editor;\n\n /**\n * A Boolean to show whether your extension is currently rendered to the screen.\n *\n * Shopify might render your extension before it's visible in the UI,\n * typically to pre-render extensions that appear on a later step of the\n * checkout.\n *\n * Your extension might also continue to run after the customer has navigated away\n * from where it was rendered. The extension continues running so that\n * your extension is immediately available to render if the customer navigates back.\n */\n rendered: SubscribableSignalLike;\n\n /**\n * The URL to the script that started the extension target.\n */\n scriptUrl: string;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n */\n target: Target;\n\n /**\n * The published version of the running extension target.\n *\n * For unpublished extensions, the value is `undefined`.\n *\n * Don't use this property as a stable identifier in development environments.\n * It becomes available only after the extension is published.\n *\n * @example 3.0.10\n */\n version?: string;\n}" }, "ApiVersion": { "filePath": "src/shared.ts", @@ -100610,7 +100610,7 @@ "Editor": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Editor", - "description": "", + "description": "Information about the editor environment when an extension is rendered inside the checkout editor. The value is `undefined` when the extension is not rendering in an editor.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -100625,7 +100625,7 @@ "I18n": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18n", - "description": "", + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use the I18n API alongside the Localization API to build fully localized extensions.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -100661,7 +100661,7 @@ "I18nTranslate": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18nTranslate", - "description": "This returns a translated string matching a key in a locale file.", + "description": "Translates a key from your extension's locale files into a localized string. Supports interpolation with placeholder replacements and pluralization via the special `count` option.", "members": [], "value": "export interface I18nTranslate {\n (\n key: string,\n options?: Record,\n ): ReplacementType extends string | number\n ? string\n : (string | ReplacementType)[];\n}" }, @@ -101225,14 +101225,14 @@ "Localization": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Localization", - "description": "", + "description": "The buyer's language, country, currency, and timezone context. Use this to adapt your extension to the buyer's region and display localized content.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "country", "value": "SubscribableSignalLike", - "description": "The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown." + "description": "The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n\nDerived from the buyer's shipping address. Returns `undefined` until the buyer enters a shipping address." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -101260,18 +101260,18 @@ "syntaxKind": "PropertySignature", "name": "market", "value": "SubscribableSignalLike", - "description": "The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n\n> Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.", - "deprecationMessage": "Deprecated as of version `2025-04`" + "description": "The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. The market context updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.", + "deprecationMessage": "Merchants now manage which extensions load for each\nmarket, so extensions no longer need to check this value." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "timezone", "value": "SubscribableSignalLike", - "description": "The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time." + "description": "The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time." } ], - "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n *\n * > Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" + "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n *\n * Derived from the buyer's shipping address. Returns `undefined` until the\n * buyer enters a shipping address.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout,\n * carried over from the cart context. Markets group countries and\n * regions with shared pricing, languages, and domains. The market\n * context updates when the buyer changes the country of their\n * shipping address. The value is `undefined` if the market is unknown.\n *\n * @deprecated Merchants now manage which extensions load for each\n * market, so extensions no longer need to check this value.\n */\n market: SubscribableSignalLike;\n}" }, "Country": { "filePath": "src/shared.ts", @@ -101472,7 +101472,7 @@ "SessionToken": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SessionToken", - "description": "", + "description": "Authenticates requests between your extension and your app backend. Use session tokens to verify the identity of the buyer and the shop context when making server-side API calls. The token is a signed JWT that contains claims such as the customer ID, shop domain, and expiration.\n\nThe `sub` claim in the decoded token is present only when the buyer is logged in and the app has permission to read customer accounts. Absent for anonymous buyers.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -101731,7 +101731,7 @@ "Shop": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Shop", - "description": "", + "description": "Metadata about the merchant's store, including its name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -101771,30 +101771,30 @@ "syntaxKind": "PropertySignature", "name": "storefrontUrl", "value": "string", - "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n\n> Caution: > As of version `2024-04` this value no longer has a trailing slash.", + "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.", "isOptional": true } ], - "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n *\n * > Caution:\n * > As of version `2024-04` this value no longer has a trailing slash.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom domain.\n */\n myshopifyDomain: string;\n}" + "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom domain.\n */\n myshopifyDomain: string;\n}" }, "Storage": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Storage", - "description": "A key-value storage object for the extension.\n\nStored data is available only to this specific extension and any of its instances.\n\nThe storage backend is implemented with `localStorage` and should persist across the buyer's checkout session. However, data persistence isn't guaranteed.", + "description": "Key-value storage for a specific extension. Use storage to save preferences or cached data that should survive page reloads without requiring a backend call. Stored data is only available to this specific extension. The storage backend is implemented with `localStorage` and data persistence isn't guaranteed.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "delete", "value": "(key: string) => Promise", - "description": "Delete stored data by key." + "description": "Deletes a previously stored value by key." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "read", "value": "(key: string) => Promise", - "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original primitive.\n\nReturns `null` if no stored data exists." + "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original type.\n\nReturns the stored value for the given key, or `null` when no value exists. Doesn't throw on a missing key." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -101804,7 +101804,7 @@ "description": "Write stored data for this key.\n\nThe data must be serializable to JSON." } ], - "value": "export interface Storage {\n /**\n * Read and return a stored value by key.\n *\n * The stored data is deserialized from JSON and returned as\n * its original primitive.\n *\n * Returns `null` if no stored data exists.\n */\n read(key: string): Promise;\n\n /**\n * Write stored data for this key.\n *\n * The data must be serializable to JSON.\n */\n write(key: string, data: any): Promise;\n\n /**\n * Delete stored data by key.\n */\n delete(key: string): Promise;\n}" + "value": "export interface Storage {\n /**\n * Read and return a stored value by key.\n *\n * The stored data is deserialized from JSON and returned as\n * its original type.\n *\n * Returns the stored value for the given key, or `null` when no value\n * exists. Doesn't throw on a missing key.\n */\n read(key: string): Promise;\n\n /**\n * Write stored data for this key.\n *\n * The data must be serializable to JSON.\n */\n write(key: string, data: any): Promise;\n\n /**\n * Deletes a previously stored value by key.\n */\n delete(key: string): Promise;\n}" }, "Version": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -101880,7 +101880,7 @@ "syntaxKind": "MethodSignature", "name": "applyAttributeChange", "value": "(change: AttributeChange) => Promise", - "description": "Updates or removes an attribute on the cart and checkout. On success, the [`attributes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/attributes#standardapi-propertydetail-attributes) property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.", + "description": "Updates or removes an attribute on the cart and checkout. On success, the [`attributes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/attributes#properties-propertydetail-attributes) property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.", "deprecationMessage": "Use cart metafields instead." }, { @@ -101888,42 +101888,42 @@ "syntaxKind": "MethodSignature", "name": "applyCartLinesChange", "value": "(change: CartLineChange) => Promise", - "description": "Adds, removes, or updates line items in the cart. The returned promise resolves when the change has been applied by the server, and the [`lines`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-lines#standardapi-propertydetail-lines) property updates with the new state.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Adds, removes, or updates line items in the cart. The returned promise resolves when the change has been applied by the server, and the [`lines`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-lines#properties-propertydetail-lines) property updates with the new state.\n\nAccepts a single change per call. To make multiple changes, call this method separately for each one.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyDiscountCodeChange", "value": "(change: DiscountCodeChange) => Promise", - "description": "Adds or removes a discount code on the checkout. The returned promise resolves when the change has been applied by the server, and the [`discountCodes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/discounts#standardapi-propertydetail-discountcodes) property updates with the new state.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves discount codes through a network call.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Adds or removes a discount code on the checkout. The returned promise resolves when the change has been applied by the server, and the [`discountCodes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/discounts#properties-propertydetail-discountcodes) property updates with the new state.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves discount codes through a network call.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyGiftCardChange", "value": "(change: GiftCardChange) => Promise", - "description": "Adds or removes a gift card from the checkout. The returned promise resolves when the change has been applied by the server, and the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/gift-cards#standardapi-propertydetail-appliedgiftcards) property updates with the new state.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves gift card codes through a network call.\n\n> Note: This method returns an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Adds or removes a gift card from the checkout. The returned promise resolves when the change has been applied by the server, and the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/gift-cards#properties-propertydetail-appliedgiftcards) property updates with the new state.\n\nUnlike other write operations, gift card changes aren't gated by a cart instruction flag.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves gift card codes through a network call.\n\n> Note: This method returns an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyMetafieldChange", "value": "(change: MetafieldChange) => Promise", - "description": "Creates, updates, or removes a cart metafield on the checkout. On success, the [`metafields`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/metafields#standardapi-propertydetail-metafields) property updates to reflect the change.\n\nCart metafields are copied to order metafields at order creation time if there's a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n\n> Caution: `MetafieldRemoveChange` and `MetafieldUpdateChange` are deprecated. Use cart metafields with `MetafieldRemoveCartChange` and `MetafieldUpdateCartChange` instead. If `MetafieldUpdateChange` writes a metafield with the same namespace and key as a cart metafield that's configured to copy, the cart metafield won't be copied.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Creates, updates, or removes a cart metafield on the checkout. On success, the [`metafields`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/metafields#properties-propertydetail-metafields) property updates to reflect the change.\n\nCart metafields are copied to order metafields at order creation time if there's a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n\n> Caution: `MetafieldRemoveChange` and `MetafieldUpdateChange` are deprecated. Use cart metafields with `MetafieldRemoveCartChange` and `MetafieldUpdateCartChange` instead. If `MetafieldUpdateChange` writes a metafield with the same namespace and key as a cart metafield that's configured to copy, the cart metafield won't be copied.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyNoteChange", "value": "(change: NoteChange) => Promise", - "description": "Sets or removes the buyer's note on the checkout. On success, the [`note`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/note#standardapi-propertydetail-note) property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Sets or removes the buyer's note on the checkout. On success, the [`note`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/note#properties-propertydetail-note) property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyShippingAddressChange", "value": "(change: ShippingAddressUpdateChange) => Promise", - "description": "Updates the buyer's shipping address on the checkout. The provided fields are merged into the existing address without prompting the buyer. On success, the `shippingAddress` property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", + "description": "Updates the buyer's shipping address on the checkout. The provided fields are merged into the existing address without prompting the buyer. On success, the `shippingAddress` property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", "isOptional": true }, { @@ -101936,7 +101936,7 @@ "isPrivate": true } ], - "value": "export interface CheckoutApi {\n /**\n * Updates or removes an attribute on the cart and checkout. On success, the\n * [`attributes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/attributes#standardapi-propertydetail-attributes) property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * @deprecated Use cart metafields instead.\n */\n applyAttributeChange(change: AttributeChange): Promise;\n\n /**\n * Adds, removes, or updates line items in the cart. The returned promise resolves when the change has been applied by the server, and the [`lines`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-lines#standardapi-propertydetail-lines) property updates with the new state.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyCartLinesChange(change: CartLineChange): Promise;\n\n /**\n * Adds or removes a discount code on the checkout. The returned promise resolves when the change has been applied by the server, and the [`discountCodes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/discounts#standardapi-propertydetail-discountcodes) property updates with the new state.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves discount codes through a network call.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyDiscountCodeChange(\n change: DiscountCodeChange,\n ): Promise;\n\n /**\n * Adds or removes a gift card from the checkout. The returned promise resolves when the change has been applied by the server, and the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/gift-cards#standardapi-propertydetail-appliedgiftcards) property updates with the new state.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves gift card codes through a network call.\n *\n * > Note: This method returns an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyGiftCardChange(change: GiftCardChange): Promise;\n\n /**\n * Creates, updates, or removes a cart metafield on the checkout. On success, the\n * [`metafields`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/metafields#standardapi-propertydetail-metafields) property updates to reflect the change.\n *\n * Cart metafields are copied to order metafields at order creation time if there's a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n *\n * > Caution: `MetafieldRemoveChange` and `MetafieldUpdateChange` are deprecated. Use cart metafields with `MetafieldRemoveCartChange` and `MetafieldUpdateCartChange` instead. If `MetafieldUpdateChange` writes a metafield with the same namespace and key as a cart metafield that's configured to copy, the cart metafield won't be copied.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyMetafieldChange(change: MetafieldChange): Promise;\n\n /**\n * Sets or removes the buyer's note on the checkout. On success, the\n * [`note`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/note#standardapi-propertydetail-note)\n * property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyNoteChange(change: NoteChange): Promise;\n\n /**\n * @private\n */\n experimentalIsShopAppStyle?: boolean;\n\n /**\n * Updates the buyer's shipping address on the checkout. The provided fields\n * are merged into the existing address without prompting the buyer. On success,\n * the `shippingAddress` property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyShippingAddressChange?(\n change: ShippingAddressChange,\n ): Promise;\n}" + "value": "export interface CheckoutApi {\n /**\n * Updates or removes an attribute on the cart and checkout. On success, the\n * [`attributes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/attributes#properties-propertydetail-attributes) property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * @deprecated Use cart metafields instead.\n */\n applyAttributeChange(change: AttributeChange): Promise;\n\n /**\n * Adds, removes, or updates line items in the cart. The returned promise resolves when the change has been applied by the server, and the [`lines`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-lines#properties-propertydetail-lines) property updates with the new state.\n *\n * Accepts a single change per call. To make multiple changes, call this\n * method separately for each one.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyCartLinesChange(change: CartLineChange): Promise;\n\n /**\n * Adds or removes a discount code on the checkout. The returned promise resolves when the change has been applied by the server, and the [`discountCodes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/discounts#properties-propertydetail-discountcodes) property updates with the new state.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves discount codes through a network call.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyDiscountCodeChange(\n change: DiscountCodeChange,\n ): Promise;\n\n /**\n * Adds or removes a gift card from the checkout. The returned promise resolves when the change has been applied by the server, and the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/gift-cards#properties-propertydetail-appliedgiftcards) property updates with the new state.\n *\n * Unlike other write operations, gift card changes aren't gated by a cart\n * instruction flag.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves gift card codes through a network call.\n *\n * > Note: This method returns an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyGiftCardChange(change: GiftCardChange): Promise;\n\n /**\n * Creates, updates, or removes a cart metafield on the checkout. On success, the\n * [`metafields`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/metafields#properties-propertydetail-metafields) property updates to reflect the change.\n *\n * Cart metafields are copied to order metafields at order creation time if there's a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n *\n * > Caution: `MetafieldRemoveChange` and `MetafieldUpdateChange` are deprecated. Use cart metafields with `MetafieldRemoveCartChange` and `MetafieldUpdateCartChange` instead. If `MetafieldUpdateChange` writes a metafield with the same namespace and key as a cart metafield that's configured to copy, the cart metafield won't be copied.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyMetafieldChange(change: MetafieldChange): Promise;\n\n /**\n * Sets or removes the buyer's note on the checkout. On success, the\n * [`note`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/note#properties-propertydetail-note)\n * property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyNoteChange(change: NoteChange): Promise;\n\n /**\n * @private\n */\n experimentalIsShopAppStyle?: boolean;\n\n /**\n * Updates the buyer's shipping address on the checkout. The provided fields\n * are merged into the existing address without prompting the buyer. On success,\n * the `shippingAddress` property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyShippingAddressChange?(\n change: ShippingAddressChange,\n ): Promise;\n}" }, "AttributeChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -102003,7 +102003,7 @@ "syntaxKind": "PropertySignature", "name": "value", "value": "string", - "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.", + "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.\n\nAttribute values are always strings. To store structured data, serialize it to JSON and parse it when reading.", "examples": [ { "title": "Example", @@ -102018,7 +102018,7 @@ ] } ], - "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" + "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * Attribute values are always strings. To store structured data, serialize\n * it to JSON and parse it when reading.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" }, "AttributeRemoveChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -102871,7 +102871,7 @@ "syntaxKind": "PropertySignature", "name": "message", "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer." + "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer.\n\nRender your own localized error text rather than displaying this message to the buyer." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -102881,7 +102881,7 @@ "description": "Indicates that the line item wasn't changed successfully. Refer to the `message` property for details about the error." } ], - "value": "export interface CartLineChangeResultError {\n /**\n * Indicates that the line item wasn't changed successfully. Refer to the `message` property for details about the error.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface CartLineChangeResultError {\n /**\n * Indicates that the line item wasn't changed successfully. Refer to the `message` property for details about the error.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n *\n * Render your own localized error text rather than displaying this message\n * to the buyer.\n */\n message: string;\n}" }, "DiscountCodeChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -103061,7 +103061,7 @@ "syntaxKind": "PropertySignature", "name": "message", "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer." + "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer.\n\nRender your own localized error text rather than displaying this message to the buyer." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -103071,7 +103071,7 @@ "description": "Indicates that the gift card change couldn't be applied. Check the `message` property for details." } ], - "value": "export interface GiftCardChangeResultError {\n /**\n * Indicates that the gift card change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface GiftCardChangeResultError {\n /**\n * Indicates that the gift card change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n *\n * Render your own localized error text rather than displaying this message\n * to the buyer.\n */\n message: string;\n}" }, "MetafieldChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -103332,7 +103332,7 @@ "syntaxKind": "PropertySignature", "name": "message", "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer." + "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer.\n\nRender your own localized error text rather than displaying this message to the buyer." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -103342,7 +103342,7 @@ "description": "Indicates that the metafield change couldn't be applied. Check the `message` property for details." } ], - "value": "export interface MetafieldChangeResultError {\n /**\n * Indicates that the metafield change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface MetafieldChangeResultError {\n /**\n * Indicates that the metafield change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n *\n * Render your own localized error text rather than displaying this message\n * to the buyer.\n */\n message: string;\n}" }, "NoteChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -103420,7 +103420,7 @@ "syntaxKind": "PropertySignature", "name": "message", "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer." + "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer.\n\nRender your own localized error text rather than displaying this message to the buyer." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -103430,7 +103430,7 @@ "description": "Indicates that the note change couldn't be applied. Check the `message` property for details." } ], - "value": "export interface NoteChangeResultError {\n /**\n * Indicates that the note change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface NoteChangeResultError {\n /**\n * Indicates that the note change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n *\n * Render your own localized error text rather than displaying this message\n * to the buyer.\n */\n message: string;\n}" }, "ShippingAddressUpdateChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -104016,7 +104016,7 @@ "syntaxKind": "PropertySignature", "name": "analytics", "value": "Analytics", - "description": "The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event." + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -104030,7 +104030,7 @@ "syntaxKind": "PropertySignature", "name": "applyTrackingConsentChange", "value": "ApplyTrackingConsentChangeType", - "description": "Enables setting and updating customer privacy consent settings and tracking consent metafields.\n\n> Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent) to be set to `true`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." + "description": "Enables setting and updating customer privacy consent settings and tracking consent metafields.\n\n> Note: Requires the [`collect_buyer_consent` capability](/docs/apps/build/customer-accounts/capabilities#collect-buyer-consent) to be set to `true`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -104051,7 +104051,7 @@ "syntaxKind": "PropertySignature", "name": "availablePaymentOptions", "value": "SubscribableSignalLike", - "description": "All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region." + "description": "All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n\nThe set of payment options can change when the buyer updates their address or cart, so subscribe to changes rather than reading once during initialization. Each option exposes `handle` and `type` only. Provider names, logos, fees, and installment terms aren't available." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -104088,7 +104088,7 @@ "syntaxKind": "PropertySignature", "name": "checkoutToken", "value": "SubscribableSignalLike", - "description": "A stable ID that represents the current checkout.\n\nThe value is `undefined` when the checkout hasn't been created on the server yet.\n\nUse this to correlate checkout sessions across your extension, web pixels, and backend systems.\n\nThis matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data) and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object)." + "description": "A stable ID that represents the current checkout.\n\nThe value is `undefined` when the checkout hasn't been created on the server yet.\n\nUse this to correlate checkout sessions across your extension, web pixels, and backend systems.\n\nThis matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data) and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n\nCan be `undefined`. Handle the `undefined` state before using the value." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -104109,7 +104109,7 @@ "syntaxKind": "PropertySignature", "name": "deliveryGroups", "value": "SubscribableSignalLike", - "description": "The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items." + "description": "The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n\nEmpty until the buyer enters enough address information for Shopify to calculate shipping rates." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -104130,7 +104130,7 @@ "syntaxKind": "PropertySignature", "name": "extension", "value": "Extension", - "description": "The meta information about the extension." + "description": "Metadata about the running extension, including the current target, API version, capabilities, and editor context. Use this to conditionally render content based on where the extension is running." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -104138,7 +104138,7 @@ "name": "extensionPoint", "value": "Target", "description": "The identifier that specifies where in Shopify's UI your code is being injected. This is one of the targets you've included in your extension's configuration file.", - "deprecationMessage": "Deprecated as of version `2023-07`, use `extension.target` instead.", + "deprecationMessage": "Use `extension.target` instead.", "examples": [ { "title": "Example", @@ -104157,14 +104157,14 @@ "syntaxKind": "PropertySignature", "name": "i18n", "value": "I18n", - "description": "Utilities for translating content and formatting values according to the current [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) of the checkout.\n\nRefer to [`localization` examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples) for more information." + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use alongside [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) to build fully localized extensions." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "instructions", "value": "SubscribableSignalLike", - "description": "The cart instructions used to create the checkout and possibly limit extension capabilities.\n\nThese instructions should be checked before performing any actions that might be affected by them.\n\nFor example, if you intend to add a discount code via the `applyDiscountCodeChange` method, check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n\n> Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs aren't available. See the [update guide](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples) for more information." + "description": "The cart instructions used to create the checkout and possibly limit extension capabilities.\n\nThese instructions should be checked before performing any actions that might be affected by them.\n\nFor example, if you intend to add a discount code via the `applyDiscountCodeChange` method, check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n\n> Caution: Check cart instructions before calling select APIs, as > some may not be available. See the > [Cart Instructions API](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples) > for more information." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -104178,7 +104178,7 @@ "syntaxKind": "PropertySignature", "name": "localization", "value": "Localization", - "description": "The details about the location, language, and currency of the customer. For utilities to easily format and translate content based on these details, you can use the [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n) object instead." + "description": "The buyer's language, country, currency, and timezone context. For formatting and translation helpers, use the [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#properties-propertydetail-i18n) object instead." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -104208,21 +104208,21 @@ "syntaxKind": "PropertySignature", "name": "query", "value": ">(query: string, options?: { variables?: Variables; version?: StorefrontApiVersion; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>", - "description": "The method used to query the Storefront GraphQL API with a prefetched token.\n\nRefer to [Storefront API access examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/storefront-api) for more information." + "description": "The method used to query the Storefront GraphQL API with a prefetched token." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "selectedPaymentOptions", "value": "SubscribableSignalLike", - "description": "The payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card)." + "description": "The payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\n\nEach option exposes `handle` and `type` only. Provider names, logos, fees, and installment terms aren't available." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "sessionToken", "value": "SessionToken", - "description": "The session token providing a set of claims as a signed JSON Web Token (JWT).\n\nThe token has a TTL of five minutes.\n\nIf the previous token expires, this value reflects a new session token with a new signature and expiry.\n\nRefer to [session token examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/session-token) for more information." + "description": "The session token providing a set of claims as a signed JSON Web Token (JWT).\n\nThe token has a TTL of five minutes.\n\nIf the previous token expires, this value reflects a new session token with a new signature and expiry.\n\nLearn more about [session tokens](/docs/apps/build/authentication-authorization/session-tokens)." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -104244,14 +104244,14 @@ "syntaxKind": "PropertySignature", "name": "shop", "value": "Shop", - "description": "The shop where the checkout is taking place." + "description": "The store where the checkout is taking place, including the shop name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "storage", "value": "Storage", - "description": "The key-value storage for the extension.\n\nIt uses `localStorage` and should persist across the customer's current checkout session.\n\n> Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n\nData is shared across all activated extension targets of this extension. In versions 2023-07 and earlier, each activated extension target had its own storage." + "description": "Key-value storage that persists across page loads within the current checkout session. Data is shared across all activated targets associated with this extension.\n\n> Caution: Data persistence isn't guaranteed and storage is cleared when the buyer starts a new checkout." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -104273,29 +104273,29 @@ ] } ], - "value": "export interface StandardApi {\n /**\n * The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event.\n */\n analytics: Analytics;\n\n /**\n * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\n */\n appliedGiftCards: SubscribableSignalLike;\n\n /**\n * The cart instructions used to create the checkout and possibly limit extension capabilities.\n *\n * These instructions should be checked before performing any actions that might be affected by them.\n *\n * For example, if you intend to add a discount code via the `applyDiscountCodeChange` method,\n * check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n *\n * > Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs aren't available.\n * See the [update guide](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples) for more information.\n *\n */\n instructions: SubscribableSignalLike;\n\n /**\n * The metafields requested in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration)\n * file. These metafields are updated when there's a change in the merchandise items\n * being purchased by the customer.\n *\n * App owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` isn't supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n appMetafields: SubscribableSignalLike;\n\n /**\n * The custom key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n buyerIdentity?: BuyerIdentity;\n\n /**\n * Provides details on the buyer's progression through the checkout and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/buyer-journey#examples)\n * examples for more information.\n */\n buyerJourney: BuyerJourney;\n\n /**\n * Settings applied to the buyer's checkout.\n */\n checkoutSettings: SubscribableSignalLike;\n\n /**\n * A stable ID that represents the current checkout.\n *\n * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\n *\n * This matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data)\n * and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n */\n checkoutToken: SubscribableSignalLike;\n\n /**\n * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * The meta information about the extension.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n *\n * @deprecated Deprecated as of version `2023-07`, use `extension.target` instead.\n */\n extensionPoint: Target;\n\n /**\n * Utilities for translating content and formatting values according to the current\n * [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization)\n * of the checkout.\n *\n * Refer to [`localization` examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples)\n * for more information.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The details about the location, language, and currency of the customer. For utilities to easily\n * format and translate content based on these details, you can use the\n * [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n)\n * object instead.\n */\n localization: Localization;\n\n /**\n * The metafields that apply to the current checkout.\n *\n * Metafields are stored locally on the client and are applied to the order object after the checkout completes.\n *\n * These metafields are shared by all extensions running on checkout, and\n * persist for as long as the customer is working on this checkout.\n *\n * Once the order is created, you can query these metafields using the\n * [GraphQL Admin API](/docs/admin-api/graphql/reference/orders/order#metafield-2021-01)\n *\n * > Caution:\n * `metafields` is deprecated. Use `appMetafields` with cart metafields instead.\n *\n * @deprecated Use `appMetafields` with cart metafields instead.\n */\n metafields: SubscribableSignalLike;\n\n /**\n * A note left by the customer to the merchant, either in their cart or during checkout.\n *\n * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\n */\n note: SubscribableSignalLike;\n\n /**\n * The method used to query the Storefront GraphQL API with a prefetched token.\n *\n * Refer to [Storefront API access examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/storefront-api) for more information.\n */\n query: >(\n query: string,\n options?: {variables?: Variables; version?: StorefrontApiVersion},\n ) => Promise<{data?: Data; errors?: GraphQLError[]}>;\n\n /**\n * The payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\n */\n selectedPaymentOptions: SubscribableSignalLike;\n\n /**\n * The session token providing a set of claims as a signed JSON Web Token (JWT).\n *\n * The token has a TTL of five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/session-token) for more information.\n */\n sessionToken: SessionToken;\n\n /**\n * The settings matching the settings definition written in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates in real time as a merchant fills in the settings.\n */\n settings: SubscribableSignalLike;\n\n /**\n * The proposed customer shipping address. During the information step, the address\n * updates when the field is committed (on change) rather than every keystroke.\n * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n shippingAddress?: SubscribableSignalLike;\n\n /**\n * The proposed customer billing address. The address updates when the field is\n * committed (on change) rather than every keystroke. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided yet.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n billingAddress?: SubscribableSignalLike;\n\n /** The shop where the checkout is taking place. */\n shop: Shop;\n\n /**\n * The key-value storage for the extension.\n *\n * It uses `localStorage` and should persist across the customer's current checkout session.\n *\n * > Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n *\n * Data is shared across all activated extension targets of this extension. In versions 2023-07 and earlier,\n * each activated extension target had its own storage.\n */\n storage: Storage;\n\n /**\n * The renderer version being used for the extension.\n *\n * @example '2025-10'\n */\n version: Version;\n\n /**\n * Customer privacy consent settings and a flag denoting if consent has previously been collected.\n */\n customerPrivacy: SubscribableSignalLike;\n\n /**\n * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent) to be set to `true`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyTrackingConsentChange: ApplyTrackingConsentChangeType;\n\n /**\n * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" + "value": "export interface StandardApi {\n /**\n * Tracks custom events and sends visitor information to\n * [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events\n * and `visitor()` to submit buyer contact details.\n */\n analytics: Analytics;\n\n /**\n * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\n */\n appliedGiftCards: SubscribableSignalLike;\n\n /**\n * The cart instructions used to create the checkout and possibly limit extension capabilities.\n *\n * These instructions should be checked before performing any actions that might be affected by them.\n *\n * For example, if you intend to add a discount code via the `applyDiscountCodeChange` method,\n * check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n *\n * > Caution: Check cart instructions before calling select APIs, as\n * > some may not be available. See the\n * > [Cart Instructions API](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples)\n * > for more information.\n *\n */\n instructions: SubscribableSignalLike;\n\n /**\n * The metafields requested in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration)\n * file. These metafields are updated when there's a change in the merchandise items\n * being purchased by the customer.\n *\n * App owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` isn't supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n appMetafields: SubscribableSignalLike;\n\n /**\n * The custom key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as\n * credit cards, wallets, and local payment methods. The list depends on\n * the shop's payment configuration and the buyer's region.\n *\n * The set of payment options can change when the buyer updates their\n * address or cart, so subscribe to changes rather than reading once\n * during initialization. Each option exposes `handle` and `type` only.\n * Provider names, logos, fees, and installment terms aren't available.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n buyerIdentity?: BuyerIdentity;\n\n /**\n * Provides details on the buyer's progression through the checkout and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/buyer-journey#examples)\n * examples for more information.\n */\n buyerJourney: BuyerJourney;\n\n /**\n * Settings applied to the buyer's checkout.\n */\n checkoutSettings: SubscribableSignalLike;\n\n /**\n * A stable ID that represents the current checkout.\n *\n * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\n *\n * This matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data)\n * and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n *\n * Can be `undefined`. Handle the `undefined` state before using the value.\n */\n checkoutToken: SubscribableSignalLike;\n\n /**\n * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n *\n * Empty until the buyer enters enough address information for Shopify to\n * calculate shipping rates.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * Metadata about the running extension, including the current target, API version,\n * capabilities, and editor context. Use this to conditionally render content\n * based on where the extension is running.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n *\n * @deprecated Use `extension.target` instead.\n */\n extensionPoint: Target;\n\n /**\n * Utilities for translating strings, formatting currencies, numbers, and dates\n * according to the buyer's locale. Use alongside\n * [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization)\n * to build fully localized extensions.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The buyer's language, country, currency, and timezone context. For\n * formatting and translation helpers, use the\n * [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#properties-propertydetail-i18n)\n * object instead.\n */\n localization: Localization;\n\n /**\n * The metafields that apply to the current checkout.\n *\n * Metafields are stored locally on the client and are applied to the order object after the checkout completes.\n *\n * These metafields are shared by all extensions running on checkout, and\n * persist for as long as the customer is working on this checkout.\n *\n * Once the order is created, you can query these metafields using the\n * [GraphQL Admin API](/docs/admin-api/graphql/reference/orders/order#metafield-2021-01)\n *\n * > Caution:\n * `metafields` is deprecated. Use `appMetafields` with cart metafields instead.\n *\n * @deprecated Use `appMetafields` with cart metafields instead.\n */\n metafields: SubscribableSignalLike;\n\n /**\n * A note left by the customer to the merchant, either in their cart or during checkout.\n *\n * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\n */\n note: SubscribableSignalLike;\n\n /**\n * The method used to query the Storefront GraphQL API with a prefetched token.\n *\n */\n query: >(\n query: string,\n options?: {variables?: Variables; version?: StorefrontApiVersion},\n ) => Promise<{data?: Data; errors?: GraphQLError[]}>;\n\n /**\n * The payment options the buyer has currently selected. This updates as\n * the buyer changes their payment method. The array can contain multiple\n * entries when the buyer splits payment across methods (for example, a\n * gift card and a credit card).\n *\n * Each option exposes `handle` and `type` only. Provider names, logos,\n * fees, and installment terms aren't available.\n */\n selectedPaymentOptions: SubscribableSignalLike;\n\n /**\n * The session token providing a set of claims as a signed JSON Web Token (JWT).\n *\n * The token has a TTL of five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Learn more about [session tokens](/docs/apps/build/authentication-authorization/session-tokens).\n */\n sessionToken: SessionToken;\n\n /**\n * The settings matching the settings definition written in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates in real time as a merchant fills in the settings.\n */\n settings: SubscribableSignalLike;\n\n /**\n * The proposed customer shipping address. During the information step, the address\n * updates when the field is committed (on change) rather than every keystroke.\n * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n shippingAddress?: SubscribableSignalLike;\n\n /**\n * The proposed customer billing address. The address updates when the field is\n * committed (on change) rather than every keystroke. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided yet.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n billingAddress?: SubscribableSignalLike;\n\n /**\n * The store where the checkout is taking place, including the shop name,\n * storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.\n */\n shop: Shop;\n\n /**\n * Key-value storage that persists across page loads within the current checkout\n * session. Data is shared across all activated targets associated with\n * this extension.\n *\n * > Caution: Data persistence isn't guaranteed and storage is cleared when the\n * buyer starts a new checkout.\n */\n storage: Storage;\n\n /**\n * The renderer version being used for the extension.\n *\n * @example '2025-10'\n */\n version: Version;\n\n /**\n * Customer privacy consent settings and a flag denoting if consent has previously been collected.\n */\n customerPrivacy: SubscribableSignalLike;\n\n /**\n * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`collect_buyer_consent` capability](/docs/apps/build/customer-accounts/capabilities#collect-buyer-consent) to be set to `true`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyTrackingConsentChange: ApplyTrackingConsentChangeType;\n\n /**\n * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" }, "Analytics": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Analytics", - "description": "", + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "publish", "value": "(name: string, data: Record) => Promise", - "description": "Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing)." + "description": "Publishes a custom event to [Web Pixels](/docs/apps/marketing). Returns `true` when the event is successfully dispatched.\n\nThe Promise resolves to `true` when the event was dispatched. The boolean indicates dispatch confirmation only. It doesn't indicate whether any specific web pixel processed the event." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "visitor", "value": "(data: { email?: string; phone?: string; }) => Promise", - "description": "A method for capturing details about a visitor on the online store." + "description": "Submits buyer contact details for attribution and analytics purposes." } ], - "value": "export interface Analytics {\n /**\n * Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing).\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * A method for capturing details about a visitor on the online store.\n */\n visitor(data: {email?: string; phone?: string}): Promise;\n}" + "value": "export interface Analytics {\n /**\n * Publishes a custom event to [Web Pixels](/docs/apps/marketing).\n * Returns `true` when the event is successfully dispatched.\n *\n * The Promise resolves to `true` when the event was dispatched. The boolean\n * indicates dispatch confirmation only. It doesn't indicate whether any\n * specific web pixel processed the event.\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * Submits buyer contact details for attribution and analytics purposes.\n */\n visitor(data: {email?: string; phone?: string}): Promise;\n}" }, "VisitorResult": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -104336,10 +104336,10 @@ "syntaxKind": "PropertySignature", "name": "type", "value": "'error'", - "description": "Indicates that the visitor information is invalid and wasn't submitted. Examples are using the wrong data type or missing a required property." + "description": "Indicates that the visitor information is invalid and wasn't submitted. Common causes include using the wrong data type or omitting a required property." } ], - "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Examples are using the wrong data type or missing a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Common causes include using the wrong data type or omitting a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" }, "SubscribableSignalLike": { "filePath": "src/surfaces/checkout/shared.ts", @@ -104553,10 +104553,10 @@ "syntaxKind": "PropertySignature", "name": "value", "value": "string | null", - "description": "The new value to store in the metafield. Set to `null` to delete the metafield." + "description": "The new value to store in the metafield. Set to `null` to delete the metafield.\n\nConsent metafield values are strings, not booleans. Pass `null` to delete a tracking consent metafield." } ], - "value": "export interface TrackingConsentMetafieldChange {\n /**\n * The identifier for the tracking consent metafield to update.\n */\n key: string;\n /**\n * The new value to store in the metafield. Set to `null` to delete the metafield.\n */\n value: string | null;\n}" + "value": "export interface TrackingConsentMetafieldChange {\n /**\n * The identifier for the tracking consent metafield to update.\n */\n key: string;\n /**\n * The new value to store in the metafield. Set to `null` to delete the metafield.\n *\n * Consent metafield values are strings, not booleans. Pass `null` to delete\n * a tracking consent metafield.\n */\n value: string | null;\n}" }, "VisitorConsent": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -104770,7 +104770,7 @@ "syntaxKind": "PropertySignature", "name": "value", "value": "string", - "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.", + "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.\n\nAttribute values are always strings. To store structured data, serialize it to JSON and parse it when reading.", "examples": [ { "title": "Example", @@ -104785,7 +104785,7 @@ ] } ], - "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" + "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * Attribute values are always strings. To store structured data, serialize\n * it to JSON and parse it when reading.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" }, "PaymentOption": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -105136,7 +105136,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A globally-unique identifier for the customer in the format `gid://shopify/Customer/`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", + "description": "An identifier for the customer in the format `gid://shopify/Customer/`. This value is unique per shop.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", "examples": [ { "title": "Example", @@ -105189,7 +105189,7 @@ "isPrivate": true } ], - "value": "export interface Customer {\n /**\n * A globally-unique identifier for the customer in the format `gid://shopify/Customer/`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'gid://shopify/Customer/123'\n */\n id: string;\n /**\n * The email address associated with the customer's account. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email?: string;\n /**\n * The phone number associated with the customer's account. The value is `undefined` if no phone number is on file or the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone?: string;\n /**\n * The customer's full name, typically a combination of first and last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n fullName?: string;\n /**\n * The customer's first name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n firstName?: string;\n /**\n * The customer's last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n lastName?: string;\n /**\n * The customer's profile image, such as a Gravatar avatar. Use this to personalize the extension UI for the logged-in buyer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n image: ImageDetails;\n /**\n * Whether the customer has opted in to receiving marketing communications from the merchant, such as email campaigns and promotional offers.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * > Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n *\n * @deprecated Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n */\n acceptsMarketing: boolean;\n /**\n * Whether the customer has opted in to email marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsEmailMarketing: boolean;\n /**\n * Whether the customer has opted in to SMS marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsSmsMarketing: boolean;\n /**\n * The store credit accounts owned by this customer that can be used as payment during checkout. Each account has a balance representing available store credit.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @private\n */\n storeCreditAccounts: StoreCreditAccount[];\n /**\n * The number of orders the customer has previously placed with this shop.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n ordersCount: number;\n}" + "value": "export interface Customer {\n /**\n * An identifier for the customer in the format `gid://shopify/Customer/`. This value is unique per shop.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'gid://shopify/Customer/123'\n */\n id: string;\n /**\n * The email address associated with the customer's account. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email?: string;\n /**\n * The phone number associated with the customer's account. The value is `undefined` if no phone number is on file or the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone?: string;\n /**\n * The customer's full name, typically a combination of first and last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n fullName?: string;\n /**\n * The customer's first name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n firstName?: string;\n /**\n * The customer's last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n lastName?: string;\n /**\n * The customer's profile image, such as a Gravatar avatar. Use this to personalize the extension UI for the logged-in buyer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n image: ImageDetails;\n /**\n * Whether the customer has opted in to receiving marketing communications from the merchant, such as email campaigns and promotional offers.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * > Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n *\n * @deprecated Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n */\n acceptsMarketing: boolean;\n /**\n * Whether the customer has opted in to email marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsEmailMarketing: boolean;\n /**\n * Whether the customer has opted in to SMS marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsSmsMarketing: boolean;\n /**\n * The store credit accounts owned by this customer that can be used as payment during checkout. Each account has a balance representing available store credit.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @private\n */\n storeCreditAccounts: StoreCreditAccount[];\n /**\n * The number of orders the customer has previously placed with this shop.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n ordersCount: number;\n}" }, "ImageDetails": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -105471,11 +105471,11 @@ "syntaxKind": "MethodSignature", "name": "perform", "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", + "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.\n\nRuns after all intercept results are collected. Use it for local state updates such as setting an error flag. By the time it runs, the navigation decision is final, so blocking logic belongs in the intercept handler itself, not here.", "isOptional": true } ], - "value": "interface InterceptorRequestAllow {\n /**\n * Indicates that the interceptor allows the buyer's journey to continue.\n */\n behavior: 'allow';\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" + "value": "interface InterceptorRequestAllow {\n /**\n * Indicates that the interceptor allows the buyer's journey to continue.\n */\n behavior: 'allow';\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n *\n * Runs after all intercept results are collected. Use it for local state\n * updates such as setting an error flag. By the time it runs, the navigation\n * decision is final, so blocking logic belongs in the intercept handler\n * itself, not here.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" }, "InterceptorResult": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -105539,7 +105539,7 @@ "syntaxKind": "MethodSignature", "name": "perform", "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", + "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.\n\nRuns after all intercept results are collected. Use it for local state updates such as setting an error flag. By the time it runs, the navigation decision is final, so blocking logic belongs in the intercept handler itself, not here.", "isOptional": true }, { @@ -105550,7 +105550,7 @@ "description": "The reason for blocking the interceptor request. This value isn't presented to the buyer, so it doesn't need to be localized. The value is used only for Shopify's own internal debugging and metrics." } ], - "value": "interface InterceptorRequestBlock {\n /**\n * Indicates that the interceptor blocks the buyer's journey from continuing.\n */\n behavior: 'block';\n\n /**\n * The reason for blocking the interceptor request. This value isn't presented to\n * the buyer, so it doesn't need to be localized. The value is used only for Shopify's\n * own internal debugging and metrics.\n */\n reason: string;\n\n /**\n * Used to pass errors to the checkout UI, outside your extension's UI boundaries.\n */\n errors?: ValidationError[];\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" + "value": "interface InterceptorRequestBlock {\n /**\n * Indicates that the interceptor blocks the buyer's journey from continuing.\n */\n behavior: 'block';\n\n /**\n * The reason for blocking the interceptor request. This value isn't presented to\n * the buyer, so it doesn't need to be localized. The value is used only for Shopify's\n * own internal debugging and metrics.\n */\n reason: string;\n\n /**\n * Used to pass errors to the checkout UI, outside your extension's UI boundaries.\n */\n errors?: ValidationError[];\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n *\n * Runs after all intercept results are collected. Use it for local state\n * updates such as setting an error flag. By the time it runs, the navigation\n * decision is final, so blocking logic belongs in the intercept handler\n * itself, not here.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" }, "ValidationError": { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -105771,17 +105771,17 @@ "syntaxKind": "PropertySignature", "name": "totalShippingAmount", "value": "SubscribableSignalLike", - "description": "The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step." + "description": "The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step.\n\n`undefined` until the buyer selects a shipping method (typically after the information step)." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "totalTaxAmount", "value": "SubscribableSignalLike", - "description": "The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet." + "description": "The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet.\n\n`undefined` when taxes haven't been calculated or aren't available for the buyer's region." } ], - "value": "export interface CartCost {\n /**\n * The sum of all line item prices at the current step of checkout, before shipping and taxes are applied. Use this value to display the base cost of the items the buyer purchased.\n */\n subtotalAmount: SubscribableSignalLike;\n\n /**\n * The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step.\n */\n totalShippingAmount: SubscribableSignalLike;\n\n /**\n * The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet.\n */\n totalTaxAmount: SubscribableSignalLike;\n\n /**\n * The minimum total at the current step of checkout. Costs not yet calculated, such as shipping on the information step, aren't included. Gift cards and store credits are excluded from this total.\n */\n totalAmount: SubscribableSignalLike;\n}" + "value": "export interface CartCost {\n /**\n * The sum of all line item prices at the current step of checkout, before shipping and taxes are applied. Use this value to display the base cost of the items the buyer purchased.\n */\n subtotalAmount: SubscribableSignalLike;\n\n /**\n * The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step.\n *\n * `undefined` until the buyer selects a shipping method (typically after the\n * information step).\n */\n totalShippingAmount: SubscribableSignalLike;\n\n /**\n * The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet.\n *\n * `undefined` when taxes haven't been calculated or aren't available for the\n * buyer's region.\n */\n totalTaxAmount: SubscribableSignalLike;\n\n /**\n * The minimum total at the current step of checkout. Costs not yet calculated, such as shipping on the information step, aren't included. Gift cards and store credits are excluded from this total.\n */\n totalAmount: SubscribableSignalLike;\n}" }, "CustomerPrivacy": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -105868,31 +105868,31 @@ "syntaxKind": "PropertySignature", "name": "analytics", "value": "boolean", - "description": "Whether analytics data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Analytics data includes how the shop was used and what interactions occurred." + "description": "Whether analytics data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Analytics data includes how the shop was used and what interactions occurred.\n\nWhether analytics data can be collected right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.analytics`, before calling `shopify.analytics.publish()`." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "marketing", "value": "boolean", - "description": "Whether marketing data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Marketing data includes attribution and targeted advertising preferences." + "description": "Whether marketing data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Marketing data includes attribution and targeted advertising preferences.\n\nWhether marketing data can be collected right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.marketing`, before performing marketing-related data collection." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "preferences", "value": "boolean", - "description": "Whether preference data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Preference data includes language, currency, and sizing choices." + "description": "Whether preference data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Preference data includes language, currency, and sizing choices.\n\nWhether preference data can be collected right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.preferences`, before storing or reading buyer preference data." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "saleOfData", "value": "boolean", - "description": "Whether data can be shared with third parties based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. This typically applies to behavioral advertising data." + "description": "Whether data can be shared with third parties based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. This typically applies to behavioral advertising data.\n\nWhether buyer data can be shared with or sold to third parties right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.saleOfData`, before sharing or selling buyer data with third parties." } ], - "value": "export interface AllowedProcessing {\n /**\n * Whether analytics data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Analytics\n * data includes how the shop was used and what interactions occurred.\n */\n analytics: boolean;\n /**\n * Whether marketing data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Marketing\n * data includes attribution and targeted advertising preferences.\n */\n marketing: boolean;\n /**\n * Whether preference data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Preference\n * data includes language, currency, and sizing choices.\n */\n preferences: boolean;\n /**\n * Whether data can be shared with third parties based on the visitor's\n * consent, the merchant's privacy configuration, and the visitor's region.\n * This typically applies to behavioral advertising data.\n */\n saleOfData: boolean;\n}" + "value": "export interface AllowedProcessing {\n /**\n * Whether analytics data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Analytics\n * data includes how the shop was used and what interactions occurred.\n *\n * Whether analytics data can be collected right now. Combines the buyer's\n * consent, the merchant's privacy configuration, and the buyer's region into\n * a single boolean. Check this flag, not `visitorConsent.analytics`, before\n * calling `shopify.analytics.publish()`.\n */\n analytics: boolean;\n /**\n * Whether marketing data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Marketing\n * data includes attribution and targeted advertising preferences.\n *\n * Whether marketing data can be collected right now. Combines the buyer's\n * consent, the merchant's privacy configuration, and the buyer's region into\n * a single boolean. Check this flag, not `visitorConsent.marketing`, before\n * performing marketing-related data collection.\n */\n marketing: boolean;\n /**\n * Whether preference data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Preference\n * data includes language, currency, and sizing choices.\n *\n * Whether preference data can be collected right now. Combines the buyer's\n * consent, the merchant's privacy configuration, and the buyer's region into\n * a single boolean. Check this flag, not `visitorConsent.preferences`,\n * before storing or reading buyer preference data.\n */\n preferences: boolean;\n /**\n * Whether data can be shared with third parties based on the visitor's\n * consent, the merchant's privacy configuration, and the visitor's region.\n * This typically applies to behavioral advertising data.\n *\n * Whether buyer data can be shared with or sold to third parties right now.\n * Combines the buyer's consent, the merchant's privacy configuration, and\n * the buyer's region into a single boolean. Check this flag, not\n * `visitorConsent.saleOfData`, before sharing or selling buyer data with\n * third parties.\n */\n saleOfData: boolean;\n}" }, "TrackingConsentMetafield": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -106584,7 +106584,7 @@ "Extension": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Extension", - "description": "The meta information about an extension target.", + "description": "Metadata about the running extension, including its API version, target, capabilities, and editor context. Use this to read configuration details or conditionally render content based on where the extension is running.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -106610,7 +106610,7 @@ "syntaxKind": "PropertySignature", "name": "capabilities", "value": "SubscribableSignalLike", - "description": "The allowed capabilities of the extension, defined in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n\n* [`api_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#api-access): the extension can access the Storefront API.\n\n* [`network_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access): the extension can make external network calls.\n\n* [`block_progress`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n\n* [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n\n* [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can register customer consent decisions that are honored on Shopify-managed services.\n\n* [`iframe.sources`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#iframe): the extension can embed an external URL in an iframe." + "description": "The allowed capabilities of the extension, defined in your [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -106658,7 +106658,7 @@ "syntaxKind": "PropertySignature", "name": "version", "value": "string", - "description": "The published version of the running extension target.\n\nFor unpublished extensions, the value is `undefined`.", + "description": "The published version of the running extension target.\n\nFor unpublished extensions, the value is `undefined`.\n\nDon't use this property as a stable identifier in development environments. It becomes available only after the extension is published.", "isOptional": true, "examples": [ { @@ -106674,7 +106674,7 @@ ] } ], - "value": "export interface Extension {\n /**\n * The API version that was set in the extension config file.\n *\n * @example '2024-10', '2025-01', '2025-04', '2025-07', '2025-10'\n */\n apiVersion: ApiVersion;\n\n /**\n * The allowed capabilities of the extension, defined\n * in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n *\n * * [`api_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#api-access): the extension can access the Storefront API.\n *\n * * [`network_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access): the extension can make external network calls.\n *\n * * [`block_progress`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n *\n * * [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n *\n * * [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can register customer consent decisions that are honored on Shopify-managed services.\n *\n * * [`iframe.sources`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#iframe): the extension can embed an external URL in an iframe.\n */\n capabilities: SubscribableSignalLike;\n\n /**\n * Information about the editor where the extension is being rendered.\n *\n * If the value is undefined, then the extension isn't running in an editor.\n */\n editor?: Editor;\n\n /**\n * A Boolean to show whether your extension is currently rendered to the screen.\n *\n * Shopify might render your extension before it's visible in the UI,\n * typically to pre-render extensions that appear on a later step of the\n * checkout.\n *\n * Your extension might also continue to run after the customer has navigated away\n * from where it was rendered. The extension continues running so that\n * your extension is immediately available to render if the customer navigates back.\n */\n rendered: SubscribableSignalLike;\n\n /**\n * The URL to the script that started the extension target.\n */\n scriptUrl: string;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n */\n target: Target;\n\n /**\n * The published version of the running extension target.\n *\n * For unpublished extensions, the value is `undefined`.\n *\n * @example 3.0.10\n */\n version?: string;\n}" + "value": "export interface Extension {\n /**\n * The API version that was set in the extension config file.\n *\n * @example '2024-10', '2025-01', '2025-04', '2025-07', '2025-10'\n */\n apiVersion: ApiVersion;\n\n /**\n * The allowed capabilities of the extension, defined in your\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n */\n capabilities: SubscribableSignalLike;\n\n /**\n * Information about the editor where the extension is being rendered.\n *\n * If the value is undefined, then the extension isn't running in an editor.\n */\n editor?: Editor;\n\n /**\n * A Boolean to show whether your extension is currently rendered to the screen.\n *\n * Shopify might render your extension before it's visible in the UI,\n * typically to pre-render extensions that appear on a later step of the\n * checkout.\n *\n * Your extension might also continue to run after the customer has navigated away\n * from where it was rendered. The extension continues running so that\n * your extension is immediately available to render if the customer navigates back.\n */\n rendered: SubscribableSignalLike;\n\n /**\n * The URL to the script that started the extension target.\n */\n scriptUrl: string;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n */\n target: Target;\n\n /**\n * The published version of the running extension target.\n *\n * For unpublished extensions, the value is `undefined`.\n *\n * Don't use this property as a stable identifier in development environments.\n * It becomes available only after the extension is published.\n *\n * @example 3.0.10\n */\n version?: string;\n}" }, "ApiVersion": { "filePath": "src/shared.ts", @@ -106693,7 +106693,7 @@ "Editor": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Editor", - "description": "", + "description": "Information about the editor environment when an extension is rendered inside the checkout editor. The value is `undefined` when the extension is not rendering in an editor.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -106708,7 +106708,7 @@ "I18n": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18n", - "description": "", + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use the I18n API alongside the Localization API to build fully localized extensions.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -106744,7 +106744,7 @@ "I18nTranslate": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18nTranslate", - "description": "This returns a translated string matching a key in a locale file.", + "description": "Translates a key from your extension's locale files into a localized string. Supports interpolation with placeholder replacements and pluralization via the special `count` option.", "members": [], "value": "export interface I18nTranslate {\n (\n key: string,\n options?: Record,\n ): ReplacementType extends string | number\n ? string\n : (string | ReplacementType)[];\n}" }, @@ -107308,14 +107308,14 @@ "Localization": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Localization", - "description": "", + "description": "The buyer's language, country, currency, and timezone context. Use this to adapt your extension to the buyer's region and display localized content.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "country", "value": "SubscribableSignalLike", - "description": "The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown." + "description": "The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n\nDerived from the buyer's shipping address. Returns `undefined` until the buyer enters a shipping address." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -107343,18 +107343,18 @@ "syntaxKind": "PropertySignature", "name": "market", "value": "SubscribableSignalLike", - "description": "The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n\n> Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.", - "deprecationMessage": "Deprecated as of version `2025-04`" + "description": "The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. The market context updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.", + "deprecationMessage": "Merchants now manage which extensions load for each\nmarket, so extensions no longer need to check this value." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "timezone", "value": "SubscribableSignalLike", - "description": "The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time." + "description": "The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time." } ], - "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n *\n * > Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" + "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n *\n * Derived from the buyer's shipping address. Returns `undefined` until the\n * buyer enters a shipping address.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout,\n * carried over from the cart context. Markets group countries and\n * regions with shared pricing, languages, and domains. The market\n * context updates when the buyer changes the country of their\n * shipping address. The value is `undefined` if the market is unknown.\n *\n * @deprecated Merchants now manage which extensions load for each\n * market, so extensions no longer need to check this value.\n */\n market: SubscribableSignalLike;\n}" }, "Country": { "filePath": "src/shared.ts", @@ -107555,7 +107555,7 @@ "SessionToken": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SessionToken", - "description": "", + "description": "Authenticates requests between your extension and your app backend. Use session tokens to verify the identity of the buyer and the shop context when making server-side API calls. The token is a signed JWT that contains claims such as the customer ID, shop domain, and expiration.\n\nThe `sub` claim in the decoded token is present only when the buyer is logged in and the app has permission to read customer accounts. Absent for anonymous buyers.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -107814,7 +107814,7 @@ "Shop": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Shop", - "description": "", + "description": "Metadata about the merchant's store, including its name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -107854,30 +107854,30 @@ "syntaxKind": "PropertySignature", "name": "storefrontUrl", "value": "string", - "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n\n> Caution: > As of version `2024-04` this value no longer has a trailing slash.", + "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.", "isOptional": true } ], - "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n *\n * > Caution:\n * > As of version `2024-04` this value no longer has a trailing slash.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom domain.\n */\n myshopifyDomain: string;\n}" + "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom domain.\n */\n myshopifyDomain: string;\n}" }, "Storage": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Storage", - "description": "A key-value storage object for the extension.\n\nStored data is available only to this specific extension and any of its instances.\n\nThe storage backend is implemented with `localStorage` and should persist across the buyer's checkout session. However, data persistence isn't guaranteed.", + "description": "Key-value storage for a specific extension. Use storage to save preferences or cached data that should survive page reloads without requiring a backend call. Stored data is only available to this specific extension. The storage backend is implemented with `localStorage` and data persistence isn't guaranteed.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "delete", "value": "(key: string) => Promise", - "description": "Delete stored data by key." + "description": "Deletes a previously stored value by key." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "read", "value": "(key: string) => Promise", - "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original primitive.\n\nReturns `null` if no stored data exists." + "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original type.\n\nReturns the stored value for the given key, or `null` when no value exists. Doesn't throw on a missing key." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -107887,7 +107887,7 @@ "description": "Write stored data for this key.\n\nThe data must be serializable to JSON." } ], - "value": "export interface Storage {\n /**\n * Read and return a stored value by key.\n *\n * The stored data is deserialized from JSON and returned as\n * its original primitive.\n *\n * Returns `null` if no stored data exists.\n */\n read(key: string): Promise;\n\n /**\n * Write stored data for this key.\n *\n * The data must be serializable to JSON.\n */\n write(key: string, data: any): Promise;\n\n /**\n * Delete stored data by key.\n */\n delete(key: string): Promise;\n}" + "value": "export interface Storage {\n /**\n * Read and return a stored value by key.\n *\n * The stored data is deserialized from JSON and returned as\n * its original type.\n *\n * Returns the stored value for the given key, or `null` when no value\n * exists. Doesn't throw on a missing key.\n */\n read(key: string): Promise;\n\n /**\n * Write stored data for this key.\n *\n * The data must be serializable to JSON.\n */\n write(key: string, data: any): Promise;\n\n /**\n * Deletes a previously stored value by key.\n */\n delete(key: string): Promise;\n}" }, "Version": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -108024,7 +108024,7 @@ "syntaxKind": "MethodSignature", "name": "applyAttributeChange", "value": "(change: AttributeChange) => Promise", - "description": "Updates or removes an attribute on the cart and checkout. On success, the [`attributes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/attributes#standardapi-propertydetail-attributes) property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.", + "description": "Updates or removes an attribute on the cart and checkout. On success, the [`attributes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/attributes#properties-propertydetail-attributes) property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.", "deprecationMessage": "Use cart metafields instead." }, { @@ -108032,42 +108032,42 @@ "syntaxKind": "MethodSignature", "name": "applyCartLinesChange", "value": "(change: CartLineChange) => Promise", - "description": "Adds, removes, or updates line items in the cart. The returned promise resolves when the change has been applied by the server, and the [`lines`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-lines#standardapi-propertydetail-lines) property updates with the new state.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Adds, removes, or updates line items in the cart. The returned promise resolves when the change has been applied by the server, and the [`lines`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-lines#properties-propertydetail-lines) property updates with the new state.\n\nAccepts a single change per call. To make multiple changes, call this method separately for each one.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyDiscountCodeChange", "value": "(change: DiscountCodeChange) => Promise", - "description": "Adds or removes a discount code on the checkout. The returned promise resolves when the change has been applied by the server, and the [`discountCodes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/discounts#standardapi-propertydetail-discountcodes) property updates with the new state.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves discount codes through a network call.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Adds or removes a discount code on the checkout. The returned promise resolves when the change has been applied by the server, and the [`discountCodes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/discounts#properties-propertydetail-discountcodes) property updates with the new state.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves discount codes through a network call.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyGiftCardChange", "value": "(change: GiftCardChange) => Promise", - "description": "Adds or removes a gift card from the checkout. The returned promise resolves when the change has been applied by the server, and the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/gift-cards#standardapi-propertydetail-appliedgiftcards) property updates with the new state.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves gift card codes through a network call.\n\n> Note: This method returns an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Adds or removes a gift card from the checkout. The returned promise resolves when the change has been applied by the server, and the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/gift-cards#properties-propertydetail-appliedgiftcards) property updates with the new state.\n\nUnlike other write operations, gift card changes aren't gated by a cart instruction flag.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves gift card codes through a network call.\n\n> Note: This method returns an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyMetafieldChange", "value": "(change: MetafieldChange) => Promise", - "description": "Creates, updates, or removes a cart metafield on the checkout. On success, the [`metafields`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/metafields#standardapi-propertydetail-metafields) property updates to reflect the change.\n\nCart metafields are copied to order metafields at order creation time if there's a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n\n> Caution: `MetafieldRemoveChange` and `MetafieldUpdateChange` are deprecated. Use cart metafields with `MetafieldRemoveCartChange` and `MetafieldUpdateCartChange` instead. If `MetafieldUpdateChange` writes a metafield with the same namespace and key as a cart metafield that's configured to copy, the cart metafield won't be copied.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Creates, updates, or removes a cart metafield on the checkout. On success, the [`metafields`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/metafields#properties-propertydetail-metafields) property updates to reflect the change.\n\nCart metafields are copied to order metafields at order creation time if there's a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n\n> Caution: `MetafieldRemoveChange` and `MetafieldUpdateChange` are deprecated. Use cart metafields with `MetafieldRemoveCartChange` and `MetafieldUpdateCartChange` instead. If `MetafieldUpdateChange` writes a metafield with the same namespace and key as a cart metafield that's configured to copy, the cart metafield won't be copied.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyNoteChange", "value": "(change: NoteChange) => Promise", - "description": "Sets or removes the buyer's note on the checkout. On success, the [`note`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/note#standardapi-propertydetail-note) property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Sets or removes the buyer's note on the checkout. On success, the [`note`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/note#properties-propertydetail-note) property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyShippingAddressChange", "value": "(change: ShippingAddressUpdateChange) => Promise", - "description": "Updates the buyer's shipping address on the checkout. The provided fields are merged into the existing address without prompting the buyer. On success, the `shippingAddress` property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", + "description": "Updates the buyer's shipping address on the checkout. The provided fields are merged into the existing address without prompting the buyer. On success, the `shippingAddress` property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", "isOptional": true }, { @@ -108080,7 +108080,7 @@ "isPrivate": true } ], - "value": "export interface CheckoutApi {\n /**\n * Updates or removes an attribute on the cart and checkout. On success, the\n * [`attributes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/attributes#standardapi-propertydetail-attributes) property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * @deprecated Use cart metafields instead.\n */\n applyAttributeChange(change: AttributeChange): Promise;\n\n /**\n * Adds, removes, or updates line items in the cart. The returned promise resolves when the change has been applied by the server, and the [`lines`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-lines#standardapi-propertydetail-lines) property updates with the new state.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyCartLinesChange(change: CartLineChange): Promise;\n\n /**\n * Adds or removes a discount code on the checkout. The returned promise resolves when the change has been applied by the server, and the [`discountCodes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/discounts#standardapi-propertydetail-discountcodes) property updates with the new state.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves discount codes through a network call.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyDiscountCodeChange(\n change: DiscountCodeChange,\n ): Promise;\n\n /**\n * Adds or removes a gift card from the checkout. The returned promise resolves when the change has been applied by the server, and the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/gift-cards#standardapi-propertydetail-appliedgiftcards) property updates with the new state.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves gift card codes through a network call.\n *\n * > Note: This method returns an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyGiftCardChange(change: GiftCardChange): Promise;\n\n /**\n * Creates, updates, or removes a cart metafield on the checkout. On success, the\n * [`metafields`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/metafields#standardapi-propertydetail-metafields) property updates to reflect the change.\n *\n * Cart metafields are copied to order metafields at order creation time if there's a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n *\n * > Caution: `MetafieldRemoveChange` and `MetafieldUpdateChange` are deprecated. Use cart metafields with `MetafieldRemoveCartChange` and `MetafieldUpdateCartChange` instead. If `MetafieldUpdateChange` writes a metafield with the same namespace and key as a cart metafield that's configured to copy, the cart metafield won't be copied.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyMetafieldChange(change: MetafieldChange): Promise;\n\n /**\n * Sets or removes the buyer's note on the checkout. On success, the\n * [`note`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/note#standardapi-propertydetail-note)\n * property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyNoteChange(change: NoteChange): Promise;\n\n /**\n * @private\n */\n experimentalIsShopAppStyle?: boolean;\n\n /**\n * Updates the buyer's shipping address on the checkout. The provided fields\n * are merged into the existing address without prompting the buyer. On success,\n * the `shippingAddress` property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyShippingAddressChange?(\n change: ShippingAddressChange,\n ): Promise;\n}" + "value": "export interface CheckoutApi {\n /**\n * Updates or removes an attribute on the cart and checkout. On success, the\n * [`attributes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/attributes#properties-propertydetail-attributes) property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * @deprecated Use cart metafields instead.\n */\n applyAttributeChange(change: AttributeChange): Promise;\n\n /**\n * Adds, removes, or updates line items in the cart. The returned promise resolves when the change has been applied by the server, and the [`lines`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-lines#properties-propertydetail-lines) property updates with the new state.\n *\n * Accepts a single change per call. To make multiple changes, call this\n * method separately for each one.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyCartLinesChange(change: CartLineChange): Promise;\n\n /**\n * Adds or removes a discount code on the checkout. The returned promise resolves when the change has been applied by the server, and the [`discountCodes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/discounts#properties-propertydetail-discountcodes) property updates with the new state.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves discount codes through a network call.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyDiscountCodeChange(\n change: DiscountCodeChange,\n ): Promise;\n\n /**\n * Adds or removes a gift card from the checkout. The returned promise resolves when the change has been applied by the server, and the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/gift-cards#properties-propertydetail-appliedgiftcards) property updates with the new state.\n *\n * Unlike other write operations, gift card changes aren't gated by a cart\n * instruction flag.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves gift card codes through a network call.\n *\n * > Note: This method returns an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyGiftCardChange(change: GiftCardChange): Promise;\n\n /**\n * Creates, updates, or removes a cart metafield on the checkout. On success, the\n * [`metafields`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/metafields#properties-propertydetail-metafields) property updates to reflect the change.\n *\n * Cart metafields are copied to order metafields at order creation time if there's a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n *\n * > Caution: `MetafieldRemoveChange` and `MetafieldUpdateChange` are deprecated. Use cart metafields with `MetafieldRemoveCartChange` and `MetafieldUpdateCartChange` instead. If `MetafieldUpdateChange` writes a metafield with the same namespace and key as a cart metafield that's configured to copy, the cart metafield won't be copied.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyMetafieldChange(change: MetafieldChange): Promise;\n\n /**\n * Sets or removes the buyer's note on the checkout. On success, the\n * [`note`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/note#properties-propertydetail-note)\n * property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyNoteChange(change: NoteChange): Promise;\n\n /**\n * @private\n */\n experimentalIsShopAppStyle?: boolean;\n\n /**\n * Updates the buyer's shipping address on the checkout. The provided fields\n * are merged into the existing address without prompting the buyer. On success,\n * the `shippingAddress` property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyShippingAddressChange?(\n change: ShippingAddressChange,\n ): Promise;\n}" }, "AttributeChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -108147,7 +108147,7 @@ "syntaxKind": "PropertySignature", "name": "value", "value": "string", - "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.", + "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.\n\nAttribute values are always strings. To store structured data, serialize it to JSON and parse it when reading.", "examples": [ { "title": "Example", @@ -108162,7 +108162,7 @@ ] } ], - "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" + "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * Attribute values are always strings. To store structured data, serialize\n * it to JSON and parse it when reading.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" }, "AttributeRemoveChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -109015,7 +109015,7 @@ "syntaxKind": "PropertySignature", "name": "message", "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer." + "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer.\n\nRender your own localized error text rather than displaying this message to the buyer." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -109025,7 +109025,7 @@ "description": "Indicates that the line item wasn't changed successfully. Refer to the `message` property for details about the error." } ], - "value": "export interface CartLineChangeResultError {\n /**\n * Indicates that the line item wasn't changed successfully. Refer to the `message` property for details about the error.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface CartLineChangeResultError {\n /**\n * Indicates that the line item wasn't changed successfully. Refer to the `message` property for details about the error.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n *\n * Render your own localized error text rather than displaying this message\n * to the buyer.\n */\n message: string;\n}" }, "DiscountCodeChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -109205,7 +109205,7 @@ "syntaxKind": "PropertySignature", "name": "message", "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer." + "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer.\n\nRender your own localized error text rather than displaying this message to the buyer." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -109215,7 +109215,7 @@ "description": "Indicates that the gift card change couldn't be applied. Check the `message` property for details." } ], - "value": "export interface GiftCardChangeResultError {\n /**\n * Indicates that the gift card change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface GiftCardChangeResultError {\n /**\n * Indicates that the gift card change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n *\n * Render your own localized error text rather than displaying this message\n * to the buyer.\n */\n message: string;\n}" }, "MetafieldChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -109476,7 +109476,7 @@ "syntaxKind": "PropertySignature", "name": "message", "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer." + "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer.\n\nRender your own localized error text rather than displaying this message to the buyer." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -109486,7 +109486,7 @@ "description": "Indicates that the metafield change couldn't be applied. Check the `message` property for details." } ], - "value": "export interface MetafieldChangeResultError {\n /**\n * Indicates that the metafield change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface MetafieldChangeResultError {\n /**\n * Indicates that the metafield change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n *\n * Render your own localized error text rather than displaying this message\n * to the buyer.\n */\n message: string;\n}" }, "NoteChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -109564,7 +109564,7 @@ "syntaxKind": "PropertySignature", "name": "message", "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer." + "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer.\n\nRender your own localized error text rather than displaying this message to the buyer." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -109574,7 +109574,7 @@ "description": "Indicates that the note change couldn't be applied. Check the `message` property for details." } ], - "value": "export interface NoteChangeResultError {\n /**\n * Indicates that the note change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface NoteChangeResultError {\n /**\n * Indicates that the note change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n *\n * Render your own localized error text rather than displaying this message\n * to the buyer.\n */\n message: string;\n}" }, "ShippingAddressUpdateChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -110160,7 +110160,7 @@ "syntaxKind": "PropertySignature", "name": "analytics", "value": "Analytics", - "description": "The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event." + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -110174,7 +110174,7 @@ "syntaxKind": "PropertySignature", "name": "applyTrackingConsentChange", "value": "ApplyTrackingConsentChangeType", - "description": "Enables setting and updating customer privacy consent settings and tracking consent metafields.\n\n> Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent) to be set to `true`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." + "description": "Enables setting and updating customer privacy consent settings and tracking consent metafields.\n\n> Note: Requires the [`collect_buyer_consent` capability](/docs/apps/build/customer-accounts/capabilities#collect-buyer-consent) to be set to `true`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -110195,7 +110195,7 @@ "syntaxKind": "PropertySignature", "name": "availablePaymentOptions", "value": "SubscribableSignalLike", - "description": "All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region." + "description": "All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n\nThe set of payment options can change when the buyer updates their address or cart, so subscribe to changes rather than reading once during initialization. Each option exposes `handle` and `type` only. Provider names, logos, fees, and installment terms aren't available." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -110232,7 +110232,7 @@ "syntaxKind": "PropertySignature", "name": "checkoutToken", "value": "SubscribableSignalLike", - "description": "A stable ID that represents the current checkout.\n\nThe value is `undefined` when the checkout hasn't been created on the server yet.\n\nUse this to correlate checkout sessions across your extension, web pixels, and backend systems.\n\nThis matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data) and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object)." + "description": "A stable ID that represents the current checkout.\n\nThe value is `undefined` when the checkout hasn't been created on the server yet.\n\nUse this to correlate checkout sessions across your extension, web pixels, and backend systems.\n\nThis matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data) and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n\nCan be `undefined`. Handle the `undefined` state before using the value." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -110253,7 +110253,7 @@ "syntaxKind": "PropertySignature", "name": "deliveryGroups", "value": "SubscribableSignalLike", - "description": "The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items." + "description": "The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n\nEmpty until the buyer enters enough address information for Shopify to calculate shipping rates." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -110274,7 +110274,7 @@ "syntaxKind": "PropertySignature", "name": "extension", "value": "Extension", - "description": "The meta information about the extension." + "description": "Metadata about the running extension, including the current target, API version, capabilities, and editor context. Use this to conditionally render content based on where the extension is running." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -110282,7 +110282,7 @@ "name": "extensionPoint", "value": "Target", "description": "The identifier that specifies where in Shopify's UI your code is being injected. This is one of the targets you've included in your extension's configuration file.", - "deprecationMessage": "Deprecated as of version `2023-07`, use `extension.target` instead.", + "deprecationMessage": "Use `extension.target` instead.", "examples": [ { "title": "Example", @@ -110301,14 +110301,14 @@ "syntaxKind": "PropertySignature", "name": "i18n", "value": "I18n", - "description": "Utilities for translating content and formatting values according to the current [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) of the checkout.\n\nRefer to [`localization` examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples) for more information." + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use alongside [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) to build fully localized extensions." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "instructions", "value": "SubscribableSignalLike", - "description": "The cart instructions used to create the checkout and possibly limit extension capabilities.\n\nThese instructions should be checked before performing any actions that might be affected by them.\n\nFor example, if you intend to add a discount code via the `applyDiscountCodeChange` method, check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n\n> Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs aren't available. See the [update guide](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples) for more information." + "description": "The cart instructions used to create the checkout and possibly limit extension capabilities.\n\nThese instructions should be checked before performing any actions that might be affected by them.\n\nFor example, if you intend to add a discount code via the `applyDiscountCodeChange` method, check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n\n> Caution: Check cart instructions before calling select APIs, as > some may not be available. See the > [Cart Instructions API](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples) > for more information." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -110322,7 +110322,7 @@ "syntaxKind": "PropertySignature", "name": "localization", "value": "Localization", - "description": "The details about the location, language, and currency of the customer. For utilities to easily format and translate content based on these details, you can use the [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n) object instead." + "description": "The buyer's language, country, currency, and timezone context. For formatting and translation helpers, use the [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#properties-propertydetail-i18n) object instead." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -110352,21 +110352,21 @@ "syntaxKind": "PropertySignature", "name": "query", "value": ">(query: string, options?: { variables?: Variables; version?: StorefrontApiVersion; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>", - "description": "The method used to query the Storefront GraphQL API with a prefetched token.\n\nRefer to [Storefront API access examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/storefront-api) for more information." + "description": "The method used to query the Storefront GraphQL API with a prefetched token." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "selectedPaymentOptions", "value": "SubscribableSignalLike", - "description": "The payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card)." + "description": "The payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\n\nEach option exposes `handle` and `type` only. Provider names, logos, fees, and installment terms aren't available." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "sessionToken", "value": "SessionToken", - "description": "The session token providing a set of claims as a signed JSON Web Token (JWT).\n\nThe token has a TTL of five minutes.\n\nIf the previous token expires, this value reflects a new session token with a new signature and expiry.\n\nRefer to [session token examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/session-token) for more information." + "description": "The session token providing a set of claims as a signed JSON Web Token (JWT).\n\nThe token has a TTL of five minutes.\n\nIf the previous token expires, this value reflects a new session token with a new signature and expiry.\n\nLearn more about [session tokens](/docs/apps/build/authentication-authorization/session-tokens)." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -110388,14 +110388,14 @@ "syntaxKind": "PropertySignature", "name": "shop", "value": "Shop", - "description": "The shop where the checkout is taking place." + "description": "The store where the checkout is taking place, including the shop name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "storage", "value": "Storage", - "description": "The key-value storage for the extension.\n\nIt uses `localStorage` and should persist across the customer's current checkout session.\n\n> Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n\nData is shared across all activated extension targets of this extension. In versions 2023-07 and earlier, each activated extension target had its own storage." + "description": "Key-value storage that persists across page loads within the current checkout session. Data is shared across all activated targets associated with this extension.\n\n> Caution: Data persistence isn't guaranteed and storage is cleared when the buyer starts a new checkout." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -110417,29 +110417,29 @@ ] } ], - "value": "export interface StandardApi {\n /**\n * The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event.\n */\n analytics: Analytics;\n\n /**\n * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\n */\n appliedGiftCards: SubscribableSignalLike;\n\n /**\n * The cart instructions used to create the checkout and possibly limit extension capabilities.\n *\n * These instructions should be checked before performing any actions that might be affected by them.\n *\n * For example, if you intend to add a discount code via the `applyDiscountCodeChange` method,\n * check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n *\n * > Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs aren't available.\n * See the [update guide](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples) for more information.\n *\n */\n instructions: SubscribableSignalLike;\n\n /**\n * The metafields requested in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration)\n * file. These metafields are updated when there's a change in the merchandise items\n * being purchased by the customer.\n *\n * App owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` isn't supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n appMetafields: SubscribableSignalLike;\n\n /**\n * The custom key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n buyerIdentity?: BuyerIdentity;\n\n /**\n * Provides details on the buyer's progression through the checkout and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/buyer-journey#examples)\n * examples for more information.\n */\n buyerJourney: BuyerJourney;\n\n /**\n * Settings applied to the buyer's checkout.\n */\n checkoutSettings: SubscribableSignalLike;\n\n /**\n * A stable ID that represents the current checkout.\n *\n * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\n *\n * This matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data)\n * and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n */\n checkoutToken: SubscribableSignalLike;\n\n /**\n * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * The meta information about the extension.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n *\n * @deprecated Deprecated as of version `2023-07`, use `extension.target` instead.\n */\n extensionPoint: Target;\n\n /**\n * Utilities for translating content and formatting values according to the current\n * [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization)\n * of the checkout.\n *\n * Refer to [`localization` examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples)\n * for more information.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The details about the location, language, and currency of the customer. For utilities to easily\n * format and translate content based on these details, you can use the\n * [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n)\n * object instead.\n */\n localization: Localization;\n\n /**\n * The metafields that apply to the current checkout.\n *\n * Metafields are stored locally on the client and are applied to the order object after the checkout completes.\n *\n * These metafields are shared by all extensions running on checkout, and\n * persist for as long as the customer is working on this checkout.\n *\n * Once the order is created, you can query these metafields using the\n * [GraphQL Admin API](/docs/admin-api/graphql/reference/orders/order#metafield-2021-01)\n *\n * > Caution:\n * `metafields` is deprecated. Use `appMetafields` with cart metafields instead.\n *\n * @deprecated Use `appMetafields` with cart metafields instead.\n */\n metafields: SubscribableSignalLike;\n\n /**\n * A note left by the customer to the merchant, either in their cart or during checkout.\n *\n * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\n */\n note: SubscribableSignalLike;\n\n /**\n * The method used to query the Storefront GraphQL API with a prefetched token.\n *\n * Refer to [Storefront API access examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/storefront-api) for more information.\n */\n query: >(\n query: string,\n options?: {variables?: Variables; version?: StorefrontApiVersion},\n ) => Promise<{data?: Data; errors?: GraphQLError[]}>;\n\n /**\n * The payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\n */\n selectedPaymentOptions: SubscribableSignalLike;\n\n /**\n * The session token providing a set of claims as a signed JSON Web Token (JWT).\n *\n * The token has a TTL of five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/session-token) for more information.\n */\n sessionToken: SessionToken;\n\n /**\n * The settings matching the settings definition written in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates in real time as a merchant fills in the settings.\n */\n settings: SubscribableSignalLike;\n\n /**\n * The proposed customer shipping address. During the information step, the address\n * updates when the field is committed (on change) rather than every keystroke.\n * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n shippingAddress?: SubscribableSignalLike;\n\n /**\n * The proposed customer billing address. The address updates when the field is\n * committed (on change) rather than every keystroke. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided yet.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n billingAddress?: SubscribableSignalLike;\n\n /** The shop where the checkout is taking place. */\n shop: Shop;\n\n /**\n * The key-value storage for the extension.\n *\n * It uses `localStorage` and should persist across the customer's current checkout session.\n *\n * > Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n *\n * Data is shared across all activated extension targets of this extension. In versions 2023-07 and earlier,\n * each activated extension target had its own storage.\n */\n storage: Storage;\n\n /**\n * The renderer version being used for the extension.\n *\n * @example '2025-10'\n */\n version: Version;\n\n /**\n * Customer privacy consent settings and a flag denoting if consent has previously been collected.\n */\n customerPrivacy: SubscribableSignalLike;\n\n /**\n * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent) to be set to `true`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyTrackingConsentChange: ApplyTrackingConsentChangeType;\n\n /**\n * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" + "value": "export interface StandardApi {\n /**\n * Tracks custom events and sends visitor information to\n * [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events\n * and `visitor()` to submit buyer contact details.\n */\n analytics: Analytics;\n\n /**\n * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\n */\n appliedGiftCards: SubscribableSignalLike;\n\n /**\n * The cart instructions used to create the checkout and possibly limit extension capabilities.\n *\n * These instructions should be checked before performing any actions that might be affected by them.\n *\n * For example, if you intend to add a discount code via the `applyDiscountCodeChange` method,\n * check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n *\n * > Caution: Check cart instructions before calling select APIs, as\n * > some may not be available. See the\n * > [Cart Instructions API](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples)\n * > for more information.\n *\n */\n instructions: SubscribableSignalLike;\n\n /**\n * The metafields requested in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration)\n * file. These metafields are updated when there's a change in the merchandise items\n * being purchased by the customer.\n *\n * App owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` isn't supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n appMetafields: SubscribableSignalLike;\n\n /**\n * The custom key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as\n * credit cards, wallets, and local payment methods. The list depends on\n * the shop's payment configuration and the buyer's region.\n *\n * The set of payment options can change when the buyer updates their\n * address or cart, so subscribe to changes rather than reading once\n * during initialization. Each option exposes `handle` and `type` only.\n * Provider names, logos, fees, and installment terms aren't available.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n buyerIdentity?: BuyerIdentity;\n\n /**\n * Provides details on the buyer's progression through the checkout and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/buyer-journey#examples)\n * examples for more information.\n */\n buyerJourney: BuyerJourney;\n\n /**\n * Settings applied to the buyer's checkout.\n */\n checkoutSettings: SubscribableSignalLike;\n\n /**\n * A stable ID that represents the current checkout.\n *\n * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\n *\n * This matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data)\n * and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n *\n * Can be `undefined`. Handle the `undefined` state before using the value.\n */\n checkoutToken: SubscribableSignalLike;\n\n /**\n * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n *\n * Empty until the buyer enters enough address information for Shopify to\n * calculate shipping rates.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * Metadata about the running extension, including the current target, API version,\n * capabilities, and editor context. Use this to conditionally render content\n * based on where the extension is running.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n *\n * @deprecated Use `extension.target` instead.\n */\n extensionPoint: Target;\n\n /**\n * Utilities for translating strings, formatting currencies, numbers, and dates\n * according to the buyer's locale. Use alongside\n * [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization)\n * to build fully localized extensions.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The buyer's language, country, currency, and timezone context. For\n * formatting and translation helpers, use the\n * [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#properties-propertydetail-i18n)\n * object instead.\n */\n localization: Localization;\n\n /**\n * The metafields that apply to the current checkout.\n *\n * Metafields are stored locally on the client and are applied to the order object after the checkout completes.\n *\n * These metafields are shared by all extensions running on checkout, and\n * persist for as long as the customer is working on this checkout.\n *\n * Once the order is created, you can query these metafields using the\n * [GraphQL Admin API](/docs/admin-api/graphql/reference/orders/order#metafield-2021-01)\n *\n * > Caution:\n * `metafields` is deprecated. Use `appMetafields` with cart metafields instead.\n *\n * @deprecated Use `appMetafields` with cart metafields instead.\n */\n metafields: SubscribableSignalLike;\n\n /**\n * A note left by the customer to the merchant, either in their cart or during checkout.\n *\n * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\n */\n note: SubscribableSignalLike;\n\n /**\n * The method used to query the Storefront GraphQL API with a prefetched token.\n *\n */\n query: >(\n query: string,\n options?: {variables?: Variables; version?: StorefrontApiVersion},\n ) => Promise<{data?: Data; errors?: GraphQLError[]}>;\n\n /**\n * The payment options the buyer has currently selected. This updates as\n * the buyer changes their payment method. The array can contain multiple\n * entries when the buyer splits payment across methods (for example, a\n * gift card and a credit card).\n *\n * Each option exposes `handle` and `type` only. Provider names, logos,\n * fees, and installment terms aren't available.\n */\n selectedPaymentOptions: SubscribableSignalLike;\n\n /**\n * The session token providing a set of claims as a signed JSON Web Token (JWT).\n *\n * The token has a TTL of five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Learn more about [session tokens](/docs/apps/build/authentication-authorization/session-tokens).\n */\n sessionToken: SessionToken;\n\n /**\n * The settings matching the settings definition written in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates in real time as a merchant fills in the settings.\n */\n settings: SubscribableSignalLike;\n\n /**\n * The proposed customer shipping address. During the information step, the address\n * updates when the field is committed (on change) rather than every keystroke.\n * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n shippingAddress?: SubscribableSignalLike;\n\n /**\n * The proposed customer billing address. The address updates when the field is\n * committed (on change) rather than every keystroke. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided yet.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n billingAddress?: SubscribableSignalLike;\n\n /**\n * The store where the checkout is taking place, including the shop name,\n * storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.\n */\n shop: Shop;\n\n /**\n * Key-value storage that persists across page loads within the current checkout\n * session. Data is shared across all activated targets associated with\n * this extension.\n *\n * > Caution: Data persistence isn't guaranteed and storage is cleared when the\n * buyer starts a new checkout.\n */\n storage: Storage;\n\n /**\n * The renderer version being used for the extension.\n *\n * @example '2025-10'\n */\n version: Version;\n\n /**\n * Customer privacy consent settings and a flag denoting if consent has previously been collected.\n */\n customerPrivacy: SubscribableSignalLike;\n\n /**\n * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`collect_buyer_consent` capability](/docs/apps/build/customer-accounts/capabilities#collect-buyer-consent) to be set to `true`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyTrackingConsentChange: ApplyTrackingConsentChangeType;\n\n /**\n * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" }, "Analytics": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Analytics", - "description": "", + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "publish", "value": "(name: string, data: Record) => Promise", - "description": "Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing)." + "description": "Publishes a custom event to [Web Pixels](/docs/apps/marketing). Returns `true` when the event is successfully dispatched.\n\nThe Promise resolves to `true` when the event was dispatched. The boolean indicates dispatch confirmation only. It doesn't indicate whether any specific web pixel processed the event." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "visitor", "value": "(data: { email?: string; phone?: string; }) => Promise", - "description": "A method for capturing details about a visitor on the online store." + "description": "Submits buyer contact details for attribution and analytics purposes." } ], - "value": "export interface Analytics {\n /**\n * Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing).\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * A method for capturing details about a visitor on the online store.\n */\n visitor(data: {email?: string; phone?: string}): Promise;\n}" + "value": "export interface Analytics {\n /**\n * Publishes a custom event to [Web Pixels](/docs/apps/marketing).\n * Returns `true` when the event is successfully dispatched.\n *\n * The Promise resolves to `true` when the event was dispatched. The boolean\n * indicates dispatch confirmation only. It doesn't indicate whether any\n * specific web pixel processed the event.\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * Submits buyer contact details for attribution and analytics purposes.\n */\n visitor(data: {email?: string; phone?: string}): Promise;\n}" }, "VisitorResult": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -110480,10 +110480,10 @@ "syntaxKind": "PropertySignature", "name": "type", "value": "'error'", - "description": "Indicates that the visitor information is invalid and wasn't submitted. Examples are using the wrong data type or missing a required property." + "description": "Indicates that the visitor information is invalid and wasn't submitted. Common causes include using the wrong data type or omitting a required property." } ], - "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Examples are using the wrong data type or missing a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Common causes include using the wrong data type or omitting a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" }, "SubscribableSignalLike": { "filePath": "src/surfaces/checkout/shared.ts", @@ -110697,10 +110697,10 @@ "syntaxKind": "PropertySignature", "name": "value", "value": "string | null", - "description": "The new value to store in the metafield. Set to `null` to delete the metafield." + "description": "The new value to store in the metafield. Set to `null` to delete the metafield.\n\nConsent metafield values are strings, not booleans. Pass `null` to delete a tracking consent metafield." } ], - "value": "export interface TrackingConsentMetafieldChange {\n /**\n * The identifier for the tracking consent metafield to update.\n */\n key: string;\n /**\n * The new value to store in the metafield. Set to `null` to delete the metafield.\n */\n value: string | null;\n}" + "value": "export interface TrackingConsentMetafieldChange {\n /**\n * The identifier for the tracking consent metafield to update.\n */\n key: string;\n /**\n * The new value to store in the metafield. Set to `null` to delete the metafield.\n *\n * Consent metafield values are strings, not booleans. Pass `null` to delete\n * a tracking consent metafield.\n */\n value: string | null;\n}" }, "VisitorConsent": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -110914,7 +110914,7 @@ "syntaxKind": "PropertySignature", "name": "value", "value": "string", - "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.", + "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.\n\nAttribute values are always strings. To store structured data, serialize it to JSON and parse it when reading.", "examples": [ { "title": "Example", @@ -110929,7 +110929,7 @@ ] } ], - "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" + "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * Attribute values are always strings. To store structured data, serialize\n * it to JSON and parse it when reading.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" }, "PaymentOption": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -111280,7 +111280,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A globally-unique identifier for the customer in the format `gid://shopify/Customer/`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", + "description": "An identifier for the customer in the format `gid://shopify/Customer/`. This value is unique per shop.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", "examples": [ { "title": "Example", @@ -111333,7 +111333,7 @@ "isPrivate": true } ], - "value": "export interface Customer {\n /**\n * A globally-unique identifier for the customer in the format `gid://shopify/Customer/`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'gid://shopify/Customer/123'\n */\n id: string;\n /**\n * The email address associated with the customer's account. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email?: string;\n /**\n * The phone number associated with the customer's account. The value is `undefined` if no phone number is on file or the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone?: string;\n /**\n * The customer's full name, typically a combination of first and last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n fullName?: string;\n /**\n * The customer's first name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n firstName?: string;\n /**\n * The customer's last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n lastName?: string;\n /**\n * The customer's profile image, such as a Gravatar avatar. Use this to personalize the extension UI for the logged-in buyer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n image: ImageDetails;\n /**\n * Whether the customer has opted in to receiving marketing communications from the merchant, such as email campaigns and promotional offers.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * > Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n *\n * @deprecated Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n */\n acceptsMarketing: boolean;\n /**\n * Whether the customer has opted in to email marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsEmailMarketing: boolean;\n /**\n * Whether the customer has opted in to SMS marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsSmsMarketing: boolean;\n /**\n * The store credit accounts owned by this customer that can be used as payment during checkout. Each account has a balance representing available store credit.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @private\n */\n storeCreditAccounts: StoreCreditAccount[];\n /**\n * The number of orders the customer has previously placed with this shop.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n ordersCount: number;\n}" + "value": "export interface Customer {\n /**\n * An identifier for the customer in the format `gid://shopify/Customer/`. This value is unique per shop.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'gid://shopify/Customer/123'\n */\n id: string;\n /**\n * The email address associated with the customer's account. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email?: string;\n /**\n * The phone number associated with the customer's account. The value is `undefined` if no phone number is on file or the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone?: string;\n /**\n * The customer's full name, typically a combination of first and last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n fullName?: string;\n /**\n * The customer's first name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n firstName?: string;\n /**\n * The customer's last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n lastName?: string;\n /**\n * The customer's profile image, such as a Gravatar avatar. Use this to personalize the extension UI for the logged-in buyer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n image: ImageDetails;\n /**\n * Whether the customer has opted in to receiving marketing communications from the merchant, such as email campaigns and promotional offers.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * > Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n *\n * @deprecated Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n */\n acceptsMarketing: boolean;\n /**\n * Whether the customer has opted in to email marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsEmailMarketing: boolean;\n /**\n * Whether the customer has opted in to SMS marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsSmsMarketing: boolean;\n /**\n * The store credit accounts owned by this customer that can be used as payment during checkout. Each account has a balance representing available store credit.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @private\n */\n storeCreditAccounts: StoreCreditAccount[];\n /**\n * The number of orders the customer has previously placed with this shop.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n ordersCount: number;\n}" }, "ImageDetails": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -111615,11 +111615,11 @@ "syntaxKind": "MethodSignature", "name": "perform", "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", + "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.\n\nRuns after all intercept results are collected. Use it for local state updates such as setting an error flag. By the time it runs, the navigation decision is final, so blocking logic belongs in the intercept handler itself, not here.", "isOptional": true } ], - "value": "interface InterceptorRequestAllow {\n /**\n * Indicates that the interceptor allows the buyer's journey to continue.\n */\n behavior: 'allow';\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" + "value": "interface InterceptorRequestAllow {\n /**\n * Indicates that the interceptor allows the buyer's journey to continue.\n */\n behavior: 'allow';\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n *\n * Runs after all intercept results are collected. Use it for local state\n * updates such as setting an error flag. By the time it runs, the navigation\n * decision is final, so blocking logic belongs in the intercept handler\n * itself, not here.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" }, "InterceptorResult": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -111683,7 +111683,7 @@ "syntaxKind": "MethodSignature", "name": "perform", "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", + "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.\n\nRuns after all intercept results are collected. Use it for local state updates such as setting an error flag. By the time it runs, the navigation decision is final, so blocking logic belongs in the intercept handler itself, not here.", "isOptional": true }, { @@ -111694,7 +111694,7 @@ "description": "The reason for blocking the interceptor request. This value isn't presented to the buyer, so it doesn't need to be localized. The value is used only for Shopify's own internal debugging and metrics." } ], - "value": "interface InterceptorRequestBlock {\n /**\n * Indicates that the interceptor blocks the buyer's journey from continuing.\n */\n behavior: 'block';\n\n /**\n * The reason for blocking the interceptor request. This value isn't presented to\n * the buyer, so it doesn't need to be localized. The value is used only for Shopify's\n * own internal debugging and metrics.\n */\n reason: string;\n\n /**\n * Used to pass errors to the checkout UI, outside your extension's UI boundaries.\n */\n errors?: ValidationError[];\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" + "value": "interface InterceptorRequestBlock {\n /**\n * Indicates that the interceptor blocks the buyer's journey from continuing.\n */\n behavior: 'block';\n\n /**\n * The reason for blocking the interceptor request. This value isn't presented to\n * the buyer, so it doesn't need to be localized. The value is used only for Shopify's\n * own internal debugging and metrics.\n */\n reason: string;\n\n /**\n * Used to pass errors to the checkout UI, outside your extension's UI boundaries.\n */\n errors?: ValidationError[];\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n *\n * Runs after all intercept results are collected. Use it for local state\n * updates such as setting an error flag. By the time it runs, the navigation\n * decision is final, so blocking logic belongs in the intercept handler\n * itself, not here.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" }, "ValidationError": { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -111915,17 +111915,17 @@ "syntaxKind": "PropertySignature", "name": "totalShippingAmount", "value": "SubscribableSignalLike", - "description": "The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step." + "description": "The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step.\n\n`undefined` until the buyer selects a shipping method (typically after the information step)." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "totalTaxAmount", "value": "SubscribableSignalLike", - "description": "The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet." + "description": "The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet.\n\n`undefined` when taxes haven't been calculated or aren't available for the buyer's region." } ], - "value": "export interface CartCost {\n /**\n * The sum of all line item prices at the current step of checkout, before shipping and taxes are applied. Use this value to display the base cost of the items the buyer purchased.\n */\n subtotalAmount: SubscribableSignalLike;\n\n /**\n * The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step.\n */\n totalShippingAmount: SubscribableSignalLike;\n\n /**\n * The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet.\n */\n totalTaxAmount: SubscribableSignalLike;\n\n /**\n * The minimum total at the current step of checkout. Costs not yet calculated, such as shipping on the information step, aren't included. Gift cards and store credits are excluded from this total.\n */\n totalAmount: SubscribableSignalLike;\n}" + "value": "export interface CartCost {\n /**\n * The sum of all line item prices at the current step of checkout, before shipping and taxes are applied. Use this value to display the base cost of the items the buyer purchased.\n */\n subtotalAmount: SubscribableSignalLike;\n\n /**\n * The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step.\n *\n * `undefined` until the buyer selects a shipping method (typically after the\n * information step).\n */\n totalShippingAmount: SubscribableSignalLike;\n\n /**\n * The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet.\n *\n * `undefined` when taxes haven't been calculated or aren't available for the\n * buyer's region.\n */\n totalTaxAmount: SubscribableSignalLike;\n\n /**\n * The minimum total at the current step of checkout. Costs not yet calculated, such as shipping on the information step, aren't included. Gift cards and store credits are excluded from this total.\n */\n totalAmount: SubscribableSignalLike;\n}" }, "CustomerPrivacy": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -112012,31 +112012,31 @@ "syntaxKind": "PropertySignature", "name": "analytics", "value": "boolean", - "description": "Whether analytics data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Analytics data includes how the shop was used and what interactions occurred." + "description": "Whether analytics data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Analytics data includes how the shop was used and what interactions occurred.\n\nWhether analytics data can be collected right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.analytics`, before calling `shopify.analytics.publish()`." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "marketing", "value": "boolean", - "description": "Whether marketing data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Marketing data includes attribution and targeted advertising preferences." + "description": "Whether marketing data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Marketing data includes attribution and targeted advertising preferences.\n\nWhether marketing data can be collected right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.marketing`, before performing marketing-related data collection." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "preferences", "value": "boolean", - "description": "Whether preference data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Preference data includes language, currency, and sizing choices." + "description": "Whether preference data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Preference data includes language, currency, and sizing choices.\n\nWhether preference data can be collected right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.preferences`, before storing or reading buyer preference data." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "saleOfData", "value": "boolean", - "description": "Whether data can be shared with third parties based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. This typically applies to behavioral advertising data." + "description": "Whether data can be shared with third parties based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. This typically applies to behavioral advertising data.\n\nWhether buyer data can be shared with or sold to third parties right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.saleOfData`, before sharing or selling buyer data with third parties." } ], - "value": "export interface AllowedProcessing {\n /**\n * Whether analytics data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Analytics\n * data includes how the shop was used and what interactions occurred.\n */\n analytics: boolean;\n /**\n * Whether marketing data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Marketing\n * data includes attribution and targeted advertising preferences.\n */\n marketing: boolean;\n /**\n * Whether preference data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Preference\n * data includes language, currency, and sizing choices.\n */\n preferences: boolean;\n /**\n * Whether data can be shared with third parties based on the visitor's\n * consent, the merchant's privacy configuration, and the visitor's region.\n * This typically applies to behavioral advertising data.\n */\n saleOfData: boolean;\n}" + "value": "export interface AllowedProcessing {\n /**\n * Whether analytics data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Analytics\n * data includes how the shop was used and what interactions occurred.\n *\n * Whether analytics data can be collected right now. Combines the buyer's\n * consent, the merchant's privacy configuration, and the buyer's region into\n * a single boolean. Check this flag, not `visitorConsent.analytics`, before\n * calling `shopify.analytics.publish()`.\n */\n analytics: boolean;\n /**\n * Whether marketing data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Marketing\n * data includes attribution and targeted advertising preferences.\n *\n * Whether marketing data can be collected right now. Combines the buyer's\n * consent, the merchant's privacy configuration, and the buyer's region into\n * a single boolean. Check this flag, not `visitorConsent.marketing`, before\n * performing marketing-related data collection.\n */\n marketing: boolean;\n /**\n * Whether preference data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Preference\n * data includes language, currency, and sizing choices.\n *\n * Whether preference data can be collected right now. Combines the buyer's\n * consent, the merchant's privacy configuration, and the buyer's region into\n * a single boolean. Check this flag, not `visitorConsent.preferences`,\n * before storing or reading buyer preference data.\n */\n preferences: boolean;\n /**\n * Whether data can be shared with third parties based on the visitor's\n * consent, the merchant's privacy configuration, and the visitor's region.\n * This typically applies to behavioral advertising data.\n *\n * Whether buyer data can be shared with or sold to third parties right now.\n * Combines the buyer's consent, the merchant's privacy configuration, and\n * the buyer's region into a single boolean. Check this flag, not\n * `visitorConsent.saleOfData`, before sharing or selling buyer data with\n * third parties.\n */\n saleOfData: boolean;\n}" }, "TrackingConsentMetafield": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -112728,7 +112728,7 @@ "Extension": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Extension", - "description": "The meta information about an extension target.", + "description": "Metadata about the running extension, including its API version, target, capabilities, and editor context. Use this to read configuration details or conditionally render content based on where the extension is running.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -112754,7 +112754,7 @@ "syntaxKind": "PropertySignature", "name": "capabilities", "value": "SubscribableSignalLike", - "description": "The allowed capabilities of the extension, defined in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n\n* [`api_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#api-access): the extension can access the Storefront API.\n\n* [`network_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access): the extension can make external network calls.\n\n* [`block_progress`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n\n* [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n\n* [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can register customer consent decisions that are honored on Shopify-managed services.\n\n* [`iframe.sources`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#iframe): the extension can embed an external URL in an iframe." + "description": "The allowed capabilities of the extension, defined in your [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -112802,7 +112802,7 @@ "syntaxKind": "PropertySignature", "name": "version", "value": "string", - "description": "The published version of the running extension target.\n\nFor unpublished extensions, the value is `undefined`.", + "description": "The published version of the running extension target.\n\nFor unpublished extensions, the value is `undefined`.\n\nDon't use this property as a stable identifier in development environments. It becomes available only after the extension is published.", "isOptional": true, "examples": [ { @@ -112818,7 +112818,7 @@ ] } ], - "value": "export interface Extension {\n /**\n * The API version that was set in the extension config file.\n *\n * @example '2024-10', '2025-01', '2025-04', '2025-07', '2025-10'\n */\n apiVersion: ApiVersion;\n\n /**\n * The allowed capabilities of the extension, defined\n * in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n *\n * * [`api_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#api-access): the extension can access the Storefront API.\n *\n * * [`network_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access): the extension can make external network calls.\n *\n * * [`block_progress`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n *\n * * [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n *\n * * [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can register customer consent decisions that are honored on Shopify-managed services.\n *\n * * [`iframe.sources`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#iframe): the extension can embed an external URL in an iframe.\n */\n capabilities: SubscribableSignalLike;\n\n /**\n * Information about the editor where the extension is being rendered.\n *\n * If the value is undefined, then the extension isn't running in an editor.\n */\n editor?: Editor;\n\n /**\n * A Boolean to show whether your extension is currently rendered to the screen.\n *\n * Shopify might render your extension before it's visible in the UI,\n * typically to pre-render extensions that appear on a later step of the\n * checkout.\n *\n * Your extension might also continue to run after the customer has navigated away\n * from where it was rendered. The extension continues running so that\n * your extension is immediately available to render if the customer navigates back.\n */\n rendered: SubscribableSignalLike;\n\n /**\n * The URL to the script that started the extension target.\n */\n scriptUrl: string;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n */\n target: Target;\n\n /**\n * The published version of the running extension target.\n *\n * For unpublished extensions, the value is `undefined`.\n *\n * @example 3.0.10\n */\n version?: string;\n}" + "value": "export interface Extension {\n /**\n * The API version that was set in the extension config file.\n *\n * @example '2024-10', '2025-01', '2025-04', '2025-07', '2025-10'\n */\n apiVersion: ApiVersion;\n\n /**\n * The allowed capabilities of the extension, defined in your\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n */\n capabilities: SubscribableSignalLike;\n\n /**\n * Information about the editor where the extension is being rendered.\n *\n * If the value is undefined, then the extension isn't running in an editor.\n */\n editor?: Editor;\n\n /**\n * A Boolean to show whether your extension is currently rendered to the screen.\n *\n * Shopify might render your extension before it's visible in the UI,\n * typically to pre-render extensions that appear on a later step of the\n * checkout.\n *\n * Your extension might also continue to run after the customer has navigated away\n * from where it was rendered. The extension continues running so that\n * your extension is immediately available to render if the customer navigates back.\n */\n rendered: SubscribableSignalLike;\n\n /**\n * The URL to the script that started the extension target.\n */\n scriptUrl: string;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n */\n target: Target;\n\n /**\n * The published version of the running extension target.\n *\n * For unpublished extensions, the value is `undefined`.\n *\n * Don't use this property as a stable identifier in development environments.\n * It becomes available only after the extension is published.\n *\n * @example 3.0.10\n */\n version?: string;\n}" }, "ApiVersion": { "filePath": "src/shared.ts", @@ -112837,7 +112837,7 @@ "Editor": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Editor", - "description": "", + "description": "Information about the editor environment when an extension is rendered inside the checkout editor. The value is `undefined` when the extension is not rendering in an editor.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -112852,7 +112852,7 @@ "I18n": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18n", - "description": "", + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use the I18n API alongside the Localization API to build fully localized extensions.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -112888,7 +112888,7 @@ "I18nTranslate": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18nTranslate", - "description": "This returns a translated string matching a key in a locale file.", + "description": "Translates a key from your extension's locale files into a localized string. Supports interpolation with placeholder replacements and pluralization via the special `count` option.", "members": [], "value": "export interface I18nTranslate {\n (\n key: string,\n options?: Record,\n ): ReplacementType extends string | number\n ? string\n : (string | ReplacementType)[];\n}" }, @@ -113452,14 +113452,14 @@ "Localization": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Localization", - "description": "", + "description": "The buyer's language, country, currency, and timezone context. Use this to adapt your extension to the buyer's region and display localized content.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "country", "value": "SubscribableSignalLike", - "description": "The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown." + "description": "The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n\nDerived from the buyer's shipping address. Returns `undefined` until the buyer enters a shipping address." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -113487,18 +113487,18 @@ "syntaxKind": "PropertySignature", "name": "market", "value": "SubscribableSignalLike", - "description": "The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n\n> Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.", - "deprecationMessage": "Deprecated as of version `2025-04`" + "description": "The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. The market context updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.", + "deprecationMessage": "Merchants now manage which extensions load for each\nmarket, so extensions no longer need to check this value." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "timezone", "value": "SubscribableSignalLike", - "description": "The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time." + "description": "The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time." } ], - "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n *\n * > Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" + "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n *\n * Derived from the buyer's shipping address. Returns `undefined` until the\n * buyer enters a shipping address.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout,\n * carried over from the cart context. Markets group countries and\n * regions with shared pricing, languages, and domains. The market\n * context updates when the buyer changes the country of their\n * shipping address. The value is `undefined` if the market is unknown.\n *\n * @deprecated Merchants now manage which extensions load for each\n * market, so extensions no longer need to check this value.\n */\n market: SubscribableSignalLike;\n}" }, "Country": { "filePath": "src/shared.ts", @@ -113699,7 +113699,7 @@ "SessionToken": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SessionToken", - "description": "", + "description": "Authenticates requests between your extension and your app backend. Use session tokens to verify the identity of the buyer and the shop context when making server-side API calls. The token is a signed JWT that contains claims such as the customer ID, shop domain, and expiration.\n\nThe `sub` claim in the decoded token is present only when the buyer is logged in and the app has permission to read customer accounts. Absent for anonymous buyers.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -113958,7 +113958,7 @@ "Shop": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Shop", - "description": "", + "description": "Metadata about the merchant's store, including its name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -113998,30 +113998,30 @@ "syntaxKind": "PropertySignature", "name": "storefrontUrl", "value": "string", - "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n\n> Caution: > As of version `2024-04` this value no longer has a trailing slash.", + "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.", "isOptional": true } ], - "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n *\n * > Caution:\n * > As of version `2024-04` this value no longer has a trailing slash.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom domain.\n */\n myshopifyDomain: string;\n}" + "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom domain.\n */\n myshopifyDomain: string;\n}" }, "Storage": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Storage", - "description": "A key-value storage object for the extension.\n\nStored data is available only to this specific extension and any of its instances.\n\nThe storage backend is implemented with `localStorage` and should persist across the buyer's checkout session. However, data persistence isn't guaranteed.", + "description": "Key-value storage for a specific extension. Use storage to save preferences or cached data that should survive page reloads without requiring a backend call. Stored data is only available to this specific extension. The storage backend is implemented with `localStorage` and data persistence isn't guaranteed.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "delete", "value": "(key: string) => Promise", - "description": "Delete stored data by key." + "description": "Deletes a previously stored value by key." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "read", "value": "(key: string) => Promise", - "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original primitive.\n\nReturns `null` if no stored data exists." + "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original type.\n\nReturns the stored value for the given key, or `null` when no value exists. Doesn't throw on a missing key." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -114031,7 +114031,7 @@ "description": "Write stored data for this key.\n\nThe data must be serializable to JSON." } ], - "value": "export interface Storage {\n /**\n * Read and return a stored value by key.\n *\n * The stored data is deserialized from JSON and returned as\n * its original primitive.\n *\n * Returns `null` if no stored data exists.\n */\n read(key: string): Promise;\n\n /**\n * Write stored data for this key.\n *\n * The data must be serializable to JSON.\n */\n write(key: string, data: any): Promise;\n\n /**\n * Delete stored data by key.\n */\n delete(key: string): Promise;\n}" + "value": "export interface Storage {\n /**\n * Read and return a stored value by key.\n *\n * The stored data is deserialized from JSON and returned as\n * its original type.\n *\n * Returns the stored value for the given key, or `null` when no value\n * exists. Doesn't throw on a missing key.\n */\n read(key: string): Promise;\n\n /**\n * Write stored data for this key.\n *\n * The data must be serializable to JSON.\n */\n write(key: string, data: any): Promise;\n\n /**\n * Deletes a previously stored value by key.\n */\n delete(key: string): Promise;\n}" }, "Version": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -114168,7 +114168,7 @@ "syntaxKind": "MethodSignature", "name": "applyAttributeChange", "value": "(change: AttributeChange) => Promise", - "description": "Updates or removes an attribute on the cart and checkout. On success, the [`attributes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/attributes#standardapi-propertydetail-attributes) property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.", + "description": "Updates or removes an attribute on the cart and checkout. On success, the [`attributes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/attributes#properties-propertydetail-attributes) property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.", "deprecationMessage": "Use cart metafields instead." }, { @@ -114176,42 +114176,42 @@ "syntaxKind": "MethodSignature", "name": "applyCartLinesChange", "value": "(change: CartLineChange) => Promise", - "description": "Adds, removes, or updates line items in the cart. The returned promise resolves when the change has been applied by the server, and the [`lines`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-lines#standardapi-propertydetail-lines) property updates with the new state.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Adds, removes, or updates line items in the cart. The returned promise resolves when the change has been applied by the server, and the [`lines`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-lines#properties-propertydetail-lines) property updates with the new state.\n\nAccepts a single change per call. To make multiple changes, call this method separately for each one.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyDiscountCodeChange", "value": "(change: DiscountCodeChange) => Promise", - "description": "Adds or removes a discount code on the checkout. The returned promise resolves when the change has been applied by the server, and the [`discountCodes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/discounts#standardapi-propertydetail-discountcodes) property updates with the new state.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves discount codes through a network call.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Adds or removes a discount code on the checkout. The returned promise resolves when the change has been applied by the server, and the [`discountCodes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/discounts#properties-propertydetail-discountcodes) property updates with the new state.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves discount codes through a network call.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyGiftCardChange", "value": "(change: GiftCardChange) => Promise", - "description": "Adds or removes a gift card from the checkout. The returned promise resolves when the change has been applied by the server, and the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/gift-cards#standardapi-propertydetail-appliedgiftcards) property updates with the new state.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves gift card codes through a network call.\n\n> Note: This method returns an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Adds or removes a gift card from the checkout. The returned promise resolves when the change has been applied by the server, and the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/gift-cards#properties-propertydetail-appliedgiftcards) property updates with the new state.\n\nUnlike other write operations, gift card changes aren't gated by a cart instruction flag.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves gift card codes through a network call.\n\n> Note: This method returns an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyMetafieldChange", "value": "(change: MetafieldChange) => Promise", - "description": "Creates, updates, or removes a cart metafield on the checkout. On success, the [`metafields`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/metafields#standardapi-propertydetail-metafields) property updates to reflect the change.\n\nCart metafields are copied to order metafields at order creation time if there's a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n\n> Caution: `MetafieldRemoveChange` and `MetafieldUpdateChange` are deprecated. Use cart metafields with `MetafieldRemoveCartChange` and `MetafieldUpdateCartChange` instead. If `MetafieldUpdateChange` writes a metafield with the same namespace and key as a cart metafield that's configured to copy, the cart metafield won't be copied.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Creates, updates, or removes a cart metafield on the checkout. On success, the [`metafields`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/metafields#properties-propertydetail-metafields) property updates to reflect the change.\n\nCart metafields are copied to order metafields at order creation time if there's a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n\n> Caution: `MetafieldRemoveChange` and `MetafieldUpdateChange` are deprecated. Use cart metafields with `MetafieldRemoveCartChange` and `MetafieldUpdateCartChange` instead. If `MetafieldUpdateChange` writes a metafield with the same namespace and key as a cart metafield that's configured to copy, the cart metafield won't be copied.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyNoteChange", "value": "(change: NoteChange) => Promise", - "description": "Sets or removes the buyer's note on the checkout. On success, the [`note`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/note#standardapi-propertydetail-note) property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Sets or removes the buyer's note on the checkout. On success, the [`note`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/note#properties-propertydetail-note) property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyShippingAddressChange", "value": "(change: ShippingAddressUpdateChange) => Promise", - "description": "Updates the buyer's shipping address on the checkout. The provided fields are merged into the existing address without prompting the buyer. On success, the `shippingAddress` property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", + "description": "Updates the buyer's shipping address on the checkout. The provided fields are merged into the existing address without prompting the buyer. On success, the `shippingAddress` property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", "isOptional": true }, { @@ -114224,7 +114224,7 @@ "isPrivate": true } ], - "value": "export interface CheckoutApi {\n /**\n * Updates or removes an attribute on the cart and checkout. On success, the\n * [`attributes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/attributes#standardapi-propertydetail-attributes) property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * @deprecated Use cart metafields instead.\n */\n applyAttributeChange(change: AttributeChange): Promise;\n\n /**\n * Adds, removes, or updates line items in the cart. The returned promise resolves when the change has been applied by the server, and the [`lines`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-lines#standardapi-propertydetail-lines) property updates with the new state.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyCartLinesChange(change: CartLineChange): Promise;\n\n /**\n * Adds or removes a discount code on the checkout. The returned promise resolves when the change has been applied by the server, and the [`discountCodes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/discounts#standardapi-propertydetail-discountcodes) property updates with the new state.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves discount codes through a network call.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyDiscountCodeChange(\n change: DiscountCodeChange,\n ): Promise;\n\n /**\n * Adds or removes a gift card from the checkout. The returned promise resolves when the change has been applied by the server, and the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/gift-cards#standardapi-propertydetail-appliedgiftcards) property updates with the new state.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves gift card codes through a network call.\n *\n * > Note: This method returns an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyGiftCardChange(change: GiftCardChange): Promise;\n\n /**\n * Creates, updates, or removes a cart metafield on the checkout. On success, the\n * [`metafields`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/metafields#standardapi-propertydetail-metafields) property updates to reflect the change.\n *\n * Cart metafields are copied to order metafields at order creation time if there's a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n *\n * > Caution: `MetafieldRemoveChange` and `MetafieldUpdateChange` are deprecated. Use cart metafields with `MetafieldRemoveCartChange` and `MetafieldUpdateCartChange` instead. If `MetafieldUpdateChange` writes a metafield with the same namespace and key as a cart metafield that's configured to copy, the cart metafield won't be copied.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyMetafieldChange(change: MetafieldChange): Promise;\n\n /**\n * Sets or removes the buyer's note on the checkout. On success, the\n * [`note`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/note#standardapi-propertydetail-note)\n * property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyNoteChange(change: NoteChange): Promise;\n\n /**\n * @private\n */\n experimentalIsShopAppStyle?: boolean;\n\n /**\n * Updates the buyer's shipping address on the checkout. The provided fields\n * are merged into the existing address without prompting the buyer. On success,\n * the `shippingAddress` property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyShippingAddressChange?(\n change: ShippingAddressChange,\n ): Promise;\n}" + "value": "export interface CheckoutApi {\n /**\n * Updates or removes an attribute on the cart and checkout. On success, the\n * [`attributes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/attributes#properties-propertydetail-attributes) property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * @deprecated Use cart metafields instead.\n */\n applyAttributeChange(change: AttributeChange): Promise;\n\n /**\n * Adds, removes, or updates line items in the cart. The returned promise resolves when the change has been applied by the server, and the [`lines`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-lines#properties-propertydetail-lines) property updates with the new state.\n *\n * Accepts a single change per call. To make multiple changes, call this\n * method separately for each one.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyCartLinesChange(change: CartLineChange): Promise;\n\n /**\n * Adds or removes a discount code on the checkout. The returned promise resolves when the change has been applied by the server, and the [`discountCodes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/discounts#properties-propertydetail-discountcodes) property updates with the new state.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves discount codes through a network call.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyDiscountCodeChange(\n change: DiscountCodeChange,\n ): Promise;\n\n /**\n * Adds or removes a gift card from the checkout. The returned promise resolves when the change has been applied by the server, and the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/gift-cards#properties-propertydetail-appliedgiftcards) property updates with the new state.\n *\n * Unlike other write operations, gift card changes aren't gated by a cart\n * instruction flag.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves gift card codes through a network call.\n *\n * > Note: This method returns an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyGiftCardChange(change: GiftCardChange): Promise;\n\n /**\n * Creates, updates, or removes a cart metafield on the checkout. On success, the\n * [`metafields`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/metafields#properties-propertydetail-metafields) property updates to reflect the change.\n *\n * Cart metafields are copied to order metafields at order creation time if there's a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n *\n * > Caution: `MetafieldRemoveChange` and `MetafieldUpdateChange` are deprecated. Use cart metafields with `MetafieldRemoveCartChange` and `MetafieldUpdateCartChange` instead. If `MetafieldUpdateChange` writes a metafield with the same namespace and key as a cart metafield that's configured to copy, the cart metafield won't be copied.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyMetafieldChange(change: MetafieldChange): Promise;\n\n /**\n * Sets or removes the buyer's note on the checkout. On success, the\n * [`note`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/note#properties-propertydetail-note)\n * property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyNoteChange(change: NoteChange): Promise;\n\n /**\n * @private\n */\n experimentalIsShopAppStyle?: boolean;\n\n /**\n * Updates the buyer's shipping address on the checkout. The provided fields\n * are merged into the existing address without prompting the buyer. On success,\n * the `shippingAddress` property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyShippingAddressChange?(\n change: ShippingAddressChange,\n ): Promise;\n}" }, "AttributeChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -114291,7 +114291,7 @@ "syntaxKind": "PropertySignature", "name": "value", "value": "string", - "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.", + "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.\n\nAttribute values are always strings. To store structured data, serialize it to JSON and parse it when reading.", "examples": [ { "title": "Example", @@ -114306,7 +114306,7 @@ ] } ], - "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" + "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * Attribute values are always strings. To store structured data, serialize\n * it to JSON and parse it when reading.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" }, "AttributeRemoveChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -115159,7 +115159,7 @@ "syntaxKind": "PropertySignature", "name": "message", "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer." + "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer.\n\nRender your own localized error text rather than displaying this message to the buyer." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -115169,7 +115169,7 @@ "description": "Indicates that the line item wasn't changed successfully. Refer to the `message` property for details about the error." } ], - "value": "export interface CartLineChangeResultError {\n /**\n * Indicates that the line item wasn't changed successfully. Refer to the `message` property for details about the error.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface CartLineChangeResultError {\n /**\n * Indicates that the line item wasn't changed successfully. Refer to the `message` property for details about the error.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n *\n * Render your own localized error text rather than displaying this message\n * to the buyer.\n */\n message: string;\n}" }, "DiscountCodeChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -115349,7 +115349,7 @@ "syntaxKind": "PropertySignature", "name": "message", "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer." + "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer.\n\nRender your own localized error text rather than displaying this message to the buyer." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -115359,7 +115359,7 @@ "description": "Indicates that the gift card change couldn't be applied. Check the `message` property for details." } ], - "value": "export interface GiftCardChangeResultError {\n /**\n * Indicates that the gift card change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface GiftCardChangeResultError {\n /**\n * Indicates that the gift card change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n *\n * Render your own localized error text rather than displaying this message\n * to the buyer.\n */\n message: string;\n}" }, "MetafieldChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -115620,7 +115620,7 @@ "syntaxKind": "PropertySignature", "name": "message", "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer." + "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer.\n\nRender your own localized error text rather than displaying this message to the buyer." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -115630,7 +115630,7 @@ "description": "Indicates that the metafield change couldn't be applied. Check the `message` property for details." } ], - "value": "export interface MetafieldChangeResultError {\n /**\n * Indicates that the metafield change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface MetafieldChangeResultError {\n /**\n * Indicates that the metafield change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n *\n * Render your own localized error text rather than displaying this message\n * to the buyer.\n */\n message: string;\n}" }, "NoteChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -115708,7 +115708,7 @@ "syntaxKind": "PropertySignature", "name": "message", "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer." + "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer.\n\nRender your own localized error text rather than displaying this message to the buyer." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -115718,7 +115718,7 @@ "description": "Indicates that the note change couldn't be applied. Check the `message` property for details." } ], - "value": "export interface NoteChangeResultError {\n /**\n * Indicates that the note change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface NoteChangeResultError {\n /**\n * Indicates that the note change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n *\n * Render your own localized error text rather than displaying this message\n * to the buyer.\n */\n message: string;\n}" }, "ShippingAddressUpdateChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -116304,7 +116304,7 @@ "syntaxKind": "PropertySignature", "name": "analytics", "value": "Analytics", - "description": "The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event." + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -116318,7 +116318,7 @@ "syntaxKind": "PropertySignature", "name": "applyTrackingConsentChange", "value": "ApplyTrackingConsentChangeType", - "description": "Enables setting and updating customer privacy consent settings and tracking consent metafields.\n\n> Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent) to be set to `true`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." + "description": "Enables setting and updating customer privacy consent settings and tracking consent metafields.\n\n> Note: Requires the [`collect_buyer_consent` capability](/docs/apps/build/customer-accounts/capabilities#collect-buyer-consent) to be set to `true`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -116339,7 +116339,7 @@ "syntaxKind": "PropertySignature", "name": "availablePaymentOptions", "value": "SubscribableSignalLike", - "description": "All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region." + "description": "All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n\nThe set of payment options can change when the buyer updates their address or cart, so subscribe to changes rather than reading once during initialization. Each option exposes `handle` and `type` only. Provider names, logos, fees, and installment terms aren't available." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -116376,7 +116376,7 @@ "syntaxKind": "PropertySignature", "name": "checkoutToken", "value": "SubscribableSignalLike", - "description": "A stable ID that represents the current checkout.\n\nThe value is `undefined` when the checkout hasn't been created on the server yet.\n\nUse this to correlate checkout sessions across your extension, web pixels, and backend systems.\n\nThis matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data) and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object)." + "description": "A stable ID that represents the current checkout.\n\nThe value is `undefined` when the checkout hasn't been created on the server yet.\n\nUse this to correlate checkout sessions across your extension, web pixels, and backend systems.\n\nThis matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data) and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n\nCan be `undefined`. Handle the `undefined` state before using the value." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -116397,7 +116397,7 @@ "syntaxKind": "PropertySignature", "name": "deliveryGroups", "value": "SubscribableSignalLike", - "description": "The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items." + "description": "The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n\nEmpty until the buyer enters enough address information for Shopify to calculate shipping rates." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -116418,7 +116418,7 @@ "syntaxKind": "PropertySignature", "name": "extension", "value": "Extension", - "description": "The meta information about the extension." + "description": "Metadata about the running extension, including the current target, API version, capabilities, and editor context. Use this to conditionally render content based on where the extension is running." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -116426,7 +116426,7 @@ "name": "extensionPoint", "value": "Target", "description": "The identifier that specifies where in Shopify's UI your code is being injected. This is one of the targets you've included in your extension's configuration file.", - "deprecationMessage": "Deprecated as of version `2023-07`, use `extension.target` instead.", + "deprecationMessage": "Use `extension.target` instead.", "examples": [ { "title": "Example", @@ -116445,14 +116445,14 @@ "syntaxKind": "PropertySignature", "name": "i18n", "value": "I18n", - "description": "Utilities for translating content and formatting values according to the current [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) of the checkout.\n\nRefer to [`localization` examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples) for more information." + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use alongside [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) to build fully localized extensions." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "instructions", "value": "SubscribableSignalLike", - "description": "The cart instructions used to create the checkout and possibly limit extension capabilities.\n\nThese instructions should be checked before performing any actions that might be affected by them.\n\nFor example, if you intend to add a discount code via the `applyDiscountCodeChange` method, check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n\n> Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs aren't available. See the [update guide](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples) for more information." + "description": "The cart instructions used to create the checkout and possibly limit extension capabilities.\n\nThese instructions should be checked before performing any actions that might be affected by them.\n\nFor example, if you intend to add a discount code via the `applyDiscountCodeChange` method, check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n\n> Caution: Check cart instructions before calling select APIs, as > some may not be available. See the > [Cart Instructions API](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples) > for more information." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -116466,7 +116466,7 @@ "syntaxKind": "PropertySignature", "name": "localization", "value": "Localization", - "description": "The details about the location, language, and currency of the customer. For utilities to easily format and translate content based on these details, you can use the [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n) object instead." + "description": "The buyer's language, country, currency, and timezone context. For formatting and translation helpers, use the [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#properties-propertydetail-i18n) object instead." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -116496,21 +116496,21 @@ "syntaxKind": "PropertySignature", "name": "query", "value": ">(query: string, options?: { variables?: Variables; version?: StorefrontApiVersion; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>", - "description": "The method used to query the Storefront GraphQL API with a prefetched token.\n\nRefer to [Storefront API access examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/storefront-api) for more information." + "description": "The method used to query the Storefront GraphQL API with a prefetched token." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "selectedPaymentOptions", "value": "SubscribableSignalLike", - "description": "The payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card)." + "description": "The payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\n\nEach option exposes `handle` and `type` only. Provider names, logos, fees, and installment terms aren't available." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "sessionToken", "value": "SessionToken", - "description": "The session token providing a set of claims as a signed JSON Web Token (JWT).\n\nThe token has a TTL of five minutes.\n\nIf the previous token expires, this value reflects a new session token with a new signature and expiry.\n\nRefer to [session token examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/session-token) for more information." + "description": "The session token providing a set of claims as a signed JSON Web Token (JWT).\n\nThe token has a TTL of five minutes.\n\nIf the previous token expires, this value reflects a new session token with a new signature and expiry.\n\nLearn more about [session tokens](/docs/apps/build/authentication-authorization/session-tokens)." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -116532,14 +116532,14 @@ "syntaxKind": "PropertySignature", "name": "shop", "value": "Shop", - "description": "The shop where the checkout is taking place." + "description": "The store where the checkout is taking place, including the shop name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "storage", "value": "Storage", - "description": "The key-value storage for the extension.\n\nIt uses `localStorage` and should persist across the customer's current checkout session.\n\n> Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n\nData is shared across all activated extension targets of this extension. In versions 2023-07 and earlier, each activated extension target had its own storage." + "description": "Key-value storage that persists across page loads within the current checkout session. Data is shared across all activated targets associated with this extension.\n\n> Caution: Data persistence isn't guaranteed and storage is cleared when the buyer starts a new checkout." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -116561,29 +116561,29 @@ ] } ], - "value": "export interface StandardApi {\n /**\n * The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event.\n */\n analytics: Analytics;\n\n /**\n * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\n */\n appliedGiftCards: SubscribableSignalLike;\n\n /**\n * The cart instructions used to create the checkout and possibly limit extension capabilities.\n *\n * These instructions should be checked before performing any actions that might be affected by them.\n *\n * For example, if you intend to add a discount code via the `applyDiscountCodeChange` method,\n * check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n *\n * > Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs aren't available.\n * See the [update guide](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples) for more information.\n *\n */\n instructions: SubscribableSignalLike;\n\n /**\n * The metafields requested in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration)\n * file. These metafields are updated when there's a change in the merchandise items\n * being purchased by the customer.\n *\n * App owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` isn't supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n appMetafields: SubscribableSignalLike;\n\n /**\n * The custom key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n buyerIdentity?: BuyerIdentity;\n\n /**\n * Provides details on the buyer's progression through the checkout and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/buyer-journey#examples)\n * examples for more information.\n */\n buyerJourney: BuyerJourney;\n\n /**\n * Settings applied to the buyer's checkout.\n */\n checkoutSettings: SubscribableSignalLike;\n\n /**\n * A stable ID that represents the current checkout.\n *\n * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\n *\n * This matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data)\n * and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n */\n checkoutToken: SubscribableSignalLike;\n\n /**\n * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * The meta information about the extension.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n *\n * @deprecated Deprecated as of version `2023-07`, use `extension.target` instead.\n */\n extensionPoint: Target;\n\n /**\n * Utilities for translating content and formatting values according to the current\n * [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization)\n * of the checkout.\n *\n * Refer to [`localization` examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples)\n * for more information.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The details about the location, language, and currency of the customer. For utilities to easily\n * format and translate content based on these details, you can use the\n * [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n)\n * object instead.\n */\n localization: Localization;\n\n /**\n * The metafields that apply to the current checkout.\n *\n * Metafields are stored locally on the client and are applied to the order object after the checkout completes.\n *\n * These metafields are shared by all extensions running on checkout, and\n * persist for as long as the customer is working on this checkout.\n *\n * Once the order is created, you can query these metafields using the\n * [GraphQL Admin API](/docs/admin-api/graphql/reference/orders/order#metafield-2021-01)\n *\n * > Caution:\n * `metafields` is deprecated. Use `appMetafields` with cart metafields instead.\n *\n * @deprecated Use `appMetafields` with cart metafields instead.\n */\n metafields: SubscribableSignalLike;\n\n /**\n * A note left by the customer to the merchant, either in their cart or during checkout.\n *\n * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\n */\n note: SubscribableSignalLike;\n\n /**\n * The method used to query the Storefront GraphQL API with a prefetched token.\n *\n * Refer to [Storefront API access examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/storefront-api) for more information.\n */\n query: >(\n query: string,\n options?: {variables?: Variables; version?: StorefrontApiVersion},\n ) => Promise<{data?: Data; errors?: GraphQLError[]}>;\n\n /**\n * The payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\n */\n selectedPaymentOptions: SubscribableSignalLike;\n\n /**\n * The session token providing a set of claims as a signed JSON Web Token (JWT).\n *\n * The token has a TTL of five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/session-token) for more information.\n */\n sessionToken: SessionToken;\n\n /**\n * The settings matching the settings definition written in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates in real time as a merchant fills in the settings.\n */\n settings: SubscribableSignalLike;\n\n /**\n * The proposed customer shipping address. During the information step, the address\n * updates when the field is committed (on change) rather than every keystroke.\n * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n shippingAddress?: SubscribableSignalLike;\n\n /**\n * The proposed customer billing address. The address updates when the field is\n * committed (on change) rather than every keystroke. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided yet.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n billingAddress?: SubscribableSignalLike;\n\n /** The shop where the checkout is taking place. */\n shop: Shop;\n\n /**\n * The key-value storage for the extension.\n *\n * It uses `localStorage` and should persist across the customer's current checkout session.\n *\n * > Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n *\n * Data is shared across all activated extension targets of this extension. In versions 2023-07 and earlier,\n * each activated extension target had its own storage.\n */\n storage: Storage;\n\n /**\n * The renderer version being used for the extension.\n *\n * @example '2025-10'\n */\n version: Version;\n\n /**\n * Customer privacy consent settings and a flag denoting if consent has previously been collected.\n */\n customerPrivacy: SubscribableSignalLike;\n\n /**\n * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent) to be set to `true`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyTrackingConsentChange: ApplyTrackingConsentChangeType;\n\n /**\n * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" + "value": "export interface StandardApi {\n /**\n * Tracks custom events and sends visitor information to\n * [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events\n * and `visitor()` to submit buyer contact details.\n */\n analytics: Analytics;\n\n /**\n * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\n */\n appliedGiftCards: SubscribableSignalLike;\n\n /**\n * The cart instructions used to create the checkout and possibly limit extension capabilities.\n *\n * These instructions should be checked before performing any actions that might be affected by them.\n *\n * For example, if you intend to add a discount code via the `applyDiscountCodeChange` method,\n * check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n *\n * > Caution: Check cart instructions before calling select APIs, as\n * > some may not be available. See the\n * > [Cart Instructions API](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples)\n * > for more information.\n *\n */\n instructions: SubscribableSignalLike;\n\n /**\n * The metafields requested in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration)\n * file. These metafields are updated when there's a change in the merchandise items\n * being purchased by the customer.\n *\n * App owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` isn't supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n appMetafields: SubscribableSignalLike;\n\n /**\n * The custom key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as\n * credit cards, wallets, and local payment methods. The list depends on\n * the shop's payment configuration and the buyer's region.\n *\n * The set of payment options can change when the buyer updates their\n * address or cart, so subscribe to changes rather than reading once\n * during initialization. Each option exposes `handle` and `type` only.\n * Provider names, logos, fees, and installment terms aren't available.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n buyerIdentity?: BuyerIdentity;\n\n /**\n * Provides details on the buyer's progression through the checkout and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/buyer-journey#examples)\n * examples for more information.\n */\n buyerJourney: BuyerJourney;\n\n /**\n * Settings applied to the buyer's checkout.\n */\n checkoutSettings: SubscribableSignalLike;\n\n /**\n * A stable ID that represents the current checkout.\n *\n * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\n *\n * This matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data)\n * and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n *\n * Can be `undefined`. Handle the `undefined` state before using the value.\n */\n checkoutToken: SubscribableSignalLike;\n\n /**\n * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n *\n * Empty until the buyer enters enough address information for Shopify to\n * calculate shipping rates.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * Metadata about the running extension, including the current target, API version,\n * capabilities, and editor context. Use this to conditionally render content\n * based on where the extension is running.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n *\n * @deprecated Use `extension.target` instead.\n */\n extensionPoint: Target;\n\n /**\n * Utilities for translating strings, formatting currencies, numbers, and dates\n * according to the buyer's locale. Use alongside\n * [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization)\n * to build fully localized extensions.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The buyer's language, country, currency, and timezone context. For\n * formatting and translation helpers, use the\n * [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#properties-propertydetail-i18n)\n * object instead.\n */\n localization: Localization;\n\n /**\n * The metafields that apply to the current checkout.\n *\n * Metafields are stored locally on the client and are applied to the order object after the checkout completes.\n *\n * These metafields are shared by all extensions running on checkout, and\n * persist for as long as the customer is working on this checkout.\n *\n * Once the order is created, you can query these metafields using the\n * [GraphQL Admin API](/docs/admin-api/graphql/reference/orders/order#metafield-2021-01)\n *\n * > Caution:\n * `metafields` is deprecated. Use `appMetafields` with cart metafields instead.\n *\n * @deprecated Use `appMetafields` with cart metafields instead.\n */\n metafields: SubscribableSignalLike;\n\n /**\n * A note left by the customer to the merchant, either in their cart or during checkout.\n *\n * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\n */\n note: SubscribableSignalLike;\n\n /**\n * The method used to query the Storefront GraphQL API with a prefetched token.\n *\n */\n query: >(\n query: string,\n options?: {variables?: Variables; version?: StorefrontApiVersion},\n ) => Promise<{data?: Data; errors?: GraphQLError[]}>;\n\n /**\n * The payment options the buyer has currently selected. This updates as\n * the buyer changes their payment method. The array can contain multiple\n * entries when the buyer splits payment across methods (for example, a\n * gift card and a credit card).\n *\n * Each option exposes `handle` and `type` only. Provider names, logos,\n * fees, and installment terms aren't available.\n */\n selectedPaymentOptions: SubscribableSignalLike;\n\n /**\n * The session token providing a set of claims as a signed JSON Web Token (JWT).\n *\n * The token has a TTL of five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Learn more about [session tokens](/docs/apps/build/authentication-authorization/session-tokens).\n */\n sessionToken: SessionToken;\n\n /**\n * The settings matching the settings definition written in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates in real time as a merchant fills in the settings.\n */\n settings: SubscribableSignalLike;\n\n /**\n * The proposed customer shipping address. During the information step, the address\n * updates when the field is committed (on change) rather than every keystroke.\n * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n shippingAddress?: SubscribableSignalLike;\n\n /**\n * The proposed customer billing address. The address updates when the field is\n * committed (on change) rather than every keystroke. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided yet.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n billingAddress?: SubscribableSignalLike;\n\n /**\n * The store where the checkout is taking place, including the shop name,\n * storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.\n */\n shop: Shop;\n\n /**\n * Key-value storage that persists across page loads within the current checkout\n * session. Data is shared across all activated targets associated with\n * this extension.\n *\n * > Caution: Data persistence isn't guaranteed and storage is cleared when the\n * buyer starts a new checkout.\n */\n storage: Storage;\n\n /**\n * The renderer version being used for the extension.\n *\n * @example '2025-10'\n */\n version: Version;\n\n /**\n * Customer privacy consent settings and a flag denoting if consent has previously been collected.\n */\n customerPrivacy: SubscribableSignalLike;\n\n /**\n * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`collect_buyer_consent` capability](/docs/apps/build/customer-accounts/capabilities#collect-buyer-consent) to be set to `true`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyTrackingConsentChange: ApplyTrackingConsentChangeType;\n\n /**\n * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" }, "Analytics": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Analytics", - "description": "", + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "publish", "value": "(name: string, data: Record) => Promise", - "description": "Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing)." + "description": "Publishes a custom event to [Web Pixels](/docs/apps/marketing). Returns `true` when the event is successfully dispatched.\n\nThe Promise resolves to `true` when the event was dispatched. The boolean indicates dispatch confirmation only. It doesn't indicate whether any specific web pixel processed the event." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "visitor", "value": "(data: { email?: string; phone?: string; }) => Promise", - "description": "A method for capturing details about a visitor on the online store." + "description": "Submits buyer contact details for attribution and analytics purposes." } ], - "value": "export interface Analytics {\n /**\n * Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing).\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * A method for capturing details about a visitor on the online store.\n */\n visitor(data: {email?: string; phone?: string}): Promise;\n}" + "value": "export interface Analytics {\n /**\n * Publishes a custom event to [Web Pixels](/docs/apps/marketing).\n * Returns `true` when the event is successfully dispatched.\n *\n * The Promise resolves to `true` when the event was dispatched. The boolean\n * indicates dispatch confirmation only. It doesn't indicate whether any\n * specific web pixel processed the event.\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * Submits buyer contact details for attribution and analytics purposes.\n */\n visitor(data: {email?: string; phone?: string}): Promise;\n}" }, "VisitorResult": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -116624,10 +116624,10 @@ "syntaxKind": "PropertySignature", "name": "type", "value": "'error'", - "description": "Indicates that the visitor information is invalid and wasn't submitted. Examples are using the wrong data type or missing a required property." + "description": "Indicates that the visitor information is invalid and wasn't submitted. Common causes include using the wrong data type or omitting a required property." } ], - "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Examples are using the wrong data type or missing a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Common causes include using the wrong data type or omitting a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" }, "SubscribableSignalLike": { "filePath": "src/surfaces/checkout/shared.ts", @@ -116841,10 +116841,10 @@ "syntaxKind": "PropertySignature", "name": "value", "value": "string | null", - "description": "The new value to store in the metafield. Set to `null` to delete the metafield." + "description": "The new value to store in the metafield. Set to `null` to delete the metafield.\n\nConsent metafield values are strings, not booleans. Pass `null` to delete a tracking consent metafield." } ], - "value": "export interface TrackingConsentMetafieldChange {\n /**\n * The identifier for the tracking consent metafield to update.\n */\n key: string;\n /**\n * The new value to store in the metafield. Set to `null` to delete the metafield.\n */\n value: string | null;\n}" + "value": "export interface TrackingConsentMetafieldChange {\n /**\n * The identifier for the tracking consent metafield to update.\n */\n key: string;\n /**\n * The new value to store in the metafield. Set to `null` to delete the metafield.\n *\n * Consent metafield values are strings, not booleans. Pass `null` to delete\n * a tracking consent metafield.\n */\n value: string | null;\n}" }, "VisitorConsent": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -117058,7 +117058,7 @@ "syntaxKind": "PropertySignature", "name": "value", "value": "string", - "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.", + "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.\n\nAttribute values are always strings. To store structured data, serialize it to JSON and parse it when reading.", "examples": [ { "title": "Example", @@ -117073,7 +117073,7 @@ ] } ], - "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" + "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * Attribute values are always strings. To store structured data, serialize\n * it to JSON and parse it when reading.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" }, "PaymentOption": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -117424,7 +117424,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A globally-unique identifier for the customer in the format `gid://shopify/Customer/`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", + "description": "An identifier for the customer in the format `gid://shopify/Customer/`. This value is unique per shop.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", "examples": [ { "title": "Example", @@ -117477,7 +117477,7 @@ "isPrivate": true } ], - "value": "export interface Customer {\n /**\n * A globally-unique identifier for the customer in the format `gid://shopify/Customer/`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'gid://shopify/Customer/123'\n */\n id: string;\n /**\n * The email address associated with the customer's account. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email?: string;\n /**\n * The phone number associated with the customer's account. The value is `undefined` if no phone number is on file or the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone?: string;\n /**\n * The customer's full name, typically a combination of first and last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n fullName?: string;\n /**\n * The customer's first name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n firstName?: string;\n /**\n * The customer's last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n lastName?: string;\n /**\n * The customer's profile image, such as a Gravatar avatar. Use this to personalize the extension UI for the logged-in buyer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n image: ImageDetails;\n /**\n * Whether the customer has opted in to receiving marketing communications from the merchant, such as email campaigns and promotional offers.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * > Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n *\n * @deprecated Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n */\n acceptsMarketing: boolean;\n /**\n * Whether the customer has opted in to email marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsEmailMarketing: boolean;\n /**\n * Whether the customer has opted in to SMS marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsSmsMarketing: boolean;\n /**\n * The store credit accounts owned by this customer that can be used as payment during checkout. Each account has a balance representing available store credit.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @private\n */\n storeCreditAccounts: StoreCreditAccount[];\n /**\n * The number of orders the customer has previously placed with this shop.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n ordersCount: number;\n}" + "value": "export interface Customer {\n /**\n * An identifier for the customer in the format `gid://shopify/Customer/`. This value is unique per shop.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'gid://shopify/Customer/123'\n */\n id: string;\n /**\n * The email address associated with the customer's account. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email?: string;\n /**\n * The phone number associated with the customer's account. The value is `undefined` if no phone number is on file or the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone?: string;\n /**\n * The customer's full name, typically a combination of first and last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n fullName?: string;\n /**\n * The customer's first name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n firstName?: string;\n /**\n * The customer's last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n lastName?: string;\n /**\n * The customer's profile image, such as a Gravatar avatar. Use this to personalize the extension UI for the logged-in buyer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n image: ImageDetails;\n /**\n * Whether the customer has opted in to receiving marketing communications from the merchant, such as email campaigns and promotional offers.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * > Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n *\n * @deprecated Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n */\n acceptsMarketing: boolean;\n /**\n * Whether the customer has opted in to email marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsEmailMarketing: boolean;\n /**\n * Whether the customer has opted in to SMS marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsSmsMarketing: boolean;\n /**\n * The store credit accounts owned by this customer that can be used as payment during checkout. Each account has a balance representing available store credit.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @private\n */\n storeCreditAccounts: StoreCreditAccount[];\n /**\n * The number of orders the customer has previously placed with this shop.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n ordersCount: number;\n}" }, "ImageDetails": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -117759,11 +117759,11 @@ "syntaxKind": "MethodSignature", "name": "perform", "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", + "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.\n\nRuns after all intercept results are collected. Use it for local state updates such as setting an error flag. By the time it runs, the navigation decision is final, so blocking logic belongs in the intercept handler itself, not here.", "isOptional": true } ], - "value": "interface InterceptorRequestAllow {\n /**\n * Indicates that the interceptor allows the buyer's journey to continue.\n */\n behavior: 'allow';\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" + "value": "interface InterceptorRequestAllow {\n /**\n * Indicates that the interceptor allows the buyer's journey to continue.\n */\n behavior: 'allow';\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n *\n * Runs after all intercept results are collected. Use it for local state\n * updates such as setting an error flag. By the time it runs, the navigation\n * decision is final, so blocking logic belongs in the intercept handler\n * itself, not here.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" }, "InterceptorResult": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -117827,7 +117827,7 @@ "syntaxKind": "MethodSignature", "name": "perform", "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", + "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.\n\nRuns after all intercept results are collected. Use it for local state updates such as setting an error flag. By the time it runs, the navigation decision is final, so blocking logic belongs in the intercept handler itself, not here.", "isOptional": true }, { @@ -117838,7 +117838,7 @@ "description": "The reason for blocking the interceptor request. This value isn't presented to the buyer, so it doesn't need to be localized. The value is used only for Shopify's own internal debugging and metrics." } ], - "value": "interface InterceptorRequestBlock {\n /**\n * Indicates that the interceptor blocks the buyer's journey from continuing.\n */\n behavior: 'block';\n\n /**\n * The reason for blocking the interceptor request. This value isn't presented to\n * the buyer, so it doesn't need to be localized. The value is used only for Shopify's\n * own internal debugging and metrics.\n */\n reason: string;\n\n /**\n * Used to pass errors to the checkout UI, outside your extension's UI boundaries.\n */\n errors?: ValidationError[];\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" + "value": "interface InterceptorRequestBlock {\n /**\n * Indicates that the interceptor blocks the buyer's journey from continuing.\n */\n behavior: 'block';\n\n /**\n * The reason for blocking the interceptor request. This value isn't presented to\n * the buyer, so it doesn't need to be localized. The value is used only for Shopify's\n * own internal debugging and metrics.\n */\n reason: string;\n\n /**\n * Used to pass errors to the checkout UI, outside your extension's UI boundaries.\n */\n errors?: ValidationError[];\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n *\n * Runs after all intercept results are collected. Use it for local state\n * updates such as setting an error flag. By the time it runs, the navigation\n * decision is final, so blocking logic belongs in the intercept handler\n * itself, not here.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" }, "ValidationError": { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -118059,17 +118059,17 @@ "syntaxKind": "PropertySignature", "name": "totalShippingAmount", "value": "SubscribableSignalLike", - "description": "The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step." + "description": "The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step.\n\n`undefined` until the buyer selects a shipping method (typically after the information step)." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "totalTaxAmount", "value": "SubscribableSignalLike", - "description": "The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet." + "description": "The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet.\n\n`undefined` when taxes haven't been calculated or aren't available for the buyer's region." } ], - "value": "export interface CartCost {\n /**\n * The sum of all line item prices at the current step of checkout, before shipping and taxes are applied. Use this value to display the base cost of the items the buyer purchased.\n */\n subtotalAmount: SubscribableSignalLike;\n\n /**\n * The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step.\n */\n totalShippingAmount: SubscribableSignalLike;\n\n /**\n * The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet.\n */\n totalTaxAmount: SubscribableSignalLike;\n\n /**\n * The minimum total at the current step of checkout. Costs not yet calculated, such as shipping on the information step, aren't included. Gift cards and store credits are excluded from this total.\n */\n totalAmount: SubscribableSignalLike;\n}" + "value": "export interface CartCost {\n /**\n * The sum of all line item prices at the current step of checkout, before shipping and taxes are applied. Use this value to display the base cost of the items the buyer purchased.\n */\n subtotalAmount: SubscribableSignalLike;\n\n /**\n * The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step.\n *\n * `undefined` until the buyer selects a shipping method (typically after the\n * information step).\n */\n totalShippingAmount: SubscribableSignalLike;\n\n /**\n * The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet.\n *\n * `undefined` when taxes haven't been calculated or aren't available for the\n * buyer's region.\n */\n totalTaxAmount: SubscribableSignalLike;\n\n /**\n * The minimum total at the current step of checkout. Costs not yet calculated, such as shipping on the information step, aren't included. Gift cards and store credits are excluded from this total.\n */\n totalAmount: SubscribableSignalLike;\n}" }, "CustomerPrivacy": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -118156,31 +118156,31 @@ "syntaxKind": "PropertySignature", "name": "analytics", "value": "boolean", - "description": "Whether analytics data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Analytics data includes how the shop was used and what interactions occurred." + "description": "Whether analytics data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Analytics data includes how the shop was used and what interactions occurred.\n\nWhether analytics data can be collected right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.analytics`, before calling `shopify.analytics.publish()`." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "marketing", "value": "boolean", - "description": "Whether marketing data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Marketing data includes attribution and targeted advertising preferences." + "description": "Whether marketing data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Marketing data includes attribution and targeted advertising preferences.\n\nWhether marketing data can be collected right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.marketing`, before performing marketing-related data collection." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "preferences", "value": "boolean", - "description": "Whether preference data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Preference data includes language, currency, and sizing choices." + "description": "Whether preference data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Preference data includes language, currency, and sizing choices.\n\nWhether preference data can be collected right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.preferences`, before storing or reading buyer preference data." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "saleOfData", "value": "boolean", - "description": "Whether data can be shared with third parties based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. This typically applies to behavioral advertising data." + "description": "Whether data can be shared with third parties based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. This typically applies to behavioral advertising data.\n\nWhether buyer data can be shared with or sold to third parties right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.saleOfData`, before sharing or selling buyer data with third parties." } ], - "value": "export interface AllowedProcessing {\n /**\n * Whether analytics data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Analytics\n * data includes how the shop was used and what interactions occurred.\n */\n analytics: boolean;\n /**\n * Whether marketing data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Marketing\n * data includes attribution and targeted advertising preferences.\n */\n marketing: boolean;\n /**\n * Whether preference data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Preference\n * data includes language, currency, and sizing choices.\n */\n preferences: boolean;\n /**\n * Whether data can be shared with third parties based on the visitor's\n * consent, the merchant's privacy configuration, and the visitor's region.\n * This typically applies to behavioral advertising data.\n */\n saleOfData: boolean;\n}" + "value": "export interface AllowedProcessing {\n /**\n * Whether analytics data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Analytics\n * data includes how the shop was used and what interactions occurred.\n *\n * Whether analytics data can be collected right now. Combines the buyer's\n * consent, the merchant's privacy configuration, and the buyer's region into\n * a single boolean. Check this flag, not `visitorConsent.analytics`, before\n * calling `shopify.analytics.publish()`.\n */\n analytics: boolean;\n /**\n * Whether marketing data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Marketing\n * data includes attribution and targeted advertising preferences.\n *\n * Whether marketing data can be collected right now. Combines the buyer's\n * consent, the merchant's privacy configuration, and the buyer's region into\n * a single boolean. Check this flag, not `visitorConsent.marketing`, before\n * performing marketing-related data collection.\n */\n marketing: boolean;\n /**\n * Whether preference data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Preference\n * data includes language, currency, and sizing choices.\n *\n * Whether preference data can be collected right now. Combines the buyer's\n * consent, the merchant's privacy configuration, and the buyer's region into\n * a single boolean. Check this flag, not `visitorConsent.preferences`,\n * before storing or reading buyer preference data.\n */\n preferences: boolean;\n /**\n * Whether data can be shared with third parties based on the visitor's\n * consent, the merchant's privacy configuration, and the visitor's region.\n * This typically applies to behavioral advertising data.\n *\n * Whether buyer data can be shared with or sold to third parties right now.\n * Combines the buyer's consent, the merchant's privacy configuration, and\n * the buyer's region into a single boolean. Check this flag, not\n * `visitorConsent.saleOfData`, before sharing or selling buyer data with\n * third parties.\n */\n saleOfData: boolean;\n}" }, "TrackingConsentMetafield": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -118872,7 +118872,7 @@ "Extension": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Extension", - "description": "The meta information about an extension target.", + "description": "Metadata about the running extension, including its API version, target, capabilities, and editor context. Use this to read configuration details or conditionally render content based on where the extension is running.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -118898,7 +118898,7 @@ "syntaxKind": "PropertySignature", "name": "capabilities", "value": "SubscribableSignalLike", - "description": "The allowed capabilities of the extension, defined in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n\n* [`api_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#api-access): the extension can access the Storefront API.\n\n* [`network_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access): the extension can make external network calls.\n\n* [`block_progress`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n\n* [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n\n* [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can register customer consent decisions that are honored on Shopify-managed services.\n\n* [`iframe.sources`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#iframe): the extension can embed an external URL in an iframe." + "description": "The allowed capabilities of the extension, defined in your [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -118946,7 +118946,7 @@ "syntaxKind": "PropertySignature", "name": "version", "value": "string", - "description": "The published version of the running extension target.\n\nFor unpublished extensions, the value is `undefined`.", + "description": "The published version of the running extension target.\n\nFor unpublished extensions, the value is `undefined`.\n\nDon't use this property as a stable identifier in development environments. It becomes available only after the extension is published.", "isOptional": true, "examples": [ { @@ -118962,7 +118962,7 @@ ] } ], - "value": "export interface Extension {\n /**\n * The API version that was set in the extension config file.\n *\n * @example '2024-10', '2025-01', '2025-04', '2025-07', '2025-10'\n */\n apiVersion: ApiVersion;\n\n /**\n * The allowed capabilities of the extension, defined\n * in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n *\n * * [`api_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#api-access): the extension can access the Storefront API.\n *\n * * [`network_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access): the extension can make external network calls.\n *\n * * [`block_progress`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n *\n * * [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n *\n * * [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can register customer consent decisions that are honored on Shopify-managed services.\n *\n * * [`iframe.sources`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#iframe): the extension can embed an external URL in an iframe.\n */\n capabilities: SubscribableSignalLike;\n\n /**\n * Information about the editor where the extension is being rendered.\n *\n * If the value is undefined, then the extension isn't running in an editor.\n */\n editor?: Editor;\n\n /**\n * A Boolean to show whether your extension is currently rendered to the screen.\n *\n * Shopify might render your extension before it's visible in the UI,\n * typically to pre-render extensions that appear on a later step of the\n * checkout.\n *\n * Your extension might also continue to run after the customer has navigated away\n * from where it was rendered. The extension continues running so that\n * your extension is immediately available to render if the customer navigates back.\n */\n rendered: SubscribableSignalLike;\n\n /**\n * The URL to the script that started the extension target.\n */\n scriptUrl: string;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n */\n target: Target;\n\n /**\n * The published version of the running extension target.\n *\n * For unpublished extensions, the value is `undefined`.\n *\n * @example 3.0.10\n */\n version?: string;\n}" + "value": "export interface Extension {\n /**\n * The API version that was set in the extension config file.\n *\n * @example '2024-10', '2025-01', '2025-04', '2025-07', '2025-10'\n */\n apiVersion: ApiVersion;\n\n /**\n * The allowed capabilities of the extension, defined in your\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n */\n capabilities: SubscribableSignalLike;\n\n /**\n * Information about the editor where the extension is being rendered.\n *\n * If the value is undefined, then the extension isn't running in an editor.\n */\n editor?: Editor;\n\n /**\n * A Boolean to show whether your extension is currently rendered to the screen.\n *\n * Shopify might render your extension before it's visible in the UI,\n * typically to pre-render extensions that appear on a later step of the\n * checkout.\n *\n * Your extension might also continue to run after the customer has navigated away\n * from where it was rendered. The extension continues running so that\n * your extension is immediately available to render if the customer navigates back.\n */\n rendered: SubscribableSignalLike;\n\n /**\n * The URL to the script that started the extension target.\n */\n scriptUrl: string;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n */\n target: Target;\n\n /**\n * The published version of the running extension target.\n *\n * For unpublished extensions, the value is `undefined`.\n *\n * Don't use this property as a stable identifier in development environments.\n * It becomes available only after the extension is published.\n *\n * @example 3.0.10\n */\n version?: string;\n}" }, "ApiVersion": { "filePath": "src/shared.ts", @@ -118981,7 +118981,7 @@ "Editor": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Editor", - "description": "", + "description": "Information about the editor environment when an extension is rendered inside the checkout editor. The value is `undefined` when the extension is not rendering in an editor.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -118996,7 +118996,7 @@ "I18n": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18n", - "description": "", + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use the I18n API alongside the Localization API to build fully localized extensions.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -119032,7 +119032,7 @@ "I18nTranslate": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18nTranslate", - "description": "This returns a translated string matching a key in a locale file.", + "description": "Translates a key from your extension's locale files into a localized string. Supports interpolation with placeholder replacements and pluralization via the special `count` option.", "members": [], "value": "export interface I18nTranslate {\n (\n key: string,\n options?: Record,\n ): ReplacementType extends string | number\n ? string\n : (string | ReplacementType)[];\n}" }, @@ -119596,14 +119596,14 @@ "Localization": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Localization", - "description": "", + "description": "The buyer's language, country, currency, and timezone context. Use this to adapt your extension to the buyer's region and display localized content.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "country", "value": "SubscribableSignalLike", - "description": "The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown." + "description": "The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n\nDerived from the buyer's shipping address. Returns `undefined` until the buyer enters a shipping address." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -119631,18 +119631,18 @@ "syntaxKind": "PropertySignature", "name": "market", "value": "SubscribableSignalLike", - "description": "The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n\n> Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.", - "deprecationMessage": "Deprecated as of version `2025-04`" + "description": "The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. The market context updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.", + "deprecationMessage": "Merchants now manage which extensions load for each\nmarket, so extensions no longer need to check this value." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "timezone", "value": "SubscribableSignalLike", - "description": "The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time." + "description": "The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time." } ], - "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n *\n * > Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" + "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n *\n * Derived from the buyer's shipping address. Returns `undefined` until the\n * buyer enters a shipping address.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout,\n * carried over from the cart context. Markets group countries and\n * regions with shared pricing, languages, and domains. The market\n * context updates when the buyer changes the country of their\n * shipping address. The value is `undefined` if the market is unknown.\n *\n * @deprecated Merchants now manage which extensions load for each\n * market, so extensions no longer need to check this value.\n */\n market: SubscribableSignalLike;\n}" }, "Country": { "filePath": "src/shared.ts", @@ -119843,7 +119843,7 @@ "SessionToken": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SessionToken", - "description": "", + "description": "Authenticates requests between your extension and your app backend. Use session tokens to verify the identity of the buyer and the shop context when making server-side API calls. The token is a signed JWT that contains claims such as the customer ID, shop domain, and expiration.\n\nThe `sub` claim in the decoded token is present only when the buyer is logged in and the app has permission to read customer accounts. Absent for anonymous buyers.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -120102,7 +120102,7 @@ "Shop": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Shop", - "description": "", + "description": "Metadata about the merchant's store, including its name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -120142,30 +120142,30 @@ "syntaxKind": "PropertySignature", "name": "storefrontUrl", "value": "string", - "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n\n> Caution: > As of version `2024-04` this value no longer has a trailing slash.", + "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.", "isOptional": true } ], - "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n *\n * > Caution:\n * > As of version `2024-04` this value no longer has a trailing slash.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom domain.\n */\n myshopifyDomain: string;\n}" + "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom domain.\n */\n myshopifyDomain: string;\n}" }, "Storage": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Storage", - "description": "A key-value storage object for the extension.\n\nStored data is available only to this specific extension and any of its instances.\n\nThe storage backend is implemented with `localStorage` and should persist across the buyer's checkout session. However, data persistence isn't guaranteed.", + "description": "Key-value storage for a specific extension. Use storage to save preferences or cached data that should survive page reloads without requiring a backend call. Stored data is only available to this specific extension. The storage backend is implemented with `localStorage` and data persistence isn't guaranteed.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "delete", "value": "(key: string) => Promise", - "description": "Delete stored data by key." + "description": "Deletes a previously stored value by key." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "read", "value": "(key: string) => Promise", - "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original primitive.\n\nReturns `null` if no stored data exists." + "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original type.\n\nReturns the stored value for the given key, or `null` when no value exists. Doesn't throw on a missing key." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -120175,7 +120175,7 @@ "description": "Write stored data for this key.\n\nThe data must be serializable to JSON." } ], - "value": "export interface Storage {\n /**\n * Read and return a stored value by key.\n *\n * The stored data is deserialized from JSON and returned as\n * its original primitive.\n *\n * Returns `null` if no stored data exists.\n */\n read(key: string): Promise;\n\n /**\n * Write stored data for this key.\n *\n * The data must be serializable to JSON.\n */\n write(key: string, data: any): Promise;\n\n /**\n * Delete stored data by key.\n */\n delete(key: string): Promise;\n}" + "value": "export interface Storage {\n /**\n * Read and return a stored value by key.\n *\n * The stored data is deserialized from JSON and returned as\n * its original type.\n *\n * Returns the stored value for the given key, or `null` when no value\n * exists. Doesn't throw on a missing key.\n */\n read(key: string): Promise;\n\n /**\n * Write stored data for this key.\n *\n * The data must be serializable to JSON.\n */\n write(key: string, data: any): Promise;\n\n /**\n * Deletes a previously stored value by key.\n */\n delete(key: string): Promise;\n}" }, "Version": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -120252,17 +120252,17 @@ "syntaxKind": "PropertySignature", "name": "isTargetSelected", "value": "SubscribableSignalLike", - "description": "Whether the buyer has selected the target pickup location. When `true`, the target location is the buyer's active choice. When `false`, the buyer has chosen a different pickup location." + "description": "Whether the buyer has selected the target pickup location. When `true`, the target location is the buyer's active choice. When `false`, the buyer has chosen a different pickup location.\n\nAvailable only on the corresponding item target. Shipping option item targets expose shipping option properties; pickup location item targets expose pickup location properties." }, { "filePath": "src/surfaces/checkout/api/pickup/pickup-location-item.ts", "syntaxKind": "PropertySignature", "name": "target", "value": "SubscribableSignalLike", - "description": "The pickup location that this extension is attached to. Use this to read the location's name, address, and other details." + "description": "The pickup location that this extension is attached to. Use this to read the location's name, address, and other details.\n\nAvailable only on the corresponding item target. Shipping option item targets expose shipping option properties; pickup location item targets expose pickup location properties." } ], - "value": "export interface PickupLocationItemApi {\n /**\n * The pickup location that this extension is attached to. Use this to read the location's name, address, and other details.\n */\n target: SubscribableSignalLike;\n\n /**\n * Whether the buyer has selected the target pickup location. When `true`, the target location is the buyer's active choice. When `false`, the buyer has chosen a different pickup location.\n */\n isTargetSelected: SubscribableSignalLike;\n}" + "value": "export interface PickupLocationItemApi {\n /**\n * The pickup location that this extension is attached to. Use this to read the location's name, address, and other details.\n *\n * Available only on the corresponding item target. Shipping option item\n * targets expose shipping option properties; pickup location item targets\n * expose pickup location properties.\n */\n target: SubscribableSignalLike;\n\n /**\n * Whether the buyer has selected the target pickup location. When `true`, the target location is the buyer's active choice. When `false`, the buyer has chosen a different pickup location.\n *\n * Available only on the corresponding item target. Shipping option item\n * targets expose shipping option properties; pickup location item targets\n * expose pickup location properties.\n */\n isTargetSelected: SubscribableSignalLike;\n}" }, "SubscribableSignalLike": { "filePath": "src/surfaces/checkout/shared.ts", @@ -120696,7 +120696,7 @@ "syntaxKind": "MethodSignature", "name": "applyAttributeChange", "value": "(change: AttributeChange) => Promise", - "description": "Updates or removes an attribute on the cart and checkout. On success, the [`attributes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/attributes#standardapi-propertydetail-attributes) property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.", + "description": "Updates or removes an attribute on the cart and checkout. On success, the [`attributes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/attributes#properties-propertydetail-attributes) property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.", "deprecationMessage": "Use cart metafields instead." }, { @@ -120704,42 +120704,42 @@ "syntaxKind": "MethodSignature", "name": "applyCartLinesChange", "value": "(change: CartLineChange) => Promise", - "description": "Adds, removes, or updates line items in the cart. The returned promise resolves when the change has been applied by the server, and the [`lines`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-lines#standardapi-propertydetail-lines) property updates with the new state.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Adds, removes, or updates line items in the cart. The returned promise resolves when the change has been applied by the server, and the [`lines`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-lines#properties-propertydetail-lines) property updates with the new state.\n\nAccepts a single change per call. To make multiple changes, call this method separately for each one.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyDiscountCodeChange", "value": "(change: DiscountCodeChange) => Promise", - "description": "Adds or removes a discount code on the checkout. The returned promise resolves when the change has been applied by the server, and the [`discountCodes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/discounts#standardapi-propertydetail-discountcodes) property updates with the new state.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves discount codes through a network call.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Adds or removes a discount code on the checkout. The returned promise resolves when the change has been applied by the server, and the [`discountCodes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/discounts#properties-propertydetail-discountcodes) property updates with the new state.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves discount codes through a network call.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyGiftCardChange", "value": "(change: GiftCardChange) => Promise", - "description": "Adds or removes a gift card from the checkout. The returned promise resolves when the change has been applied by the server, and the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/gift-cards#standardapi-propertydetail-appliedgiftcards) property updates with the new state.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves gift card codes through a network call.\n\n> Note: This method returns an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Adds or removes a gift card from the checkout. The returned promise resolves when the change has been applied by the server, and the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/gift-cards#properties-propertydetail-appliedgiftcards) property updates with the new state.\n\nUnlike other write operations, gift card changes aren't gated by a cart instruction flag.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves gift card codes through a network call.\n\n> Note: This method returns an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyMetafieldChange", "value": "(change: MetafieldChange) => Promise", - "description": "Creates, updates, or removes a cart metafield on the checkout. On success, the [`metafields`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/metafields#standardapi-propertydetail-metafields) property updates to reflect the change.\n\nCart metafields are copied to order metafields at order creation time if there's a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n\n> Caution: `MetafieldRemoveChange` and `MetafieldUpdateChange` are deprecated. Use cart metafields with `MetafieldRemoveCartChange` and `MetafieldUpdateCartChange` instead. If `MetafieldUpdateChange` writes a metafield with the same namespace and key as a cart metafield that's configured to copy, the cart metafield won't be copied.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Creates, updates, or removes a cart metafield on the checkout. On success, the [`metafields`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/metafields#properties-propertydetail-metafields) property updates to reflect the change.\n\nCart metafields are copied to order metafields at order creation time if there's a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n\n> Caution: `MetafieldRemoveChange` and `MetafieldUpdateChange` are deprecated. Use cart metafields with `MetafieldRemoveCartChange` and `MetafieldUpdateCartChange` instead. If `MetafieldUpdateChange` writes a metafield with the same namespace and key as a cart metafield that's configured to copy, the cart metafield won't be copied.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyNoteChange", "value": "(change: NoteChange) => Promise", - "description": "Sets or removes the buyer's note on the checkout. On success, the [`note`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/note#standardapi-propertydetail-note) property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Sets or removes the buyer's note on the checkout. On success, the [`note`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/note#properties-propertydetail-note) property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyShippingAddressChange", "value": "(change: ShippingAddressUpdateChange) => Promise", - "description": "Updates the buyer's shipping address on the checkout. The provided fields are merged into the existing address without prompting the buyer. On success, the `shippingAddress` property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", + "description": "Updates the buyer's shipping address on the checkout. The provided fields are merged into the existing address without prompting the buyer. On success, the `shippingAddress` property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", "isOptional": true }, { @@ -120752,7 +120752,7 @@ "isPrivate": true } ], - "value": "export interface CheckoutApi {\n /**\n * Updates or removes an attribute on the cart and checkout. On success, the\n * [`attributes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/attributes#standardapi-propertydetail-attributes) property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * @deprecated Use cart metafields instead.\n */\n applyAttributeChange(change: AttributeChange): Promise;\n\n /**\n * Adds, removes, or updates line items in the cart. The returned promise resolves when the change has been applied by the server, and the [`lines`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-lines#standardapi-propertydetail-lines) property updates with the new state.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyCartLinesChange(change: CartLineChange): Promise;\n\n /**\n * Adds or removes a discount code on the checkout. The returned promise resolves when the change has been applied by the server, and the [`discountCodes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/discounts#standardapi-propertydetail-discountcodes) property updates with the new state.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves discount codes through a network call.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyDiscountCodeChange(\n change: DiscountCodeChange,\n ): Promise;\n\n /**\n * Adds or removes a gift card from the checkout. The returned promise resolves when the change has been applied by the server, and the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/gift-cards#standardapi-propertydetail-appliedgiftcards) property updates with the new state.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves gift card codes through a network call.\n *\n * > Note: This method returns an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyGiftCardChange(change: GiftCardChange): Promise;\n\n /**\n * Creates, updates, or removes a cart metafield on the checkout. On success, the\n * [`metafields`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/metafields#standardapi-propertydetail-metafields) property updates to reflect the change.\n *\n * Cart metafields are copied to order metafields at order creation time if there's a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n *\n * > Caution: `MetafieldRemoveChange` and `MetafieldUpdateChange` are deprecated. Use cart metafields with `MetafieldRemoveCartChange` and `MetafieldUpdateCartChange` instead. If `MetafieldUpdateChange` writes a metafield with the same namespace and key as a cart metafield that's configured to copy, the cart metafield won't be copied.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyMetafieldChange(change: MetafieldChange): Promise;\n\n /**\n * Sets or removes the buyer's note on the checkout. On success, the\n * [`note`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/note#standardapi-propertydetail-note)\n * property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyNoteChange(change: NoteChange): Promise;\n\n /**\n * @private\n */\n experimentalIsShopAppStyle?: boolean;\n\n /**\n * Updates the buyer's shipping address on the checkout. The provided fields\n * are merged into the existing address without prompting the buyer. On success,\n * the `shippingAddress` property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyShippingAddressChange?(\n change: ShippingAddressChange,\n ): Promise;\n}" + "value": "export interface CheckoutApi {\n /**\n * Updates or removes an attribute on the cart and checkout. On success, the\n * [`attributes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/attributes#properties-propertydetail-attributes) property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * @deprecated Use cart metafields instead.\n */\n applyAttributeChange(change: AttributeChange): Promise;\n\n /**\n * Adds, removes, or updates line items in the cart. The returned promise resolves when the change has been applied by the server, and the [`lines`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-lines#properties-propertydetail-lines) property updates with the new state.\n *\n * Accepts a single change per call. To make multiple changes, call this\n * method separately for each one.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyCartLinesChange(change: CartLineChange): Promise;\n\n /**\n * Adds or removes a discount code on the checkout. The returned promise resolves when the change has been applied by the server, and the [`discountCodes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/discounts#properties-propertydetail-discountcodes) property updates with the new state.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves discount codes through a network call.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyDiscountCodeChange(\n change: DiscountCodeChange,\n ): Promise;\n\n /**\n * Adds or removes a gift card from the checkout. The returned promise resolves when the change has been applied by the server, and the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/gift-cards#properties-propertydetail-appliedgiftcards) property updates with the new state.\n *\n * Unlike other write operations, gift card changes aren't gated by a cart\n * instruction flag.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves gift card codes through a network call.\n *\n * > Note: This method returns an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyGiftCardChange(change: GiftCardChange): Promise;\n\n /**\n * Creates, updates, or removes a cart metafield on the checkout. On success, the\n * [`metafields`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/metafields#properties-propertydetail-metafields) property updates to reflect the change.\n *\n * Cart metafields are copied to order metafields at order creation time if there's a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n *\n * > Caution: `MetafieldRemoveChange` and `MetafieldUpdateChange` are deprecated. Use cart metafields with `MetafieldRemoveCartChange` and `MetafieldUpdateCartChange` instead. If `MetafieldUpdateChange` writes a metafield with the same namespace and key as a cart metafield that's configured to copy, the cart metafield won't be copied.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyMetafieldChange(change: MetafieldChange): Promise;\n\n /**\n * Sets or removes the buyer's note on the checkout. On success, the\n * [`note`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/note#properties-propertydetail-note)\n * property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyNoteChange(change: NoteChange): Promise;\n\n /**\n * @private\n */\n experimentalIsShopAppStyle?: boolean;\n\n /**\n * Updates the buyer's shipping address on the checkout. The provided fields\n * are merged into the existing address without prompting the buyer. On success,\n * the `shippingAddress` property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyShippingAddressChange?(\n change: ShippingAddressChange,\n ): Promise;\n}" }, "AttributeChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -120819,7 +120819,7 @@ "syntaxKind": "PropertySignature", "name": "value", "value": "string", - "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.", + "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.\n\nAttribute values are always strings. To store structured data, serialize it to JSON and parse it when reading.", "examples": [ { "title": "Example", @@ -120834,7 +120834,7 @@ ] } ], - "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" + "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * Attribute values are always strings. To store structured data, serialize\n * it to JSON and parse it when reading.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" }, "AttributeRemoveChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -121687,7 +121687,7 @@ "syntaxKind": "PropertySignature", "name": "message", "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer." + "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer.\n\nRender your own localized error text rather than displaying this message to the buyer." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -121697,7 +121697,7 @@ "description": "Indicates that the line item wasn't changed successfully. Refer to the `message` property for details about the error." } ], - "value": "export interface CartLineChangeResultError {\n /**\n * Indicates that the line item wasn't changed successfully. Refer to the `message` property for details about the error.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface CartLineChangeResultError {\n /**\n * Indicates that the line item wasn't changed successfully. Refer to the `message` property for details about the error.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n *\n * Render your own localized error text rather than displaying this message\n * to the buyer.\n */\n message: string;\n}" }, "DiscountCodeChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -121877,7 +121877,7 @@ "syntaxKind": "PropertySignature", "name": "message", "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer." + "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer.\n\nRender your own localized error text rather than displaying this message to the buyer." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -121887,7 +121887,7 @@ "description": "Indicates that the gift card change couldn't be applied. Check the `message` property for details." } ], - "value": "export interface GiftCardChangeResultError {\n /**\n * Indicates that the gift card change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface GiftCardChangeResultError {\n /**\n * Indicates that the gift card change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n *\n * Render your own localized error text rather than displaying this message\n * to the buyer.\n */\n message: string;\n}" }, "MetafieldChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -122148,7 +122148,7 @@ "syntaxKind": "PropertySignature", "name": "message", "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer." + "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer.\n\nRender your own localized error text rather than displaying this message to the buyer." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -122158,7 +122158,7 @@ "description": "Indicates that the metafield change couldn't be applied. Check the `message` property for details." } ], - "value": "export interface MetafieldChangeResultError {\n /**\n * Indicates that the metafield change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface MetafieldChangeResultError {\n /**\n * Indicates that the metafield change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n *\n * Render your own localized error text rather than displaying this message\n * to the buyer.\n */\n message: string;\n}" }, "NoteChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -122236,7 +122236,7 @@ "syntaxKind": "PropertySignature", "name": "message", "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer." + "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer.\n\nRender your own localized error text rather than displaying this message to the buyer." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -122246,7 +122246,7 @@ "description": "Indicates that the note change couldn't be applied. Check the `message` property for details." } ], - "value": "export interface NoteChangeResultError {\n /**\n * Indicates that the note change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface NoteChangeResultError {\n /**\n * Indicates that the note change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n *\n * Render your own localized error text rather than displaying this message\n * to the buyer.\n */\n message: string;\n}" }, "ShippingAddressUpdateChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -122832,7 +122832,7 @@ "syntaxKind": "PropertySignature", "name": "analytics", "value": "Analytics", - "description": "The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event." + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -122846,7 +122846,7 @@ "syntaxKind": "PropertySignature", "name": "applyTrackingConsentChange", "value": "ApplyTrackingConsentChangeType", - "description": "Enables setting and updating customer privacy consent settings and tracking consent metafields.\n\n> Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent) to be set to `true`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." + "description": "Enables setting and updating customer privacy consent settings and tracking consent metafields.\n\n> Note: Requires the [`collect_buyer_consent` capability](/docs/apps/build/customer-accounts/capabilities#collect-buyer-consent) to be set to `true`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -122867,7 +122867,7 @@ "syntaxKind": "PropertySignature", "name": "availablePaymentOptions", "value": "SubscribableSignalLike", - "description": "All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region." + "description": "All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n\nThe set of payment options can change when the buyer updates their address or cart, so subscribe to changes rather than reading once during initialization. Each option exposes `handle` and `type` only. Provider names, logos, fees, and installment terms aren't available." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -122904,7 +122904,7 @@ "syntaxKind": "PropertySignature", "name": "checkoutToken", "value": "SubscribableSignalLike", - "description": "A stable ID that represents the current checkout.\n\nThe value is `undefined` when the checkout hasn't been created on the server yet.\n\nUse this to correlate checkout sessions across your extension, web pixels, and backend systems.\n\nThis matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data) and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object)." + "description": "A stable ID that represents the current checkout.\n\nThe value is `undefined` when the checkout hasn't been created on the server yet.\n\nUse this to correlate checkout sessions across your extension, web pixels, and backend systems.\n\nThis matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data) and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n\nCan be `undefined`. Handle the `undefined` state before using the value." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -122925,7 +122925,7 @@ "syntaxKind": "PropertySignature", "name": "deliveryGroups", "value": "SubscribableSignalLike", - "description": "The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items." + "description": "The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n\nEmpty until the buyer enters enough address information for Shopify to calculate shipping rates." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -122946,7 +122946,7 @@ "syntaxKind": "PropertySignature", "name": "extension", "value": "Extension", - "description": "The meta information about the extension." + "description": "Metadata about the running extension, including the current target, API version, capabilities, and editor context. Use this to conditionally render content based on where the extension is running." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -122954,7 +122954,7 @@ "name": "extensionPoint", "value": "Target", "description": "The identifier that specifies where in Shopify's UI your code is being injected. This is one of the targets you've included in your extension's configuration file.", - "deprecationMessage": "Deprecated as of version `2023-07`, use `extension.target` instead.", + "deprecationMessage": "Use `extension.target` instead.", "examples": [ { "title": "Example", @@ -122973,14 +122973,14 @@ "syntaxKind": "PropertySignature", "name": "i18n", "value": "I18n", - "description": "Utilities for translating content and formatting values according to the current [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) of the checkout.\n\nRefer to [`localization` examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples) for more information." + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use alongside [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) to build fully localized extensions." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "instructions", "value": "SubscribableSignalLike", - "description": "The cart instructions used to create the checkout and possibly limit extension capabilities.\n\nThese instructions should be checked before performing any actions that might be affected by them.\n\nFor example, if you intend to add a discount code via the `applyDiscountCodeChange` method, check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n\n> Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs aren't available. See the [update guide](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples) for more information." + "description": "The cart instructions used to create the checkout and possibly limit extension capabilities.\n\nThese instructions should be checked before performing any actions that might be affected by them.\n\nFor example, if you intend to add a discount code via the `applyDiscountCodeChange` method, check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n\n> Caution: Check cart instructions before calling select APIs, as > some may not be available. See the > [Cart Instructions API](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples) > for more information." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -122994,7 +122994,7 @@ "syntaxKind": "PropertySignature", "name": "localization", "value": "Localization", - "description": "The details about the location, language, and currency of the customer. For utilities to easily format and translate content based on these details, you can use the [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n) object instead." + "description": "The buyer's language, country, currency, and timezone context. For formatting and translation helpers, use the [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#properties-propertydetail-i18n) object instead." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -123024,21 +123024,21 @@ "syntaxKind": "PropertySignature", "name": "query", "value": ">(query: string, options?: { variables?: Variables; version?: StorefrontApiVersion; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>", - "description": "The method used to query the Storefront GraphQL API with a prefetched token.\n\nRefer to [Storefront API access examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/storefront-api) for more information." + "description": "The method used to query the Storefront GraphQL API with a prefetched token." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "selectedPaymentOptions", "value": "SubscribableSignalLike", - "description": "The payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card)." + "description": "The payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\n\nEach option exposes `handle` and `type` only. Provider names, logos, fees, and installment terms aren't available." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "sessionToken", "value": "SessionToken", - "description": "The session token providing a set of claims as a signed JSON Web Token (JWT).\n\nThe token has a TTL of five minutes.\n\nIf the previous token expires, this value reflects a new session token with a new signature and expiry.\n\nRefer to [session token examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/session-token) for more information." + "description": "The session token providing a set of claims as a signed JSON Web Token (JWT).\n\nThe token has a TTL of five minutes.\n\nIf the previous token expires, this value reflects a new session token with a new signature and expiry.\n\nLearn more about [session tokens](/docs/apps/build/authentication-authorization/session-tokens)." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -123060,14 +123060,14 @@ "syntaxKind": "PropertySignature", "name": "shop", "value": "Shop", - "description": "The shop where the checkout is taking place." + "description": "The store where the checkout is taking place, including the shop name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "storage", "value": "Storage", - "description": "The key-value storage for the extension.\n\nIt uses `localStorage` and should persist across the customer's current checkout session.\n\n> Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n\nData is shared across all activated extension targets of this extension. In versions 2023-07 and earlier, each activated extension target had its own storage." + "description": "Key-value storage that persists across page loads within the current checkout session. Data is shared across all activated targets associated with this extension.\n\n> Caution: Data persistence isn't guaranteed and storage is cleared when the buyer starts a new checkout." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -123089,29 +123089,29 @@ ] } ], - "value": "export interface StandardApi {\n /**\n * The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event.\n */\n analytics: Analytics;\n\n /**\n * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\n */\n appliedGiftCards: SubscribableSignalLike;\n\n /**\n * The cart instructions used to create the checkout and possibly limit extension capabilities.\n *\n * These instructions should be checked before performing any actions that might be affected by them.\n *\n * For example, if you intend to add a discount code via the `applyDiscountCodeChange` method,\n * check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n *\n * > Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs aren't available.\n * See the [update guide](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples) for more information.\n *\n */\n instructions: SubscribableSignalLike;\n\n /**\n * The metafields requested in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration)\n * file. These metafields are updated when there's a change in the merchandise items\n * being purchased by the customer.\n *\n * App owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` isn't supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n appMetafields: SubscribableSignalLike;\n\n /**\n * The custom key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n buyerIdentity?: BuyerIdentity;\n\n /**\n * Provides details on the buyer's progression through the checkout and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/buyer-journey#examples)\n * examples for more information.\n */\n buyerJourney: BuyerJourney;\n\n /**\n * Settings applied to the buyer's checkout.\n */\n checkoutSettings: SubscribableSignalLike;\n\n /**\n * A stable ID that represents the current checkout.\n *\n * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\n *\n * This matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data)\n * and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n */\n checkoutToken: SubscribableSignalLike;\n\n /**\n * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * The meta information about the extension.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n *\n * @deprecated Deprecated as of version `2023-07`, use `extension.target` instead.\n */\n extensionPoint: Target;\n\n /**\n * Utilities for translating content and formatting values according to the current\n * [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization)\n * of the checkout.\n *\n * Refer to [`localization` examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples)\n * for more information.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The details about the location, language, and currency of the customer. For utilities to easily\n * format and translate content based on these details, you can use the\n * [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n)\n * object instead.\n */\n localization: Localization;\n\n /**\n * The metafields that apply to the current checkout.\n *\n * Metafields are stored locally on the client and are applied to the order object after the checkout completes.\n *\n * These metafields are shared by all extensions running on checkout, and\n * persist for as long as the customer is working on this checkout.\n *\n * Once the order is created, you can query these metafields using the\n * [GraphQL Admin API](/docs/admin-api/graphql/reference/orders/order#metafield-2021-01)\n *\n * > Caution:\n * `metafields` is deprecated. Use `appMetafields` with cart metafields instead.\n *\n * @deprecated Use `appMetafields` with cart metafields instead.\n */\n metafields: SubscribableSignalLike;\n\n /**\n * A note left by the customer to the merchant, either in their cart or during checkout.\n *\n * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\n */\n note: SubscribableSignalLike;\n\n /**\n * The method used to query the Storefront GraphQL API with a prefetched token.\n *\n * Refer to [Storefront API access examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/storefront-api) for more information.\n */\n query: >(\n query: string,\n options?: {variables?: Variables; version?: StorefrontApiVersion},\n ) => Promise<{data?: Data; errors?: GraphQLError[]}>;\n\n /**\n * The payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\n */\n selectedPaymentOptions: SubscribableSignalLike;\n\n /**\n * The session token providing a set of claims as a signed JSON Web Token (JWT).\n *\n * The token has a TTL of five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/session-token) for more information.\n */\n sessionToken: SessionToken;\n\n /**\n * The settings matching the settings definition written in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates in real time as a merchant fills in the settings.\n */\n settings: SubscribableSignalLike;\n\n /**\n * The proposed customer shipping address. During the information step, the address\n * updates when the field is committed (on change) rather than every keystroke.\n * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n shippingAddress?: SubscribableSignalLike;\n\n /**\n * The proposed customer billing address. The address updates when the field is\n * committed (on change) rather than every keystroke. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided yet.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n billingAddress?: SubscribableSignalLike;\n\n /** The shop where the checkout is taking place. */\n shop: Shop;\n\n /**\n * The key-value storage for the extension.\n *\n * It uses `localStorage` and should persist across the customer's current checkout session.\n *\n * > Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n *\n * Data is shared across all activated extension targets of this extension. In versions 2023-07 and earlier,\n * each activated extension target had its own storage.\n */\n storage: Storage;\n\n /**\n * The renderer version being used for the extension.\n *\n * @example '2025-10'\n */\n version: Version;\n\n /**\n * Customer privacy consent settings and a flag denoting if consent has previously been collected.\n */\n customerPrivacy: SubscribableSignalLike;\n\n /**\n * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent) to be set to `true`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyTrackingConsentChange: ApplyTrackingConsentChangeType;\n\n /**\n * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" + "value": "export interface StandardApi {\n /**\n * Tracks custom events and sends visitor information to\n * [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events\n * and `visitor()` to submit buyer contact details.\n */\n analytics: Analytics;\n\n /**\n * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\n */\n appliedGiftCards: SubscribableSignalLike;\n\n /**\n * The cart instructions used to create the checkout and possibly limit extension capabilities.\n *\n * These instructions should be checked before performing any actions that might be affected by them.\n *\n * For example, if you intend to add a discount code via the `applyDiscountCodeChange` method,\n * check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n *\n * > Caution: Check cart instructions before calling select APIs, as\n * > some may not be available. See the\n * > [Cart Instructions API](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples)\n * > for more information.\n *\n */\n instructions: SubscribableSignalLike;\n\n /**\n * The metafields requested in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration)\n * file. These metafields are updated when there's a change in the merchandise items\n * being purchased by the customer.\n *\n * App owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` isn't supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n appMetafields: SubscribableSignalLike;\n\n /**\n * The custom key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as\n * credit cards, wallets, and local payment methods. The list depends on\n * the shop's payment configuration and the buyer's region.\n *\n * The set of payment options can change when the buyer updates their\n * address or cart, so subscribe to changes rather than reading once\n * during initialization. Each option exposes `handle` and `type` only.\n * Provider names, logos, fees, and installment terms aren't available.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n buyerIdentity?: BuyerIdentity;\n\n /**\n * Provides details on the buyer's progression through the checkout and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/buyer-journey#examples)\n * examples for more information.\n */\n buyerJourney: BuyerJourney;\n\n /**\n * Settings applied to the buyer's checkout.\n */\n checkoutSettings: SubscribableSignalLike;\n\n /**\n * A stable ID that represents the current checkout.\n *\n * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\n *\n * This matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data)\n * and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n *\n * Can be `undefined`. Handle the `undefined` state before using the value.\n */\n checkoutToken: SubscribableSignalLike;\n\n /**\n * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n *\n * Empty until the buyer enters enough address information for Shopify to\n * calculate shipping rates.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * Metadata about the running extension, including the current target, API version,\n * capabilities, and editor context. Use this to conditionally render content\n * based on where the extension is running.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n *\n * @deprecated Use `extension.target` instead.\n */\n extensionPoint: Target;\n\n /**\n * Utilities for translating strings, formatting currencies, numbers, and dates\n * according to the buyer's locale. Use alongside\n * [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization)\n * to build fully localized extensions.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The buyer's language, country, currency, and timezone context. For\n * formatting and translation helpers, use the\n * [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#properties-propertydetail-i18n)\n * object instead.\n */\n localization: Localization;\n\n /**\n * The metafields that apply to the current checkout.\n *\n * Metafields are stored locally on the client and are applied to the order object after the checkout completes.\n *\n * These metafields are shared by all extensions running on checkout, and\n * persist for as long as the customer is working on this checkout.\n *\n * Once the order is created, you can query these metafields using the\n * [GraphQL Admin API](/docs/admin-api/graphql/reference/orders/order#metafield-2021-01)\n *\n * > Caution:\n * `metafields` is deprecated. Use `appMetafields` with cart metafields instead.\n *\n * @deprecated Use `appMetafields` with cart metafields instead.\n */\n metafields: SubscribableSignalLike;\n\n /**\n * A note left by the customer to the merchant, either in their cart or during checkout.\n *\n * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\n */\n note: SubscribableSignalLike;\n\n /**\n * The method used to query the Storefront GraphQL API with a prefetched token.\n *\n */\n query: >(\n query: string,\n options?: {variables?: Variables; version?: StorefrontApiVersion},\n ) => Promise<{data?: Data; errors?: GraphQLError[]}>;\n\n /**\n * The payment options the buyer has currently selected. This updates as\n * the buyer changes their payment method. The array can contain multiple\n * entries when the buyer splits payment across methods (for example, a\n * gift card and a credit card).\n *\n * Each option exposes `handle` and `type` only. Provider names, logos,\n * fees, and installment terms aren't available.\n */\n selectedPaymentOptions: SubscribableSignalLike;\n\n /**\n * The session token providing a set of claims as a signed JSON Web Token (JWT).\n *\n * The token has a TTL of five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Learn more about [session tokens](/docs/apps/build/authentication-authorization/session-tokens).\n */\n sessionToken: SessionToken;\n\n /**\n * The settings matching the settings definition written in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates in real time as a merchant fills in the settings.\n */\n settings: SubscribableSignalLike;\n\n /**\n * The proposed customer shipping address. During the information step, the address\n * updates when the field is committed (on change) rather than every keystroke.\n * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n shippingAddress?: SubscribableSignalLike;\n\n /**\n * The proposed customer billing address. The address updates when the field is\n * committed (on change) rather than every keystroke. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided yet.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n billingAddress?: SubscribableSignalLike;\n\n /**\n * The store where the checkout is taking place, including the shop name,\n * storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.\n */\n shop: Shop;\n\n /**\n * Key-value storage that persists across page loads within the current checkout\n * session. Data is shared across all activated targets associated with\n * this extension.\n *\n * > Caution: Data persistence isn't guaranteed and storage is cleared when the\n * buyer starts a new checkout.\n */\n storage: Storage;\n\n /**\n * The renderer version being used for the extension.\n *\n * @example '2025-10'\n */\n version: Version;\n\n /**\n * Customer privacy consent settings and a flag denoting if consent has previously been collected.\n */\n customerPrivacy: SubscribableSignalLike;\n\n /**\n * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`collect_buyer_consent` capability](/docs/apps/build/customer-accounts/capabilities#collect-buyer-consent) to be set to `true`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyTrackingConsentChange: ApplyTrackingConsentChangeType;\n\n /**\n * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" }, "Analytics": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Analytics", - "description": "", + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "publish", "value": "(name: string, data: Record) => Promise", - "description": "Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing)." + "description": "Publishes a custom event to [Web Pixels](/docs/apps/marketing). Returns `true` when the event is successfully dispatched.\n\nThe Promise resolves to `true` when the event was dispatched. The boolean indicates dispatch confirmation only. It doesn't indicate whether any specific web pixel processed the event." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "visitor", "value": "(data: { email?: string; phone?: string; }) => Promise", - "description": "A method for capturing details about a visitor on the online store." + "description": "Submits buyer contact details for attribution and analytics purposes." } ], - "value": "export interface Analytics {\n /**\n * Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing).\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * A method for capturing details about a visitor on the online store.\n */\n visitor(data: {email?: string; phone?: string}): Promise;\n}" + "value": "export interface Analytics {\n /**\n * Publishes a custom event to [Web Pixels](/docs/apps/marketing).\n * Returns `true` when the event is successfully dispatched.\n *\n * The Promise resolves to `true` when the event was dispatched. The boolean\n * indicates dispatch confirmation only. It doesn't indicate whether any\n * specific web pixel processed the event.\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * Submits buyer contact details for attribution and analytics purposes.\n */\n visitor(data: {email?: string; phone?: string}): Promise;\n}" }, "VisitorResult": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -123152,10 +123152,10 @@ "syntaxKind": "PropertySignature", "name": "type", "value": "'error'", - "description": "Indicates that the visitor information is invalid and wasn't submitted. Examples are using the wrong data type or missing a required property." + "description": "Indicates that the visitor information is invalid and wasn't submitted. Common causes include using the wrong data type or omitting a required property." } ], - "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Examples are using the wrong data type or missing a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Common causes include using the wrong data type or omitting a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" }, "SubscribableSignalLike": { "filePath": "src/surfaces/checkout/shared.ts", @@ -123369,10 +123369,10 @@ "syntaxKind": "PropertySignature", "name": "value", "value": "string | null", - "description": "The new value to store in the metafield. Set to `null` to delete the metafield." + "description": "The new value to store in the metafield. Set to `null` to delete the metafield.\n\nConsent metafield values are strings, not booleans. Pass `null` to delete a tracking consent metafield." } ], - "value": "export interface TrackingConsentMetafieldChange {\n /**\n * The identifier for the tracking consent metafield to update.\n */\n key: string;\n /**\n * The new value to store in the metafield. Set to `null` to delete the metafield.\n */\n value: string | null;\n}" + "value": "export interface TrackingConsentMetafieldChange {\n /**\n * The identifier for the tracking consent metafield to update.\n */\n key: string;\n /**\n * The new value to store in the metafield. Set to `null` to delete the metafield.\n *\n * Consent metafield values are strings, not booleans. Pass `null` to delete\n * a tracking consent metafield.\n */\n value: string | null;\n}" }, "VisitorConsent": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -123586,7 +123586,7 @@ "syntaxKind": "PropertySignature", "name": "value", "value": "string", - "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.", + "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.\n\nAttribute values are always strings. To store structured data, serialize it to JSON and parse it when reading.", "examples": [ { "title": "Example", @@ -123601,7 +123601,7 @@ ] } ], - "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" + "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * Attribute values are always strings. To store structured data, serialize\n * it to JSON and parse it when reading.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" }, "PaymentOption": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -123952,7 +123952,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A globally-unique identifier for the customer in the format `gid://shopify/Customer/`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", + "description": "An identifier for the customer in the format `gid://shopify/Customer/`. This value is unique per shop.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", "examples": [ { "title": "Example", @@ -124005,7 +124005,7 @@ "isPrivate": true } ], - "value": "export interface Customer {\n /**\n * A globally-unique identifier for the customer in the format `gid://shopify/Customer/`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'gid://shopify/Customer/123'\n */\n id: string;\n /**\n * The email address associated with the customer's account. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email?: string;\n /**\n * The phone number associated with the customer's account. The value is `undefined` if no phone number is on file or the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone?: string;\n /**\n * The customer's full name, typically a combination of first and last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n fullName?: string;\n /**\n * The customer's first name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n firstName?: string;\n /**\n * The customer's last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n lastName?: string;\n /**\n * The customer's profile image, such as a Gravatar avatar. Use this to personalize the extension UI for the logged-in buyer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n image: ImageDetails;\n /**\n * Whether the customer has opted in to receiving marketing communications from the merchant, such as email campaigns and promotional offers.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * > Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n *\n * @deprecated Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n */\n acceptsMarketing: boolean;\n /**\n * Whether the customer has opted in to email marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsEmailMarketing: boolean;\n /**\n * Whether the customer has opted in to SMS marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsSmsMarketing: boolean;\n /**\n * The store credit accounts owned by this customer that can be used as payment during checkout. Each account has a balance representing available store credit.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @private\n */\n storeCreditAccounts: StoreCreditAccount[];\n /**\n * The number of orders the customer has previously placed with this shop.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n ordersCount: number;\n}" + "value": "export interface Customer {\n /**\n * An identifier for the customer in the format `gid://shopify/Customer/`. This value is unique per shop.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'gid://shopify/Customer/123'\n */\n id: string;\n /**\n * The email address associated with the customer's account. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email?: string;\n /**\n * The phone number associated with the customer's account. The value is `undefined` if no phone number is on file or the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone?: string;\n /**\n * The customer's full name, typically a combination of first and last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n fullName?: string;\n /**\n * The customer's first name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n firstName?: string;\n /**\n * The customer's last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n lastName?: string;\n /**\n * The customer's profile image, such as a Gravatar avatar. Use this to personalize the extension UI for the logged-in buyer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n image: ImageDetails;\n /**\n * Whether the customer has opted in to receiving marketing communications from the merchant, such as email campaigns and promotional offers.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * > Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n *\n * @deprecated Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n */\n acceptsMarketing: boolean;\n /**\n * Whether the customer has opted in to email marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsEmailMarketing: boolean;\n /**\n * Whether the customer has opted in to SMS marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsSmsMarketing: boolean;\n /**\n * The store credit accounts owned by this customer that can be used as payment during checkout. Each account has a balance representing available store credit.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @private\n */\n storeCreditAccounts: StoreCreditAccount[];\n /**\n * The number of orders the customer has previously placed with this shop.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n ordersCount: number;\n}" }, "ImageDetails": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -124287,11 +124287,11 @@ "syntaxKind": "MethodSignature", "name": "perform", "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", + "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.\n\nRuns after all intercept results are collected. Use it for local state updates such as setting an error flag. By the time it runs, the navigation decision is final, so blocking logic belongs in the intercept handler itself, not here.", "isOptional": true } ], - "value": "interface InterceptorRequestAllow {\n /**\n * Indicates that the interceptor allows the buyer's journey to continue.\n */\n behavior: 'allow';\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" + "value": "interface InterceptorRequestAllow {\n /**\n * Indicates that the interceptor allows the buyer's journey to continue.\n */\n behavior: 'allow';\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n *\n * Runs after all intercept results are collected. Use it for local state\n * updates such as setting an error flag. By the time it runs, the navigation\n * decision is final, so blocking logic belongs in the intercept handler\n * itself, not here.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" }, "InterceptorResult": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -124355,7 +124355,7 @@ "syntaxKind": "MethodSignature", "name": "perform", "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", + "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.\n\nRuns after all intercept results are collected. Use it for local state updates such as setting an error flag. By the time it runs, the navigation decision is final, so blocking logic belongs in the intercept handler itself, not here.", "isOptional": true }, { @@ -124366,7 +124366,7 @@ "description": "The reason for blocking the interceptor request. This value isn't presented to the buyer, so it doesn't need to be localized. The value is used only for Shopify's own internal debugging and metrics." } ], - "value": "interface InterceptorRequestBlock {\n /**\n * Indicates that the interceptor blocks the buyer's journey from continuing.\n */\n behavior: 'block';\n\n /**\n * The reason for blocking the interceptor request. This value isn't presented to\n * the buyer, so it doesn't need to be localized. The value is used only for Shopify's\n * own internal debugging and metrics.\n */\n reason: string;\n\n /**\n * Used to pass errors to the checkout UI, outside your extension's UI boundaries.\n */\n errors?: ValidationError[];\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" + "value": "interface InterceptorRequestBlock {\n /**\n * Indicates that the interceptor blocks the buyer's journey from continuing.\n */\n behavior: 'block';\n\n /**\n * The reason for blocking the interceptor request. This value isn't presented to\n * the buyer, so it doesn't need to be localized. The value is used only for Shopify's\n * own internal debugging and metrics.\n */\n reason: string;\n\n /**\n * Used to pass errors to the checkout UI, outside your extension's UI boundaries.\n */\n errors?: ValidationError[];\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n *\n * Runs after all intercept results are collected. Use it for local state\n * updates such as setting an error flag. By the time it runs, the navigation\n * decision is final, so blocking logic belongs in the intercept handler\n * itself, not here.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" }, "ValidationError": { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -124587,17 +124587,17 @@ "syntaxKind": "PropertySignature", "name": "totalShippingAmount", "value": "SubscribableSignalLike", - "description": "The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step." + "description": "The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step.\n\n`undefined` until the buyer selects a shipping method (typically after the information step)." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "totalTaxAmount", "value": "SubscribableSignalLike", - "description": "The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet." + "description": "The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet.\n\n`undefined` when taxes haven't been calculated or aren't available for the buyer's region." } ], - "value": "export interface CartCost {\n /**\n * The sum of all line item prices at the current step of checkout, before shipping and taxes are applied. Use this value to display the base cost of the items the buyer purchased.\n */\n subtotalAmount: SubscribableSignalLike;\n\n /**\n * The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step.\n */\n totalShippingAmount: SubscribableSignalLike;\n\n /**\n * The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet.\n */\n totalTaxAmount: SubscribableSignalLike;\n\n /**\n * The minimum total at the current step of checkout. Costs not yet calculated, such as shipping on the information step, aren't included. Gift cards and store credits are excluded from this total.\n */\n totalAmount: SubscribableSignalLike;\n}" + "value": "export interface CartCost {\n /**\n * The sum of all line item prices at the current step of checkout, before shipping and taxes are applied. Use this value to display the base cost of the items the buyer purchased.\n */\n subtotalAmount: SubscribableSignalLike;\n\n /**\n * The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step.\n *\n * `undefined` until the buyer selects a shipping method (typically after the\n * information step).\n */\n totalShippingAmount: SubscribableSignalLike;\n\n /**\n * The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet.\n *\n * `undefined` when taxes haven't been calculated or aren't available for the\n * buyer's region.\n */\n totalTaxAmount: SubscribableSignalLike;\n\n /**\n * The minimum total at the current step of checkout. Costs not yet calculated, such as shipping on the information step, aren't included. Gift cards and store credits are excluded from this total.\n */\n totalAmount: SubscribableSignalLike;\n}" }, "CustomerPrivacy": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -124684,31 +124684,31 @@ "syntaxKind": "PropertySignature", "name": "analytics", "value": "boolean", - "description": "Whether analytics data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Analytics data includes how the shop was used and what interactions occurred." + "description": "Whether analytics data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Analytics data includes how the shop was used and what interactions occurred.\n\nWhether analytics data can be collected right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.analytics`, before calling `shopify.analytics.publish()`." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "marketing", "value": "boolean", - "description": "Whether marketing data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Marketing data includes attribution and targeted advertising preferences." + "description": "Whether marketing data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Marketing data includes attribution and targeted advertising preferences.\n\nWhether marketing data can be collected right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.marketing`, before performing marketing-related data collection." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "preferences", "value": "boolean", - "description": "Whether preference data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Preference data includes language, currency, and sizing choices." + "description": "Whether preference data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Preference data includes language, currency, and sizing choices.\n\nWhether preference data can be collected right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.preferences`, before storing or reading buyer preference data." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "saleOfData", "value": "boolean", - "description": "Whether data can be shared with third parties based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. This typically applies to behavioral advertising data." + "description": "Whether data can be shared with third parties based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. This typically applies to behavioral advertising data.\n\nWhether buyer data can be shared with or sold to third parties right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.saleOfData`, before sharing or selling buyer data with third parties." } ], - "value": "export interface AllowedProcessing {\n /**\n * Whether analytics data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Analytics\n * data includes how the shop was used and what interactions occurred.\n */\n analytics: boolean;\n /**\n * Whether marketing data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Marketing\n * data includes attribution and targeted advertising preferences.\n */\n marketing: boolean;\n /**\n * Whether preference data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Preference\n * data includes language, currency, and sizing choices.\n */\n preferences: boolean;\n /**\n * Whether data can be shared with third parties based on the visitor's\n * consent, the merchant's privacy configuration, and the visitor's region.\n * This typically applies to behavioral advertising data.\n */\n saleOfData: boolean;\n}" + "value": "export interface AllowedProcessing {\n /**\n * Whether analytics data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Analytics\n * data includes how the shop was used and what interactions occurred.\n *\n * Whether analytics data can be collected right now. Combines the buyer's\n * consent, the merchant's privacy configuration, and the buyer's region into\n * a single boolean. Check this flag, not `visitorConsent.analytics`, before\n * calling `shopify.analytics.publish()`.\n */\n analytics: boolean;\n /**\n * Whether marketing data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Marketing\n * data includes attribution and targeted advertising preferences.\n *\n * Whether marketing data can be collected right now. Combines the buyer's\n * consent, the merchant's privacy configuration, and the buyer's region into\n * a single boolean. Check this flag, not `visitorConsent.marketing`, before\n * performing marketing-related data collection.\n */\n marketing: boolean;\n /**\n * Whether preference data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Preference\n * data includes language, currency, and sizing choices.\n *\n * Whether preference data can be collected right now. Combines the buyer's\n * consent, the merchant's privacy configuration, and the buyer's region into\n * a single boolean. Check this flag, not `visitorConsent.preferences`,\n * before storing or reading buyer preference data.\n */\n preferences: boolean;\n /**\n * Whether data can be shared with third parties based on the visitor's\n * consent, the merchant's privacy configuration, and the visitor's region.\n * This typically applies to behavioral advertising data.\n *\n * Whether buyer data can be shared with or sold to third parties right now.\n * Combines the buyer's consent, the merchant's privacy configuration, and\n * the buyer's region into a single boolean. Check this flag, not\n * `visitorConsent.saleOfData`, before sharing or selling buyer data with\n * third parties.\n */\n saleOfData: boolean;\n}" }, "TrackingConsentMetafield": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -125400,7 +125400,7 @@ "Extension": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Extension", - "description": "The meta information about an extension target.", + "description": "Metadata about the running extension, including its API version, target, capabilities, and editor context. Use this to read configuration details or conditionally render content based on where the extension is running.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -125426,7 +125426,7 @@ "syntaxKind": "PropertySignature", "name": "capabilities", "value": "SubscribableSignalLike", - "description": "The allowed capabilities of the extension, defined in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n\n* [`api_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#api-access): the extension can access the Storefront API.\n\n* [`network_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access): the extension can make external network calls.\n\n* [`block_progress`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n\n* [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n\n* [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can register customer consent decisions that are honored on Shopify-managed services.\n\n* [`iframe.sources`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#iframe): the extension can embed an external URL in an iframe." + "description": "The allowed capabilities of the extension, defined in your [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -125474,7 +125474,7 @@ "syntaxKind": "PropertySignature", "name": "version", "value": "string", - "description": "The published version of the running extension target.\n\nFor unpublished extensions, the value is `undefined`.", + "description": "The published version of the running extension target.\n\nFor unpublished extensions, the value is `undefined`.\n\nDon't use this property as a stable identifier in development environments. It becomes available only after the extension is published.", "isOptional": true, "examples": [ { @@ -125490,7 +125490,7 @@ ] } ], - "value": "export interface Extension {\n /**\n * The API version that was set in the extension config file.\n *\n * @example '2024-10', '2025-01', '2025-04', '2025-07', '2025-10'\n */\n apiVersion: ApiVersion;\n\n /**\n * The allowed capabilities of the extension, defined\n * in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n *\n * * [`api_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#api-access): the extension can access the Storefront API.\n *\n * * [`network_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access): the extension can make external network calls.\n *\n * * [`block_progress`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n *\n * * [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n *\n * * [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can register customer consent decisions that are honored on Shopify-managed services.\n *\n * * [`iframe.sources`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#iframe): the extension can embed an external URL in an iframe.\n */\n capabilities: SubscribableSignalLike;\n\n /**\n * Information about the editor where the extension is being rendered.\n *\n * If the value is undefined, then the extension isn't running in an editor.\n */\n editor?: Editor;\n\n /**\n * A Boolean to show whether your extension is currently rendered to the screen.\n *\n * Shopify might render your extension before it's visible in the UI,\n * typically to pre-render extensions that appear on a later step of the\n * checkout.\n *\n * Your extension might also continue to run after the customer has navigated away\n * from where it was rendered. The extension continues running so that\n * your extension is immediately available to render if the customer navigates back.\n */\n rendered: SubscribableSignalLike;\n\n /**\n * The URL to the script that started the extension target.\n */\n scriptUrl: string;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n */\n target: Target;\n\n /**\n * The published version of the running extension target.\n *\n * For unpublished extensions, the value is `undefined`.\n *\n * @example 3.0.10\n */\n version?: string;\n}" + "value": "export interface Extension {\n /**\n * The API version that was set in the extension config file.\n *\n * @example '2024-10', '2025-01', '2025-04', '2025-07', '2025-10'\n */\n apiVersion: ApiVersion;\n\n /**\n * The allowed capabilities of the extension, defined in your\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n */\n capabilities: SubscribableSignalLike;\n\n /**\n * Information about the editor where the extension is being rendered.\n *\n * If the value is undefined, then the extension isn't running in an editor.\n */\n editor?: Editor;\n\n /**\n * A Boolean to show whether your extension is currently rendered to the screen.\n *\n * Shopify might render your extension before it's visible in the UI,\n * typically to pre-render extensions that appear on a later step of the\n * checkout.\n *\n * Your extension might also continue to run after the customer has navigated away\n * from where it was rendered. The extension continues running so that\n * your extension is immediately available to render if the customer navigates back.\n */\n rendered: SubscribableSignalLike;\n\n /**\n * The URL to the script that started the extension target.\n */\n scriptUrl: string;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n */\n target: Target;\n\n /**\n * The published version of the running extension target.\n *\n * For unpublished extensions, the value is `undefined`.\n *\n * Don't use this property as a stable identifier in development environments.\n * It becomes available only after the extension is published.\n *\n * @example 3.0.10\n */\n version?: string;\n}" }, "ApiVersion": { "filePath": "src/shared.ts", @@ -125509,7 +125509,7 @@ "Editor": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Editor", - "description": "", + "description": "Information about the editor environment when an extension is rendered inside the checkout editor. The value is `undefined` when the extension is not rendering in an editor.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -125524,7 +125524,7 @@ "I18n": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18n", - "description": "", + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use the I18n API alongside the Localization API to build fully localized extensions.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -125560,7 +125560,7 @@ "I18nTranslate": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18nTranslate", - "description": "This returns a translated string matching a key in a locale file.", + "description": "Translates a key from your extension's locale files into a localized string. Supports interpolation with placeholder replacements and pluralization via the special `count` option.", "members": [], "value": "export interface I18nTranslate {\n (\n key: string,\n options?: Record,\n ): ReplacementType extends string | number\n ? string\n : (string | ReplacementType)[];\n}" }, @@ -126124,14 +126124,14 @@ "Localization": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Localization", - "description": "", + "description": "The buyer's language, country, currency, and timezone context. Use this to adapt your extension to the buyer's region and display localized content.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "country", "value": "SubscribableSignalLike", - "description": "The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown." + "description": "The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n\nDerived from the buyer's shipping address. Returns `undefined` until the buyer enters a shipping address." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -126159,18 +126159,18 @@ "syntaxKind": "PropertySignature", "name": "market", "value": "SubscribableSignalLike", - "description": "The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n\n> Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.", - "deprecationMessage": "Deprecated as of version `2025-04`" + "description": "The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. The market context updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.", + "deprecationMessage": "Merchants now manage which extensions load for each\nmarket, so extensions no longer need to check this value." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "timezone", "value": "SubscribableSignalLike", - "description": "The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time." + "description": "The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time." } ], - "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n *\n * > Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" + "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n *\n * Derived from the buyer's shipping address. Returns `undefined` until the\n * buyer enters a shipping address.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout,\n * carried over from the cart context. Markets group countries and\n * regions with shared pricing, languages, and domains. The market\n * context updates when the buyer changes the country of their\n * shipping address. The value is `undefined` if the market is unknown.\n *\n * @deprecated Merchants now manage which extensions load for each\n * market, so extensions no longer need to check this value.\n */\n market: SubscribableSignalLike;\n}" }, "Country": { "filePath": "src/shared.ts", @@ -126371,7 +126371,7 @@ "SessionToken": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SessionToken", - "description": "", + "description": "Authenticates requests between your extension and your app backend. Use session tokens to verify the identity of the buyer and the shop context when making server-side API calls. The token is a signed JWT that contains claims such as the customer ID, shop domain, and expiration.\n\nThe `sub` claim in the decoded token is present only when the buyer is logged in and the app has permission to read customer accounts. Absent for anonymous buyers.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -126630,7 +126630,7 @@ "Shop": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Shop", - "description": "", + "description": "Metadata about the merchant's store, including its name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -126670,30 +126670,30 @@ "syntaxKind": "PropertySignature", "name": "storefrontUrl", "value": "string", - "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n\n> Caution: > As of version `2024-04` this value no longer has a trailing slash.", + "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.", "isOptional": true } ], - "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n *\n * > Caution:\n * > As of version `2024-04` this value no longer has a trailing slash.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom domain.\n */\n myshopifyDomain: string;\n}" + "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom domain.\n */\n myshopifyDomain: string;\n}" }, "Storage": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Storage", - "description": "A key-value storage object for the extension.\n\nStored data is available only to this specific extension and any of its instances.\n\nThe storage backend is implemented with `localStorage` and should persist across the buyer's checkout session. However, data persistence isn't guaranteed.", + "description": "Key-value storage for a specific extension. Use storage to save preferences or cached data that should survive page reloads without requiring a backend call. Stored data is only available to this specific extension. The storage backend is implemented with `localStorage` and data persistence isn't guaranteed.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "delete", "value": "(key: string) => Promise", - "description": "Delete stored data by key." + "description": "Deletes a previously stored value by key." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "read", "value": "(key: string) => Promise", - "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original primitive.\n\nReturns `null` if no stored data exists." + "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original type.\n\nReturns the stored value for the given key, or `null` when no value exists. Doesn't throw on a missing key." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -126703,7 +126703,7 @@ "description": "Write stored data for this key.\n\nThe data must be serializable to JSON." } ], - "value": "export interface Storage {\n /**\n * Read and return a stored value by key.\n *\n * The stored data is deserialized from JSON and returned as\n * its original primitive.\n *\n * Returns `null` if no stored data exists.\n */\n read(key: string): Promise;\n\n /**\n * Write stored data for this key.\n *\n * The data must be serializable to JSON.\n */\n write(key: string, data: any): Promise;\n\n /**\n * Delete stored data by key.\n */\n delete(key: string): Promise;\n}" + "value": "export interface Storage {\n /**\n * Read and return a stored value by key.\n *\n * The stored data is deserialized from JSON and returned as\n * its original type.\n *\n * Returns the stored value for the given key, or `null` when no value\n * exists. Doesn't throw on a missing key.\n */\n read(key: string): Promise;\n\n /**\n * Write stored data for this key.\n *\n * The data must be serializable to JSON.\n */\n write(key: string, data: any): Promise;\n\n /**\n * Deletes a previously stored value by key.\n */\n delete(key: string): Promise;\n}" }, "Version": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -126780,10 +126780,10 @@ "syntaxKind": "PropertySignature", "name": "isLocationFormVisible", "value": "SubscribableSignalLike", - "description": "Whether the location search form is currently visible to the buyer. Use this to conditionally render UI that depends on the buyer actively searching for pickup points." + "description": "Reflects which view was active when the extension loaded. When the buyer moves to the next view, the extension restarts with the current value rather than updating in place." } ], - "value": "export interface PickupPointListApi {\n /**\n * Whether the location search form is currently visible to the buyer.\n * Use this to conditionally render UI that depends on the buyer actively\n * searching for pickup points.\n */\n isLocationFormVisible: SubscribableSignalLike;\n}" + "value": "export interface PickupPointListApi {\n /**\n * Reflects which view was active when the extension loaded. When the\n * buyer moves to the next view, the extension restarts with the\n * current value rather than updating in place.\n */\n isLocationFormVisible: SubscribableSignalLike;\n}" }, "SubscribableSignalLike": { "filePath": "src/surfaces/checkout/shared.ts", @@ -126840,7 +126840,7 @@ "syntaxKind": "MethodSignature", "name": "applyAttributeChange", "value": "(change: AttributeChange) => Promise", - "description": "Updates or removes an attribute on the cart and checkout. On success, the [`attributes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/attributes#standardapi-propertydetail-attributes) property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.", + "description": "Updates or removes an attribute on the cart and checkout. On success, the [`attributes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/attributes#properties-propertydetail-attributes) property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.", "deprecationMessage": "Use cart metafields instead." }, { @@ -126848,42 +126848,42 @@ "syntaxKind": "MethodSignature", "name": "applyCartLinesChange", "value": "(change: CartLineChange) => Promise", - "description": "Adds, removes, or updates line items in the cart. The returned promise resolves when the change has been applied by the server, and the [`lines`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-lines#standardapi-propertydetail-lines) property updates with the new state.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Adds, removes, or updates line items in the cart. The returned promise resolves when the change has been applied by the server, and the [`lines`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-lines#properties-propertydetail-lines) property updates with the new state.\n\nAccepts a single change per call. To make multiple changes, call this method separately for each one.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyDiscountCodeChange", "value": "(change: DiscountCodeChange) => Promise", - "description": "Adds or removes a discount code on the checkout. The returned promise resolves when the change has been applied by the server, and the [`discountCodes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/discounts#standardapi-propertydetail-discountcodes) property updates with the new state.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves discount codes through a network call.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Adds or removes a discount code on the checkout. The returned promise resolves when the change has been applied by the server, and the [`discountCodes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/discounts#properties-propertydetail-discountcodes) property updates with the new state.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves discount codes through a network call.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyGiftCardChange", "value": "(change: GiftCardChange) => Promise", - "description": "Adds or removes a gift card from the checkout. The returned promise resolves when the change has been applied by the server, and the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/gift-cards#standardapi-propertydetail-appliedgiftcards) property updates with the new state.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves gift card codes through a network call.\n\n> Note: This method returns an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Adds or removes a gift card from the checkout. The returned promise resolves when the change has been applied by the server, and the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/gift-cards#properties-propertydetail-appliedgiftcards) property updates with the new state.\n\nUnlike other write operations, gift card changes aren't gated by a cart instruction flag.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves gift card codes through a network call.\n\n> Note: This method returns an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyMetafieldChange", "value": "(change: MetafieldChange) => Promise", - "description": "Creates, updates, or removes a cart metafield on the checkout. On success, the [`metafields`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/metafields#standardapi-propertydetail-metafields) property updates to reflect the change.\n\nCart metafields are copied to order metafields at order creation time if there's a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n\n> Caution: `MetafieldRemoveChange` and `MetafieldUpdateChange` are deprecated. Use cart metafields with `MetafieldRemoveCartChange` and `MetafieldUpdateCartChange` instead. If `MetafieldUpdateChange` writes a metafield with the same namespace and key as a cart metafield that's configured to copy, the cart metafield won't be copied.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Creates, updates, or removes a cart metafield on the checkout. On success, the [`metafields`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/metafields#properties-propertydetail-metafields) property updates to reflect the change.\n\nCart metafields are copied to order metafields at order creation time if there's a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n\n> Caution: `MetafieldRemoveChange` and `MetafieldUpdateChange` are deprecated. Use cart metafields with `MetafieldRemoveCartChange` and `MetafieldUpdateCartChange` instead. If `MetafieldUpdateChange` writes a metafield with the same namespace and key as a cart metafield that's configured to copy, the cart metafield won't be copied.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyNoteChange", "value": "(change: NoteChange) => Promise", - "description": "Sets or removes the buyer's note on the checkout. On success, the [`note`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/note#standardapi-propertydetail-note) property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Sets or removes the buyer's note on the checkout. On success, the [`note`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/note#properties-propertydetail-note) property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyShippingAddressChange", "value": "(change: ShippingAddressUpdateChange) => Promise", - "description": "Updates the buyer's shipping address on the checkout. The provided fields are merged into the existing address without prompting the buyer. On success, the `shippingAddress` property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", + "description": "Updates the buyer's shipping address on the checkout. The provided fields are merged into the existing address without prompting the buyer. On success, the `shippingAddress` property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", "isOptional": true }, { @@ -126896,7 +126896,7 @@ "isPrivate": true } ], - "value": "export interface CheckoutApi {\n /**\n * Updates or removes an attribute on the cart and checkout. On success, the\n * [`attributes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/attributes#standardapi-propertydetail-attributes) property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * @deprecated Use cart metafields instead.\n */\n applyAttributeChange(change: AttributeChange): Promise;\n\n /**\n * Adds, removes, or updates line items in the cart. The returned promise resolves when the change has been applied by the server, and the [`lines`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-lines#standardapi-propertydetail-lines) property updates with the new state.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyCartLinesChange(change: CartLineChange): Promise;\n\n /**\n * Adds or removes a discount code on the checkout. The returned promise resolves when the change has been applied by the server, and the [`discountCodes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/discounts#standardapi-propertydetail-discountcodes) property updates with the new state.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves discount codes through a network call.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyDiscountCodeChange(\n change: DiscountCodeChange,\n ): Promise;\n\n /**\n * Adds or removes a gift card from the checkout. The returned promise resolves when the change has been applied by the server, and the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/gift-cards#standardapi-propertydetail-appliedgiftcards) property updates with the new state.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves gift card codes through a network call.\n *\n * > Note: This method returns an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyGiftCardChange(change: GiftCardChange): Promise;\n\n /**\n * Creates, updates, or removes a cart metafield on the checkout. On success, the\n * [`metafields`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/metafields#standardapi-propertydetail-metafields) property updates to reflect the change.\n *\n * Cart metafields are copied to order metafields at order creation time if there's a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n *\n * > Caution: `MetafieldRemoveChange` and `MetafieldUpdateChange` are deprecated. Use cart metafields with `MetafieldRemoveCartChange` and `MetafieldUpdateCartChange` instead. If `MetafieldUpdateChange` writes a metafield with the same namespace and key as a cart metafield that's configured to copy, the cart metafield won't be copied.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyMetafieldChange(change: MetafieldChange): Promise;\n\n /**\n * Sets or removes the buyer's note on the checkout. On success, the\n * [`note`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/note#standardapi-propertydetail-note)\n * property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyNoteChange(change: NoteChange): Promise;\n\n /**\n * @private\n */\n experimentalIsShopAppStyle?: boolean;\n\n /**\n * Updates the buyer's shipping address on the checkout. The provided fields\n * are merged into the existing address without prompting the buyer. On success,\n * the `shippingAddress` property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyShippingAddressChange?(\n change: ShippingAddressChange,\n ): Promise;\n}" + "value": "export interface CheckoutApi {\n /**\n * Updates or removes an attribute on the cart and checkout. On success, the\n * [`attributes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/attributes#properties-propertydetail-attributes) property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * @deprecated Use cart metafields instead.\n */\n applyAttributeChange(change: AttributeChange): Promise;\n\n /**\n * Adds, removes, or updates line items in the cart. The returned promise resolves when the change has been applied by the server, and the [`lines`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-lines#properties-propertydetail-lines) property updates with the new state.\n *\n * Accepts a single change per call. To make multiple changes, call this\n * method separately for each one.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyCartLinesChange(change: CartLineChange): Promise;\n\n /**\n * Adds or removes a discount code on the checkout. The returned promise resolves when the change has been applied by the server, and the [`discountCodes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/discounts#properties-propertydetail-discountcodes) property updates with the new state.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves discount codes through a network call.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyDiscountCodeChange(\n change: DiscountCodeChange,\n ): Promise;\n\n /**\n * Adds or removes a gift card from the checkout. The returned promise resolves when the change has been applied by the server, and the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/gift-cards#properties-propertydetail-appliedgiftcards) property updates with the new state.\n *\n * Unlike other write operations, gift card changes aren't gated by a cart\n * instruction flag.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves gift card codes through a network call.\n *\n * > Note: This method returns an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyGiftCardChange(change: GiftCardChange): Promise;\n\n /**\n * Creates, updates, or removes a cart metafield on the checkout. On success, the\n * [`metafields`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/metafields#properties-propertydetail-metafields) property updates to reflect the change.\n *\n * Cart metafields are copied to order metafields at order creation time if there's a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n *\n * > Caution: `MetafieldRemoveChange` and `MetafieldUpdateChange` are deprecated. Use cart metafields with `MetafieldRemoveCartChange` and `MetafieldUpdateCartChange` instead. If `MetafieldUpdateChange` writes a metafield with the same namespace and key as a cart metafield that's configured to copy, the cart metafield won't be copied.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyMetafieldChange(change: MetafieldChange): Promise;\n\n /**\n * Sets or removes the buyer's note on the checkout. On success, the\n * [`note`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/note#properties-propertydetail-note)\n * property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyNoteChange(change: NoteChange): Promise;\n\n /**\n * @private\n */\n experimentalIsShopAppStyle?: boolean;\n\n /**\n * Updates the buyer's shipping address on the checkout. The provided fields\n * are merged into the existing address without prompting the buyer. On success,\n * the `shippingAddress` property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyShippingAddressChange?(\n change: ShippingAddressChange,\n ): Promise;\n}" }, "AttributeChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -126963,7 +126963,7 @@ "syntaxKind": "PropertySignature", "name": "value", "value": "string", - "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.", + "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.\n\nAttribute values are always strings. To store structured data, serialize it to JSON and parse it when reading.", "examples": [ { "title": "Example", @@ -126978,7 +126978,7 @@ ] } ], - "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" + "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * Attribute values are always strings. To store structured data, serialize\n * it to JSON and parse it when reading.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" }, "AttributeRemoveChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -127831,7 +127831,7 @@ "syntaxKind": "PropertySignature", "name": "message", "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer." + "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer.\n\nRender your own localized error text rather than displaying this message to the buyer." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -127841,7 +127841,7 @@ "description": "Indicates that the line item wasn't changed successfully. Refer to the `message` property for details about the error." } ], - "value": "export interface CartLineChangeResultError {\n /**\n * Indicates that the line item wasn't changed successfully. Refer to the `message` property for details about the error.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface CartLineChangeResultError {\n /**\n * Indicates that the line item wasn't changed successfully. Refer to the `message` property for details about the error.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n *\n * Render your own localized error text rather than displaying this message\n * to the buyer.\n */\n message: string;\n}" }, "DiscountCodeChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -128021,7 +128021,7 @@ "syntaxKind": "PropertySignature", "name": "message", "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer." + "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer.\n\nRender your own localized error text rather than displaying this message to the buyer." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -128031,7 +128031,7 @@ "description": "Indicates that the gift card change couldn't be applied. Check the `message` property for details." } ], - "value": "export interface GiftCardChangeResultError {\n /**\n * Indicates that the gift card change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface GiftCardChangeResultError {\n /**\n * Indicates that the gift card change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n *\n * Render your own localized error text rather than displaying this message\n * to the buyer.\n */\n message: string;\n}" }, "MetafieldChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -128292,7 +128292,7 @@ "syntaxKind": "PropertySignature", "name": "message", "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer." + "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer.\n\nRender your own localized error text rather than displaying this message to the buyer." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -128302,7 +128302,7 @@ "description": "Indicates that the metafield change couldn't be applied. Check the `message` property for details." } ], - "value": "export interface MetafieldChangeResultError {\n /**\n * Indicates that the metafield change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface MetafieldChangeResultError {\n /**\n * Indicates that the metafield change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n *\n * Render your own localized error text rather than displaying this message\n * to the buyer.\n */\n message: string;\n}" }, "NoteChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -128380,7 +128380,7 @@ "syntaxKind": "PropertySignature", "name": "message", "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer." + "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer.\n\nRender your own localized error text rather than displaying this message to the buyer." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -128390,7 +128390,7 @@ "description": "Indicates that the note change couldn't be applied. Check the `message` property for details." } ], - "value": "export interface NoteChangeResultError {\n /**\n * Indicates that the note change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface NoteChangeResultError {\n /**\n * Indicates that the note change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n *\n * Render your own localized error text rather than displaying this message\n * to the buyer.\n */\n message: string;\n}" }, "ShippingAddressUpdateChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -128976,7 +128976,7 @@ "syntaxKind": "PropertySignature", "name": "analytics", "value": "Analytics", - "description": "The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event." + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -128990,7 +128990,7 @@ "syntaxKind": "PropertySignature", "name": "applyTrackingConsentChange", "value": "ApplyTrackingConsentChangeType", - "description": "Enables setting and updating customer privacy consent settings and tracking consent metafields.\n\n> Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent) to be set to `true`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." + "description": "Enables setting and updating customer privacy consent settings and tracking consent metafields.\n\n> Note: Requires the [`collect_buyer_consent` capability](/docs/apps/build/customer-accounts/capabilities#collect-buyer-consent) to be set to `true`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -129011,7 +129011,7 @@ "syntaxKind": "PropertySignature", "name": "availablePaymentOptions", "value": "SubscribableSignalLike", - "description": "All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region." + "description": "All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n\nThe set of payment options can change when the buyer updates their address or cart, so subscribe to changes rather than reading once during initialization. Each option exposes `handle` and `type` only. Provider names, logos, fees, and installment terms aren't available." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -129048,7 +129048,7 @@ "syntaxKind": "PropertySignature", "name": "checkoutToken", "value": "SubscribableSignalLike", - "description": "A stable ID that represents the current checkout.\n\nThe value is `undefined` when the checkout hasn't been created on the server yet.\n\nUse this to correlate checkout sessions across your extension, web pixels, and backend systems.\n\nThis matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data) and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object)." + "description": "A stable ID that represents the current checkout.\n\nThe value is `undefined` when the checkout hasn't been created on the server yet.\n\nUse this to correlate checkout sessions across your extension, web pixels, and backend systems.\n\nThis matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data) and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n\nCan be `undefined`. Handle the `undefined` state before using the value." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -129069,7 +129069,7 @@ "syntaxKind": "PropertySignature", "name": "deliveryGroups", "value": "SubscribableSignalLike", - "description": "The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items." + "description": "The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n\nEmpty until the buyer enters enough address information for Shopify to calculate shipping rates." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -129090,7 +129090,7 @@ "syntaxKind": "PropertySignature", "name": "extension", "value": "Extension", - "description": "The meta information about the extension." + "description": "Metadata about the running extension, including the current target, API version, capabilities, and editor context. Use this to conditionally render content based on where the extension is running." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -129098,7 +129098,7 @@ "name": "extensionPoint", "value": "Target", "description": "The identifier that specifies where in Shopify's UI your code is being injected. This is one of the targets you've included in your extension's configuration file.", - "deprecationMessage": "Deprecated as of version `2023-07`, use `extension.target` instead.", + "deprecationMessage": "Use `extension.target` instead.", "examples": [ { "title": "Example", @@ -129117,14 +129117,14 @@ "syntaxKind": "PropertySignature", "name": "i18n", "value": "I18n", - "description": "Utilities for translating content and formatting values according to the current [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) of the checkout.\n\nRefer to [`localization` examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples) for more information." + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use alongside [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) to build fully localized extensions." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "instructions", "value": "SubscribableSignalLike", - "description": "The cart instructions used to create the checkout and possibly limit extension capabilities.\n\nThese instructions should be checked before performing any actions that might be affected by them.\n\nFor example, if you intend to add a discount code via the `applyDiscountCodeChange` method, check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n\n> Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs aren't available. See the [update guide](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples) for more information." + "description": "The cart instructions used to create the checkout and possibly limit extension capabilities.\n\nThese instructions should be checked before performing any actions that might be affected by them.\n\nFor example, if you intend to add a discount code via the `applyDiscountCodeChange` method, check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n\n> Caution: Check cart instructions before calling select APIs, as > some may not be available. See the > [Cart Instructions API](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples) > for more information." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -129138,7 +129138,7 @@ "syntaxKind": "PropertySignature", "name": "localization", "value": "Localization", - "description": "The details about the location, language, and currency of the customer. For utilities to easily format and translate content based on these details, you can use the [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n) object instead." + "description": "The buyer's language, country, currency, and timezone context. For formatting and translation helpers, use the [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#properties-propertydetail-i18n) object instead." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -129168,21 +129168,21 @@ "syntaxKind": "PropertySignature", "name": "query", "value": ">(query: string, options?: { variables?: Variables; version?: StorefrontApiVersion; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>", - "description": "The method used to query the Storefront GraphQL API with a prefetched token.\n\nRefer to [Storefront API access examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/storefront-api) for more information." + "description": "The method used to query the Storefront GraphQL API with a prefetched token." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "selectedPaymentOptions", "value": "SubscribableSignalLike", - "description": "The payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card)." + "description": "The payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\n\nEach option exposes `handle` and `type` only. Provider names, logos, fees, and installment terms aren't available." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "sessionToken", "value": "SessionToken", - "description": "The session token providing a set of claims as a signed JSON Web Token (JWT).\n\nThe token has a TTL of five minutes.\n\nIf the previous token expires, this value reflects a new session token with a new signature and expiry.\n\nRefer to [session token examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/session-token) for more information." + "description": "The session token providing a set of claims as a signed JSON Web Token (JWT).\n\nThe token has a TTL of five minutes.\n\nIf the previous token expires, this value reflects a new session token with a new signature and expiry.\n\nLearn more about [session tokens](/docs/apps/build/authentication-authorization/session-tokens)." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -129204,14 +129204,14 @@ "syntaxKind": "PropertySignature", "name": "shop", "value": "Shop", - "description": "The shop where the checkout is taking place." + "description": "The store where the checkout is taking place, including the shop name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "storage", "value": "Storage", - "description": "The key-value storage for the extension.\n\nIt uses `localStorage` and should persist across the customer's current checkout session.\n\n> Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n\nData is shared across all activated extension targets of this extension. In versions 2023-07 and earlier, each activated extension target had its own storage." + "description": "Key-value storage that persists across page loads within the current checkout session. Data is shared across all activated targets associated with this extension.\n\n> Caution: Data persistence isn't guaranteed and storage is cleared when the buyer starts a new checkout." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -129233,29 +129233,29 @@ ] } ], - "value": "export interface StandardApi {\n /**\n * The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event.\n */\n analytics: Analytics;\n\n /**\n * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\n */\n appliedGiftCards: SubscribableSignalLike;\n\n /**\n * The cart instructions used to create the checkout and possibly limit extension capabilities.\n *\n * These instructions should be checked before performing any actions that might be affected by them.\n *\n * For example, if you intend to add a discount code via the `applyDiscountCodeChange` method,\n * check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n *\n * > Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs aren't available.\n * See the [update guide](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples) for more information.\n *\n */\n instructions: SubscribableSignalLike;\n\n /**\n * The metafields requested in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration)\n * file. These metafields are updated when there's a change in the merchandise items\n * being purchased by the customer.\n *\n * App owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` isn't supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n appMetafields: SubscribableSignalLike;\n\n /**\n * The custom key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n buyerIdentity?: BuyerIdentity;\n\n /**\n * Provides details on the buyer's progression through the checkout and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/buyer-journey#examples)\n * examples for more information.\n */\n buyerJourney: BuyerJourney;\n\n /**\n * Settings applied to the buyer's checkout.\n */\n checkoutSettings: SubscribableSignalLike;\n\n /**\n * A stable ID that represents the current checkout.\n *\n * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\n *\n * This matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data)\n * and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n */\n checkoutToken: SubscribableSignalLike;\n\n /**\n * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * The meta information about the extension.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n *\n * @deprecated Deprecated as of version `2023-07`, use `extension.target` instead.\n */\n extensionPoint: Target;\n\n /**\n * Utilities for translating content and formatting values according to the current\n * [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization)\n * of the checkout.\n *\n * Refer to [`localization` examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples)\n * for more information.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The details about the location, language, and currency of the customer. For utilities to easily\n * format and translate content based on these details, you can use the\n * [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n)\n * object instead.\n */\n localization: Localization;\n\n /**\n * The metafields that apply to the current checkout.\n *\n * Metafields are stored locally on the client and are applied to the order object after the checkout completes.\n *\n * These metafields are shared by all extensions running on checkout, and\n * persist for as long as the customer is working on this checkout.\n *\n * Once the order is created, you can query these metafields using the\n * [GraphQL Admin API](/docs/admin-api/graphql/reference/orders/order#metafield-2021-01)\n *\n * > Caution:\n * `metafields` is deprecated. Use `appMetafields` with cart metafields instead.\n *\n * @deprecated Use `appMetafields` with cart metafields instead.\n */\n metafields: SubscribableSignalLike;\n\n /**\n * A note left by the customer to the merchant, either in their cart or during checkout.\n *\n * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\n */\n note: SubscribableSignalLike;\n\n /**\n * The method used to query the Storefront GraphQL API with a prefetched token.\n *\n * Refer to [Storefront API access examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/storefront-api) for more information.\n */\n query: >(\n query: string,\n options?: {variables?: Variables; version?: StorefrontApiVersion},\n ) => Promise<{data?: Data; errors?: GraphQLError[]}>;\n\n /**\n * The payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\n */\n selectedPaymentOptions: SubscribableSignalLike;\n\n /**\n * The session token providing a set of claims as a signed JSON Web Token (JWT).\n *\n * The token has a TTL of five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/session-token) for more information.\n */\n sessionToken: SessionToken;\n\n /**\n * The settings matching the settings definition written in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates in real time as a merchant fills in the settings.\n */\n settings: SubscribableSignalLike;\n\n /**\n * The proposed customer shipping address. During the information step, the address\n * updates when the field is committed (on change) rather than every keystroke.\n * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n shippingAddress?: SubscribableSignalLike;\n\n /**\n * The proposed customer billing address. The address updates when the field is\n * committed (on change) rather than every keystroke. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided yet.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n billingAddress?: SubscribableSignalLike;\n\n /** The shop where the checkout is taking place. */\n shop: Shop;\n\n /**\n * The key-value storage for the extension.\n *\n * It uses `localStorage` and should persist across the customer's current checkout session.\n *\n * > Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n *\n * Data is shared across all activated extension targets of this extension. In versions 2023-07 and earlier,\n * each activated extension target had its own storage.\n */\n storage: Storage;\n\n /**\n * The renderer version being used for the extension.\n *\n * @example '2025-10'\n */\n version: Version;\n\n /**\n * Customer privacy consent settings and a flag denoting if consent has previously been collected.\n */\n customerPrivacy: SubscribableSignalLike;\n\n /**\n * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent) to be set to `true`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyTrackingConsentChange: ApplyTrackingConsentChangeType;\n\n /**\n * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" + "value": "export interface StandardApi {\n /**\n * Tracks custom events and sends visitor information to\n * [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events\n * and `visitor()` to submit buyer contact details.\n */\n analytics: Analytics;\n\n /**\n * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\n */\n appliedGiftCards: SubscribableSignalLike;\n\n /**\n * The cart instructions used to create the checkout and possibly limit extension capabilities.\n *\n * These instructions should be checked before performing any actions that might be affected by them.\n *\n * For example, if you intend to add a discount code via the `applyDiscountCodeChange` method,\n * check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n *\n * > Caution: Check cart instructions before calling select APIs, as\n * > some may not be available. See the\n * > [Cart Instructions API](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples)\n * > for more information.\n *\n */\n instructions: SubscribableSignalLike;\n\n /**\n * The metafields requested in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration)\n * file. These metafields are updated when there's a change in the merchandise items\n * being purchased by the customer.\n *\n * App owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` isn't supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n appMetafields: SubscribableSignalLike;\n\n /**\n * The custom key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as\n * credit cards, wallets, and local payment methods. The list depends on\n * the shop's payment configuration and the buyer's region.\n *\n * The set of payment options can change when the buyer updates their\n * address or cart, so subscribe to changes rather than reading once\n * during initialization. Each option exposes `handle` and `type` only.\n * Provider names, logos, fees, and installment terms aren't available.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n buyerIdentity?: BuyerIdentity;\n\n /**\n * Provides details on the buyer's progression through the checkout and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/buyer-journey#examples)\n * examples for more information.\n */\n buyerJourney: BuyerJourney;\n\n /**\n * Settings applied to the buyer's checkout.\n */\n checkoutSettings: SubscribableSignalLike;\n\n /**\n * A stable ID that represents the current checkout.\n *\n * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\n *\n * This matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data)\n * and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n *\n * Can be `undefined`. Handle the `undefined` state before using the value.\n */\n checkoutToken: SubscribableSignalLike;\n\n /**\n * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n *\n * Empty until the buyer enters enough address information for Shopify to\n * calculate shipping rates.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * Metadata about the running extension, including the current target, API version,\n * capabilities, and editor context. Use this to conditionally render content\n * based on where the extension is running.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n *\n * @deprecated Use `extension.target` instead.\n */\n extensionPoint: Target;\n\n /**\n * Utilities for translating strings, formatting currencies, numbers, and dates\n * according to the buyer's locale. Use alongside\n * [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization)\n * to build fully localized extensions.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The buyer's language, country, currency, and timezone context. For\n * formatting and translation helpers, use the\n * [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#properties-propertydetail-i18n)\n * object instead.\n */\n localization: Localization;\n\n /**\n * The metafields that apply to the current checkout.\n *\n * Metafields are stored locally on the client and are applied to the order object after the checkout completes.\n *\n * These metafields are shared by all extensions running on checkout, and\n * persist for as long as the customer is working on this checkout.\n *\n * Once the order is created, you can query these metafields using the\n * [GraphQL Admin API](/docs/admin-api/graphql/reference/orders/order#metafield-2021-01)\n *\n * > Caution:\n * `metafields` is deprecated. Use `appMetafields` with cart metafields instead.\n *\n * @deprecated Use `appMetafields` with cart metafields instead.\n */\n metafields: SubscribableSignalLike;\n\n /**\n * A note left by the customer to the merchant, either in their cart or during checkout.\n *\n * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\n */\n note: SubscribableSignalLike;\n\n /**\n * The method used to query the Storefront GraphQL API with a prefetched token.\n *\n */\n query: >(\n query: string,\n options?: {variables?: Variables; version?: StorefrontApiVersion},\n ) => Promise<{data?: Data; errors?: GraphQLError[]}>;\n\n /**\n * The payment options the buyer has currently selected. This updates as\n * the buyer changes their payment method. The array can contain multiple\n * entries when the buyer splits payment across methods (for example, a\n * gift card and a credit card).\n *\n * Each option exposes `handle` and `type` only. Provider names, logos,\n * fees, and installment terms aren't available.\n */\n selectedPaymentOptions: SubscribableSignalLike;\n\n /**\n * The session token providing a set of claims as a signed JSON Web Token (JWT).\n *\n * The token has a TTL of five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Learn more about [session tokens](/docs/apps/build/authentication-authorization/session-tokens).\n */\n sessionToken: SessionToken;\n\n /**\n * The settings matching the settings definition written in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates in real time as a merchant fills in the settings.\n */\n settings: SubscribableSignalLike;\n\n /**\n * The proposed customer shipping address. During the information step, the address\n * updates when the field is committed (on change) rather than every keystroke.\n * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n shippingAddress?: SubscribableSignalLike;\n\n /**\n * The proposed customer billing address. The address updates when the field is\n * committed (on change) rather than every keystroke. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided yet.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n billingAddress?: SubscribableSignalLike;\n\n /**\n * The store where the checkout is taking place, including the shop name,\n * storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.\n */\n shop: Shop;\n\n /**\n * Key-value storage that persists across page loads within the current checkout\n * session. Data is shared across all activated targets associated with\n * this extension.\n *\n * > Caution: Data persistence isn't guaranteed and storage is cleared when the\n * buyer starts a new checkout.\n */\n storage: Storage;\n\n /**\n * The renderer version being used for the extension.\n *\n * @example '2025-10'\n */\n version: Version;\n\n /**\n * Customer privacy consent settings and a flag denoting if consent has previously been collected.\n */\n customerPrivacy: SubscribableSignalLike;\n\n /**\n * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`collect_buyer_consent` capability](/docs/apps/build/customer-accounts/capabilities#collect-buyer-consent) to be set to `true`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyTrackingConsentChange: ApplyTrackingConsentChangeType;\n\n /**\n * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" }, "Analytics": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Analytics", - "description": "", + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "publish", "value": "(name: string, data: Record) => Promise", - "description": "Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing)." + "description": "Publishes a custom event to [Web Pixels](/docs/apps/marketing). Returns `true` when the event is successfully dispatched.\n\nThe Promise resolves to `true` when the event was dispatched. The boolean indicates dispatch confirmation only. It doesn't indicate whether any specific web pixel processed the event." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "visitor", "value": "(data: { email?: string; phone?: string; }) => Promise", - "description": "A method for capturing details about a visitor on the online store." + "description": "Submits buyer contact details for attribution and analytics purposes." } ], - "value": "export interface Analytics {\n /**\n * Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing).\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * A method for capturing details about a visitor on the online store.\n */\n visitor(data: {email?: string; phone?: string}): Promise;\n}" + "value": "export interface Analytics {\n /**\n * Publishes a custom event to [Web Pixels](/docs/apps/marketing).\n * Returns `true` when the event is successfully dispatched.\n *\n * The Promise resolves to `true` when the event was dispatched. The boolean\n * indicates dispatch confirmation only. It doesn't indicate whether any\n * specific web pixel processed the event.\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * Submits buyer contact details for attribution and analytics purposes.\n */\n visitor(data: {email?: string; phone?: string}): Promise;\n}" }, "VisitorResult": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -129296,10 +129296,10 @@ "syntaxKind": "PropertySignature", "name": "type", "value": "'error'", - "description": "Indicates that the visitor information is invalid and wasn't submitted. Examples are using the wrong data type or missing a required property." + "description": "Indicates that the visitor information is invalid and wasn't submitted. Common causes include using the wrong data type or omitting a required property." } ], - "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Examples are using the wrong data type or missing a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Common causes include using the wrong data type or omitting a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" }, "SubscribableSignalLike": { "filePath": "src/surfaces/checkout/shared.ts", @@ -129513,10 +129513,10 @@ "syntaxKind": "PropertySignature", "name": "value", "value": "string | null", - "description": "The new value to store in the metafield. Set to `null` to delete the metafield." + "description": "The new value to store in the metafield. Set to `null` to delete the metafield.\n\nConsent metafield values are strings, not booleans. Pass `null` to delete a tracking consent metafield." } ], - "value": "export interface TrackingConsentMetafieldChange {\n /**\n * The identifier for the tracking consent metafield to update.\n */\n key: string;\n /**\n * The new value to store in the metafield. Set to `null` to delete the metafield.\n */\n value: string | null;\n}" + "value": "export interface TrackingConsentMetafieldChange {\n /**\n * The identifier for the tracking consent metafield to update.\n */\n key: string;\n /**\n * The new value to store in the metafield. Set to `null` to delete the metafield.\n *\n * Consent metafield values are strings, not booleans. Pass `null` to delete\n * a tracking consent metafield.\n */\n value: string | null;\n}" }, "VisitorConsent": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -129730,7 +129730,7 @@ "syntaxKind": "PropertySignature", "name": "value", "value": "string", - "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.", + "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.\n\nAttribute values are always strings. To store structured data, serialize it to JSON and parse it when reading.", "examples": [ { "title": "Example", @@ -129745,7 +129745,7 @@ ] } ], - "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" + "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * Attribute values are always strings. To store structured data, serialize\n * it to JSON and parse it when reading.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" }, "PaymentOption": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -130096,7 +130096,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A globally-unique identifier for the customer in the format `gid://shopify/Customer/`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", + "description": "An identifier for the customer in the format `gid://shopify/Customer/`. This value is unique per shop.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", "examples": [ { "title": "Example", @@ -130149,7 +130149,7 @@ "isPrivate": true } ], - "value": "export interface Customer {\n /**\n * A globally-unique identifier for the customer in the format `gid://shopify/Customer/`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'gid://shopify/Customer/123'\n */\n id: string;\n /**\n * The email address associated with the customer's account. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email?: string;\n /**\n * The phone number associated with the customer's account. The value is `undefined` if no phone number is on file or the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone?: string;\n /**\n * The customer's full name, typically a combination of first and last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n fullName?: string;\n /**\n * The customer's first name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n firstName?: string;\n /**\n * The customer's last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n lastName?: string;\n /**\n * The customer's profile image, such as a Gravatar avatar. Use this to personalize the extension UI for the logged-in buyer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n image: ImageDetails;\n /**\n * Whether the customer has opted in to receiving marketing communications from the merchant, such as email campaigns and promotional offers.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * > Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n *\n * @deprecated Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n */\n acceptsMarketing: boolean;\n /**\n * Whether the customer has opted in to email marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsEmailMarketing: boolean;\n /**\n * Whether the customer has opted in to SMS marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsSmsMarketing: boolean;\n /**\n * The store credit accounts owned by this customer that can be used as payment during checkout. Each account has a balance representing available store credit.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @private\n */\n storeCreditAccounts: StoreCreditAccount[];\n /**\n * The number of orders the customer has previously placed with this shop.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n ordersCount: number;\n}" + "value": "export interface Customer {\n /**\n * An identifier for the customer in the format `gid://shopify/Customer/`. This value is unique per shop.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'gid://shopify/Customer/123'\n */\n id: string;\n /**\n * The email address associated with the customer's account. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email?: string;\n /**\n * The phone number associated with the customer's account. The value is `undefined` if no phone number is on file or the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone?: string;\n /**\n * The customer's full name, typically a combination of first and last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n fullName?: string;\n /**\n * The customer's first name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n firstName?: string;\n /**\n * The customer's last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n lastName?: string;\n /**\n * The customer's profile image, such as a Gravatar avatar. Use this to personalize the extension UI for the logged-in buyer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n image: ImageDetails;\n /**\n * Whether the customer has opted in to receiving marketing communications from the merchant, such as email campaigns and promotional offers.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * > Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n *\n * @deprecated Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n */\n acceptsMarketing: boolean;\n /**\n * Whether the customer has opted in to email marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsEmailMarketing: boolean;\n /**\n * Whether the customer has opted in to SMS marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsSmsMarketing: boolean;\n /**\n * The store credit accounts owned by this customer that can be used as payment during checkout. Each account has a balance representing available store credit.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @private\n */\n storeCreditAccounts: StoreCreditAccount[];\n /**\n * The number of orders the customer has previously placed with this shop.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n ordersCount: number;\n}" }, "ImageDetails": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -130431,11 +130431,11 @@ "syntaxKind": "MethodSignature", "name": "perform", "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", + "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.\n\nRuns after all intercept results are collected. Use it for local state updates such as setting an error flag. By the time it runs, the navigation decision is final, so blocking logic belongs in the intercept handler itself, not here.", "isOptional": true } ], - "value": "interface InterceptorRequestAllow {\n /**\n * Indicates that the interceptor allows the buyer's journey to continue.\n */\n behavior: 'allow';\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" + "value": "interface InterceptorRequestAllow {\n /**\n * Indicates that the interceptor allows the buyer's journey to continue.\n */\n behavior: 'allow';\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n *\n * Runs after all intercept results are collected. Use it for local state\n * updates such as setting an error flag. By the time it runs, the navigation\n * decision is final, so blocking logic belongs in the intercept handler\n * itself, not here.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" }, "InterceptorResult": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -130499,7 +130499,7 @@ "syntaxKind": "MethodSignature", "name": "perform", "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", + "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.\n\nRuns after all intercept results are collected. Use it for local state updates such as setting an error flag. By the time it runs, the navigation decision is final, so blocking logic belongs in the intercept handler itself, not here.", "isOptional": true }, { @@ -130510,7 +130510,7 @@ "description": "The reason for blocking the interceptor request. This value isn't presented to the buyer, so it doesn't need to be localized. The value is used only for Shopify's own internal debugging and metrics." } ], - "value": "interface InterceptorRequestBlock {\n /**\n * Indicates that the interceptor blocks the buyer's journey from continuing.\n */\n behavior: 'block';\n\n /**\n * The reason for blocking the interceptor request. This value isn't presented to\n * the buyer, so it doesn't need to be localized. The value is used only for Shopify's\n * own internal debugging and metrics.\n */\n reason: string;\n\n /**\n * Used to pass errors to the checkout UI, outside your extension's UI boundaries.\n */\n errors?: ValidationError[];\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" + "value": "interface InterceptorRequestBlock {\n /**\n * Indicates that the interceptor blocks the buyer's journey from continuing.\n */\n behavior: 'block';\n\n /**\n * The reason for blocking the interceptor request. This value isn't presented to\n * the buyer, so it doesn't need to be localized. The value is used only for Shopify's\n * own internal debugging and metrics.\n */\n reason: string;\n\n /**\n * Used to pass errors to the checkout UI, outside your extension's UI boundaries.\n */\n errors?: ValidationError[];\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n *\n * Runs after all intercept results are collected. Use it for local state\n * updates such as setting an error flag. By the time it runs, the navigation\n * decision is final, so blocking logic belongs in the intercept handler\n * itself, not here.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" }, "ValidationError": { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -130731,17 +130731,17 @@ "syntaxKind": "PropertySignature", "name": "totalShippingAmount", "value": "SubscribableSignalLike", - "description": "The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step." + "description": "The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step.\n\n`undefined` until the buyer selects a shipping method (typically after the information step)." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "totalTaxAmount", "value": "SubscribableSignalLike", - "description": "The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet." + "description": "The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet.\n\n`undefined` when taxes haven't been calculated or aren't available for the buyer's region." } ], - "value": "export interface CartCost {\n /**\n * The sum of all line item prices at the current step of checkout, before shipping and taxes are applied. Use this value to display the base cost of the items the buyer purchased.\n */\n subtotalAmount: SubscribableSignalLike;\n\n /**\n * The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step.\n */\n totalShippingAmount: SubscribableSignalLike;\n\n /**\n * The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet.\n */\n totalTaxAmount: SubscribableSignalLike;\n\n /**\n * The minimum total at the current step of checkout. Costs not yet calculated, such as shipping on the information step, aren't included. Gift cards and store credits are excluded from this total.\n */\n totalAmount: SubscribableSignalLike;\n}" + "value": "export interface CartCost {\n /**\n * The sum of all line item prices at the current step of checkout, before shipping and taxes are applied. Use this value to display the base cost of the items the buyer purchased.\n */\n subtotalAmount: SubscribableSignalLike;\n\n /**\n * The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step.\n *\n * `undefined` until the buyer selects a shipping method (typically after the\n * information step).\n */\n totalShippingAmount: SubscribableSignalLike;\n\n /**\n * The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet.\n *\n * `undefined` when taxes haven't been calculated or aren't available for the\n * buyer's region.\n */\n totalTaxAmount: SubscribableSignalLike;\n\n /**\n * The minimum total at the current step of checkout. Costs not yet calculated, such as shipping on the information step, aren't included. Gift cards and store credits are excluded from this total.\n */\n totalAmount: SubscribableSignalLike;\n}" }, "CustomerPrivacy": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -130828,31 +130828,31 @@ "syntaxKind": "PropertySignature", "name": "analytics", "value": "boolean", - "description": "Whether analytics data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Analytics data includes how the shop was used and what interactions occurred." + "description": "Whether analytics data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Analytics data includes how the shop was used and what interactions occurred.\n\nWhether analytics data can be collected right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.analytics`, before calling `shopify.analytics.publish()`." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "marketing", "value": "boolean", - "description": "Whether marketing data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Marketing data includes attribution and targeted advertising preferences." + "description": "Whether marketing data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Marketing data includes attribution and targeted advertising preferences.\n\nWhether marketing data can be collected right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.marketing`, before performing marketing-related data collection." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "preferences", "value": "boolean", - "description": "Whether preference data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Preference data includes language, currency, and sizing choices." + "description": "Whether preference data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Preference data includes language, currency, and sizing choices.\n\nWhether preference data can be collected right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.preferences`, before storing or reading buyer preference data." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "saleOfData", "value": "boolean", - "description": "Whether data can be shared with third parties based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. This typically applies to behavioral advertising data." + "description": "Whether data can be shared with third parties based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. This typically applies to behavioral advertising data.\n\nWhether buyer data can be shared with or sold to third parties right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.saleOfData`, before sharing or selling buyer data with third parties." } ], - "value": "export interface AllowedProcessing {\n /**\n * Whether analytics data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Analytics\n * data includes how the shop was used and what interactions occurred.\n */\n analytics: boolean;\n /**\n * Whether marketing data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Marketing\n * data includes attribution and targeted advertising preferences.\n */\n marketing: boolean;\n /**\n * Whether preference data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Preference\n * data includes language, currency, and sizing choices.\n */\n preferences: boolean;\n /**\n * Whether data can be shared with third parties based on the visitor's\n * consent, the merchant's privacy configuration, and the visitor's region.\n * This typically applies to behavioral advertising data.\n */\n saleOfData: boolean;\n}" + "value": "export interface AllowedProcessing {\n /**\n * Whether analytics data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Analytics\n * data includes how the shop was used and what interactions occurred.\n *\n * Whether analytics data can be collected right now. Combines the buyer's\n * consent, the merchant's privacy configuration, and the buyer's region into\n * a single boolean. Check this flag, not `visitorConsent.analytics`, before\n * calling `shopify.analytics.publish()`.\n */\n analytics: boolean;\n /**\n * Whether marketing data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Marketing\n * data includes attribution and targeted advertising preferences.\n *\n * Whether marketing data can be collected right now. Combines the buyer's\n * consent, the merchant's privacy configuration, and the buyer's region into\n * a single boolean. Check this flag, not `visitorConsent.marketing`, before\n * performing marketing-related data collection.\n */\n marketing: boolean;\n /**\n * Whether preference data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Preference\n * data includes language, currency, and sizing choices.\n *\n * Whether preference data can be collected right now. Combines the buyer's\n * consent, the merchant's privacy configuration, and the buyer's region into\n * a single boolean. Check this flag, not `visitorConsent.preferences`,\n * before storing or reading buyer preference data.\n */\n preferences: boolean;\n /**\n * Whether data can be shared with third parties based on the visitor's\n * consent, the merchant's privacy configuration, and the visitor's region.\n * This typically applies to behavioral advertising data.\n *\n * Whether buyer data can be shared with or sold to third parties right now.\n * Combines the buyer's consent, the merchant's privacy configuration, and\n * the buyer's region into a single boolean. Check this flag, not\n * `visitorConsent.saleOfData`, before sharing or selling buyer data with\n * third parties.\n */\n saleOfData: boolean;\n}" }, "TrackingConsentMetafield": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -131544,7 +131544,7 @@ "Extension": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Extension", - "description": "The meta information about an extension target.", + "description": "Metadata about the running extension, including its API version, target, capabilities, and editor context. Use this to read configuration details or conditionally render content based on where the extension is running.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -131570,7 +131570,7 @@ "syntaxKind": "PropertySignature", "name": "capabilities", "value": "SubscribableSignalLike", - "description": "The allowed capabilities of the extension, defined in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n\n* [`api_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#api-access): the extension can access the Storefront API.\n\n* [`network_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access): the extension can make external network calls.\n\n* [`block_progress`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n\n* [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n\n* [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can register customer consent decisions that are honored on Shopify-managed services.\n\n* [`iframe.sources`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#iframe): the extension can embed an external URL in an iframe." + "description": "The allowed capabilities of the extension, defined in your [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -131618,7 +131618,7 @@ "syntaxKind": "PropertySignature", "name": "version", "value": "string", - "description": "The published version of the running extension target.\n\nFor unpublished extensions, the value is `undefined`.", + "description": "The published version of the running extension target.\n\nFor unpublished extensions, the value is `undefined`.\n\nDon't use this property as a stable identifier in development environments. It becomes available only after the extension is published.", "isOptional": true, "examples": [ { @@ -131634,7 +131634,7 @@ ] } ], - "value": "export interface Extension {\n /**\n * The API version that was set in the extension config file.\n *\n * @example '2024-10', '2025-01', '2025-04', '2025-07', '2025-10'\n */\n apiVersion: ApiVersion;\n\n /**\n * The allowed capabilities of the extension, defined\n * in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n *\n * * [`api_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#api-access): the extension can access the Storefront API.\n *\n * * [`network_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access): the extension can make external network calls.\n *\n * * [`block_progress`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n *\n * * [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n *\n * * [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can register customer consent decisions that are honored on Shopify-managed services.\n *\n * * [`iframe.sources`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#iframe): the extension can embed an external URL in an iframe.\n */\n capabilities: SubscribableSignalLike;\n\n /**\n * Information about the editor where the extension is being rendered.\n *\n * If the value is undefined, then the extension isn't running in an editor.\n */\n editor?: Editor;\n\n /**\n * A Boolean to show whether your extension is currently rendered to the screen.\n *\n * Shopify might render your extension before it's visible in the UI,\n * typically to pre-render extensions that appear on a later step of the\n * checkout.\n *\n * Your extension might also continue to run after the customer has navigated away\n * from where it was rendered. The extension continues running so that\n * your extension is immediately available to render if the customer navigates back.\n */\n rendered: SubscribableSignalLike;\n\n /**\n * The URL to the script that started the extension target.\n */\n scriptUrl: string;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n */\n target: Target;\n\n /**\n * The published version of the running extension target.\n *\n * For unpublished extensions, the value is `undefined`.\n *\n * @example 3.0.10\n */\n version?: string;\n}" + "value": "export interface Extension {\n /**\n * The API version that was set in the extension config file.\n *\n * @example '2024-10', '2025-01', '2025-04', '2025-07', '2025-10'\n */\n apiVersion: ApiVersion;\n\n /**\n * The allowed capabilities of the extension, defined in your\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n */\n capabilities: SubscribableSignalLike;\n\n /**\n * Information about the editor where the extension is being rendered.\n *\n * If the value is undefined, then the extension isn't running in an editor.\n */\n editor?: Editor;\n\n /**\n * A Boolean to show whether your extension is currently rendered to the screen.\n *\n * Shopify might render your extension before it's visible in the UI,\n * typically to pre-render extensions that appear on a later step of the\n * checkout.\n *\n * Your extension might also continue to run after the customer has navigated away\n * from where it was rendered. The extension continues running so that\n * your extension is immediately available to render if the customer navigates back.\n */\n rendered: SubscribableSignalLike;\n\n /**\n * The URL to the script that started the extension target.\n */\n scriptUrl: string;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n */\n target: Target;\n\n /**\n * The published version of the running extension target.\n *\n * For unpublished extensions, the value is `undefined`.\n *\n * Don't use this property as a stable identifier in development environments.\n * It becomes available only after the extension is published.\n *\n * @example 3.0.10\n */\n version?: string;\n}" }, "ApiVersion": { "filePath": "src/shared.ts", @@ -131653,7 +131653,7 @@ "Editor": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Editor", - "description": "", + "description": "Information about the editor environment when an extension is rendered inside the checkout editor. The value is `undefined` when the extension is not rendering in an editor.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -131668,7 +131668,7 @@ "I18n": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18n", - "description": "", + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use the I18n API alongside the Localization API to build fully localized extensions.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -131704,7 +131704,7 @@ "I18nTranslate": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18nTranslate", - "description": "This returns a translated string matching a key in a locale file.", + "description": "Translates a key from your extension's locale files into a localized string. Supports interpolation with placeholder replacements and pluralization via the special `count` option.", "members": [], "value": "export interface I18nTranslate {\n (\n key: string,\n options?: Record,\n ): ReplacementType extends string | number\n ? string\n : (string | ReplacementType)[];\n}" }, @@ -132268,14 +132268,14 @@ "Localization": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Localization", - "description": "", + "description": "The buyer's language, country, currency, and timezone context. Use this to adapt your extension to the buyer's region and display localized content.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "country", "value": "SubscribableSignalLike", - "description": "The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown." + "description": "The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n\nDerived from the buyer's shipping address. Returns `undefined` until the buyer enters a shipping address." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -132303,18 +132303,18 @@ "syntaxKind": "PropertySignature", "name": "market", "value": "SubscribableSignalLike", - "description": "The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n\n> Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.", - "deprecationMessage": "Deprecated as of version `2025-04`" + "description": "The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. The market context updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.", + "deprecationMessage": "Merchants now manage which extensions load for each\nmarket, so extensions no longer need to check this value." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "timezone", "value": "SubscribableSignalLike", - "description": "The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time." + "description": "The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time." } ], - "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n *\n * > Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" + "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n *\n * Derived from the buyer's shipping address. Returns `undefined` until the\n * buyer enters a shipping address.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout,\n * carried over from the cart context. Markets group countries and\n * regions with shared pricing, languages, and domains. The market\n * context updates when the buyer changes the country of their\n * shipping address. The value is `undefined` if the market is unknown.\n *\n * @deprecated Merchants now manage which extensions load for each\n * market, so extensions no longer need to check this value.\n */\n market: SubscribableSignalLike;\n}" }, "Country": { "filePath": "src/shared.ts", @@ -132515,7 +132515,7 @@ "SessionToken": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SessionToken", - "description": "", + "description": "Authenticates requests between your extension and your app backend. Use session tokens to verify the identity of the buyer and the shop context when making server-side API calls. The token is a signed JWT that contains claims such as the customer ID, shop domain, and expiration.\n\nThe `sub` claim in the decoded token is present only when the buyer is logged in and the app has permission to read customer accounts. Absent for anonymous buyers.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -132774,7 +132774,7 @@ "Shop": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Shop", - "description": "", + "description": "Metadata about the merchant's store, including its name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -132814,30 +132814,30 @@ "syntaxKind": "PropertySignature", "name": "storefrontUrl", "value": "string", - "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n\n> Caution: > As of version `2024-04` this value no longer has a trailing slash.", + "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.", "isOptional": true } ], - "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n *\n * > Caution:\n * > As of version `2024-04` this value no longer has a trailing slash.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom domain.\n */\n myshopifyDomain: string;\n}" + "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom domain.\n */\n myshopifyDomain: string;\n}" }, "Storage": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Storage", - "description": "A key-value storage object for the extension.\n\nStored data is available only to this specific extension and any of its instances.\n\nThe storage backend is implemented with `localStorage` and should persist across the buyer's checkout session. However, data persistence isn't guaranteed.", + "description": "Key-value storage for a specific extension. Use storage to save preferences or cached data that should survive page reloads without requiring a backend call. Stored data is only available to this specific extension. The storage backend is implemented with `localStorage` and data persistence isn't guaranteed.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "delete", "value": "(key: string) => Promise", - "description": "Delete stored data by key." + "description": "Deletes a previously stored value by key." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "read", "value": "(key: string) => Promise", - "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original primitive.\n\nReturns `null` if no stored data exists." + "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original type.\n\nReturns the stored value for the given key, or `null` when no value exists. Doesn't throw on a missing key." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -132847,7 +132847,7 @@ "description": "Write stored data for this key.\n\nThe data must be serializable to JSON." } ], - "value": "export interface Storage {\n /**\n * Read and return a stored value by key.\n *\n * The stored data is deserialized from JSON and returned as\n * its original primitive.\n *\n * Returns `null` if no stored data exists.\n */\n read(key: string): Promise;\n\n /**\n * Write stored data for this key.\n *\n * The data must be serializable to JSON.\n */\n write(key: string, data: any): Promise;\n\n /**\n * Delete stored data by key.\n */\n delete(key: string): Promise;\n}" + "value": "export interface Storage {\n /**\n * Read and return a stored value by key.\n *\n * The stored data is deserialized from JSON and returned as\n * its original type.\n *\n * Returns the stored value for the given key, or `null` when no value\n * exists. Doesn't throw on a missing key.\n */\n read(key: string): Promise;\n\n /**\n * Write stored data for this key.\n *\n * The data must be serializable to JSON.\n */\n write(key: string, data: any): Promise;\n\n /**\n * Deletes a previously stored value by key.\n */\n delete(key: string): Promise;\n}" }, "Version": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -132924,10 +132924,10 @@ "syntaxKind": "PropertySignature", "name": "isLocationFormVisible", "value": "SubscribableSignalLike", - "description": "Whether the location search form is currently visible to the buyer. Use this to conditionally render UI that depends on the buyer actively searching for pickup points." + "description": "Reflects which view was active when the extension loaded. When the buyer moves to the next view, the extension restarts with the current value rather than updating in place." } ], - "value": "export interface PickupPointListApi {\n /**\n * Whether the location search form is currently visible to the buyer.\n * Use this to conditionally render UI that depends on the buyer actively\n * searching for pickup points.\n */\n isLocationFormVisible: SubscribableSignalLike;\n}" + "value": "export interface PickupPointListApi {\n /**\n * Reflects which view was active when the extension loaded. When the\n * buyer moves to the next view, the extension restarts with the\n * current value rather than updating in place.\n */\n isLocationFormVisible: SubscribableSignalLike;\n}" }, "SubscribableSignalLike": { "filePath": "src/surfaces/checkout/shared.ts", @@ -132984,7 +132984,7 @@ "syntaxKind": "MethodSignature", "name": "applyAttributeChange", "value": "(change: AttributeChange) => Promise", - "description": "Updates or removes an attribute on the cart and checkout. On success, the [`attributes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/attributes#standardapi-propertydetail-attributes) property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.", + "description": "Updates or removes an attribute on the cart and checkout. On success, the [`attributes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/attributes#properties-propertydetail-attributes) property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.", "deprecationMessage": "Use cart metafields instead." }, { @@ -132992,42 +132992,42 @@ "syntaxKind": "MethodSignature", "name": "applyCartLinesChange", "value": "(change: CartLineChange) => Promise", - "description": "Adds, removes, or updates line items in the cart. The returned promise resolves when the change has been applied by the server, and the [`lines`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-lines#standardapi-propertydetail-lines) property updates with the new state.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Adds, removes, or updates line items in the cart. The returned promise resolves when the change has been applied by the server, and the [`lines`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-lines#properties-propertydetail-lines) property updates with the new state.\n\nAccepts a single change per call. To make multiple changes, call this method separately for each one.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyDiscountCodeChange", "value": "(change: DiscountCodeChange) => Promise", - "description": "Adds or removes a discount code on the checkout. The returned promise resolves when the change has been applied by the server, and the [`discountCodes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/discounts#standardapi-propertydetail-discountcodes) property updates with the new state.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves discount codes through a network call.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Adds or removes a discount code on the checkout. The returned promise resolves when the change has been applied by the server, and the [`discountCodes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/discounts#properties-propertydetail-discountcodes) property updates with the new state.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves discount codes through a network call.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyGiftCardChange", "value": "(change: GiftCardChange) => Promise", - "description": "Adds or removes a gift card from the checkout. The returned promise resolves when the change has been applied by the server, and the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/gift-cards#standardapi-propertydetail-appliedgiftcards) property updates with the new state.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves gift card codes through a network call.\n\n> Note: This method returns an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Adds or removes a gift card from the checkout. The returned promise resolves when the change has been applied by the server, and the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/gift-cards#properties-propertydetail-appliedgiftcards) property updates with the new state.\n\nUnlike other write operations, gift card changes aren't gated by a cart instruction flag.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves gift card codes through a network call.\n\n> Note: This method returns an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyMetafieldChange", "value": "(change: MetafieldChange) => Promise", - "description": "Creates, updates, or removes a cart metafield on the checkout. On success, the [`metafields`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/metafields#standardapi-propertydetail-metafields) property updates to reflect the change.\n\nCart metafields are copied to order metafields at order creation time if there's a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n\n> Caution: `MetafieldRemoveChange` and `MetafieldUpdateChange` are deprecated. Use cart metafields with `MetafieldRemoveCartChange` and `MetafieldUpdateCartChange` instead. If `MetafieldUpdateChange` writes a metafield with the same namespace and key as a cart metafield that's configured to copy, the cart metafield won't be copied.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Creates, updates, or removes a cart metafield on the checkout. On success, the [`metafields`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/metafields#properties-propertydetail-metafields) property updates to reflect the change.\n\nCart metafields are copied to order metafields at order creation time if there's a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n\n> Caution: `MetafieldRemoveChange` and `MetafieldUpdateChange` are deprecated. Use cart metafields with `MetafieldRemoveCartChange` and `MetafieldUpdateCartChange` instead. If `MetafieldUpdateChange` writes a metafield with the same namespace and key as a cart metafield that's configured to copy, the cart metafield won't be copied.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyNoteChange", "value": "(change: NoteChange) => Promise", - "description": "Sets or removes the buyer's note on the checkout. On success, the [`note`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/note#standardapi-propertydetail-note) property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Sets or removes the buyer's note on the checkout. On success, the [`note`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/note#properties-propertydetail-note) property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyShippingAddressChange", "value": "(change: ShippingAddressUpdateChange) => Promise", - "description": "Updates the buyer's shipping address on the checkout. The provided fields are merged into the existing address without prompting the buyer. On success, the `shippingAddress` property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", + "description": "Updates the buyer's shipping address on the checkout. The provided fields are merged into the existing address without prompting the buyer. On success, the `shippingAddress` property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", "isOptional": true }, { @@ -133040,7 +133040,7 @@ "isPrivate": true } ], - "value": "export interface CheckoutApi {\n /**\n * Updates or removes an attribute on the cart and checkout. On success, the\n * [`attributes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/attributes#standardapi-propertydetail-attributes) property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * @deprecated Use cart metafields instead.\n */\n applyAttributeChange(change: AttributeChange): Promise;\n\n /**\n * Adds, removes, or updates line items in the cart. The returned promise resolves when the change has been applied by the server, and the [`lines`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-lines#standardapi-propertydetail-lines) property updates with the new state.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyCartLinesChange(change: CartLineChange): Promise;\n\n /**\n * Adds or removes a discount code on the checkout. The returned promise resolves when the change has been applied by the server, and the [`discountCodes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/discounts#standardapi-propertydetail-discountcodes) property updates with the new state.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves discount codes through a network call.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyDiscountCodeChange(\n change: DiscountCodeChange,\n ): Promise;\n\n /**\n * Adds or removes a gift card from the checkout. The returned promise resolves when the change has been applied by the server, and the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/gift-cards#standardapi-propertydetail-appliedgiftcards) property updates with the new state.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves gift card codes through a network call.\n *\n * > Note: This method returns an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyGiftCardChange(change: GiftCardChange): Promise;\n\n /**\n * Creates, updates, or removes a cart metafield on the checkout. On success, the\n * [`metafields`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/metafields#standardapi-propertydetail-metafields) property updates to reflect the change.\n *\n * Cart metafields are copied to order metafields at order creation time if there's a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n *\n * > Caution: `MetafieldRemoveChange` and `MetafieldUpdateChange` are deprecated. Use cart metafields with `MetafieldRemoveCartChange` and `MetafieldUpdateCartChange` instead. If `MetafieldUpdateChange` writes a metafield with the same namespace and key as a cart metafield that's configured to copy, the cart metafield won't be copied.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyMetafieldChange(change: MetafieldChange): Promise;\n\n /**\n * Sets or removes the buyer's note on the checkout. On success, the\n * [`note`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/note#standardapi-propertydetail-note)\n * property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyNoteChange(change: NoteChange): Promise;\n\n /**\n * @private\n */\n experimentalIsShopAppStyle?: boolean;\n\n /**\n * Updates the buyer's shipping address on the checkout. The provided fields\n * are merged into the existing address without prompting the buyer. On success,\n * the `shippingAddress` property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyShippingAddressChange?(\n change: ShippingAddressChange,\n ): Promise;\n}" + "value": "export interface CheckoutApi {\n /**\n * Updates or removes an attribute on the cart and checkout. On success, the\n * [`attributes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/attributes#properties-propertydetail-attributes) property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * @deprecated Use cart metafields instead.\n */\n applyAttributeChange(change: AttributeChange): Promise;\n\n /**\n * Adds, removes, or updates line items in the cart. The returned promise resolves when the change has been applied by the server, and the [`lines`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-lines#properties-propertydetail-lines) property updates with the new state.\n *\n * Accepts a single change per call. To make multiple changes, call this\n * method separately for each one.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyCartLinesChange(change: CartLineChange): Promise;\n\n /**\n * Adds or removes a discount code on the checkout. The returned promise resolves when the change has been applied by the server, and the [`discountCodes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/discounts#properties-propertydetail-discountcodes) property updates with the new state.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves discount codes through a network call.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyDiscountCodeChange(\n change: DiscountCodeChange,\n ): Promise;\n\n /**\n * Adds or removes a gift card from the checkout. The returned promise resolves when the change has been applied by the server, and the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/gift-cards#properties-propertydetail-appliedgiftcards) property updates with the new state.\n *\n * Unlike other write operations, gift card changes aren't gated by a cart\n * instruction flag.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves gift card codes through a network call.\n *\n * > Note: This method returns an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyGiftCardChange(change: GiftCardChange): Promise;\n\n /**\n * Creates, updates, or removes a cart metafield on the checkout. On success, the\n * [`metafields`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/metafields#properties-propertydetail-metafields) property updates to reflect the change.\n *\n * Cart metafields are copied to order metafields at order creation time if there's a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n *\n * > Caution: `MetafieldRemoveChange` and `MetafieldUpdateChange` are deprecated. Use cart metafields with `MetafieldRemoveCartChange` and `MetafieldUpdateCartChange` instead. If `MetafieldUpdateChange` writes a metafield with the same namespace and key as a cart metafield that's configured to copy, the cart metafield won't be copied.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyMetafieldChange(change: MetafieldChange): Promise;\n\n /**\n * Sets or removes the buyer's note on the checkout. On success, the\n * [`note`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/note#properties-propertydetail-note)\n * property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyNoteChange(change: NoteChange): Promise;\n\n /**\n * @private\n */\n experimentalIsShopAppStyle?: boolean;\n\n /**\n * Updates the buyer's shipping address on the checkout. The provided fields\n * are merged into the existing address without prompting the buyer. On success,\n * the `shippingAddress` property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyShippingAddressChange?(\n change: ShippingAddressChange,\n ): Promise;\n}" }, "AttributeChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -133107,7 +133107,7 @@ "syntaxKind": "PropertySignature", "name": "value", "value": "string", - "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.", + "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.\n\nAttribute values are always strings. To store structured data, serialize it to JSON and parse it when reading.", "examples": [ { "title": "Example", @@ -133122,7 +133122,7 @@ ] } ], - "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" + "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * Attribute values are always strings. To store structured data, serialize\n * it to JSON and parse it when reading.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" }, "AttributeRemoveChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -133975,7 +133975,7 @@ "syntaxKind": "PropertySignature", "name": "message", "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer." + "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer.\n\nRender your own localized error text rather than displaying this message to the buyer." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -133985,7 +133985,7 @@ "description": "Indicates that the line item wasn't changed successfully. Refer to the `message` property for details about the error." } ], - "value": "export interface CartLineChangeResultError {\n /**\n * Indicates that the line item wasn't changed successfully. Refer to the `message` property for details about the error.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface CartLineChangeResultError {\n /**\n * Indicates that the line item wasn't changed successfully. Refer to the `message` property for details about the error.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n *\n * Render your own localized error text rather than displaying this message\n * to the buyer.\n */\n message: string;\n}" }, "DiscountCodeChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -134165,7 +134165,7 @@ "syntaxKind": "PropertySignature", "name": "message", "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer." + "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer.\n\nRender your own localized error text rather than displaying this message to the buyer." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -134175,7 +134175,7 @@ "description": "Indicates that the gift card change couldn't be applied. Check the `message` property for details." } ], - "value": "export interface GiftCardChangeResultError {\n /**\n * Indicates that the gift card change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface GiftCardChangeResultError {\n /**\n * Indicates that the gift card change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n *\n * Render your own localized error text rather than displaying this message\n * to the buyer.\n */\n message: string;\n}" }, "MetafieldChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -134436,7 +134436,7 @@ "syntaxKind": "PropertySignature", "name": "message", "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer." + "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer.\n\nRender your own localized error text rather than displaying this message to the buyer." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -134446,7 +134446,7 @@ "description": "Indicates that the metafield change couldn't be applied. Check the `message` property for details." } ], - "value": "export interface MetafieldChangeResultError {\n /**\n * Indicates that the metafield change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface MetafieldChangeResultError {\n /**\n * Indicates that the metafield change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n *\n * Render your own localized error text rather than displaying this message\n * to the buyer.\n */\n message: string;\n}" }, "NoteChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -134524,7 +134524,7 @@ "syntaxKind": "PropertySignature", "name": "message", "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer." + "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer.\n\nRender your own localized error text rather than displaying this message to the buyer." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -134534,7 +134534,7 @@ "description": "Indicates that the note change couldn't be applied. Check the `message` property for details." } ], - "value": "export interface NoteChangeResultError {\n /**\n * Indicates that the note change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface NoteChangeResultError {\n /**\n * Indicates that the note change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n *\n * Render your own localized error text rather than displaying this message\n * to the buyer.\n */\n message: string;\n}" }, "ShippingAddressUpdateChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -135120,7 +135120,7 @@ "syntaxKind": "PropertySignature", "name": "analytics", "value": "Analytics", - "description": "The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event." + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -135134,7 +135134,7 @@ "syntaxKind": "PropertySignature", "name": "applyTrackingConsentChange", "value": "ApplyTrackingConsentChangeType", - "description": "Enables setting and updating customer privacy consent settings and tracking consent metafields.\n\n> Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent) to be set to `true`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." + "description": "Enables setting and updating customer privacy consent settings and tracking consent metafields.\n\n> Note: Requires the [`collect_buyer_consent` capability](/docs/apps/build/customer-accounts/capabilities#collect-buyer-consent) to be set to `true`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -135155,7 +135155,7 @@ "syntaxKind": "PropertySignature", "name": "availablePaymentOptions", "value": "SubscribableSignalLike", - "description": "All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region." + "description": "All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n\nThe set of payment options can change when the buyer updates their address or cart, so subscribe to changes rather than reading once during initialization. Each option exposes `handle` and `type` only. Provider names, logos, fees, and installment terms aren't available." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -135192,7 +135192,7 @@ "syntaxKind": "PropertySignature", "name": "checkoutToken", "value": "SubscribableSignalLike", - "description": "A stable ID that represents the current checkout.\n\nThe value is `undefined` when the checkout hasn't been created on the server yet.\n\nUse this to correlate checkout sessions across your extension, web pixels, and backend systems.\n\nThis matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data) and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object)." + "description": "A stable ID that represents the current checkout.\n\nThe value is `undefined` when the checkout hasn't been created on the server yet.\n\nUse this to correlate checkout sessions across your extension, web pixels, and backend systems.\n\nThis matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data) and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n\nCan be `undefined`. Handle the `undefined` state before using the value." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -135213,7 +135213,7 @@ "syntaxKind": "PropertySignature", "name": "deliveryGroups", "value": "SubscribableSignalLike", - "description": "The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items." + "description": "The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n\nEmpty until the buyer enters enough address information for Shopify to calculate shipping rates." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -135234,7 +135234,7 @@ "syntaxKind": "PropertySignature", "name": "extension", "value": "Extension", - "description": "The meta information about the extension." + "description": "Metadata about the running extension, including the current target, API version, capabilities, and editor context. Use this to conditionally render content based on where the extension is running." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -135242,7 +135242,7 @@ "name": "extensionPoint", "value": "Target", "description": "The identifier that specifies where in Shopify's UI your code is being injected. This is one of the targets you've included in your extension's configuration file.", - "deprecationMessage": "Deprecated as of version `2023-07`, use `extension.target` instead.", + "deprecationMessage": "Use `extension.target` instead.", "examples": [ { "title": "Example", @@ -135261,14 +135261,14 @@ "syntaxKind": "PropertySignature", "name": "i18n", "value": "I18n", - "description": "Utilities for translating content and formatting values according to the current [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) of the checkout.\n\nRefer to [`localization` examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples) for more information." + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use alongside [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) to build fully localized extensions." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "instructions", "value": "SubscribableSignalLike", - "description": "The cart instructions used to create the checkout and possibly limit extension capabilities.\n\nThese instructions should be checked before performing any actions that might be affected by them.\n\nFor example, if you intend to add a discount code via the `applyDiscountCodeChange` method, check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n\n> Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs aren't available. See the [update guide](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples) for more information." + "description": "The cart instructions used to create the checkout and possibly limit extension capabilities.\n\nThese instructions should be checked before performing any actions that might be affected by them.\n\nFor example, if you intend to add a discount code via the `applyDiscountCodeChange` method, check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n\n> Caution: Check cart instructions before calling select APIs, as > some may not be available. See the > [Cart Instructions API](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples) > for more information." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -135282,7 +135282,7 @@ "syntaxKind": "PropertySignature", "name": "localization", "value": "Localization", - "description": "The details about the location, language, and currency of the customer. For utilities to easily format and translate content based on these details, you can use the [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n) object instead." + "description": "The buyer's language, country, currency, and timezone context. For formatting and translation helpers, use the [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#properties-propertydetail-i18n) object instead." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -135312,21 +135312,21 @@ "syntaxKind": "PropertySignature", "name": "query", "value": ">(query: string, options?: { variables?: Variables; version?: StorefrontApiVersion; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>", - "description": "The method used to query the Storefront GraphQL API with a prefetched token.\n\nRefer to [Storefront API access examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/storefront-api) for more information." + "description": "The method used to query the Storefront GraphQL API with a prefetched token." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "selectedPaymentOptions", "value": "SubscribableSignalLike", - "description": "The payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card)." + "description": "The payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\n\nEach option exposes `handle` and `type` only. Provider names, logos, fees, and installment terms aren't available." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "sessionToken", "value": "SessionToken", - "description": "The session token providing a set of claims as a signed JSON Web Token (JWT).\n\nThe token has a TTL of five minutes.\n\nIf the previous token expires, this value reflects a new session token with a new signature and expiry.\n\nRefer to [session token examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/session-token) for more information." + "description": "The session token providing a set of claims as a signed JSON Web Token (JWT).\n\nThe token has a TTL of five minutes.\n\nIf the previous token expires, this value reflects a new session token with a new signature and expiry.\n\nLearn more about [session tokens](/docs/apps/build/authentication-authorization/session-tokens)." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -135348,14 +135348,14 @@ "syntaxKind": "PropertySignature", "name": "shop", "value": "Shop", - "description": "The shop where the checkout is taking place." + "description": "The store where the checkout is taking place, including the shop name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "storage", "value": "Storage", - "description": "The key-value storage for the extension.\n\nIt uses `localStorage` and should persist across the customer's current checkout session.\n\n> Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n\nData is shared across all activated extension targets of this extension. In versions 2023-07 and earlier, each activated extension target had its own storage." + "description": "Key-value storage that persists across page loads within the current checkout session. Data is shared across all activated targets associated with this extension.\n\n> Caution: Data persistence isn't guaranteed and storage is cleared when the buyer starts a new checkout." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -135377,29 +135377,29 @@ ] } ], - "value": "export interface StandardApi {\n /**\n * The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event.\n */\n analytics: Analytics;\n\n /**\n * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\n */\n appliedGiftCards: SubscribableSignalLike;\n\n /**\n * The cart instructions used to create the checkout and possibly limit extension capabilities.\n *\n * These instructions should be checked before performing any actions that might be affected by them.\n *\n * For example, if you intend to add a discount code via the `applyDiscountCodeChange` method,\n * check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n *\n * > Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs aren't available.\n * See the [update guide](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples) for more information.\n *\n */\n instructions: SubscribableSignalLike;\n\n /**\n * The metafields requested in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration)\n * file. These metafields are updated when there's a change in the merchandise items\n * being purchased by the customer.\n *\n * App owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` isn't supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n appMetafields: SubscribableSignalLike;\n\n /**\n * The custom key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n buyerIdentity?: BuyerIdentity;\n\n /**\n * Provides details on the buyer's progression through the checkout and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/buyer-journey#examples)\n * examples for more information.\n */\n buyerJourney: BuyerJourney;\n\n /**\n * Settings applied to the buyer's checkout.\n */\n checkoutSettings: SubscribableSignalLike;\n\n /**\n * A stable ID that represents the current checkout.\n *\n * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\n *\n * This matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data)\n * and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n */\n checkoutToken: SubscribableSignalLike;\n\n /**\n * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * The meta information about the extension.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n *\n * @deprecated Deprecated as of version `2023-07`, use `extension.target` instead.\n */\n extensionPoint: Target;\n\n /**\n * Utilities for translating content and formatting values according to the current\n * [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization)\n * of the checkout.\n *\n * Refer to [`localization` examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples)\n * for more information.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The details about the location, language, and currency of the customer. For utilities to easily\n * format and translate content based on these details, you can use the\n * [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n)\n * object instead.\n */\n localization: Localization;\n\n /**\n * The metafields that apply to the current checkout.\n *\n * Metafields are stored locally on the client and are applied to the order object after the checkout completes.\n *\n * These metafields are shared by all extensions running on checkout, and\n * persist for as long as the customer is working on this checkout.\n *\n * Once the order is created, you can query these metafields using the\n * [GraphQL Admin API](/docs/admin-api/graphql/reference/orders/order#metafield-2021-01)\n *\n * > Caution:\n * `metafields` is deprecated. Use `appMetafields` with cart metafields instead.\n *\n * @deprecated Use `appMetafields` with cart metafields instead.\n */\n metafields: SubscribableSignalLike;\n\n /**\n * A note left by the customer to the merchant, either in their cart or during checkout.\n *\n * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\n */\n note: SubscribableSignalLike;\n\n /**\n * The method used to query the Storefront GraphQL API with a prefetched token.\n *\n * Refer to [Storefront API access examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/storefront-api) for more information.\n */\n query: >(\n query: string,\n options?: {variables?: Variables; version?: StorefrontApiVersion},\n ) => Promise<{data?: Data; errors?: GraphQLError[]}>;\n\n /**\n * The payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\n */\n selectedPaymentOptions: SubscribableSignalLike;\n\n /**\n * The session token providing a set of claims as a signed JSON Web Token (JWT).\n *\n * The token has a TTL of five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/session-token) for more information.\n */\n sessionToken: SessionToken;\n\n /**\n * The settings matching the settings definition written in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates in real time as a merchant fills in the settings.\n */\n settings: SubscribableSignalLike;\n\n /**\n * The proposed customer shipping address. During the information step, the address\n * updates when the field is committed (on change) rather than every keystroke.\n * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n shippingAddress?: SubscribableSignalLike;\n\n /**\n * The proposed customer billing address. The address updates when the field is\n * committed (on change) rather than every keystroke. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided yet.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n billingAddress?: SubscribableSignalLike;\n\n /** The shop where the checkout is taking place. */\n shop: Shop;\n\n /**\n * The key-value storage for the extension.\n *\n * It uses `localStorage` and should persist across the customer's current checkout session.\n *\n * > Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n *\n * Data is shared across all activated extension targets of this extension. In versions 2023-07 and earlier,\n * each activated extension target had its own storage.\n */\n storage: Storage;\n\n /**\n * The renderer version being used for the extension.\n *\n * @example '2025-10'\n */\n version: Version;\n\n /**\n * Customer privacy consent settings and a flag denoting if consent has previously been collected.\n */\n customerPrivacy: SubscribableSignalLike;\n\n /**\n * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent) to be set to `true`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyTrackingConsentChange: ApplyTrackingConsentChangeType;\n\n /**\n * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" + "value": "export interface StandardApi {\n /**\n * Tracks custom events and sends visitor information to\n * [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events\n * and `visitor()` to submit buyer contact details.\n */\n analytics: Analytics;\n\n /**\n * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\n */\n appliedGiftCards: SubscribableSignalLike;\n\n /**\n * The cart instructions used to create the checkout and possibly limit extension capabilities.\n *\n * These instructions should be checked before performing any actions that might be affected by them.\n *\n * For example, if you intend to add a discount code via the `applyDiscountCodeChange` method,\n * check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n *\n * > Caution: Check cart instructions before calling select APIs, as\n * > some may not be available. See the\n * > [Cart Instructions API](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples)\n * > for more information.\n *\n */\n instructions: SubscribableSignalLike;\n\n /**\n * The metafields requested in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration)\n * file. These metafields are updated when there's a change in the merchandise items\n * being purchased by the customer.\n *\n * App owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` isn't supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n appMetafields: SubscribableSignalLike;\n\n /**\n * The custom key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as\n * credit cards, wallets, and local payment methods. The list depends on\n * the shop's payment configuration and the buyer's region.\n *\n * The set of payment options can change when the buyer updates their\n * address or cart, so subscribe to changes rather than reading once\n * during initialization. Each option exposes `handle` and `type` only.\n * Provider names, logos, fees, and installment terms aren't available.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n buyerIdentity?: BuyerIdentity;\n\n /**\n * Provides details on the buyer's progression through the checkout and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/buyer-journey#examples)\n * examples for more information.\n */\n buyerJourney: BuyerJourney;\n\n /**\n * Settings applied to the buyer's checkout.\n */\n checkoutSettings: SubscribableSignalLike;\n\n /**\n * A stable ID that represents the current checkout.\n *\n * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\n *\n * This matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data)\n * and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n *\n * Can be `undefined`. Handle the `undefined` state before using the value.\n */\n checkoutToken: SubscribableSignalLike;\n\n /**\n * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n *\n * Empty until the buyer enters enough address information for Shopify to\n * calculate shipping rates.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * Metadata about the running extension, including the current target, API version,\n * capabilities, and editor context. Use this to conditionally render content\n * based on where the extension is running.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n *\n * @deprecated Use `extension.target` instead.\n */\n extensionPoint: Target;\n\n /**\n * Utilities for translating strings, formatting currencies, numbers, and dates\n * according to the buyer's locale. Use alongside\n * [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization)\n * to build fully localized extensions.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The buyer's language, country, currency, and timezone context. For\n * formatting and translation helpers, use the\n * [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#properties-propertydetail-i18n)\n * object instead.\n */\n localization: Localization;\n\n /**\n * The metafields that apply to the current checkout.\n *\n * Metafields are stored locally on the client and are applied to the order object after the checkout completes.\n *\n * These metafields are shared by all extensions running on checkout, and\n * persist for as long as the customer is working on this checkout.\n *\n * Once the order is created, you can query these metafields using the\n * [GraphQL Admin API](/docs/admin-api/graphql/reference/orders/order#metafield-2021-01)\n *\n * > Caution:\n * `metafields` is deprecated. Use `appMetafields` with cart metafields instead.\n *\n * @deprecated Use `appMetafields` with cart metafields instead.\n */\n metafields: SubscribableSignalLike;\n\n /**\n * A note left by the customer to the merchant, either in their cart or during checkout.\n *\n * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\n */\n note: SubscribableSignalLike;\n\n /**\n * The method used to query the Storefront GraphQL API with a prefetched token.\n *\n */\n query: >(\n query: string,\n options?: {variables?: Variables; version?: StorefrontApiVersion},\n ) => Promise<{data?: Data; errors?: GraphQLError[]}>;\n\n /**\n * The payment options the buyer has currently selected. This updates as\n * the buyer changes their payment method. The array can contain multiple\n * entries when the buyer splits payment across methods (for example, a\n * gift card and a credit card).\n *\n * Each option exposes `handle` and `type` only. Provider names, logos,\n * fees, and installment terms aren't available.\n */\n selectedPaymentOptions: SubscribableSignalLike;\n\n /**\n * The session token providing a set of claims as a signed JSON Web Token (JWT).\n *\n * The token has a TTL of five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Learn more about [session tokens](/docs/apps/build/authentication-authorization/session-tokens).\n */\n sessionToken: SessionToken;\n\n /**\n * The settings matching the settings definition written in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates in real time as a merchant fills in the settings.\n */\n settings: SubscribableSignalLike;\n\n /**\n * The proposed customer shipping address. During the information step, the address\n * updates when the field is committed (on change) rather than every keystroke.\n * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n shippingAddress?: SubscribableSignalLike;\n\n /**\n * The proposed customer billing address. The address updates when the field is\n * committed (on change) rather than every keystroke. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided yet.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n billingAddress?: SubscribableSignalLike;\n\n /**\n * The store where the checkout is taking place, including the shop name,\n * storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.\n */\n shop: Shop;\n\n /**\n * Key-value storage that persists across page loads within the current checkout\n * session. Data is shared across all activated targets associated with\n * this extension.\n *\n * > Caution: Data persistence isn't guaranteed and storage is cleared when the\n * buyer starts a new checkout.\n */\n storage: Storage;\n\n /**\n * The renderer version being used for the extension.\n *\n * @example '2025-10'\n */\n version: Version;\n\n /**\n * Customer privacy consent settings and a flag denoting if consent has previously been collected.\n */\n customerPrivacy: SubscribableSignalLike;\n\n /**\n * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`collect_buyer_consent` capability](/docs/apps/build/customer-accounts/capabilities#collect-buyer-consent) to be set to `true`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyTrackingConsentChange: ApplyTrackingConsentChangeType;\n\n /**\n * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" }, "Analytics": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Analytics", - "description": "", + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "publish", "value": "(name: string, data: Record) => Promise", - "description": "Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing)." + "description": "Publishes a custom event to [Web Pixels](/docs/apps/marketing). Returns `true` when the event is successfully dispatched.\n\nThe Promise resolves to `true` when the event was dispatched. The boolean indicates dispatch confirmation only. It doesn't indicate whether any specific web pixel processed the event." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "visitor", "value": "(data: { email?: string; phone?: string; }) => Promise", - "description": "A method for capturing details about a visitor on the online store." + "description": "Submits buyer contact details for attribution and analytics purposes." } ], - "value": "export interface Analytics {\n /**\n * Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing).\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * A method for capturing details about a visitor on the online store.\n */\n visitor(data: {email?: string; phone?: string}): Promise;\n}" + "value": "export interface Analytics {\n /**\n * Publishes a custom event to [Web Pixels](/docs/apps/marketing).\n * Returns `true` when the event is successfully dispatched.\n *\n * The Promise resolves to `true` when the event was dispatched. The boolean\n * indicates dispatch confirmation only. It doesn't indicate whether any\n * specific web pixel processed the event.\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * Submits buyer contact details for attribution and analytics purposes.\n */\n visitor(data: {email?: string; phone?: string}): Promise;\n}" }, "VisitorResult": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -135440,10 +135440,10 @@ "syntaxKind": "PropertySignature", "name": "type", "value": "'error'", - "description": "Indicates that the visitor information is invalid and wasn't submitted. Examples are using the wrong data type or missing a required property." + "description": "Indicates that the visitor information is invalid and wasn't submitted. Common causes include using the wrong data type or omitting a required property." } ], - "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Examples are using the wrong data type or missing a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Common causes include using the wrong data type or omitting a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" }, "SubscribableSignalLike": { "filePath": "src/surfaces/checkout/shared.ts", @@ -135657,10 +135657,10 @@ "syntaxKind": "PropertySignature", "name": "value", "value": "string | null", - "description": "The new value to store in the metafield. Set to `null` to delete the metafield." + "description": "The new value to store in the metafield. Set to `null` to delete the metafield.\n\nConsent metafield values are strings, not booleans. Pass `null` to delete a tracking consent metafield." } ], - "value": "export interface TrackingConsentMetafieldChange {\n /**\n * The identifier for the tracking consent metafield to update.\n */\n key: string;\n /**\n * The new value to store in the metafield. Set to `null` to delete the metafield.\n */\n value: string | null;\n}" + "value": "export interface TrackingConsentMetafieldChange {\n /**\n * The identifier for the tracking consent metafield to update.\n */\n key: string;\n /**\n * The new value to store in the metafield. Set to `null` to delete the metafield.\n *\n * Consent metafield values are strings, not booleans. Pass `null` to delete\n * a tracking consent metafield.\n */\n value: string | null;\n}" }, "VisitorConsent": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -135874,7 +135874,7 @@ "syntaxKind": "PropertySignature", "name": "value", "value": "string", - "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.", + "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.\n\nAttribute values are always strings. To store structured data, serialize it to JSON and parse it when reading.", "examples": [ { "title": "Example", @@ -135889,7 +135889,7 @@ ] } ], - "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" + "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * Attribute values are always strings. To store structured data, serialize\n * it to JSON and parse it when reading.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" }, "PaymentOption": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -136240,7 +136240,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A globally-unique identifier for the customer in the format `gid://shopify/Customer/`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", + "description": "An identifier for the customer in the format `gid://shopify/Customer/`. This value is unique per shop.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", "examples": [ { "title": "Example", @@ -136293,7 +136293,7 @@ "isPrivate": true } ], - "value": "export interface Customer {\n /**\n * A globally-unique identifier for the customer in the format `gid://shopify/Customer/`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'gid://shopify/Customer/123'\n */\n id: string;\n /**\n * The email address associated with the customer's account. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email?: string;\n /**\n * The phone number associated with the customer's account. The value is `undefined` if no phone number is on file or the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone?: string;\n /**\n * The customer's full name, typically a combination of first and last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n fullName?: string;\n /**\n * The customer's first name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n firstName?: string;\n /**\n * The customer's last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n lastName?: string;\n /**\n * The customer's profile image, such as a Gravatar avatar. Use this to personalize the extension UI for the logged-in buyer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n image: ImageDetails;\n /**\n * Whether the customer has opted in to receiving marketing communications from the merchant, such as email campaigns and promotional offers.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * > Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n *\n * @deprecated Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n */\n acceptsMarketing: boolean;\n /**\n * Whether the customer has opted in to email marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsEmailMarketing: boolean;\n /**\n * Whether the customer has opted in to SMS marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsSmsMarketing: boolean;\n /**\n * The store credit accounts owned by this customer that can be used as payment during checkout. Each account has a balance representing available store credit.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @private\n */\n storeCreditAccounts: StoreCreditAccount[];\n /**\n * The number of orders the customer has previously placed with this shop.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n ordersCount: number;\n}" + "value": "export interface Customer {\n /**\n * An identifier for the customer in the format `gid://shopify/Customer/`. This value is unique per shop.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'gid://shopify/Customer/123'\n */\n id: string;\n /**\n * The email address associated with the customer's account. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email?: string;\n /**\n * The phone number associated with the customer's account. The value is `undefined` if no phone number is on file or the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone?: string;\n /**\n * The customer's full name, typically a combination of first and last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n fullName?: string;\n /**\n * The customer's first name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n firstName?: string;\n /**\n * The customer's last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n lastName?: string;\n /**\n * The customer's profile image, such as a Gravatar avatar. Use this to personalize the extension UI for the logged-in buyer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n image: ImageDetails;\n /**\n * Whether the customer has opted in to receiving marketing communications from the merchant, such as email campaigns and promotional offers.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * > Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n *\n * @deprecated Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n */\n acceptsMarketing: boolean;\n /**\n * Whether the customer has opted in to email marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsEmailMarketing: boolean;\n /**\n * Whether the customer has opted in to SMS marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsSmsMarketing: boolean;\n /**\n * The store credit accounts owned by this customer that can be used as payment during checkout. Each account has a balance representing available store credit.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @private\n */\n storeCreditAccounts: StoreCreditAccount[];\n /**\n * The number of orders the customer has previously placed with this shop.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n ordersCount: number;\n}" }, "ImageDetails": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -136575,11 +136575,11 @@ "syntaxKind": "MethodSignature", "name": "perform", "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", + "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.\n\nRuns after all intercept results are collected. Use it for local state updates such as setting an error flag. By the time it runs, the navigation decision is final, so blocking logic belongs in the intercept handler itself, not here.", "isOptional": true } ], - "value": "interface InterceptorRequestAllow {\n /**\n * Indicates that the interceptor allows the buyer's journey to continue.\n */\n behavior: 'allow';\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" + "value": "interface InterceptorRequestAllow {\n /**\n * Indicates that the interceptor allows the buyer's journey to continue.\n */\n behavior: 'allow';\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n *\n * Runs after all intercept results are collected. Use it for local state\n * updates such as setting an error flag. By the time it runs, the navigation\n * decision is final, so blocking logic belongs in the intercept handler\n * itself, not here.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" }, "InterceptorResult": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -136643,7 +136643,7 @@ "syntaxKind": "MethodSignature", "name": "perform", "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", + "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.\n\nRuns after all intercept results are collected. Use it for local state updates such as setting an error flag. By the time it runs, the navigation decision is final, so blocking logic belongs in the intercept handler itself, not here.", "isOptional": true }, { @@ -136654,7 +136654,7 @@ "description": "The reason for blocking the interceptor request. This value isn't presented to the buyer, so it doesn't need to be localized. The value is used only for Shopify's own internal debugging and metrics." } ], - "value": "interface InterceptorRequestBlock {\n /**\n * Indicates that the interceptor blocks the buyer's journey from continuing.\n */\n behavior: 'block';\n\n /**\n * The reason for blocking the interceptor request. This value isn't presented to\n * the buyer, so it doesn't need to be localized. The value is used only for Shopify's\n * own internal debugging and metrics.\n */\n reason: string;\n\n /**\n * Used to pass errors to the checkout UI, outside your extension's UI boundaries.\n */\n errors?: ValidationError[];\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" + "value": "interface InterceptorRequestBlock {\n /**\n * Indicates that the interceptor blocks the buyer's journey from continuing.\n */\n behavior: 'block';\n\n /**\n * The reason for blocking the interceptor request. This value isn't presented to\n * the buyer, so it doesn't need to be localized. The value is used only for Shopify's\n * own internal debugging and metrics.\n */\n reason: string;\n\n /**\n * Used to pass errors to the checkout UI, outside your extension's UI boundaries.\n */\n errors?: ValidationError[];\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n *\n * Runs after all intercept results are collected. Use it for local state\n * updates such as setting an error flag. By the time it runs, the navigation\n * decision is final, so blocking logic belongs in the intercept handler\n * itself, not here.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" }, "ValidationError": { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -136875,17 +136875,17 @@ "syntaxKind": "PropertySignature", "name": "totalShippingAmount", "value": "SubscribableSignalLike", - "description": "The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step." + "description": "The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step.\n\n`undefined` until the buyer selects a shipping method (typically after the information step)." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "totalTaxAmount", "value": "SubscribableSignalLike", - "description": "The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet." + "description": "The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet.\n\n`undefined` when taxes haven't been calculated or aren't available for the buyer's region." } ], - "value": "export interface CartCost {\n /**\n * The sum of all line item prices at the current step of checkout, before shipping and taxes are applied. Use this value to display the base cost of the items the buyer purchased.\n */\n subtotalAmount: SubscribableSignalLike;\n\n /**\n * The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step.\n */\n totalShippingAmount: SubscribableSignalLike;\n\n /**\n * The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet.\n */\n totalTaxAmount: SubscribableSignalLike;\n\n /**\n * The minimum total at the current step of checkout. Costs not yet calculated, such as shipping on the information step, aren't included. Gift cards and store credits are excluded from this total.\n */\n totalAmount: SubscribableSignalLike;\n}" + "value": "export interface CartCost {\n /**\n * The sum of all line item prices at the current step of checkout, before shipping and taxes are applied. Use this value to display the base cost of the items the buyer purchased.\n */\n subtotalAmount: SubscribableSignalLike;\n\n /**\n * The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step.\n *\n * `undefined` until the buyer selects a shipping method (typically after the\n * information step).\n */\n totalShippingAmount: SubscribableSignalLike;\n\n /**\n * The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet.\n *\n * `undefined` when taxes haven't been calculated or aren't available for the\n * buyer's region.\n */\n totalTaxAmount: SubscribableSignalLike;\n\n /**\n * The minimum total at the current step of checkout. Costs not yet calculated, such as shipping on the information step, aren't included. Gift cards and store credits are excluded from this total.\n */\n totalAmount: SubscribableSignalLike;\n}" }, "CustomerPrivacy": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -136972,31 +136972,31 @@ "syntaxKind": "PropertySignature", "name": "analytics", "value": "boolean", - "description": "Whether analytics data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Analytics data includes how the shop was used and what interactions occurred." + "description": "Whether analytics data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Analytics data includes how the shop was used and what interactions occurred.\n\nWhether analytics data can be collected right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.analytics`, before calling `shopify.analytics.publish()`." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "marketing", "value": "boolean", - "description": "Whether marketing data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Marketing data includes attribution and targeted advertising preferences." + "description": "Whether marketing data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Marketing data includes attribution and targeted advertising preferences.\n\nWhether marketing data can be collected right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.marketing`, before performing marketing-related data collection." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "preferences", "value": "boolean", - "description": "Whether preference data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Preference data includes language, currency, and sizing choices." + "description": "Whether preference data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Preference data includes language, currency, and sizing choices.\n\nWhether preference data can be collected right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.preferences`, before storing or reading buyer preference data." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "saleOfData", "value": "boolean", - "description": "Whether data can be shared with third parties based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. This typically applies to behavioral advertising data." + "description": "Whether data can be shared with third parties based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. This typically applies to behavioral advertising data.\n\nWhether buyer data can be shared with or sold to third parties right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.saleOfData`, before sharing or selling buyer data with third parties." } ], - "value": "export interface AllowedProcessing {\n /**\n * Whether analytics data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Analytics\n * data includes how the shop was used and what interactions occurred.\n */\n analytics: boolean;\n /**\n * Whether marketing data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Marketing\n * data includes attribution and targeted advertising preferences.\n */\n marketing: boolean;\n /**\n * Whether preference data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Preference\n * data includes language, currency, and sizing choices.\n */\n preferences: boolean;\n /**\n * Whether data can be shared with third parties based on the visitor's\n * consent, the merchant's privacy configuration, and the visitor's region.\n * This typically applies to behavioral advertising data.\n */\n saleOfData: boolean;\n}" + "value": "export interface AllowedProcessing {\n /**\n * Whether analytics data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Analytics\n * data includes how the shop was used and what interactions occurred.\n *\n * Whether analytics data can be collected right now. Combines the buyer's\n * consent, the merchant's privacy configuration, and the buyer's region into\n * a single boolean. Check this flag, not `visitorConsent.analytics`, before\n * calling `shopify.analytics.publish()`.\n */\n analytics: boolean;\n /**\n * Whether marketing data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Marketing\n * data includes attribution and targeted advertising preferences.\n *\n * Whether marketing data can be collected right now. Combines the buyer's\n * consent, the merchant's privacy configuration, and the buyer's region into\n * a single boolean. Check this flag, not `visitorConsent.marketing`, before\n * performing marketing-related data collection.\n */\n marketing: boolean;\n /**\n * Whether preference data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Preference\n * data includes language, currency, and sizing choices.\n *\n * Whether preference data can be collected right now. Combines the buyer's\n * consent, the merchant's privacy configuration, and the buyer's region into\n * a single boolean. Check this flag, not `visitorConsent.preferences`,\n * before storing or reading buyer preference data.\n */\n preferences: boolean;\n /**\n * Whether data can be shared with third parties based on the visitor's\n * consent, the merchant's privacy configuration, and the visitor's region.\n * This typically applies to behavioral advertising data.\n *\n * Whether buyer data can be shared with or sold to third parties right now.\n * Combines the buyer's consent, the merchant's privacy configuration, and\n * the buyer's region into a single boolean. Check this flag, not\n * `visitorConsent.saleOfData`, before sharing or selling buyer data with\n * third parties.\n */\n saleOfData: boolean;\n}" }, "TrackingConsentMetafield": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -137688,7 +137688,7 @@ "Extension": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Extension", - "description": "The meta information about an extension target.", + "description": "Metadata about the running extension, including its API version, target, capabilities, and editor context. Use this to read configuration details or conditionally render content based on where the extension is running.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -137714,7 +137714,7 @@ "syntaxKind": "PropertySignature", "name": "capabilities", "value": "SubscribableSignalLike", - "description": "The allowed capabilities of the extension, defined in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n\n* [`api_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#api-access): the extension can access the Storefront API.\n\n* [`network_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access): the extension can make external network calls.\n\n* [`block_progress`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n\n* [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n\n* [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can register customer consent decisions that are honored on Shopify-managed services.\n\n* [`iframe.sources`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#iframe): the extension can embed an external URL in an iframe." + "description": "The allowed capabilities of the extension, defined in your [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -137762,7 +137762,7 @@ "syntaxKind": "PropertySignature", "name": "version", "value": "string", - "description": "The published version of the running extension target.\n\nFor unpublished extensions, the value is `undefined`.", + "description": "The published version of the running extension target.\n\nFor unpublished extensions, the value is `undefined`.\n\nDon't use this property as a stable identifier in development environments. It becomes available only after the extension is published.", "isOptional": true, "examples": [ { @@ -137778,7 +137778,7 @@ ] } ], - "value": "export interface Extension {\n /**\n * The API version that was set in the extension config file.\n *\n * @example '2024-10', '2025-01', '2025-04', '2025-07', '2025-10'\n */\n apiVersion: ApiVersion;\n\n /**\n * The allowed capabilities of the extension, defined\n * in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n *\n * * [`api_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#api-access): the extension can access the Storefront API.\n *\n * * [`network_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access): the extension can make external network calls.\n *\n * * [`block_progress`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n *\n * * [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n *\n * * [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can register customer consent decisions that are honored on Shopify-managed services.\n *\n * * [`iframe.sources`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#iframe): the extension can embed an external URL in an iframe.\n */\n capabilities: SubscribableSignalLike;\n\n /**\n * Information about the editor where the extension is being rendered.\n *\n * If the value is undefined, then the extension isn't running in an editor.\n */\n editor?: Editor;\n\n /**\n * A Boolean to show whether your extension is currently rendered to the screen.\n *\n * Shopify might render your extension before it's visible in the UI,\n * typically to pre-render extensions that appear on a later step of the\n * checkout.\n *\n * Your extension might also continue to run after the customer has navigated away\n * from where it was rendered. The extension continues running so that\n * your extension is immediately available to render if the customer navigates back.\n */\n rendered: SubscribableSignalLike;\n\n /**\n * The URL to the script that started the extension target.\n */\n scriptUrl: string;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n */\n target: Target;\n\n /**\n * The published version of the running extension target.\n *\n * For unpublished extensions, the value is `undefined`.\n *\n * @example 3.0.10\n */\n version?: string;\n}" + "value": "export interface Extension {\n /**\n * The API version that was set in the extension config file.\n *\n * @example '2024-10', '2025-01', '2025-04', '2025-07', '2025-10'\n */\n apiVersion: ApiVersion;\n\n /**\n * The allowed capabilities of the extension, defined in your\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n */\n capabilities: SubscribableSignalLike;\n\n /**\n * Information about the editor where the extension is being rendered.\n *\n * If the value is undefined, then the extension isn't running in an editor.\n */\n editor?: Editor;\n\n /**\n * A Boolean to show whether your extension is currently rendered to the screen.\n *\n * Shopify might render your extension before it's visible in the UI,\n * typically to pre-render extensions that appear on a later step of the\n * checkout.\n *\n * Your extension might also continue to run after the customer has navigated away\n * from where it was rendered. The extension continues running so that\n * your extension is immediately available to render if the customer navigates back.\n */\n rendered: SubscribableSignalLike;\n\n /**\n * The URL to the script that started the extension target.\n */\n scriptUrl: string;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n */\n target: Target;\n\n /**\n * The published version of the running extension target.\n *\n * For unpublished extensions, the value is `undefined`.\n *\n * Don't use this property as a stable identifier in development environments.\n * It becomes available only after the extension is published.\n *\n * @example 3.0.10\n */\n version?: string;\n}" }, "ApiVersion": { "filePath": "src/shared.ts", @@ -137797,7 +137797,7 @@ "Editor": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Editor", - "description": "", + "description": "Information about the editor environment when an extension is rendered inside the checkout editor. The value is `undefined` when the extension is not rendering in an editor.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -137812,7 +137812,7 @@ "I18n": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18n", - "description": "", + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use the I18n API alongside the Localization API to build fully localized extensions.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -137848,7 +137848,7 @@ "I18nTranslate": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18nTranslate", - "description": "This returns a translated string matching a key in a locale file.", + "description": "Translates a key from your extension's locale files into a localized string. Supports interpolation with placeholder replacements and pluralization via the special `count` option.", "members": [], "value": "export interface I18nTranslate {\n (\n key: string,\n options?: Record,\n ): ReplacementType extends string | number\n ? string\n : (string | ReplacementType)[];\n}" }, @@ -138412,14 +138412,14 @@ "Localization": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Localization", - "description": "", + "description": "The buyer's language, country, currency, and timezone context. Use this to adapt your extension to the buyer's region and display localized content.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "country", "value": "SubscribableSignalLike", - "description": "The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown." + "description": "The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n\nDerived from the buyer's shipping address. Returns `undefined` until the buyer enters a shipping address." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -138447,18 +138447,18 @@ "syntaxKind": "PropertySignature", "name": "market", "value": "SubscribableSignalLike", - "description": "The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n\n> Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.", - "deprecationMessage": "Deprecated as of version `2025-04`" + "description": "The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. The market context updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.", + "deprecationMessage": "Merchants now manage which extensions load for each\nmarket, so extensions no longer need to check this value." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "timezone", "value": "SubscribableSignalLike", - "description": "The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time." + "description": "The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time." } ], - "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n *\n * > Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" + "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n *\n * Derived from the buyer's shipping address. Returns `undefined` until the\n * buyer enters a shipping address.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout,\n * carried over from the cart context. Markets group countries and\n * regions with shared pricing, languages, and domains. The market\n * context updates when the buyer changes the country of their\n * shipping address. The value is `undefined` if the market is unknown.\n *\n * @deprecated Merchants now manage which extensions load for each\n * market, so extensions no longer need to check this value.\n */\n market: SubscribableSignalLike;\n}" }, "Country": { "filePath": "src/shared.ts", @@ -138659,7 +138659,7 @@ "SessionToken": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SessionToken", - "description": "", + "description": "Authenticates requests between your extension and your app backend. Use session tokens to verify the identity of the buyer and the shop context when making server-side API calls. The token is a signed JWT that contains claims such as the customer ID, shop domain, and expiration.\n\nThe `sub` claim in the decoded token is present only when the buyer is logged in and the app has permission to read customer accounts. Absent for anonymous buyers.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -138918,7 +138918,7 @@ "Shop": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Shop", - "description": "", + "description": "Metadata about the merchant's store, including its name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -138958,30 +138958,30 @@ "syntaxKind": "PropertySignature", "name": "storefrontUrl", "value": "string", - "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n\n> Caution: > As of version `2024-04` this value no longer has a trailing slash.", + "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.", "isOptional": true } ], - "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n *\n * > Caution:\n * > As of version `2024-04` this value no longer has a trailing slash.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom domain.\n */\n myshopifyDomain: string;\n}" + "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom domain.\n */\n myshopifyDomain: string;\n}" }, "Storage": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Storage", - "description": "A key-value storage object for the extension.\n\nStored data is available only to this specific extension and any of its instances.\n\nThe storage backend is implemented with `localStorage` and should persist across the buyer's checkout session. However, data persistence isn't guaranteed.", + "description": "Key-value storage for a specific extension. Use storage to save preferences or cached data that should survive page reloads without requiring a backend call. Stored data is only available to this specific extension. The storage backend is implemented with `localStorage` and data persistence isn't guaranteed.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "delete", "value": "(key: string) => Promise", - "description": "Delete stored data by key." + "description": "Deletes a previously stored value by key." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "read", "value": "(key: string) => Promise", - "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original primitive.\n\nReturns `null` if no stored data exists." + "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original type.\n\nReturns the stored value for the given key, or `null` when no value exists. Doesn't throw on a missing key." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -138991,7 +138991,7 @@ "description": "Write stored data for this key.\n\nThe data must be serializable to JSON." } ], - "value": "export interface Storage {\n /**\n * Read and return a stored value by key.\n *\n * The stored data is deserialized from JSON and returned as\n * its original primitive.\n *\n * Returns `null` if no stored data exists.\n */\n read(key: string): Promise;\n\n /**\n * Write stored data for this key.\n *\n * The data must be serializable to JSON.\n */\n write(key: string, data: any): Promise;\n\n /**\n * Delete stored data by key.\n */\n delete(key: string): Promise;\n}" + "value": "export interface Storage {\n /**\n * Read and return a stored value by key.\n *\n * The stored data is deserialized from JSON and returned as\n * its original type.\n *\n * Returns the stored value for the given key, or `null` when no value\n * exists. Doesn't throw on a missing key.\n */\n read(key: string): Promise;\n\n /**\n * Write stored data for this key.\n *\n * The data must be serializable to JSON.\n */\n write(key: string, data: any): Promise;\n\n /**\n * Deletes a previously stored value by key.\n */\n delete(key: string): Promise;\n}" }, "Version": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -139067,7 +139067,7 @@ "syntaxKind": "MethodSignature", "name": "applyAttributeChange", "value": "(change: AttributeChange) => Promise", - "description": "Updates or removes an attribute on the cart and checkout. On success, the [`attributes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/attributes#standardapi-propertydetail-attributes) property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.", + "description": "Updates or removes an attribute on the cart and checkout. On success, the [`attributes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/attributes#properties-propertydetail-attributes) property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.", "deprecationMessage": "Use cart metafields instead." }, { @@ -139075,42 +139075,42 @@ "syntaxKind": "MethodSignature", "name": "applyCartLinesChange", "value": "(change: CartLineChange) => Promise", - "description": "Adds, removes, or updates line items in the cart. The returned promise resolves when the change has been applied by the server, and the [`lines`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-lines#standardapi-propertydetail-lines) property updates with the new state.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Adds, removes, or updates line items in the cart. The returned promise resolves when the change has been applied by the server, and the [`lines`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-lines#properties-propertydetail-lines) property updates with the new state.\n\nAccepts a single change per call. To make multiple changes, call this method separately for each one.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyDiscountCodeChange", "value": "(change: DiscountCodeChange) => Promise", - "description": "Adds or removes a discount code on the checkout. The returned promise resolves when the change has been applied by the server, and the [`discountCodes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/discounts#standardapi-propertydetail-discountcodes) property updates with the new state.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves discount codes through a network call.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Adds or removes a discount code on the checkout. The returned promise resolves when the change has been applied by the server, and the [`discountCodes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/discounts#properties-propertydetail-discountcodes) property updates with the new state.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves discount codes through a network call.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyGiftCardChange", "value": "(change: GiftCardChange) => Promise", - "description": "Adds or removes a gift card from the checkout. The returned promise resolves when the change has been applied by the server, and the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/gift-cards#standardapi-propertydetail-appliedgiftcards) property updates with the new state.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves gift card codes through a network call.\n\n> Note: This method returns an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Adds or removes a gift card from the checkout. The returned promise resolves when the change has been applied by the server, and the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/gift-cards#properties-propertydetail-appliedgiftcards) property updates with the new state.\n\nUnlike other write operations, gift card changes aren't gated by a cart instruction flag.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves gift card codes through a network call.\n\n> Note: This method returns an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyMetafieldChange", "value": "(change: MetafieldChange) => Promise", - "description": "Creates, updates, or removes a cart metafield on the checkout. On success, the [`metafields`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/metafields#standardapi-propertydetail-metafields) property updates to reflect the change.\n\nCart metafields are copied to order metafields at order creation time if there's a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n\n> Caution: `MetafieldRemoveChange` and `MetafieldUpdateChange` are deprecated. Use cart metafields with `MetafieldRemoveCartChange` and `MetafieldUpdateCartChange` instead. If `MetafieldUpdateChange` writes a metafield with the same namespace and key as a cart metafield that's configured to copy, the cart metafield won't be copied.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Creates, updates, or removes a cart metafield on the checkout. On success, the [`metafields`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/metafields#properties-propertydetail-metafields) property updates to reflect the change.\n\nCart metafields are copied to order metafields at order creation time if there's a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n\n> Caution: `MetafieldRemoveChange` and `MetafieldUpdateChange` are deprecated. Use cart metafields with `MetafieldRemoveCartChange` and `MetafieldUpdateCartChange` instead. If `MetafieldUpdateChange` writes a metafield with the same namespace and key as a cart metafield that's configured to copy, the cart metafield won't be copied.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyNoteChange", "value": "(change: NoteChange) => Promise", - "description": "Sets or removes the buyer's note on the checkout. On success, the [`note`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/note#standardapi-propertydetail-note) property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Sets or removes the buyer's note on the checkout. On success, the [`note`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/note#properties-propertydetail-note) property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyShippingAddressChange", "value": "(change: ShippingAddressUpdateChange) => Promise", - "description": "Updates the buyer's shipping address on the checkout. The provided fields are merged into the existing address without prompting the buyer. On success, the `shippingAddress` property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", + "description": "Updates the buyer's shipping address on the checkout. The provided fields are merged into the existing address without prompting the buyer. On success, the `shippingAddress` property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", "isOptional": true }, { @@ -139123,7 +139123,7 @@ "isPrivate": true } ], - "value": "export interface CheckoutApi {\n /**\n * Updates or removes an attribute on the cart and checkout. On success, the\n * [`attributes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/attributes#standardapi-propertydetail-attributes) property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * @deprecated Use cart metafields instead.\n */\n applyAttributeChange(change: AttributeChange): Promise;\n\n /**\n * Adds, removes, or updates line items in the cart. The returned promise resolves when the change has been applied by the server, and the [`lines`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-lines#standardapi-propertydetail-lines) property updates with the new state.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyCartLinesChange(change: CartLineChange): Promise;\n\n /**\n * Adds or removes a discount code on the checkout. The returned promise resolves when the change has been applied by the server, and the [`discountCodes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/discounts#standardapi-propertydetail-discountcodes) property updates with the new state.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves discount codes through a network call.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyDiscountCodeChange(\n change: DiscountCodeChange,\n ): Promise;\n\n /**\n * Adds or removes a gift card from the checkout. The returned promise resolves when the change has been applied by the server, and the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/gift-cards#standardapi-propertydetail-appliedgiftcards) property updates with the new state.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves gift card codes through a network call.\n *\n * > Note: This method returns an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyGiftCardChange(change: GiftCardChange): Promise;\n\n /**\n * Creates, updates, or removes a cart metafield on the checkout. On success, the\n * [`metafields`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/metafields#standardapi-propertydetail-metafields) property updates to reflect the change.\n *\n * Cart metafields are copied to order metafields at order creation time if there's a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n *\n * > Caution: `MetafieldRemoveChange` and `MetafieldUpdateChange` are deprecated. Use cart metafields with `MetafieldRemoveCartChange` and `MetafieldUpdateCartChange` instead. If `MetafieldUpdateChange` writes a metafield with the same namespace and key as a cart metafield that's configured to copy, the cart metafield won't be copied.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyMetafieldChange(change: MetafieldChange): Promise;\n\n /**\n * Sets or removes the buyer's note on the checkout. On success, the\n * [`note`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/note#standardapi-propertydetail-note)\n * property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyNoteChange(change: NoteChange): Promise;\n\n /**\n * @private\n */\n experimentalIsShopAppStyle?: boolean;\n\n /**\n * Updates the buyer's shipping address on the checkout. The provided fields\n * are merged into the existing address without prompting the buyer. On success,\n * the `shippingAddress` property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyShippingAddressChange?(\n change: ShippingAddressChange,\n ): Promise;\n}" + "value": "export interface CheckoutApi {\n /**\n * Updates or removes an attribute on the cart and checkout. On success, the\n * [`attributes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/attributes#properties-propertydetail-attributes) property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * @deprecated Use cart metafields instead.\n */\n applyAttributeChange(change: AttributeChange): Promise;\n\n /**\n * Adds, removes, or updates line items in the cart. The returned promise resolves when the change has been applied by the server, and the [`lines`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-lines#properties-propertydetail-lines) property updates with the new state.\n *\n * Accepts a single change per call. To make multiple changes, call this\n * method separately for each one.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyCartLinesChange(change: CartLineChange): Promise;\n\n /**\n * Adds or removes a discount code on the checkout. The returned promise resolves when the change has been applied by the server, and the [`discountCodes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/discounts#properties-propertydetail-discountcodes) property updates with the new state.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves discount codes through a network call.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyDiscountCodeChange(\n change: DiscountCodeChange,\n ): Promise;\n\n /**\n * Adds or removes a gift card from the checkout. The returned promise resolves when the change has been applied by the server, and the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/gift-cards#properties-propertydetail-appliedgiftcards) property updates with the new state.\n *\n * Unlike other write operations, gift card changes aren't gated by a cart\n * instruction flag.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves gift card codes through a network call.\n *\n * > Note: This method returns an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyGiftCardChange(change: GiftCardChange): Promise;\n\n /**\n * Creates, updates, or removes a cart metafield on the checkout. On success, the\n * [`metafields`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/metafields#properties-propertydetail-metafields) property updates to reflect the change.\n *\n * Cart metafields are copied to order metafields at order creation time if there's a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n *\n * > Caution: `MetafieldRemoveChange` and `MetafieldUpdateChange` are deprecated. Use cart metafields with `MetafieldRemoveCartChange` and `MetafieldUpdateCartChange` instead. If `MetafieldUpdateChange` writes a metafield with the same namespace and key as a cart metafield that's configured to copy, the cart metafield won't be copied.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyMetafieldChange(change: MetafieldChange): Promise;\n\n /**\n * Sets or removes the buyer's note on the checkout. On success, the\n * [`note`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/note#properties-propertydetail-note)\n * property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyNoteChange(change: NoteChange): Promise;\n\n /**\n * @private\n */\n experimentalIsShopAppStyle?: boolean;\n\n /**\n * Updates the buyer's shipping address on the checkout. The provided fields\n * are merged into the existing address without prompting the buyer. On success,\n * the `shippingAddress` property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyShippingAddressChange?(\n change: ShippingAddressChange,\n ): Promise;\n}" }, "AttributeChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -139190,7 +139190,7 @@ "syntaxKind": "PropertySignature", "name": "value", "value": "string", - "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.", + "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.\n\nAttribute values are always strings. To store structured data, serialize it to JSON and parse it when reading.", "examples": [ { "title": "Example", @@ -139205,7 +139205,7 @@ ] } ], - "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" + "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * Attribute values are always strings. To store structured data, serialize\n * it to JSON and parse it when reading.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" }, "AttributeRemoveChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -140058,7 +140058,7 @@ "syntaxKind": "PropertySignature", "name": "message", "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer." + "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer.\n\nRender your own localized error text rather than displaying this message to the buyer." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -140068,7 +140068,7 @@ "description": "Indicates that the line item wasn't changed successfully. Refer to the `message` property for details about the error." } ], - "value": "export interface CartLineChangeResultError {\n /**\n * Indicates that the line item wasn't changed successfully. Refer to the `message` property for details about the error.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface CartLineChangeResultError {\n /**\n * Indicates that the line item wasn't changed successfully. Refer to the `message` property for details about the error.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n *\n * Render your own localized error text rather than displaying this message\n * to the buyer.\n */\n message: string;\n}" }, "DiscountCodeChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -140248,7 +140248,7 @@ "syntaxKind": "PropertySignature", "name": "message", "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer." + "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer.\n\nRender your own localized error text rather than displaying this message to the buyer." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -140258,7 +140258,7 @@ "description": "Indicates that the gift card change couldn't be applied. Check the `message` property for details." } ], - "value": "export interface GiftCardChangeResultError {\n /**\n * Indicates that the gift card change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface GiftCardChangeResultError {\n /**\n * Indicates that the gift card change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n *\n * Render your own localized error text rather than displaying this message\n * to the buyer.\n */\n message: string;\n}" }, "MetafieldChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -140519,7 +140519,7 @@ "syntaxKind": "PropertySignature", "name": "message", "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer." + "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer.\n\nRender your own localized error text rather than displaying this message to the buyer." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -140529,7 +140529,7 @@ "description": "Indicates that the metafield change couldn't be applied. Check the `message` property for details." } ], - "value": "export interface MetafieldChangeResultError {\n /**\n * Indicates that the metafield change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface MetafieldChangeResultError {\n /**\n * Indicates that the metafield change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n *\n * Render your own localized error text rather than displaying this message\n * to the buyer.\n */\n message: string;\n}" }, "NoteChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -140607,7 +140607,7 @@ "syntaxKind": "PropertySignature", "name": "message", "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer." + "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer.\n\nRender your own localized error text rather than displaying this message to the buyer." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -140617,7 +140617,7 @@ "description": "Indicates that the note change couldn't be applied. Check the `message` property for details." } ], - "value": "export interface NoteChangeResultError {\n /**\n * Indicates that the note change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface NoteChangeResultError {\n /**\n * Indicates that the note change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n *\n * Render your own localized error text rather than displaying this message\n * to the buyer.\n */\n message: string;\n}" }, "ShippingAddressUpdateChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -141203,7 +141203,7 @@ "syntaxKind": "PropertySignature", "name": "analytics", "value": "Analytics", - "description": "The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event." + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -141217,7 +141217,7 @@ "syntaxKind": "PropertySignature", "name": "applyTrackingConsentChange", "value": "ApplyTrackingConsentChangeType", - "description": "Enables setting and updating customer privacy consent settings and tracking consent metafields.\n\n> Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent) to be set to `true`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." + "description": "Enables setting and updating customer privacy consent settings and tracking consent metafields.\n\n> Note: Requires the [`collect_buyer_consent` capability](/docs/apps/build/customer-accounts/capabilities#collect-buyer-consent) to be set to `true`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -141238,7 +141238,7 @@ "syntaxKind": "PropertySignature", "name": "availablePaymentOptions", "value": "SubscribableSignalLike", - "description": "All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region." + "description": "All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n\nThe set of payment options can change when the buyer updates their address or cart, so subscribe to changes rather than reading once during initialization. Each option exposes `handle` and `type` only. Provider names, logos, fees, and installment terms aren't available." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -141275,7 +141275,7 @@ "syntaxKind": "PropertySignature", "name": "checkoutToken", "value": "SubscribableSignalLike", - "description": "A stable ID that represents the current checkout.\n\nThe value is `undefined` when the checkout hasn't been created on the server yet.\n\nUse this to correlate checkout sessions across your extension, web pixels, and backend systems.\n\nThis matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data) and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object)." + "description": "A stable ID that represents the current checkout.\n\nThe value is `undefined` when the checkout hasn't been created on the server yet.\n\nUse this to correlate checkout sessions across your extension, web pixels, and backend systems.\n\nThis matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data) and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n\nCan be `undefined`. Handle the `undefined` state before using the value." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -141296,7 +141296,7 @@ "syntaxKind": "PropertySignature", "name": "deliveryGroups", "value": "SubscribableSignalLike", - "description": "The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items." + "description": "The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n\nEmpty until the buyer enters enough address information for Shopify to calculate shipping rates." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -141317,7 +141317,7 @@ "syntaxKind": "PropertySignature", "name": "extension", "value": "Extension", - "description": "The meta information about the extension." + "description": "Metadata about the running extension, including the current target, API version, capabilities, and editor context. Use this to conditionally render content based on where the extension is running." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -141325,7 +141325,7 @@ "name": "extensionPoint", "value": "Target", "description": "The identifier that specifies where in Shopify's UI your code is being injected. This is one of the targets you've included in your extension's configuration file.", - "deprecationMessage": "Deprecated as of version `2023-07`, use `extension.target` instead.", + "deprecationMessage": "Use `extension.target` instead.", "examples": [ { "title": "Example", @@ -141344,14 +141344,14 @@ "syntaxKind": "PropertySignature", "name": "i18n", "value": "I18n", - "description": "Utilities for translating content and formatting values according to the current [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) of the checkout.\n\nRefer to [`localization` examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples) for more information." + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use alongside [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) to build fully localized extensions." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "instructions", "value": "SubscribableSignalLike", - "description": "The cart instructions used to create the checkout and possibly limit extension capabilities.\n\nThese instructions should be checked before performing any actions that might be affected by them.\n\nFor example, if you intend to add a discount code via the `applyDiscountCodeChange` method, check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n\n> Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs aren't available. See the [update guide](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples) for more information." + "description": "The cart instructions used to create the checkout and possibly limit extension capabilities.\n\nThese instructions should be checked before performing any actions that might be affected by them.\n\nFor example, if you intend to add a discount code via the `applyDiscountCodeChange` method, check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n\n> Caution: Check cart instructions before calling select APIs, as > some may not be available. See the > [Cart Instructions API](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples) > for more information." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -141365,7 +141365,7 @@ "syntaxKind": "PropertySignature", "name": "localization", "value": "Localization", - "description": "The details about the location, language, and currency of the customer. For utilities to easily format and translate content based on these details, you can use the [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n) object instead." + "description": "The buyer's language, country, currency, and timezone context. For formatting and translation helpers, use the [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#properties-propertydetail-i18n) object instead." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -141395,21 +141395,21 @@ "syntaxKind": "PropertySignature", "name": "query", "value": ">(query: string, options?: { variables?: Variables; version?: StorefrontApiVersion; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>", - "description": "The method used to query the Storefront GraphQL API with a prefetched token.\n\nRefer to [Storefront API access examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/storefront-api) for more information." + "description": "The method used to query the Storefront GraphQL API with a prefetched token." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "selectedPaymentOptions", "value": "SubscribableSignalLike", - "description": "The payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card)." + "description": "The payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\n\nEach option exposes `handle` and `type` only. Provider names, logos, fees, and installment terms aren't available." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "sessionToken", "value": "SessionToken", - "description": "The session token providing a set of claims as a signed JSON Web Token (JWT).\n\nThe token has a TTL of five minutes.\n\nIf the previous token expires, this value reflects a new session token with a new signature and expiry.\n\nRefer to [session token examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/session-token) for more information." + "description": "The session token providing a set of claims as a signed JSON Web Token (JWT).\n\nThe token has a TTL of five minutes.\n\nIf the previous token expires, this value reflects a new session token with a new signature and expiry.\n\nLearn more about [session tokens](/docs/apps/build/authentication-authorization/session-tokens)." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -141431,14 +141431,14 @@ "syntaxKind": "PropertySignature", "name": "shop", "value": "Shop", - "description": "The shop where the checkout is taking place." + "description": "The store where the checkout is taking place, including the shop name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "storage", "value": "Storage", - "description": "The key-value storage for the extension.\n\nIt uses `localStorage` and should persist across the customer's current checkout session.\n\n> Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n\nData is shared across all activated extension targets of this extension. In versions 2023-07 and earlier, each activated extension target had its own storage." + "description": "Key-value storage that persists across page loads within the current checkout session. Data is shared across all activated targets associated with this extension.\n\n> Caution: Data persistence isn't guaranteed and storage is cleared when the buyer starts a new checkout." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -141460,29 +141460,29 @@ ] } ], - "value": "export interface StandardApi {\n /**\n * The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event.\n */\n analytics: Analytics;\n\n /**\n * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\n */\n appliedGiftCards: SubscribableSignalLike;\n\n /**\n * The cart instructions used to create the checkout and possibly limit extension capabilities.\n *\n * These instructions should be checked before performing any actions that might be affected by them.\n *\n * For example, if you intend to add a discount code via the `applyDiscountCodeChange` method,\n * check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n *\n * > Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs aren't available.\n * See the [update guide](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples) for more information.\n *\n */\n instructions: SubscribableSignalLike;\n\n /**\n * The metafields requested in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration)\n * file. These metafields are updated when there's a change in the merchandise items\n * being purchased by the customer.\n *\n * App owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` isn't supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n appMetafields: SubscribableSignalLike;\n\n /**\n * The custom key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n buyerIdentity?: BuyerIdentity;\n\n /**\n * Provides details on the buyer's progression through the checkout and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/buyer-journey#examples)\n * examples for more information.\n */\n buyerJourney: BuyerJourney;\n\n /**\n * Settings applied to the buyer's checkout.\n */\n checkoutSettings: SubscribableSignalLike;\n\n /**\n * A stable ID that represents the current checkout.\n *\n * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\n *\n * This matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data)\n * and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n */\n checkoutToken: SubscribableSignalLike;\n\n /**\n * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * The meta information about the extension.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n *\n * @deprecated Deprecated as of version `2023-07`, use `extension.target` instead.\n */\n extensionPoint: Target;\n\n /**\n * Utilities for translating content and formatting values according to the current\n * [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization)\n * of the checkout.\n *\n * Refer to [`localization` examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples)\n * for more information.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The details about the location, language, and currency of the customer. For utilities to easily\n * format and translate content based on these details, you can use the\n * [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n)\n * object instead.\n */\n localization: Localization;\n\n /**\n * The metafields that apply to the current checkout.\n *\n * Metafields are stored locally on the client and are applied to the order object after the checkout completes.\n *\n * These metafields are shared by all extensions running on checkout, and\n * persist for as long as the customer is working on this checkout.\n *\n * Once the order is created, you can query these metafields using the\n * [GraphQL Admin API](/docs/admin-api/graphql/reference/orders/order#metafield-2021-01)\n *\n * > Caution:\n * `metafields` is deprecated. Use `appMetafields` with cart metafields instead.\n *\n * @deprecated Use `appMetafields` with cart metafields instead.\n */\n metafields: SubscribableSignalLike;\n\n /**\n * A note left by the customer to the merchant, either in their cart or during checkout.\n *\n * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\n */\n note: SubscribableSignalLike;\n\n /**\n * The method used to query the Storefront GraphQL API with a prefetched token.\n *\n * Refer to [Storefront API access examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/storefront-api) for more information.\n */\n query: >(\n query: string,\n options?: {variables?: Variables; version?: StorefrontApiVersion},\n ) => Promise<{data?: Data; errors?: GraphQLError[]}>;\n\n /**\n * The payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\n */\n selectedPaymentOptions: SubscribableSignalLike;\n\n /**\n * The session token providing a set of claims as a signed JSON Web Token (JWT).\n *\n * The token has a TTL of five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/session-token) for more information.\n */\n sessionToken: SessionToken;\n\n /**\n * The settings matching the settings definition written in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates in real time as a merchant fills in the settings.\n */\n settings: SubscribableSignalLike;\n\n /**\n * The proposed customer shipping address. During the information step, the address\n * updates when the field is committed (on change) rather than every keystroke.\n * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n shippingAddress?: SubscribableSignalLike;\n\n /**\n * The proposed customer billing address. The address updates when the field is\n * committed (on change) rather than every keystroke. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided yet.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n billingAddress?: SubscribableSignalLike;\n\n /** The shop where the checkout is taking place. */\n shop: Shop;\n\n /**\n * The key-value storage for the extension.\n *\n * It uses `localStorage` and should persist across the customer's current checkout session.\n *\n * > Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n *\n * Data is shared across all activated extension targets of this extension. In versions 2023-07 and earlier,\n * each activated extension target had its own storage.\n */\n storage: Storage;\n\n /**\n * The renderer version being used for the extension.\n *\n * @example '2025-10'\n */\n version: Version;\n\n /**\n * Customer privacy consent settings and a flag denoting if consent has previously been collected.\n */\n customerPrivacy: SubscribableSignalLike;\n\n /**\n * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent) to be set to `true`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyTrackingConsentChange: ApplyTrackingConsentChangeType;\n\n /**\n * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" + "value": "export interface StandardApi {\n /**\n * Tracks custom events and sends visitor information to\n * [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events\n * and `visitor()` to submit buyer contact details.\n */\n analytics: Analytics;\n\n /**\n * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\n */\n appliedGiftCards: SubscribableSignalLike;\n\n /**\n * The cart instructions used to create the checkout and possibly limit extension capabilities.\n *\n * These instructions should be checked before performing any actions that might be affected by them.\n *\n * For example, if you intend to add a discount code via the `applyDiscountCodeChange` method,\n * check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n *\n * > Caution: Check cart instructions before calling select APIs, as\n * > some may not be available. See the\n * > [Cart Instructions API](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples)\n * > for more information.\n *\n */\n instructions: SubscribableSignalLike;\n\n /**\n * The metafields requested in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration)\n * file. These metafields are updated when there's a change in the merchandise items\n * being purchased by the customer.\n *\n * App owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` isn't supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n appMetafields: SubscribableSignalLike;\n\n /**\n * The custom key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as\n * credit cards, wallets, and local payment methods. The list depends on\n * the shop's payment configuration and the buyer's region.\n *\n * The set of payment options can change when the buyer updates their\n * address or cart, so subscribe to changes rather than reading once\n * during initialization. Each option exposes `handle` and `type` only.\n * Provider names, logos, fees, and installment terms aren't available.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n buyerIdentity?: BuyerIdentity;\n\n /**\n * Provides details on the buyer's progression through the checkout and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/buyer-journey#examples)\n * examples for more information.\n */\n buyerJourney: BuyerJourney;\n\n /**\n * Settings applied to the buyer's checkout.\n */\n checkoutSettings: SubscribableSignalLike;\n\n /**\n * A stable ID that represents the current checkout.\n *\n * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\n *\n * This matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data)\n * and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n *\n * Can be `undefined`. Handle the `undefined` state before using the value.\n */\n checkoutToken: SubscribableSignalLike;\n\n /**\n * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n *\n * Empty until the buyer enters enough address information for Shopify to\n * calculate shipping rates.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * Metadata about the running extension, including the current target, API version,\n * capabilities, and editor context. Use this to conditionally render content\n * based on where the extension is running.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n *\n * @deprecated Use `extension.target` instead.\n */\n extensionPoint: Target;\n\n /**\n * Utilities for translating strings, formatting currencies, numbers, and dates\n * according to the buyer's locale. Use alongside\n * [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization)\n * to build fully localized extensions.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The buyer's language, country, currency, and timezone context. For\n * formatting and translation helpers, use the\n * [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#properties-propertydetail-i18n)\n * object instead.\n */\n localization: Localization;\n\n /**\n * The metafields that apply to the current checkout.\n *\n * Metafields are stored locally on the client and are applied to the order object after the checkout completes.\n *\n * These metafields are shared by all extensions running on checkout, and\n * persist for as long as the customer is working on this checkout.\n *\n * Once the order is created, you can query these metafields using the\n * [GraphQL Admin API](/docs/admin-api/graphql/reference/orders/order#metafield-2021-01)\n *\n * > Caution:\n * `metafields` is deprecated. Use `appMetafields` with cart metafields instead.\n *\n * @deprecated Use `appMetafields` with cart metafields instead.\n */\n metafields: SubscribableSignalLike;\n\n /**\n * A note left by the customer to the merchant, either in their cart or during checkout.\n *\n * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\n */\n note: SubscribableSignalLike;\n\n /**\n * The method used to query the Storefront GraphQL API with a prefetched token.\n *\n */\n query: >(\n query: string,\n options?: {variables?: Variables; version?: StorefrontApiVersion},\n ) => Promise<{data?: Data; errors?: GraphQLError[]}>;\n\n /**\n * The payment options the buyer has currently selected. This updates as\n * the buyer changes their payment method. The array can contain multiple\n * entries when the buyer splits payment across methods (for example, a\n * gift card and a credit card).\n *\n * Each option exposes `handle` and `type` only. Provider names, logos,\n * fees, and installment terms aren't available.\n */\n selectedPaymentOptions: SubscribableSignalLike;\n\n /**\n * The session token providing a set of claims as a signed JSON Web Token (JWT).\n *\n * The token has a TTL of five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Learn more about [session tokens](/docs/apps/build/authentication-authorization/session-tokens).\n */\n sessionToken: SessionToken;\n\n /**\n * The settings matching the settings definition written in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates in real time as a merchant fills in the settings.\n */\n settings: SubscribableSignalLike;\n\n /**\n * The proposed customer shipping address. During the information step, the address\n * updates when the field is committed (on change) rather than every keystroke.\n * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n shippingAddress?: SubscribableSignalLike;\n\n /**\n * The proposed customer billing address. The address updates when the field is\n * committed (on change) rather than every keystroke. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided yet.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n billingAddress?: SubscribableSignalLike;\n\n /**\n * The store where the checkout is taking place, including the shop name,\n * storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.\n */\n shop: Shop;\n\n /**\n * Key-value storage that persists across page loads within the current checkout\n * session. Data is shared across all activated targets associated with\n * this extension.\n *\n * > Caution: Data persistence isn't guaranteed and storage is cleared when the\n * buyer starts a new checkout.\n */\n storage: Storage;\n\n /**\n * The renderer version being used for the extension.\n *\n * @example '2025-10'\n */\n version: Version;\n\n /**\n * Customer privacy consent settings and a flag denoting if consent has previously been collected.\n */\n customerPrivacy: SubscribableSignalLike;\n\n /**\n * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`collect_buyer_consent` capability](/docs/apps/build/customer-accounts/capabilities#collect-buyer-consent) to be set to `true`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyTrackingConsentChange: ApplyTrackingConsentChangeType;\n\n /**\n * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" }, "Analytics": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Analytics", - "description": "", + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "publish", "value": "(name: string, data: Record) => Promise", - "description": "Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing)." + "description": "Publishes a custom event to [Web Pixels](/docs/apps/marketing). Returns `true` when the event is successfully dispatched.\n\nThe Promise resolves to `true` when the event was dispatched. The boolean indicates dispatch confirmation only. It doesn't indicate whether any specific web pixel processed the event." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "visitor", "value": "(data: { email?: string; phone?: string; }) => Promise", - "description": "A method for capturing details about a visitor on the online store." + "description": "Submits buyer contact details for attribution and analytics purposes." } ], - "value": "export interface Analytics {\n /**\n * Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing).\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * A method for capturing details about a visitor on the online store.\n */\n visitor(data: {email?: string; phone?: string}): Promise;\n}" + "value": "export interface Analytics {\n /**\n * Publishes a custom event to [Web Pixels](/docs/apps/marketing).\n * Returns `true` when the event is successfully dispatched.\n *\n * The Promise resolves to `true` when the event was dispatched. The boolean\n * indicates dispatch confirmation only. It doesn't indicate whether any\n * specific web pixel processed the event.\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * Submits buyer contact details for attribution and analytics purposes.\n */\n visitor(data: {email?: string; phone?: string}): Promise;\n}" }, "VisitorResult": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -141523,10 +141523,10 @@ "syntaxKind": "PropertySignature", "name": "type", "value": "'error'", - "description": "Indicates that the visitor information is invalid and wasn't submitted. Examples are using the wrong data type or missing a required property." + "description": "Indicates that the visitor information is invalid and wasn't submitted. Common causes include using the wrong data type or omitting a required property." } ], - "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Examples are using the wrong data type or missing a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Common causes include using the wrong data type or omitting a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" }, "SubscribableSignalLike": { "filePath": "src/surfaces/checkout/shared.ts", @@ -141740,10 +141740,10 @@ "syntaxKind": "PropertySignature", "name": "value", "value": "string | null", - "description": "The new value to store in the metafield. Set to `null` to delete the metafield." + "description": "The new value to store in the metafield. Set to `null` to delete the metafield.\n\nConsent metafield values are strings, not booleans. Pass `null` to delete a tracking consent metafield." } ], - "value": "export interface TrackingConsentMetafieldChange {\n /**\n * The identifier for the tracking consent metafield to update.\n */\n key: string;\n /**\n * The new value to store in the metafield. Set to `null` to delete the metafield.\n */\n value: string | null;\n}" + "value": "export interface TrackingConsentMetafieldChange {\n /**\n * The identifier for the tracking consent metafield to update.\n */\n key: string;\n /**\n * The new value to store in the metafield. Set to `null` to delete the metafield.\n *\n * Consent metafield values are strings, not booleans. Pass `null` to delete\n * a tracking consent metafield.\n */\n value: string | null;\n}" }, "VisitorConsent": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -141957,7 +141957,7 @@ "syntaxKind": "PropertySignature", "name": "value", "value": "string", - "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.", + "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.\n\nAttribute values are always strings. To store structured data, serialize it to JSON and parse it when reading.", "examples": [ { "title": "Example", @@ -141972,7 +141972,7 @@ ] } ], - "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" + "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * Attribute values are always strings. To store structured data, serialize\n * it to JSON and parse it when reading.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" }, "PaymentOption": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -142323,7 +142323,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A globally-unique identifier for the customer in the format `gid://shopify/Customer/`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", + "description": "An identifier for the customer in the format `gid://shopify/Customer/`. This value is unique per shop.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", "examples": [ { "title": "Example", @@ -142376,7 +142376,7 @@ "isPrivate": true } ], - "value": "export interface Customer {\n /**\n * A globally-unique identifier for the customer in the format `gid://shopify/Customer/`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'gid://shopify/Customer/123'\n */\n id: string;\n /**\n * The email address associated with the customer's account. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email?: string;\n /**\n * The phone number associated with the customer's account. The value is `undefined` if no phone number is on file or the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone?: string;\n /**\n * The customer's full name, typically a combination of first and last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n fullName?: string;\n /**\n * The customer's first name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n firstName?: string;\n /**\n * The customer's last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n lastName?: string;\n /**\n * The customer's profile image, such as a Gravatar avatar. Use this to personalize the extension UI for the logged-in buyer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n image: ImageDetails;\n /**\n * Whether the customer has opted in to receiving marketing communications from the merchant, such as email campaigns and promotional offers.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * > Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n *\n * @deprecated Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n */\n acceptsMarketing: boolean;\n /**\n * Whether the customer has opted in to email marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsEmailMarketing: boolean;\n /**\n * Whether the customer has opted in to SMS marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsSmsMarketing: boolean;\n /**\n * The store credit accounts owned by this customer that can be used as payment during checkout. Each account has a balance representing available store credit.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @private\n */\n storeCreditAccounts: StoreCreditAccount[];\n /**\n * The number of orders the customer has previously placed with this shop.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n ordersCount: number;\n}" + "value": "export interface Customer {\n /**\n * An identifier for the customer in the format `gid://shopify/Customer/`. This value is unique per shop.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'gid://shopify/Customer/123'\n */\n id: string;\n /**\n * The email address associated with the customer's account. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email?: string;\n /**\n * The phone number associated with the customer's account. The value is `undefined` if no phone number is on file or the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone?: string;\n /**\n * The customer's full name, typically a combination of first and last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n fullName?: string;\n /**\n * The customer's first name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n firstName?: string;\n /**\n * The customer's last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n lastName?: string;\n /**\n * The customer's profile image, such as a Gravatar avatar. Use this to personalize the extension UI for the logged-in buyer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n image: ImageDetails;\n /**\n * Whether the customer has opted in to receiving marketing communications from the merchant, such as email campaigns and promotional offers.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * > Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n *\n * @deprecated Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n */\n acceptsMarketing: boolean;\n /**\n * Whether the customer has opted in to email marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsEmailMarketing: boolean;\n /**\n * Whether the customer has opted in to SMS marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsSmsMarketing: boolean;\n /**\n * The store credit accounts owned by this customer that can be used as payment during checkout. Each account has a balance representing available store credit.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @private\n */\n storeCreditAccounts: StoreCreditAccount[];\n /**\n * The number of orders the customer has previously placed with this shop.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n ordersCount: number;\n}" }, "ImageDetails": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -142658,11 +142658,11 @@ "syntaxKind": "MethodSignature", "name": "perform", "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", + "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.\n\nRuns after all intercept results are collected. Use it for local state updates such as setting an error flag. By the time it runs, the navigation decision is final, so blocking logic belongs in the intercept handler itself, not here.", "isOptional": true } ], - "value": "interface InterceptorRequestAllow {\n /**\n * Indicates that the interceptor allows the buyer's journey to continue.\n */\n behavior: 'allow';\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" + "value": "interface InterceptorRequestAllow {\n /**\n * Indicates that the interceptor allows the buyer's journey to continue.\n */\n behavior: 'allow';\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n *\n * Runs after all intercept results are collected. Use it for local state\n * updates such as setting an error flag. By the time it runs, the navigation\n * decision is final, so blocking logic belongs in the intercept handler\n * itself, not here.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" }, "InterceptorResult": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -142726,7 +142726,7 @@ "syntaxKind": "MethodSignature", "name": "perform", "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", + "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.\n\nRuns after all intercept results are collected. Use it for local state updates such as setting an error flag. By the time it runs, the navigation decision is final, so blocking logic belongs in the intercept handler itself, not here.", "isOptional": true }, { @@ -142737,7 +142737,7 @@ "description": "The reason for blocking the interceptor request. This value isn't presented to the buyer, so it doesn't need to be localized. The value is used only for Shopify's own internal debugging and metrics." } ], - "value": "interface InterceptorRequestBlock {\n /**\n * Indicates that the interceptor blocks the buyer's journey from continuing.\n */\n behavior: 'block';\n\n /**\n * The reason for blocking the interceptor request. This value isn't presented to\n * the buyer, so it doesn't need to be localized. The value is used only for Shopify's\n * own internal debugging and metrics.\n */\n reason: string;\n\n /**\n * Used to pass errors to the checkout UI, outside your extension's UI boundaries.\n */\n errors?: ValidationError[];\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" + "value": "interface InterceptorRequestBlock {\n /**\n * Indicates that the interceptor blocks the buyer's journey from continuing.\n */\n behavior: 'block';\n\n /**\n * The reason for blocking the interceptor request. This value isn't presented to\n * the buyer, so it doesn't need to be localized. The value is used only for Shopify's\n * own internal debugging and metrics.\n */\n reason: string;\n\n /**\n * Used to pass errors to the checkout UI, outside your extension's UI boundaries.\n */\n errors?: ValidationError[];\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n *\n * Runs after all intercept results are collected. Use it for local state\n * updates such as setting an error flag. By the time it runs, the navigation\n * decision is final, so blocking logic belongs in the intercept handler\n * itself, not here.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" }, "ValidationError": { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -142958,17 +142958,17 @@ "syntaxKind": "PropertySignature", "name": "totalShippingAmount", "value": "SubscribableSignalLike", - "description": "The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step." + "description": "The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step.\n\n`undefined` until the buyer selects a shipping method (typically after the information step)." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "totalTaxAmount", "value": "SubscribableSignalLike", - "description": "The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet." + "description": "The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet.\n\n`undefined` when taxes haven't been calculated or aren't available for the buyer's region." } ], - "value": "export interface CartCost {\n /**\n * The sum of all line item prices at the current step of checkout, before shipping and taxes are applied. Use this value to display the base cost of the items the buyer purchased.\n */\n subtotalAmount: SubscribableSignalLike;\n\n /**\n * The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step.\n */\n totalShippingAmount: SubscribableSignalLike;\n\n /**\n * The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet.\n */\n totalTaxAmount: SubscribableSignalLike;\n\n /**\n * The minimum total at the current step of checkout. Costs not yet calculated, such as shipping on the information step, aren't included. Gift cards and store credits are excluded from this total.\n */\n totalAmount: SubscribableSignalLike;\n}" + "value": "export interface CartCost {\n /**\n * The sum of all line item prices at the current step of checkout, before shipping and taxes are applied. Use this value to display the base cost of the items the buyer purchased.\n */\n subtotalAmount: SubscribableSignalLike;\n\n /**\n * The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step.\n *\n * `undefined` until the buyer selects a shipping method (typically after the\n * information step).\n */\n totalShippingAmount: SubscribableSignalLike;\n\n /**\n * The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet.\n *\n * `undefined` when taxes haven't been calculated or aren't available for the\n * buyer's region.\n */\n totalTaxAmount: SubscribableSignalLike;\n\n /**\n * The minimum total at the current step of checkout. Costs not yet calculated, such as shipping on the information step, aren't included. Gift cards and store credits are excluded from this total.\n */\n totalAmount: SubscribableSignalLike;\n}" }, "CustomerPrivacy": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -143055,31 +143055,31 @@ "syntaxKind": "PropertySignature", "name": "analytics", "value": "boolean", - "description": "Whether analytics data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Analytics data includes how the shop was used and what interactions occurred." + "description": "Whether analytics data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Analytics data includes how the shop was used and what interactions occurred.\n\nWhether analytics data can be collected right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.analytics`, before calling `shopify.analytics.publish()`." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "marketing", "value": "boolean", - "description": "Whether marketing data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Marketing data includes attribution and targeted advertising preferences." + "description": "Whether marketing data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Marketing data includes attribution and targeted advertising preferences.\n\nWhether marketing data can be collected right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.marketing`, before performing marketing-related data collection." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "preferences", "value": "boolean", - "description": "Whether preference data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Preference data includes language, currency, and sizing choices." + "description": "Whether preference data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Preference data includes language, currency, and sizing choices.\n\nWhether preference data can be collected right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.preferences`, before storing or reading buyer preference data." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "saleOfData", "value": "boolean", - "description": "Whether data can be shared with third parties based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. This typically applies to behavioral advertising data." + "description": "Whether data can be shared with third parties based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. This typically applies to behavioral advertising data.\n\nWhether buyer data can be shared with or sold to third parties right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.saleOfData`, before sharing or selling buyer data with third parties." } ], - "value": "export interface AllowedProcessing {\n /**\n * Whether analytics data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Analytics\n * data includes how the shop was used and what interactions occurred.\n */\n analytics: boolean;\n /**\n * Whether marketing data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Marketing\n * data includes attribution and targeted advertising preferences.\n */\n marketing: boolean;\n /**\n * Whether preference data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Preference\n * data includes language, currency, and sizing choices.\n */\n preferences: boolean;\n /**\n * Whether data can be shared with third parties based on the visitor's\n * consent, the merchant's privacy configuration, and the visitor's region.\n * This typically applies to behavioral advertising data.\n */\n saleOfData: boolean;\n}" + "value": "export interface AllowedProcessing {\n /**\n * Whether analytics data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Analytics\n * data includes how the shop was used and what interactions occurred.\n *\n * Whether analytics data can be collected right now. Combines the buyer's\n * consent, the merchant's privacy configuration, and the buyer's region into\n * a single boolean. Check this flag, not `visitorConsent.analytics`, before\n * calling `shopify.analytics.publish()`.\n */\n analytics: boolean;\n /**\n * Whether marketing data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Marketing\n * data includes attribution and targeted advertising preferences.\n *\n * Whether marketing data can be collected right now. Combines the buyer's\n * consent, the merchant's privacy configuration, and the buyer's region into\n * a single boolean. Check this flag, not `visitorConsent.marketing`, before\n * performing marketing-related data collection.\n */\n marketing: boolean;\n /**\n * Whether preference data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Preference\n * data includes language, currency, and sizing choices.\n *\n * Whether preference data can be collected right now. Combines the buyer's\n * consent, the merchant's privacy configuration, and the buyer's region into\n * a single boolean. Check this flag, not `visitorConsent.preferences`,\n * before storing or reading buyer preference data.\n */\n preferences: boolean;\n /**\n * Whether data can be shared with third parties based on the visitor's\n * consent, the merchant's privacy configuration, and the visitor's region.\n * This typically applies to behavioral advertising data.\n *\n * Whether buyer data can be shared with or sold to third parties right now.\n * Combines the buyer's consent, the merchant's privacy configuration, and\n * the buyer's region into a single boolean. Check this flag, not\n * `visitorConsent.saleOfData`, before sharing or selling buyer data with\n * third parties.\n */\n saleOfData: boolean;\n}" }, "TrackingConsentMetafield": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -143771,7 +143771,7 @@ "Extension": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Extension", - "description": "The meta information about an extension target.", + "description": "Metadata about the running extension, including its API version, target, capabilities, and editor context. Use this to read configuration details or conditionally render content based on where the extension is running.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -143797,7 +143797,7 @@ "syntaxKind": "PropertySignature", "name": "capabilities", "value": "SubscribableSignalLike", - "description": "The allowed capabilities of the extension, defined in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n\n* [`api_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#api-access): the extension can access the Storefront API.\n\n* [`network_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access): the extension can make external network calls.\n\n* [`block_progress`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n\n* [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n\n* [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can register customer consent decisions that are honored on Shopify-managed services.\n\n* [`iframe.sources`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#iframe): the extension can embed an external URL in an iframe." + "description": "The allowed capabilities of the extension, defined in your [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -143845,7 +143845,7 @@ "syntaxKind": "PropertySignature", "name": "version", "value": "string", - "description": "The published version of the running extension target.\n\nFor unpublished extensions, the value is `undefined`.", + "description": "The published version of the running extension target.\n\nFor unpublished extensions, the value is `undefined`.\n\nDon't use this property as a stable identifier in development environments. It becomes available only after the extension is published.", "isOptional": true, "examples": [ { @@ -143861,7 +143861,7 @@ ] } ], - "value": "export interface Extension {\n /**\n * The API version that was set in the extension config file.\n *\n * @example '2024-10', '2025-01', '2025-04', '2025-07', '2025-10'\n */\n apiVersion: ApiVersion;\n\n /**\n * The allowed capabilities of the extension, defined\n * in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n *\n * * [`api_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#api-access): the extension can access the Storefront API.\n *\n * * [`network_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access): the extension can make external network calls.\n *\n * * [`block_progress`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n *\n * * [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n *\n * * [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can register customer consent decisions that are honored on Shopify-managed services.\n *\n * * [`iframe.sources`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#iframe): the extension can embed an external URL in an iframe.\n */\n capabilities: SubscribableSignalLike;\n\n /**\n * Information about the editor where the extension is being rendered.\n *\n * If the value is undefined, then the extension isn't running in an editor.\n */\n editor?: Editor;\n\n /**\n * A Boolean to show whether your extension is currently rendered to the screen.\n *\n * Shopify might render your extension before it's visible in the UI,\n * typically to pre-render extensions that appear on a later step of the\n * checkout.\n *\n * Your extension might also continue to run after the customer has navigated away\n * from where it was rendered. The extension continues running so that\n * your extension is immediately available to render if the customer navigates back.\n */\n rendered: SubscribableSignalLike;\n\n /**\n * The URL to the script that started the extension target.\n */\n scriptUrl: string;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n */\n target: Target;\n\n /**\n * The published version of the running extension target.\n *\n * For unpublished extensions, the value is `undefined`.\n *\n * @example 3.0.10\n */\n version?: string;\n}" + "value": "export interface Extension {\n /**\n * The API version that was set in the extension config file.\n *\n * @example '2024-10', '2025-01', '2025-04', '2025-07', '2025-10'\n */\n apiVersion: ApiVersion;\n\n /**\n * The allowed capabilities of the extension, defined in your\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n */\n capabilities: SubscribableSignalLike;\n\n /**\n * Information about the editor where the extension is being rendered.\n *\n * If the value is undefined, then the extension isn't running in an editor.\n */\n editor?: Editor;\n\n /**\n * A Boolean to show whether your extension is currently rendered to the screen.\n *\n * Shopify might render your extension before it's visible in the UI,\n * typically to pre-render extensions that appear on a later step of the\n * checkout.\n *\n * Your extension might also continue to run after the customer has navigated away\n * from where it was rendered. The extension continues running so that\n * your extension is immediately available to render if the customer navigates back.\n */\n rendered: SubscribableSignalLike;\n\n /**\n * The URL to the script that started the extension target.\n */\n scriptUrl: string;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n */\n target: Target;\n\n /**\n * The published version of the running extension target.\n *\n * For unpublished extensions, the value is `undefined`.\n *\n * Don't use this property as a stable identifier in development environments.\n * It becomes available only after the extension is published.\n *\n * @example 3.0.10\n */\n version?: string;\n}" }, "ApiVersion": { "filePath": "src/shared.ts", @@ -143880,7 +143880,7 @@ "Editor": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Editor", - "description": "", + "description": "Information about the editor environment when an extension is rendered inside the checkout editor. The value is `undefined` when the extension is not rendering in an editor.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -143895,7 +143895,7 @@ "I18n": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18n", - "description": "", + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use the I18n API alongside the Localization API to build fully localized extensions.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -143931,7 +143931,7 @@ "I18nTranslate": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18nTranslate", - "description": "This returns a translated string matching a key in a locale file.", + "description": "Translates a key from your extension's locale files into a localized string. Supports interpolation with placeholder replacements and pluralization via the special `count` option.", "members": [], "value": "export interface I18nTranslate {\n (\n key: string,\n options?: Record,\n ): ReplacementType extends string | number\n ? string\n : (string | ReplacementType)[];\n}" }, @@ -144495,14 +144495,14 @@ "Localization": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Localization", - "description": "", + "description": "The buyer's language, country, currency, and timezone context. Use this to adapt your extension to the buyer's region and display localized content.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "country", "value": "SubscribableSignalLike", - "description": "The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown." + "description": "The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n\nDerived from the buyer's shipping address. Returns `undefined` until the buyer enters a shipping address." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -144530,18 +144530,18 @@ "syntaxKind": "PropertySignature", "name": "market", "value": "SubscribableSignalLike", - "description": "The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n\n> Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.", - "deprecationMessage": "Deprecated as of version `2025-04`" + "description": "The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. The market context updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.", + "deprecationMessage": "Merchants now manage which extensions load for each\nmarket, so extensions no longer need to check this value." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "timezone", "value": "SubscribableSignalLike", - "description": "The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time." + "description": "The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time." } ], - "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n *\n * > Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" + "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n *\n * Derived from the buyer's shipping address. Returns `undefined` until the\n * buyer enters a shipping address.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout,\n * carried over from the cart context. Markets group countries and\n * regions with shared pricing, languages, and domains. The market\n * context updates when the buyer changes the country of their\n * shipping address. The value is `undefined` if the market is unknown.\n *\n * @deprecated Merchants now manage which extensions load for each\n * market, so extensions no longer need to check this value.\n */\n market: SubscribableSignalLike;\n}" }, "Country": { "filePath": "src/shared.ts", @@ -144742,7 +144742,7 @@ "SessionToken": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SessionToken", - "description": "", + "description": "Authenticates requests between your extension and your app backend. Use session tokens to verify the identity of the buyer and the shop context when making server-side API calls. The token is a signed JWT that contains claims such as the customer ID, shop domain, and expiration.\n\nThe `sub` claim in the decoded token is present only when the buyer is logged in and the app has permission to read customer accounts. Absent for anonymous buyers.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -145001,7 +145001,7 @@ "Shop": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Shop", - "description": "", + "description": "Metadata about the merchant's store, including its name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -145041,30 +145041,30 @@ "syntaxKind": "PropertySignature", "name": "storefrontUrl", "value": "string", - "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n\n> Caution: > As of version `2024-04` this value no longer has a trailing slash.", + "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.", "isOptional": true } ], - "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n *\n * > Caution:\n * > As of version `2024-04` this value no longer has a trailing slash.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom domain.\n */\n myshopifyDomain: string;\n}" + "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom domain.\n */\n myshopifyDomain: string;\n}" }, "Storage": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Storage", - "description": "A key-value storage object for the extension.\n\nStored data is available only to this specific extension and any of its instances.\n\nThe storage backend is implemented with `localStorage` and should persist across the buyer's checkout session. However, data persistence isn't guaranteed.", + "description": "Key-value storage for a specific extension. Use storage to save preferences or cached data that should survive page reloads without requiring a backend call. Stored data is only available to this specific extension. The storage backend is implemented with `localStorage` and data persistence isn't guaranteed.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "delete", "value": "(key: string) => Promise", - "description": "Delete stored data by key." + "description": "Deletes a previously stored value by key." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "read", "value": "(key: string) => Promise", - "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original primitive.\n\nReturns `null` if no stored data exists." + "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original type.\n\nReturns the stored value for the given key, or `null` when no value exists. Doesn't throw on a missing key." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -145074,7 +145074,7 @@ "description": "Write stored data for this key.\n\nThe data must be serializable to JSON." } ], - "value": "export interface Storage {\n /**\n * Read and return a stored value by key.\n *\n * The stored data is deserialized from JSON and returned as\n * its original primitive.\n *\n * Returns `null` if no stored data exists.\n */\n read(key: string): Promise;\n\n /**\n * Write stored data for this key.\n *\n * The data must be serializable to JSON.\n */\n write(key: string, data: any): Promise;\n\n /**\n * Delete stored data by key.\n */\n delete(key: string): Promise;\n}" + "value": "export interface Storage {\n /**\n * Read and return a stored value by key.\n *\n * The stored data is deserialized from JSON and returned as\n * its original type.\n *\n * Returns the stored value for the given key, or `null` when no value\n * exists. Doesn't throw on a missing key.\n */\n read(key: string): Promise;\n\n /**\n * Write stored data for this key.\n *\n * The data must be serializable to JSON.\n */\n write(key: string, data: any): Promise;\n\n /**\n * Deletes a previously stored value by key.\n */\n delete(key: string): Promise;\n}" }, "Version": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -145150,7 +145150,7 @@ "syntaxKind": "MethodSignature", "name": "applyAttributeChange", "value": "(change: AttributeChange) => Promise", - "description": "Updates or removes an attribute on the cart and checkout. On success, the [`attributes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/attributes#standardapi-propertydetail-attributes) property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.", + "description": "Updates or removes an attribute on the cart and checkout. On success, the [`attributes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/attributes#properties-propertydetail-attributes) property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.", "deprecationMessage": "Use cart metafields instead." }, { @@ -145158,42 +145158,42 @@ "syntaxKind": "MethodSignature", "name": "applyCartLinesChange", "value": "(change: CartLineChange) => Promise", - "description": "Adds, removes, or updates line items in the cart. The returned promise resolves when the change has been applied by the server, and the [`lines`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-lines#standardapi-propertydetail-lines) property updates with the new state.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Adds, removes, or updates line items in the cart. The returned promise resolves when the change has been applied by the server, and the [`lines`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-lines#properties-propertydetail-lines) property updates with the new state.\n\nAccepts a single change per call. To make multiple changes, call this method separately for each one.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyDiscountCodeChange", "value": "(change: DiscountCodeChange) => Promise", - "description": "Adds or removes a discount code on the checkout. The returned promise resolves when the change has been applied by the server, and the [`discountCodes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/discounts#standardapi-propertydetail-discountcodes) property updates with the new state.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves discount codes through a network call.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Adds or removes a discount code on the checkout. The returned promise resolves when the change has been applied by the server, and the [`discountCodes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/discounts#properties-propertydetail-discountcodes) property updates with the new state.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves discount codes through a network call.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyGiftCardChange", "value": "(change: GiftCardChange) => Promise", - "description": "Adds or removes a gift card from the checkout. The returned promise resolves when the change has been applied by the server, and the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/gift-cards#standardapi-propertydetail-appliedgiftcards) property updates with the new state.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves gift card codes through a network call.\n\n> Note: This method returns an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Adds or removes a gift card from the checkout. The returned promise resolves when the change has been applied by the server, and the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/gift-cards#properties-propertydetail-appliedgiftcards) property updates with the new state.\n\nUnlike other write operations, gift card changes aren't gated by a cart instruction flag.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves gift card codes through a network call.\n\n> Note: This method returns an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyMetafieldChange", "value": "(change: MetafieldChange) => Promise", - "description": "Creates, updates, or removes a cart metafield on the checkout. On success, the [`metafields`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/metafields#standardapi-propertydetail-metafields) property updates to reflect the change.\n\nCart metafields are copied to order metafields at order creation time if there's a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n\n> Caution: `MetafieldRemoveChange` and `MetafieldUpdateChange` are deprecated. Use cart metafields with `MetafieldRemoveCartChange` and `MetafieldUpdateCartChange` instead. If `MetafieldUpdateChange` writes a metafield with the same namespace and key as a cart metafield that's configured to copy, the cart metafield won't be copied.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Creates, updates, or removes a cart metafield on the checkout. On success, the [`metafields`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/metafields#properties-propertydetail-metafields) property updates to reflect the change.\n\nCart metafields are copied to order metafields at order creation time if there's a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n\n> Caution: `MetafieldRemoveChange` and `MetafieldUpdateChange` are deprecated. Use cart metafields with `MetafieldRemoveCartChange` and `MetafieldUpdateCartChange` instead. If `MetafieldUpdateChange` writes a metafield with the same namespace and key as a cart metafield that's configured to copy, the cart metafield won't be copied.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyNoteChange", "value": "(change: NoteChange) => Promise", - "description": "Sets or removes the buyer's note on the checkout. On success, the [`note`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/note#standardapi-propertydetail-note) property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Sets or removes the buyer's note on the checkout. On success, the [`note`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/note#properties-propertydetail-note) property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyShippingAddressChange", "value": "(change: ShippingAddressUpdateChange) => Promise", - "description": "Updates the buyer's shipping address on the checkout. The provided fields are merged into the existing address without prompting the buyer. On success, the `shippingAddress` property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", + "description": "Updates the buyer's shipping address on the checkout. The provided fields are merged into the existing address without prompting the buyer. On success, the `shippingAddress` property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", "isOptional": true }, { @@ -145206,7 +145206,7 @@ "isPrivate": true } ], - "value": "export interface CheckoutApi {\n /**\n * Updates or removes an attribute on the cart and checkout. On success, the\n * [`attributes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/attributes#standardapi-propertydetail-attributes) property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * @deprecated Use cart metafields instead.\n */\n applyAttributeChange(change: AttributeChange): Promise;\n\n /**\n * Adds, removes, or updates line items in the cart. The returned promise resolves when the change has been applied by the server, and the [`lines`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-lines#standardapi-propertydetail-lines) property updates with the new state.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyCartLinesChange(change: CartLineChange): Promise;\n\n /**\n * Adds or removes a discount code on the checkout. The returned promise resolves when the change has been applied by the server, and the [`discountCodes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/discounts#standardapi-propertydetail-discountcodes) property updates with the new state.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves discount codes through a network call.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyDiscountCodeChange(\n change: DiscountCodeChange,\n ): Promise;\n\n /**\n * Adds or removes a gift card from the checkout. The returned promise resolves when the change has been applied by the server, and the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/gift-cards#standardapi-propertydetail-appliedgiftcards) property updates with the new state.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves gift card codes through a network call.\n *\n * > Note: This method returns an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyGiftCardChange(change: GiftCardChange): Promise;\n\n /**\n * Creates, updates, or removes a cart metafield on the checkout. On success, the\n * [`metafields`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/metafields#standardapi-propertydetail-metafields) property updates to reflect the change.\n *\n * Cart metafields are copied to order metafields at order creation time if there's a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n *\n * > Caution: `MetafieldRemoveChange` and `MetafieldUpdateChange` are deprecated. Use cart metafields with `MetafieldRemoveCartChange` and `MetafieldUpdateCartChange` instead. If `MetafieldUpdateChange` writes a metafield with the same namespace and key as a cart metafield that's configured to copy, the cart metafield won't be copied.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyMetafieldChange(change: MetafieldChange): Promise;\n\n /**\n * Sets or removes the buyer's note on the checkout. On success, the\n * [`note`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/note#standardapi-propertydetail-note)\n * property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyNoteChange(change: NoteChange): Promise;\n\n /**\n * @private\n */\n experimentalIsShopAppStyle?: boolean;\n\n /**\n * Updates the buyer's shipping address on the checkout. The provided fields\n * are merged into the existing address without prompting the buyer. On success,\n * the `shippingAddress` property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyShippingAddressChange?(\n change: ShippingAddressChange,\n ): Promise;\n}" + "value": "export interface CheckoutApi {\n /**\n * Updates or removes an attribute on the cart and checkout. On success, the\n * [`attributes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/attributes#properties-propertydetail-attributes) property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * @deprecated Use cart metafields instead.\n */\n applyAttributeChange(change: AttributeChange): Promise;\n\n /**\n * Adds, removes, or updates line items in the cart. The returned promise resolves when the change has been applied by the server, and the [`lines`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-lines#properties-propertydetail-lines) property updates with the new state.\n *\n * Accepts a single change per call. To make multiple changes, call this\n * method separately for each one.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyCartLinesChange(change: CartLineChange): Promise;\n\n /**\n * Adds or removes a discount code on the checkout. The returned promise resolves when the change has been applied by the server, and the [`discountCodes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/discounts#properties-propertydetail-discountcodes) property updates with the new state.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves discount codes through a network call.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyDiscountCodeChange(\n change: DiscountCodeChange,\n ): Promise;\n\n /**\n * Adds or removes a gift card from the checkout. The returned promise resolves when the change has been applied by the server, and the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/gift-cards#properties-propertydetail-appliedgiftcards) property updates with the new state.\n *\n * Unlike other write operations, gift card changes aren't gated by a cart\n * instruction flag.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves gift card codes through a network call.\n *\n * > Note: This method returns an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyGiftCardChange(change: GiftCardChange): Promise;\n\n /**\n * Creates, updates, or removes a cart metafield on the checkout. On success, the\n * [`metafields`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/metafields#properties-propertydetail-metafields) property updates to reflect the change.\n *\n * Cart metafields are copied to order metafields at order creation time if there's a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n *\n * > Caution: `MetafieldRemoveChange` and `MetafieldUpdateChange` are deprecated. Use cart metafields with `MetafieldRemoveCartChange` and `MetafieldUpdateCartChange` instead. If `MetafieldUpdateChange` writes a metafield with the same namespace and key as a cart metafield that's configured to copy, the cart metafield won't be copied.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyMetafieldChange(change: MetafieldChange): Promise;\n\n /**\n * Sets or removes the buyer's note on the checkout. On success, the\n * [`note`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/note#properties-propertydetail-note)\n * property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyNoteChange(change: NoteChange): Promise;\n\n /**\n * @private\n */\n experimentalIsShopAppStyle?: boolean;\n\n /**\n * Updates the buyer's shipping address on the checkout. The provided fields\n * are merged into the existing address without prompting the buyer. On success,\n * the `shippingAddress` property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyShippingAddressChange?(\n change: ShippingAddressChange,\n ): Promise;\n}" }, "AttributeChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -145273,7 +145273,7 @@ "syntaxKind": "PropertySignature", "name": "value", "value": "string", - "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.", + "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.\n\nAttribute values are always strings. To store structured data, serialize it to JSON and parse it when reading.", "examples": [ { "title": "Example", @@ -145288,7 +145288,7 @@ ] } ], - "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" + "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * Attribute values are always strings. To store structured data, serialize\n * it to JSON and parse it when reading.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" }, "AttributeRemoveChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -146141,7 +146141,7 @@ "syntaxKind": "PropertySignature", "name": "message", "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer." + "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer.\n\nRender your own localized error text rather than displaying this message to the buyer." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -146151,7 +146151,7 @@ "description": "Indicates that the line item wasn't changed successfully. Refer to the `message` property for details about the error." } ], - "value": "export interface CartLineChangeResultError {\n /**\n * Indicates that the line item wasn't changed successfully. Refer to the `message` property for details about the error.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface CartLineChangeResultError {\n /**\n * Indicates that the line item wasn't changed successfully. Refer to the `message` property for details about the error.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n *\n * Render your own localized error text rather than displaying this message\n * to the buyer.\n */\n message: string;\n}" }, "DiscountCodeChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -146331,7 +146331,7 @@ "syntaxKind": "PropertySignature", "name": "message", "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer." + "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer.\n\nRender your own localized error text rather than displaying this message to the buyer." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -146341,7 +146341,7 @@ "description": "Indicates that the gift card change couldn't be applied. Check the `message` property for details." } ], - "value": "export interface GiftCardChangeResultError {\n /**\n * Indicates that the gift card change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface GiftCardChangeResultError {\n /**\n * Indicates that the gift card change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n *\n * Render your own localized error text rather than displaying this message\n * to the buyer.\n */\n message: string;\n}" }, "MetafieldChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -146602,7 +146602,7 @@ "syntaxKind": "PropertySignature", "name": "message", "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer." + "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer.\n\nRender your own localized error text rather than displaying this message to the buyer." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -146612,7 +146612,7 @@ "description": "Indicates that the metafield change couldn't be applied. Check the `message` property for details." } ], - "value": "export interface MetafieldChangeResultError {\n /**\n * Indicates that the metafield change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface MetafieldChangeResultError {\n /**\n * Indicates that the metafield change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n *\n * Render your own localized error text rather than displaying this message\n * to the buyer.\n */\n message: string;\n}" }, "NoteChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -146690,7 +146690,7 @@ "syntaxKind": "PropertySignature", "name": "message", "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer." + "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer.\n\nRender your own localized error text rather than displaying this message to the buyer." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -146700,7 +146700,7 @@ "description": "Indicates that the note change couldn't be applied. Check the `message` property for details." } ], - "value": "export interface NoteChangeResultError {\n /**\n * Indicates that the note change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface NoteChangeResultError {\n /**\n * Indicates that the note change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n *\n * Render your own localized error text rather than displaying this message\n * to the buyer.\n */\n message: string;\n}" }, "ShippingAddressUpdateChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -147286,7 +147286,7 @@ "syntaxKind": "PropertySignature", "name": "analytics", "value": "Analytics", - "description": "The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event." + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -147300,7 +147300,7 @@ "syntaxKind": "PropertySignature", "name": "applyTrackingConsentChange", "value": "ApplyTrackingConsentChangeType", - "description": "Enables setting and updating customer privacy consent settings and tracking consent metafields.\n\n> Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent) to be set to `true`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." + "description": "Enables setting and updating customer privacy consent settings and tracking consent metafields.\n\n> Note: Requires the [`collect_buyer_consent` capability](/docs/apps/build/customer-accounts/capabilities#collect-buyer-consent) to be set to `true`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -147321,7 +147321,7 @@ "syntaxKind": "PropertySignature", "name": "availablePaymentOptions", "value": "SubscribableSignalLike", - "description": "All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region." + "description": "All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n\nThe set of payment options can change when the buyer updates their address or cart, so subscribe to changes rather than reading once during initialization. Each option exposes `handle` and `type` only. Provider names, logos, fees, and installment terms aren't available." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -147358,7 +147358,7 @@ "syntaxKind": "PropertySignature", "name": "checkoutToken", "value": "SubscribableSignalLike", - "description": "A stable ID that represents the current checkout.\n\nThe value is `undefined` when the checkout hasn't been created on the server yet.\n\nUse this to correlate checkout sessions across your extension, web pixels, and backend systems.\n\nThis matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data) and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object)." + "description": "A stable ID that represents the current checkout.\n\nThe value is `undefined` when the checkout hasn't been created on the server yet.\n\nUse this to correlate checkout sessions across your extension, web pixels, and backend systems.\n\nThis matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data) and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n\nCan be `undefined`. Handle the `undefined` state before using the value." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -147379,7 +147379,7 @@ "syntaxKind": "PropertySignature", "name": "deliveryGroups", "value": "SubscribableSignalLike", - "description": "The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items." + "description": "The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n\nEmpty until the buyer enters enough address information for Shopify to calculate shipping rates." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -147400,7 +147400,7 @@ "syntaxKind": "PropertySignature", "name": "extension", "value": "Extension", - "description": "The meta information about the extension." + "description": "Metadata about the running extension, including the current target, API version, capabilities, and editor context. Use this to conditionally render content based on where the extension is running." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -147408,7 +147408,7 @@ "name": "extensionPoint", "value": "Target", "description": "The identifier that specifies where in Shopify's UI your code is being injected. This is one of the targets you've included in your extension's configuration file.", - "deprecationMessage": "Deprecated as of version `2023-07`, use `extension.target` instead.", + "deprecationMessage": "Use `extension.target` instead.", "examples": [ { "title": "Example", @@ -147427,14 +147427,14 @@ "syntaxKind": "PropertySignature", "name": "i18n", "value": "I18n", - "description": "Utilities for translating content and formatting values according to the current [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) of the checkout.\n\nRefer to [`localization` examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples) for more information." + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use alongside [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) to build fully localized extensions." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "instructions", "value": "SubscribableSignalLike", - "description": "The cart instructions used to create the checkout and possibly limit extension capabilities.\n\nThese instructions should be checked before performing any actions that might be affected by them.\n\nFor example, if you intend to add a discount code via the `applyDiscountCodeChange` method, check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n\n> Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs aren't available. See the [update guide](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples) for more information." + "description": "The cart instructions used to create the checkout and possibly limit extension capabilities.\n\nThese instructions should be checked before performing any actions that might be affected by them.\n\nFor example, if you intend to add a discount code via the `applyDiscountCodeChange` method, check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n\n> Caution: Check cart instructions before calling select APIs, as > some may not be available. See the > [Cart Instructions API](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples) > for more information." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -147448,7 +147448,7 @@ "syntaxKind": "PropertySignature", "name": "localization", "value": "Localization", - "description": "The details about the location, language, and currency of the customer. For utilities to easily format and translate content based on these details, you can use the [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n) object instead." + "description": "The buyer's language, country, currency, and timezone context. For formatting and translation helpers, use the [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#properties-propertydetail-i18n) object instead." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -147478,21 +147478,21 @@ "syntaxKind": "PropertySignature", "name": "query", "value": ">(query: string, options?: { variables?: Variables; version?: StorefrontApiVersion; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>", - "description": "The method used to query the Storefront GraphQL API with a prefetched token.\n\nRefer to [Storefront API access examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/storefront-api) for more information." + "description": "The method used to query the Storefront GraphQL API with a prefetched token." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "selectedPaymentOptions", "value": "SubscribableSignalLike", - "description": "The payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card)." + "description": "The payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\n\nEach option exposes `handle` and `type` only. Provider names, logos, fees, and installment terms aren't available." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "sessionToken", "value": "SessionToken", - "description": "The session token providing a set of claims as a signed JSON Web Token (JWT).\n\nThe token has a TTL of five minutes.\n\nIf the previous token expires, this value reflects a new session token with a new signature and expiry.\n\nRefer to [session token examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/session-token) for more information." + "description": "The session token providing a set of claims as a signed JSON Web Token (JWT).\n\nThe token has a TTL of five minutes.\n\nIf the previous token expires, this value reflects a new session token with a new signature and expiry.\n\nLearn more about [session tokens](/docs/apps/build/authentication-authorization/session-tokens)." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -147514,14 +147514,14 @@ "syntaxKind": "PropertySignature", "name": "shop", "value": "Shop", - "description": "The shop where the checkout is taking place." + "description": "The store where the checkout is taking place, including the shop name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "storage", "value": "Storage", - "description": "The key-value storage for the extension.\n\nIt uses `localStorage` and should persist across the customer's current checkout session.\n\n> Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n\nData is shared across all activated extension targets of this extension. In versions 2023-07 and earlier, each activated extension target had its own storage." + "description": "Key-value storage that persists across page loads within the current checkout session. Data is shared across all activated targets associated with this extension.\n\n> Caution: Data persistence isn't guaranteed and storage is cleared when the buyer starts a new checkout." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -147543,29 +147543,29 @@ ] } ], - "value": "export interface StandardApi {\n /**\n * The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event.\n */\n analytics: Analytics;\n\n /**\n * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\n */\n appliedGiftCards: SubscribableSignalLike;\n\n /**\n * The cart instructions used to create the checkout and possibly limit extension capabilities.\n *\n * These instructions should be checked before performing any actions that might be affected by them.\n *\n * For example, if you intend to add a discount code via the `applyDiscountCodeChange` method,\n * check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n *\n * > Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs aren't available.\n * See the [update guide](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples) for more information.\n *\n */\n instructions: SubscribableSignalLike;\n\n /**\n * The metafields requested in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration)\n * file. These metafields are updated when there's a change in the merchandise items\n * being purchased by the customer.\n *\n * App owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` isn't supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n appMetafields: SubscribableSignalLike;\n\n /**\n * The custom key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n buyerIdentity?: BuyerIdentity;\n\n /**\n * Provides details on the buyer's progression through the checkout and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/buyer-journey#examples)\n * examples for more information.\n */\n buyerJourney: BuyerJourney;\n\n /**\n * Settings applied to the buyer's checkout.\n */\n checkoutSettings: SubscribableSignalLike;\n\n /**\n * A stable ID that represents the current checkout.\n *\n * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\n *\n * This matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data)\n * and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n */\n checkoutToken: SubscribableSignalLike;\n\n /**\n * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * The meta information about the extension.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n *\n * @deprecated Deprecated as of version `2023-07`, use `extension.target` instead.\n */\n extensionPoint: Target;\n\n /**\n * Utilities for translating content and formatting values according to the current\n * [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization)\n * of the checkout.\n *\n * Refer to [`localization` examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples)\n * for more information.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The details about the location, language, and currency of the customer. For utilities to easily\n * format and translate content based on these details, you can use the\n * [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n)\n * object instead.\n */\n localization: Localization;\n\n /**\n * The metafields that apply to the current checkout.\n *\n * Metafields are stored locally on the client and are applied to the order object after the checkout completes.\n *\n * These metafields are shared by all extensions running on checkout, and\n * persist for as long as the customer is working on this checkout.\n *\n * Once the order is created, you can query these metafields using the\n * [GraphQL Admin API](/docs/admin-api/graphql/reference/orders/order#metafield-2021-01)\n *\n * > Caution:\n * `metafields` is deprecated. Use `appMetafields` with cart metafields instead.\n *\n * @deprecated Use `appMetafields` with cart metafields instead.\n */\n metafields: SubscribableSignalLike;\n\n /**\n * A note left by the customer to the merchant, either in their cart or during checkout.\n *\n * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\n */\n note: SubscribableSignalLike;\n\n /**\n * The method used to query the Storefront GraphQL API with a prefetched token.\n *\n * Refer to [Storefront API access examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/storefront-api) for more information.\n */\n query: >(\n query: string,\n options?: {variables?: Variables; version?: StorefrontApiVersion},\n ) => Promise<{data?: Data; errors?: GraphQLError[]}>;\n\n /**\n * The payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\n */\n selectedPaymentOptions: SubscribableSignalLike;\n\n /**\n * The session token providing a set of claims as a signed JSON Web Token (JWT).\n *\n * The token has a TTL of five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/session-token) for more information.\n */\n sessionToken: SessionToken;\n\n /**\n * The settings matching the settings definition written in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates in real time as a merchant fills in the settings.\n */\n settings: SubscribableSignalLike;\n\n /**\n * The proposed customer shipping address. During the information step, the address\n * updates when the field is committed (on change) rather than every keystroke.\n * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n shippingAddress?: SubscribableSignalLike;\n\n /**\n * The proposed customer billing address. The address updates when the field is\n * committed (on change) rather than every keystroke. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided yet.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n billingAddress?: SubscribableSignalLike;\n\n /** The shop where the checkout is taking place. */\n shop: Shop;\n\n /**\n * The key-value storage for the extension.\n *\n * It uses `localStorage` and should persist across the customer's current checkout session.\n *\n * > Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n *\n * Data is shared across all activated extension targets of this extension. In versions 2023-07 and earlier,\n * each activated extension target had its own storage.\n */\n storage: Storage;\n\n /**\n * The renderer version being used for the extension.\n *\n * @example '2025-10'\n */\n version: Version;\n\n /**\n * Customer privacy consent settings and a flag denoting if consent has previously been collected.\n */\n customerPrivacy: SubscribableSignalLike;\n\n /**\n * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent) to be set to `true`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyTrackingConsentChange: ApplyTrackingConsentChangeType;\n\n /**\n * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" + "value": "export interface StandardApi {\n /**\n * Tracks custom events and sends visitor information to\n * [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events\n * and `visitor()` to submit buyer contact details.\n */\n analytics: Analytics;\n\n /**\n * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\n */\n appliedGiftCards: SubscribableSignalLike;\n\n /**\n * The cart instructions used to create the checkout and possibly limit extension capabilities.\n *\n * These instructions should be checked before performing any actions that might be affected by them.\n *\n * For example, if you intend to add a discount code via the `applyDiscountCodeChange` method,\n * check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n *\n * > Caution: Check cart instructions before calling select APIs, as\n * > some may not be available. See the\n * > [Cart Instructions API](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples)\n * > for more information.\n *\n */\n instructions: SubscribableSignalLike;\n\n /**\n * The metafields requested in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration)\n * file. These metafields are updated when there's a change in the merchandise items\n * being purchased by the customer.\n *\n * App owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` isn't supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n appMetafields: SubscribableSignalLike;\n\n /**\n * The custom key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as\n * credit cards, wallets, and local payment methods. The list depends on\n * the shop's payment configuration and the buyer's region.\n *\n * The set of payment options can change when the buyer updates their\n * address or cart, so subscribe to changes rather than reading once\n * during initialization. Each option exposes `handle` and `type` only.\n * Provider names, logos, fees, and installment terms aren't available.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n buyerIdentity?: BuyerIdentity;\n\n /**\n * Provides details on the buyer's progression through the checkout and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/buyer-journey#examples)\n * examples for more information.\n */\n buyerJourney: BuyerJourney;\n\n /**\n * Settings applied to the buyer's checkout.\n */\n checkoutSettings: SubscribableSignalLike;\n\n /**\n * A stable ID that represents the current checkout.\n *\n * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\n *\n * This matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data)\n * and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n *\n * Can be `undefined`. Handle the `undefined` state before using the value.\n */\n checkoutToken: SubscribableSignalLike;\n\n /**\n * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n *\n * Empty until the buyer enters enough address information for Shopify to\n * calculate shipping rates.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * Metadata about the running extension, including the current target, API version,\n * capabilities, and editor context. Use this to conditionally render content\n * based on where the extension is running.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n *\n * @deprecated Use `extension.target` instead.\n */\n extensionPoint: Target;\n\n /**\n * Utilities for translating strings, formatting currencies, numbers, and dates\n * according to the buyer's locale. Use alongside\n * [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization)\n * to build fully localized extensions.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The buyer's language, country, currency, and timezone context. For\n * formatting and translation helpers, use the\n * [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#properties-propertydetail-i18n)\n * object instead.\n */\n localization: Localization;\n\n /**\n * The metafields that apply to the current checkout.\n *\n * Metafields are stored locally on the client and are applied to the order object after the checkout completes.\n *\n * These metafields are shared by all extensions running on checkout, and\n * persist for as long as the customer is working on this checkout.\n *\n * Once the order is created, you can query these metafields using the\n * [GraphQL Admin API](/docs/admin-api/graphql/reference/orders/order#metafield-2021-01)\n *\n * > Caution:\n * `metafields` is deprecated. Use `appMetafields` with cart metafields instead.\n *\n * @deprecated Use `appMetafields` with cart metafields instead.\n */\n metafields: SubscribableSignalLike;\n\n /**\n * A note left by the customer to the merchant, either in their cart or during checkout.\n *\n * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\n */\n note: SubscribableSignalLike;\n\n /**\n * The method used to query the Storefront GraphQL API with a prefetched token.\n *\n */\n query: >(\n query: string,\n options?: {variables?: Variables; version?: StorefrontApiVersion},\n ) => Promise<{data?: Data; errors?: GraphQLError[]}>;\n\n /**\n * The payment options the buyer has currently selected. This updates as\n * the buyer changes their payment method. The array can contain multiple\n * entries when the buyer splits payment across methods (for example, a\n * gift card and a credit card).\n *\n * Each option exposes `handle` and `type` only. Provider names, logos,\n * fees, and installment terms aren't available.\n */\n selectedPaymentOptions: SubscribableSignalLike;\n\n /**\n * The session token providing a set of claims as a signed JSON Web Token (JWT).\n *\n * The token has a TTL of five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Learn more about [session tokens](/docs/apps/build/authentication-authorization/session-tokens).\n */\n sessionToken: SessionToken;\n\n /**\n * The settings matching the settings definition written in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates in real time as a merchant fills in the settings.\n */\n settings: SubscribableSignalLike;\n\n /**\n * The proposed customer shipping address. During the information step, the address\n * updates when the field is committed (on change) rather than every keystroke.\n * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n shippingAddress?: SubscribableSignalLike;\n\n /**\n * The proposed customer billing address. The address updates when the field is\n * committed (on change) rather than every keystroke. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided yet.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n billingAddress?: SubscribableSignalLike;\n\n /**\n * The store where the checkout is taking place, including the shop name,\n * storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.\n */\n shop: Shop;\n\n /**\n * Key-value storage that persists across page loads within the current checkout\n * session. Data is shared across all activated targets associated with\n * this extension.\n *\n * > Caution: Data persistence isn't guaranteed and storage is cleared when the\n * buyer starts a new checkout.\n */\n storage: Storage;\n\n /**\n * The renderer version being used for the extension.\n *\n * @example '2025-10'\n */\n version: Version;\n\n /**\n * Customer privacy consent settings and a flag denoting if consent has previously been collected.\n */\n customerPrivacy: SubscribableSignalLike;\n\n /**\n * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`collect_buyer_consent` capability](/docs/apps/build/customer-accounts/capabilities#collect-buyer-consent) to be set to `true`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyTrackingConsentChange: ApplyTrackingConsentChangeType;\n\n /**\n * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" }, "Analytics": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Analytics", - "description": "", + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "publish", "value": "(name: string, data: Record) => Promise", - "description": "Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing)." + "description": "Publishes a custom event to [Web Pixels](/docs/apps/marketing). Returns `true` when the event is successfully dispatched.\n\nThe Promise resolves to `true` when the event was dispatched. The boolean indicates dispatch confirmation only. It doesn't indicate whether any specific web pixel processed the event." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "visitor", "value": "(data: { email?: string; phone?: string; }) => Promise", - "description": "A method for capturing details about a visitor on the online store." + "description": "Submits buyer contact details for attribution and analytics purposes." } ], - "value": "export interface Analytics {\n /**\n * Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing).\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * A method for capturing details about a visitor on the online store.\n */\n visitor(data: {email?: string; phone?: string}): Promise;\n}" + "value": "export interface Analytics {\n /**\n * Publishes a custom event to [Web Pixels](/docs/apps/marketing).\n * Returns `true` when the event is successfully dispatched.\n *\n * The Promise resolves to `true` when the event was dispatched. The boolean\n * indicates dispatch confirmation only. It doesn't indicate whether any\n * specific web pixel processed the event.\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * Submits buyer contact details for attribution and analytics purposes.\n */\n visitor(data: {email?: string; phone?: string}): Promise;\n}" }, "VisitorResult": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -147606,10 +147606,10 @@ "syntaxKind": "PropertySignature", "name": "type", "value": "'error'", - "description": "Indicates that the visitor information is invalid and wasn't submitted. Examples are using the wrong data type or missing a required property." + "description": "Indicates that the visitor information is invalid and wasn't submitted. Common causes include using the wrong data type or omitting a required property." } ], - "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Examples are using the wrong data type or missing a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Common causes include using the wrong data type or omitting a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" }, "SubscribableSignalLike": { "filePath": "src/surfaces/checkout/shared.ts", @@ -147823,10 +147823,10 @@ "syntaxKind": "PropertySignature", "name": "value", "value": "string | null", - "description": "The new value to store in the metafield. Set to `null` to delete the metafield." + "description": "The new value to store in the metafield. Set to `null` to delete the metafield.\n\nConsent metafield values are strings, not booleans. Pass `null` to delete a tracking consent metafield." } ], - "value": "export interface TrackingConsentMetafieldChange {\n /**\n * The identifier for the tracking consent metafield to update.\n */\n key: string;\n /**\n * The new value to store in the metafield. Set to `null` to delete the metafield.\n */\n value: string | null;\n}" + "value": "export interface TrackingConsentMetafieldChange {\n /**\n * The identifier for the tracking consent metafield to update.\n */\n key: string;\n /**\n * The new value to store in the metafield. Set to `null` to delete the metafield.\n *\n * Consent metafield values are strings, not booleans. Pass `null` to delete\n * a tracking consent metafield.\n */\n value: string | null;\n}" }, "VisitorConsent": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -148040,7 +148040,7 @@ "syntaxKind": "PropertySignature", "name": "value", "value": "string", - "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.", + "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.\n\nAttribute values are always strings. To store structured data, serialize it to JSON and parse it when reading.", "examples": [ { "title": "Example", @@ -148055,7 +148055,7 @@ ] } ], - "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" + "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * Attribute values are always strings. To store structured data, serialize\n * it to JSON and parse it when reading.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" }, "PaymentOption": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -148406,7 +148406,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A globally-unique identifier for the customer in the format `gid://shopify/Customer/`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", + "description": "An identifier for the customer in the format `gid://shopify/Customer/`. This value is unique per shop.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", "examples": [ { "title": "Example", @@ -148459,7 +148459,7 @@ "isPrivate": true } ], - "value": "export interface Customer {\n /**\n * A globally-unique identifier for the customer in the format `gid://shopify/Customer/`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'gid://shopify/Customer/123'\n */\n id: string;\n /**\n * The email address associated with the customer's account. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email?: string;\n /**\n * The phone number associated with the customer's account. The value is `undefined` if no phone number is on file or the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone?: string;\n /**\n * The customer's full name, typically a combination of first and last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n fullName?: string;\n /**\n * The customer's first name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n firstName?: string;\n /**\n * The customer's last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n lastName?: string;\n /**\n * The customer's profile image, such as a Gravatar avatar. Use this to personalize the extension UI for the logged-in buyer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n image: ImageDetails;\n /**\n * Whether the customer has opted in to receiving marketing communications from the merchant, such as email campaigns and promotional offers.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * > Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n *\n * @deprecated Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n */\n acceptsMarketing: boolean;\n /**\n * Whether the customer has opted in to email marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsEmailMarketing: boolean;\n /**\n * Whether the customer has opted in to SMS marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsSmsMarketing: boolean;\n /**\n * The store credit accounts owned by this customer that can be used as payment during checkout. Each account has a balance representing available store credit.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @private\n */\n storeCreditAccounts: StoreCreditAccount[];\n /**\n * The number of orders the customer has previously placed with this shop.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n ordersCount: number;\n}" + "value": "export interface Customer {\n /**\n * An identifier for the customer in the format `gid://shopify/Customer/`. This value is unique per shop.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'gid://shopify/Customer/123'\n */\n id: string;\n /**\n * The email address associated with the customer's account. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email?: string;\n /**\n * The phone number associated with the customer's account. The value is `undefined` if no phone number is on file or the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone?: string;\n /**\n * The customer's full name, typically a combination of first and last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n fullName?: string;\n /**\n * The customer's first name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n firstName?: string;\n /**\n * The customer's last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n lastName?: string;\n /**\n * The customer's profile image, such as a Gravatar avatar. Use this to personalize the extension UI for the logged-in buyer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n image: ImageDetails;\n /**\n * Whether the customer has opted in to receiving marketing communications from the merchant, such as email campaigns and promotional offers.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * > Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n *\n * @deprecated Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n */\n acceptsMarketing: boolean;\n /**\n * Whether the customer has opted in to email marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsEmailMarketing: boolean;\n /**\n * Whether the customer has opted in to SMS marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsSmsMarketing: boolean;\n /**\n * The store credit accounts owned by this customer that can be used as payment during checkout. Each account has a balance representing available store credit.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @private\n */\n storeCreditAccounts: StoreCreditAccount[];\n /**\n * The number of orders the customer has previously placed with this shop.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n ordersCount: number;\n}" }, "ImageDetails": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -148741,11 +148741,11 @@ "syntaxKind": "MethodSignature", "name": "perform", "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", + "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.\n\nRuns after all intercept results are collected. Use it for local state updates such as setting an error flag. By the time it runs, the navigation decision is final, so blocking logic belongs in the intercept handler itself, not here.", "isOptional": true } ], - "value": "interface InterceptorRequestAllow {\n /**\n * Indicates that the interceptor allows the buyer's journey to continue.\n */\n behavior: 'allow';\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" + "value": "interface InterceptorRequestAllow {\n /**\n * Indicates that the interceptor allows the buyer's journey to continue.\n */\n behavior: 'allow';\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n *\n * Runs after all intercept results are collected. Use it for local state\n * updates such as setting an error flag. By the time it runs, the navigation\n * decision is final, so blocking logic belongs in the intercept handler\n * itself, not here.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" }, "InterceptorResult": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -148809,7 +148809,7 @@ "syntaxKind": "MethodSignature", "name": "perform", "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", + "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.\n\nRuns after all intercept results are collected. Use it for local state updates such as setting an error flag. By the time it runs, the navigation decision is final, so blocking logic belongs in the intercept handler itself, not here.", "isOptional": true }, { @@ -148820,7 +148820,7 @@ "description": "The reason for blocking the interceptor request. This value isn't presented to the buyer, so it doesn't need to be localized. The value is used only for Shopify's own internal debugging and metrics." } ], - "value": "interface InterceptorRequestBlock {\n /**\n * Indicates that the interceptor blocks the buyer's journey from continuing.\n */\n behavior: 'block';\n\n /**\n * The reason for blocking the interceptor request. This value isn't presented to\n * the buyer, so it doesn't need to be localized. The value is used only for Shopify's\n * own internal debugging and metrics.\n */\n reason: string;\n\n /**\n * Used to pass errors to the checkout UI, outside your extension's UI boundaries.\n */\n errors?: ValidationError[];\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" + "value": "interface InterceptorRequestBlock {\n /**\n * Indicates that the interceptor blocks the buyer's journey from continuing.\n */\n behavior: 'block';\n\n /**\n * The reason for blocking the interceptor request. This value isn't presented to\n * the buyer, so it doesn't need to be localized. The value is used only for Shopify's\n * own internal debugging and metrics.\n */\n reason: string;\n\n /**\n * Used to pass errors to the checkout UI, outside your extension's UI boundaries.\n */\n errors?: ValidationError[];\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n *\n * Runs after all intercept results are collected. Use it for local state\n * updates such as setting an error flag. By the time it runs, the navigation\n * decision is final, so blocking logic belongs in the intercept handler\n * itself, not here.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" }, "ValidationError": { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -149041,17 +149041,17 @@ "syntaxKind": "PropertySignature", "name": "totalShippingAmount", "value": "SubscribableSignalLike", - "description": "The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step." + "description": "The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step.\n\n`undefined` until the buyer selects a shipping method (typically after the information step)." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "totalTaxAmount", "value": "SubscribableSignalLike", - "description": "The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet." + "description": "The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet.\n\n`undefined` when taxes haven't been calculated or aren't available for the buyer's region." } ], - "value": "export interface CartCost {\n /**\n * The sum of all line item prices at the current step of checkout, before shipping and taxes are applied. Use this value to display the base cost of the items the buyer purchased.\n */\n subtotalAmount: SubscribableSignalLike;\n\n /**\n * The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step.\n */\n totalShippingAmount: SubscribableSignalLike;\n\n /**\n * The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet.\n */\n totalTaxAmount: SubscribableSignalLike;\n\n /**\n * The minimum total at the current step of checkout. Costs not yet calculated, such as shipping on the information step, aren't included. Gift cards and store credits are excluded from this total.\n */\n totalAmount: SubscribableSignalLike;\n}" + "value": "export interface CartCost {\n /**\n * The sum of all line item prices at the current step of checkout, before shipping and taxes are applied. Use this value to display the base cost of the items the buyer purchased.\n */\n subtotalAmount: SubscribableSignalLike;\n\n /**\n * The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step.\n *\n * `undefined` until the buyer selects a shipping method (typically after the\n * information step).\n */\n totalShippingAmount: SubscribableSignalLike;\n\n /**\n * The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet.\n *\n * `undefined` when taxes haven't been calculated or aren't available for the\n * buyer's region.\n */\n totalTaxAmount: SubscribableSignalLike;\n\n /**\n * The minimum total at the current step of checkout. Costs not yet calculated, such as shipping on the information step, aren't included. Gift cards and store credits are excluded from this total.\n */\n totalAmount: SubscribableSignalLike;\n}" }, "CustomerPrivacy": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -149138,31 +149138,31 @@ "syntaxKind": "PropertySignature", "name": "analytics", "value": "boolean", - "description": "Whether analytics data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Analytics data includes how the shop was used and what interactions occurred." + "description": "Whether analytics data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Analytics data includes how the shop was used and what interactions occurred.\n\nWhether analytics data can be collected right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.analytics`, before calling `shopify.analytics.publish()`." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "marketing", "value": "boolean", - "description": "Whether marketing data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Marketing data includes attribution and targeted advertising preferences." + "description": "Whether marketing data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Marketing data includes attribution and targeted advertising preferences.\n\nWhether marketing data can be collected right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.marketing`, before performing marketing-related data collection." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "preferences", "value": "boolean", - "description": "Whether preference data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Preference data includes language, currency, and sizing choices." + "description": "Whether preference data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Preference data includes language, currency, and sizing choices.\n\nWhether preference data can be collected right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.preferences`, before storing or reading buyer preference data." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "saleOfData", "value": "boolean", - "description": "Whether data can be shared with third parties based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. This typically applies to behavioral advertising data." + "description": "Whether data can be shared with third parties based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. This typically applies to behavioral advertising data.\n\nWhether buyer data can be shared with or sold to third parties right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.saleOfData`, before sharing or selling buyer data with third parties." } ], - "value": "export interface AllowedProcessing {\n /**\n * Whether analytics data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Analytics\n * data includes how the shop was used and what interactions occurred.\n */\n analytics: boolean;\n /**\n * Whether marketing data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Marketing\n * data includes attribution and targeted advertising preferences.\n */\n marketing: boolean;\n /**\n * Whether preference data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Preference\n * data includes language, currency, and sizing choices.\n */\n preferences: boolean;\n /**\n * Whether data can be shared with third parties based on the visitor's\n * consent, the merchant's privacy configuration, and the visitor's region.\n * This typically applies to behavioral advertising data.\n */\n saleOfData: boolean;\n}" + "value": "export interface AllowedProcessing {\n /**\n * Whether analytics data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Analytics\n * data includes how the shop was used and what interactions occurred.\n *\n * Whether analytics data can be collected right now. Combines the buyer's\n * consent, the merchant's privacy configuration, and the buyer's region into\n * a single boolean. Check this flag, not `visitorConsent.analytics`, before\n * calling `shopify.analytics.publish()`.\n */\n analytics: boolean;\n /**\n * Whether marketing data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Marketing\n * data includes attribution and targeted advertising preferences.\n *\n * Whether marketing data can be collected right now. Combines the buyer's\n * consent, the merchant's privacy configuration, and the buyer's region into\n * a single boolean. Check this flag, not `visitorConsent.marketing`, before\n * performing marketing-related data collection.\n */\n marketing: boolean;\n /**\n * Whether preference data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Preference\n * data includes language, currency, and sizing choices.\n *\n * Whether preference data can be collected right now. Combines the buyer's\n * consent, the merchant's privacy configuration, and the buyer's region into\n * a single boolean. Check this flag, not `visitorConsent.preferences`,\n * before storing or reading buyer preference data.\n */\n preferences: boolean;\n /**\n * Whether data can be shared with third parties based on the visitor's\n * consent, the merchant's privacy configuration, and the visitor's region.\n * This typically applies to behavioral advertising data.\n *\n * Whether buyer data can be shared with or sold to third parties right now.\n * Combines the buyer's consent, the merchant's privacy configuration, and\n * the buyer's region into a single boolean. Check this flag, not\n * `visitorConsent.saleOfData`, before sharing or selling buyer data with\n * third parties.\n */\n saleOfData: boolean;\n}" }, "TrackingConsentMetafield": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -149854,7 +149854,7 @@ "Extension": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Extension", - "description": "The meta information about an extension target.", + "description": "Metadata about the running extension, including its API version, target, capabilities, and editor context. Use this to read configuration details or conditionally render content based on where the extension is running.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -149880,7 +149880,7 @@ "syntaxKind": "PropertySignature", "name": "capabilities", "value": "SubscribableSignalLike", - "description": "The allowed capabilities of the extension, defined in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n\n* [`api_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#api-access): the extension can access the Storefront API.\n\n* [`network_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access): the extension can make external network calls.\n\n* [`block_progress`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n\n* [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n\n* [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can register customer consent decisions that are honored on Shopify-managed services.\n\n* [`iframe.sources`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#iframe): the extension can embed an external URL in an iframe." + "description": "The allowed capabilities of the extension, defined in your [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -149928,7 +149928,7 @@ "syntaxKind": "PropertySignature", "name": "version", "value": "string", - "description": "The published version of the running extension target.\n\nFor unpublished extensions, the value is `undefined`.", + "description": "The published version of the running extension target.\n\nFor unpublished extensions, the value is `undefined`.\n\nDon't use this property as a stable identifier in development environments. It becomes available only after the extension is published.", "isOptional": true, "examples": [ { @@ -149944,7 +149944,7 @@ ] } ], - "value": "export interface Extension {\n /**\n * The API version that was set in the extension config file.\n *\n * @example '2024-10', '2025-01', '2025-04', '2025-07', '2025-10'\n */\n apiVersion: ApiVersion;\n\n /**\n * The allowed capabilities of the extension, defined\n * in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n *\n * * [`api_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#api-access): the extension can access the Storefront API.\n *\n * * [`network_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access): the extension can make external network calls.\n *\n * * [`block_progress`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n *\n * * [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n *\n * * [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can register customer consent decisions that are honored on Shopify-managed services.\n *\n * * [`iframe.sources`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#iframe): the extension can embed an external URL in an iframe.\n */\n capabilities: SubscribableSignalLike;\n\n /**\n * Information about the editor where the extension is being rendered.\n *\n * If the value is undefined, then the extension isn't running in an editor.\n */\n editor?: Editor;\n\n /**\n * A Boolean to show whether your extension is currently rendered to the screen.\n *\n * Shopify might render your extension before it's visible in the UI,\n * typically to pre-render extensions that appear on a later step of the\n * checkout.\n *\n * Your extension might also continue to run after the customer has navigated away\n * from where it was rendered. The extension continues running so that\n * your extension is immediately available to render if the customer navigates back.\n */\n rendered: SubscribableSignalLike;\n\n /**\n * The URL to the script that started the extension target.\n */\n scriptUrl: string;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n */\n target: Target;\n\n /**\n * The published version of the running extension target.\n *\n * For unpublished extensions, the value is `undefined`.\n *\n * @example 3.0.10\n */\n version?: string;\n}" + "value": "export interface Extension {\n /**\n * The API version that was set in the extension config file.\n *\n * @example '2024-10', '2025-01', '2025-04', '2025-07', '2025-10'\n */\n apiVersion: ApiVersion;\n\n /**\n * The allowed capabilities of the extension, defined in your\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n */\n capabilities: SubscribableSignalLike;\n\n /**\n * Information about the editor where the extension is being rendered.\n *\n * If the value is undefined, then the extension isn't running in an editor.\n */\n editor?: Editor;\n\n /**\n * A Boolean to show whether your extension is currently rendered to the screen.\n *\n * Shopify might render your extension before it's visible in the UI,\n * typically to pre-render extensions that appear on a later step of the\n * checkout.\n *\n * Your extension might also continue to run after the customer has navigated away\n * from where it was rendered. The extension continues running so that\n * your extension is immediately available to render if the customer navigates back.\n */\n rendered: SubscribableSignalLike;\n\n /**\n * The URL to the script that started the extension target.\n */\n scriptUrl: string;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n */\n target: Target;\n\n /**\n * The published version of the running extension target.\n *\n * For unpublished extensions, the value is `undefined`.\n *\n * Don't use this property as a stable identifier in development environments.\n * It becomes available only after the extension is published.\n *\n * @example 3.0.10\n */\n version?: string;\n}" }, "ApiVersion": { "filePath": "src/shared.ts", @@ -149963,7 +149963,7 @@ "Editor": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Editor", - "description": "", + "description": "Information about the editor environment when an extension is rendered inside the checkout editor. The value is `undefined` when the extension is not rendering in an editor.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -149978,7 +149978,7 @@ "I18n": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18n", - "description": "", + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use the I18n API alongside the Localization API to build fully localized extensions.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -150014,7 +150014,7 @@ "I18nTranslate": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18nTranslate", - "description": "This returns a translated string matching a key in a locale file.", + "description": "Translates a key from your extension's locale files into a localized string. Supports interpolation with placeholder replacements and pluralization via the special `count` option.", "members": [], "value": "export interface I18nTranslate {\n (\n key: string,\n options?: Record,\n ): ReplacementType extends string | number\n ? string\n : (string | ReplacementType)[];\n}" }, @@ -150578,14 +150578,14 @@ "Localization": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Localization", - "description": "", + "description": "The buyer's language, country, currency, and timezone context. Use this to adapt your extension to the buyer's region and display localized content.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "country", "value": "SubscribableSignalLike", - "description": "The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown." + "description": "The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n\nDerived from the buyer's shipping address. Returns `undefined` until the buyer enters a shipping address." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -150613,18 +150613,18 @@ "syntaxKind": "PropertySignature", "name": "market", "value": "SubscribableSignalLike", - "description": "The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n\n> Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.", - "deprecationMessage": "Deprecated as of version `2025-04`" + "description": "The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. The market context updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.", + "deprecationMessage": "Merchants now manage which extensions load for each\nmarket, so extensions no longer need to check this value." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "timezone", "value": "SubscribableSignalLike", - "description": "The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time." + "description": "The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time." } ], - "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n *\n * > Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" + "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n *\n * Derived from the buyer's shipping address. Returns `undefined` until the\n * buyer enters a shipping address.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout,\n * carried over from the cart context. Markets group countries and\n * regions with shared pricing, languages, and domains. The market\n * context updates when the buyer changes the country of their\n * shipping address. The value is `undefined` if the market is unknown.\n *\n * @deprecated Merchants now manage which extensions load for each\n * market, so extensions no longer need to check this value.\n */\n market: SubscribableSignalLike;\n}" }, "Country": { "filePath": "src/shared.ts", @@ -150825,7 +150825,7 @@ "SessionToken": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SessionToken", - "description": "", + "description": "Authenticates requests between your extension and your app backend. Use session tokens to verify the identity of the buyer and the shop context when making server-side API calls. The token is a signed JWT that contains claims such as the customer ID, shop domain, and expiration.\n\nThe `sub` claim in the decoded token is present only when the buyer is logged in and the app has permission to read customer accounts. Absent for anonymous buyers.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -151084,7 +151084,7 @@ "Shop": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Shop", - "description": "", + "description": "Metadata about the merchant's store, including its name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -151124,30 +151124,30 @@ "syntaxKind": "PropertySignature", "name": "storefrontUrl", "value": "string", - "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n\n> Caution: > As of version `2024-04` this value no longer has a trailing slash.", + "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.", "isOptional": true } ], - "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n *\n * > Caution:\n * > As of version `2024-04` this value no longer has a trailing slash.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom domain.\n */\n myshopifyDomain: string;\n}" + "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom domain.\n */\n myshopifyDomain: string;\n}" }, "Storage": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Storage", - "description": "A key-value storage object for the extension.\n\nStored data is available only to this specific extension and any of its instances.\n\nThe storage backend is implemented with `localStorage` and should persist across the buyer's checkout session. However, data persistence isn't guaranteed.", + "description": "Key-value storage for a specific extension. Use storage to save preferences or cached data that should survive page reloads without requiring a backend call. Stored data is only available to this specific extension. The storage backend is implemented with `localStorage` and data persistence isn't guaranteed.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "delete", "value": "(key: string) => Promise", - "description": "Delete stored data by key." + "description": "Deletes a previously stored value by key." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "read", "value": "(key: string) => Promise", - "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original primitive.\n\nReturns `null` if no stored data exists." + "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original type.\n\nReturns the stored value for the given key, or `null` when no value exists. Doesn't throw on a missing key." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -151157,7 +151157,7 @@ "description": "Write stored data for this key.\n\nThe data must be serializable to JSON." } ], - "value": "export interface Storage {\n /**\n * Read and return a stored value by key.\n *\n * The stored data is deserialized from JSON and returned as\n * its original primitive.\n *\n * Returns `null` if no stored data exists.\n */\n read(key: string): Promise;\n\n /**\n * Write stored data for this key.\n *\n * The data must be serializable to JSON.\n */\n write(key: string, data: any): Promise;\n\n /**\n * Delete stored data by key.\n */\n delete(key: string): Promise;\n}" + "value": "export interface Storage {\n /**\n * Read and return a stored value by key.\n *\n * The stored data is deserialized from JSON and returned as\n * its original type.\n *\n * Returns the stored value for the given key, or `null` when no value\n * exists. Doesn't throw on a missing key.\n */\n read(key: string): Promise;\n\n /**\n * Write stored data for this key.\n *\n * The data must be serializable to JSON.\n */\n write(key: string, data: any): Promise;\n\n /**\n * Deletes a previously stored value by key.\n */\n delete(key: string): Promise;\n}" }, "Version": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -151234,7 +151234,7 @@ "syntaxKind": "PropertySignature", "name": "isTargetSelected", "value": "SubscribableSignalLike", - "description": "Whether the buyer has selected the target shipping option. When `true`, the target option is the buyer's active choice. When `false`, the buyer has chosen a different shipping option." + "description": "Whether the buyer has selected the target shipping option. When `true`, the target option is the buyer's active choice. When `false`, the buyer has chosen a different shipping option.\n\nAvailable only on the corresponding item target. Shipping option item targets expose shipping option properties; pickup location item targets expose pickup location properties." }, { "filePath": "src/surfaces/checkout/api/shipping/shipping-option-item.ts", @@ -151248,10 +151248,10 @@ "syntaxKind": "PropertySignature", "name": "target", "value": "SubscribableSignalLike", - "description": "The shipping option that this extension is attached to. Use this to read the option's cost, carrier, delivery estimate, and other details." + "description": "The shipping option that this extension is attached to. Use this to read the option's cost, carrier, delivery estimate, and other details.\n\nAvailable only on the corresponding item target. Shipping option item targets expose shipping option properties; pickup location item targets expose pickup location properties." } ], - "value": "export interface ShippingOptionItemApi {\n /**\n * The shipping option that this extension is attached to. Use this to read the option's cost, carrier, delivery estimate, and other details.\n */\n target: SubscribableSignalLike;\n\n /**\n * Whether the buyer has selected the target shipping option. When `true`, the target option is the buyer's active choice. When `false`, the buyer has chosen a different shipping option.\n */\n isTargetSelected: SubscribableSignalLike;\n\n /**\n * The render mode of this shipping option, indicating how the extension is displayed in the checkout UI.\n */\n renderMode: ShippingOptionItemRenderMode;\n}" + "value": "export interface ShippingOptionItemApi {\n /**\n * The shipping option that this extension is attached to. Use this to read the option's cost, carrier, delivery estimate, and other details.\n *\n * Available only on the corresponding item target. Shipping option item\n * targets expose shipping option properties; pickup location item targets\n * expose pickup location properties.\n */\n target: SubscribableSignalLike;\n\n /**\n * Whether the buyer has selected the target shipping option. When `true`, the target option is the buyer's active choice. When `false`, the buyer has chosen a different shipping option.\n *\n * Available only on the corresponding item target. Shipping option item\n * targets expose shipping option properties; pickup location item targets\n * expose pickup location properties.\n */\n isTargetSelected: SubscribableSignalLike;\n\n /**\n * The render mode of this shipping option, indicating how the extension is displayed in the checkout UI.\n */\n renderMode: ShippingOptionItemRenderMode;\n}" }, "SubscribableSignalLike": { "filePath": "src/surfaces/checkout/shared.ts", @@ -151560,7 +151560,7 @@ "syntaxKind": "MethodSignature", "name": "applyAttributeChange", "value": "(change: AttributeChange) => Promise", - "description": "Updates or removes an attribute on the cart and checkout. On success, the [`attributes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/attributes#standardapi-propertydetail-attributes) property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.", + "description": "Updates or removes an attribute on the cart and checkout. On success, the [`attributes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/attributes#properties-propertydetail-attributes) property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.", "deprecationMessage": "Use cart metafields instead." }, { @@ -151568,42 +151568,42 @@ "syntaxKind": "MethodSignature", "name": "applyCartLinesChange", "value": "(change: CartLineChange) => Promise", - "description": "Adds, removes, or updates line items in the cart. The returned promise resolves when the change has been applied by the server, and the [`lines`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-lines#standardapi-propertydetail-lines) property updates with the new state.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Adds, removes, or updates line items in the cart. The returned promise resolves when the change has been applied by the server, and the [`lines`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-lines#properties-propertydetail-lines) property updates with the new state.\n\nAccepts a single change per call. To make multiple changes, call this method separately for each one.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyDiscountCodeChange", "value": "(change: DiscountCodeChange) => Promise", - "description": "Adds or removes a discount code on the checkout. The returned promise resolves when the change has been applied by the server, and the [`discountCodes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/discounts#standardapi-propertydetail-discountcodes) property updates with the new state.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves discount codes through a network call.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Adds or removes a discount code on the checkout. The returned promise resolves when the change has been applied by the server, and the [`discountCodes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/discounts#properties-propertydetail-discountcodes) property updates with the new state.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves discount codes through a network call.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyGiftCardChange", "value": "(change: GiftCardChange) => Promise", - "description": "Adds or removes a gift card from the checkout. The returned promise resolves when the change has been applied by the server, and the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/gift-cards#standardapi-propertydetail-appliedgiftcards) property updates with the new state.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves gift card codes through a network call.\n\n> Note: This method returns an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Adds or removes a gift card from the checkout. The returned promise resolves when the change has been applied by the server, and the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/gift-cards#properties-propertydetail-appliedgiftcards) property updates with the new state.\n\nUnlike other write operations, gift card changes aren't gated by a cart instruction flag.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves gift card codes through a network call.\n\n> Note: This method returns an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyMetafieldChange", "value": "(change: MetafieldChange) => Promise", - "description": "Creates, updates, or removes a cart metafield on the checkout. On success, the [`metafields`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/metafields#standardapi-propertydetail-metafields) property updates to reflect the change.\n\nCart metafields are copied to order metafields at order creation time if there's a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n\n> Caution: `MetafieldRemoveChange` and `MetafieldUpdateChange` are deprecated. Use cart metafields with `MetafieldRemoveCartChange` and `MetafieldUpdateCartChange` instead. If `MetafieldUpdateChange` writes a metafield with the same namespace and key as a cart metafield that's configured to copy, the cart metafield won't be copied.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Creates, updates, or removes a cart metafield on the checkout. On success, the [`metafields`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/metafields#properties-propertydetail-metafields) property updates to reflect the change.\n\nCart metafields are copied to order metafields at order creation time if there's a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n\n> Caution: `MetafieldRemoveChange` and `MetafieldUpdateChange` are deprecated. Use cart metafields with `MetafieldRemoveCartChange` and `MetafieldUpdateCartChange` instead. If `MetafieldUpdateChange` writes a metafield with the same namespace and key as a cart metafield that's configured to copy, the cart metafield won't be copied.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyNoteChange", "value": "(change: NoteChange) => Promise", - "description": "Sets or removes the buyer's note on the checkout. On success, the [`note`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/note#standardapi-propertydetail-note) property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Sets or removes the buyer's note on the checkout. On success, the [`note`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/note#properties-propertydetail-note) property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyShippingAddressChange", "value": "(change: ShippingAddressUpdateChange) => Promise", - "description": "Updates the buyer's shipping address on the checkout. The provided fields are merged into the existing address without prompting the buyer. On success, the `shippingAddress` property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", + "description": "Updates the buyer's shipping address on the checkout. The provided fields are merged into the existing address without prompting the buyer. On success, the `shippingAddress` property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", "isOptional": true }, { @@ -151616,7 +151616,7 @@ "isPrivate": true } ], - "value": "export interface CheckoutApi {\n /**\n * Updates or removes an attribute on the cart and checkout. On success, the\n * [`attributes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/attributes#standardapi-propertydetail-attributes) property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * @deprecated Use cart metafields instead.\n */\n applyAttributeChange(change: AttributeChange): Promise;\n\n /**\n * Adds, removes, or updates line items in the cart. The returned promise resolves when the change has been applied by the server, and the [`lines`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-lines#standardapi-propertydetail-lines) property updates with the new state.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyCartLinesChange(change: CartLineChange): Promise;\n\n /**\n * Adds or removes a discount code on the checkout. The returned promise resolves when the change has been applied by the server, and the [`discountCodes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/discounts#standardapi-propertydetail-discountcodes) property updates with the new state.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves discount codes through a network call.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyDiscountCodeChange(\n change: DiscountCodeChange,\n ): Promise;\n\n /**\n * Adds or removes a gift card from the checkout. The returned promise resolves when the change has been applied by the server, and the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/gift-cards#standardapi-propertydetail-appliedgiftcards) property updates with the new state.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves gift card codes through a network call.\n *\n * > Note: This method returns an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyGiftCardChange(change: GiftCardChange): Promise;\n\n /**\n * Creates, updates, or removes a cart metafield on the checkout. On success, the\n * [`metafields`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/metafields#standardapi-propertydetail-metafields) property updates to reflect the change.\n *\n * Cart metafields are copied to order metafields at order creation time if there's a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n *\n * > Caution: `MetafieldRemoveChange` and `MetafieldUpdateChange` are deprecated. Use cart metafields with `MetafieldRemoveCartChange` and `MetafieldUpdateCartChange` instead. If `MetafieldUpdateChange` writes a metafield with the same namespace and key as a cart metafield that's configured to copy, the cart metafield won't be copied.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyMetafieldChange(change: MetafieldChange): Promise;\n\n /**\n * Sets or removes the buyer's note on the checkout. On success, the\n * [`note`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/note#standardapi-propertydetail-note)\n * property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyNoteChange(change: NoteChange): Promise;\n\n /**\n * @private\n */\n experimentalIsShopAppStyle?: boolean;\n\n /**\n * Updates the buyer's shipping address on the checkout. The provided fields\n * are merged into the existing address without prompting the buyer. On success,\n * the `shippingAddress` property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyShippingAddressChange?(\n change: ShippingAddressChange,\n ): Promise;\n}" + "value": "export interface CheckoutApi {\n /**\n * Updates or removes an attribute on the cart and checkout. On success, the\n * [`attributes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/attributes#properties-propertydetail-attributes) property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * @deprecated Use cart metafields instead.\n */\n applyAttributeChange(change: AttributeChange): Promise;\n\n /**\n * Adds, removes, or updates line items in the cart. The returned promise resolves when the change has been applied by the server, and the [`lines`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-lines#properties-propertydetail-lines) property updates with the new state.\n *\n * Accepts a single change per call. To make multiple changes, call this\n * method separately for each one.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyCartLinesChange(change: CartLineChange): Promise;\n\n /**\n * Adds or removes a discount code on the checkout. The returned promise resolves when the change has been applied by the server, and the [`discountCodes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/discounts#properties-propertydetail-discountcodes) property updates with the new state.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves discount codes through a network call.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyDiscountCodeChange(\n change: DiscountCodeChange,\n ): Promise;\n\n /**\n * Adds or removes a gift card from the checkout. The returned promise resolves when the change has been applied by the server, and the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/gift-cards#properties-propertydetail-appliedgiftcards) property updates with the new state.\n *\n * Unlike other write operations, gift card changes aren't gated by a cart\n * instruction flag.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves gift card codes through a network call.\n *\n * > Note: This method returns an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyGiftCardChange(change: GiftCardChange): Promise;\n\n /**\n * Creates, updates, or removes a cart metafield on the checkout. On success, the\n * [`metafields`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/metafields#properties-propertydetail-metafields) property updates to reflect the change.\n *\n * Cart metafields are copied to order metafields at order creation time if there's a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n *\n * > Caution: `MetafieldRemoveChange` and `MetafieldUpdateChange` are deprecated. Use cart metafields with `MetafieldRemoveCartChange` and `MetafieldUpdateCartChange` instead. If `MetafieldUpdateChange` writes a metafield with the same namespace and key as a cart metafield that's configured to copy, the cart metafield won't be copied.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyMetafieldChange(change: MetafieldChange): Promise;\n\n /**\n * Sets or removes the buyer's note on the checkout. On success, the\n * [`note`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/note#properties-propertydetail-note)\n * property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyNoteChange(change: NoteChange): Promise;\n\n /**\n * @private\n */\n experimentalIsShopAppStyle?: boolean;\n\n /**\n * Updates the buyer's shipping address on the checkout. The provided fields\n * are merged into the existing address without prompting the buyer. On success,\n * the `shippingAddress` property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyShippingAddressChange?(\n change: ShippingAddressChange,\n ): Promise;\n}" }, "AttributeChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -151683,7 +151683,7 @@ "syntaxKind": "PropertySignature", "name": "value", "value": "string", - "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.", + "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.\n\nAttribute values are always strings. To store structured data, serialize it to JSON and parse it when reading.", "examples": [ { "title": "Example", @@ -151698,7 +151698,7 @@ ] } ], - "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" + "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * Attribute values are always strings. To store structured data, serialize\n * it to JSON and parse it when reading.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" }, "AttributeRemoveChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -152551,7 +152551,7 @@ "syntaxKind": "PropertySignature", "name": "message", "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer." + "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer.\n\nRender your own localized error text rather than displaying this message to the buyer." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -152561,7 +152561,7 @@ "description": "Indicates that the line item wasn't changed successfully. Refer to the `message` property for details about the error." } ], - "value": "export interface CartLineChangeResultError {\n /**\n * Indicates that the line item wasn't changed successfully. Refer to the `message` property for details about the error.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface CartLineChangeResultError {\n /**\n * Indicates that the line item wasn't changed successfully. Refer to the `message` property for details about the error.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n *\n * Render your own localized error text rather than displaying this message\n * to the buyer.\n */\n message: string;\n}" }, "DiscountCodeChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -152741,7 +152741,7 @@ "syntaxKind": "PropertySignature", "name": "message", "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer." + "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer.\n\nRender your own localized error text rather than displaying this message to the buyer." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -152751,7 +152751,7 @@ "description": "Indicates that the gift card change couldn't be applied. Check the `message` property for details." } ], - "value": "export interface GiftCardChangeResultError {\n /**\n * Indicates that the gift card change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface GiftCardChangeResultError {\n /**\n * Indicates that the gift card change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n *\n * Render your own localized error text rather than displaying this message\n * to the buyer.\n */\n message: string;\n}" }, "MetafieldChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -153012,7 +153012,7 @@ "syntaxKind": "PropertySignature", "name": "message", "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer." + "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer.\n\nRender your own localized error text rather than displaying this message to the buyer." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -153022,7 +153022,7 @@ "description": "Indicates that the metafield change couldn't be applied. Check the `message` property for details." } ], - "value": "export interface MetafieldChangeResultError {\n /**\n * Indicates that the metafield change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface MetafieldChangeResultError {\n /**\n * Indicates that the metafield change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n *\n * Render your own localized error text rather than displaying this message\n * to the buyer.\n */\n message: string;\n}" }, "NoteChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -153100,7 +153100,7 @@ "syntaxKind": "PropertySignature", "name": "message", "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer." + "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer.\n\nRender your own localized error text rather than displaying this message to the buyer." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -153110,7 +153110,7 @@ "description": "Indicates that the note change couldn't be applied. Check the `message` property for details." } ], - "value": "export interface NoteChangeResultError {\n /**\n * Indicates that the note change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface NoteChangeResultError {\n /**\n * Indicates that the note change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n *\n * Render your own localized error text rather than displaying this message\n * to the buyer.\n */\n message: string;\n}" }, "ShippingAddressUpdateChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -153696,7 +153696,7 @@ "syntaxKind": "PropertySignature", "name": "analytics", "value": "Analytics", - "description": "The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event." + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -153710,7 +153710,7 @@ "syntaxKind": "PropertySignature", "name": "applyTrackingConsentChange", "value": "ApplyTrackingConsentChangeType", - "description": "Enables setting and updating customer privacy consent settings and tracking consent metafields.\n\n> Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent) to be set to `true`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." + "description": "Enables setting and updating customer privacy consent settings and tracking consent metafields.\n\n> Note: Requires the [`collect_buyer_consent` capability](/docs/apps/build/customer-accounts/capabilities#collect-buyer-consent) to be set to `true`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -153731,7 +153731,7 @@ "syntaxKind": "PropertySignature", "name": "availablePaymentOptions", "value": "SubscribableSignalLike", - "description": "All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region." + "description": "All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n\nThe set of payment options can change when the buyer updates their address or cart, so subscribe to changes rather than reading once during initialization. Each option exposes `handle` and `type` only. Provider names, logos, fees, and installment terms aren't available." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -153768,7 +153768,7 @@ "syntaxKind": "PropertySignature", "name": "checkoutToken", "value": "SubscribableSignalLike", - "description": "A stable ID that represents the current checkout.\n\nThe value is `undefined` when the checkout hasn't been created on the server yet.\n\nUse this to correlate checkout sessions across your extension, web pixels, and backend systems.\n\nThis matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data) and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object)." + "description": "A stable ID that represents the current checkout.\n\nThe value is `undefined` when the checkout hasn't been created on the server yet.\n\nUse this to correlate checkout sessions across your extension, web pixels, and backend systems.\n\nThis matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data) and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n\nCan be `undefined`. Handle the `undefined` state before using the value." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -153789,7 +153789,7 @@ "syntaxKind": "PropertySignature", "name": "deliveryGroups", "value": "SubscribableSignalLike", - "description": "The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items." + "description": "The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n\nEmpty until the buyer enters enough address information for Shopify to calculate shipping rates." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -153810,7 +153810,7 @@ "syntaxKind": "PropertySignature", "name": "extension", "value": "Extension", - "description": "The meta information about the extension." + "description": "Metadata about the running extension, including the current target, API version, capabilities, and editor context. Use this to conditionally render content based on where the extension is running." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -153818,7 +153818,7 @@ "name": "extensionPoint", "value": "Target", "description": "The identifier that specifies where in Shopify's UI your code is being injected. This is one of the targets you've included in your extension's configuration file.", - "deprecationMessage": "Deprecated as of version `2023-07`, use `extension.target` instead.", + "deprecationMessage": "Use `extension.target` instead.", "examples": [ { "title": "Example", @@ -153837,14 +153837,14 @@ "syntaxKind": "PropertySignature", "name": "i18n", "value": "I18n", - "description": "Utilities for translating content and formatting values according to the current [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) of the checkout.\n\nRefer to [`localization` examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples) for more information." + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use alongside [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) to build fully localized extensions." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "instructions", "value": "SubscribableSignalLike", - "description": "The cart instructions used to create the checkout and possibly limit extension capabilities.\n\nThese instructions should be checked before performing any actions that might be affected by them.\n\nFor example, if you intend to add a discount code via the `applyDiscountCodeChange` method, check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n\n> Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs aren't available. See the [update guide](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples) for more information." + "description": "The cart instructions used to create the checkout and possibly limit extension capabilities.\n\nThese instructions should be checked before performing any actions that might be affected by them.\n\nFor example, if you intend to add a discount code via the `applyDiscountCodeChange` method, check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n\n> Caution: Check cart instructions before calling select APIs, as > some may not be available. See the > [Cart Instructions API](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples) > for more information." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -153858,7 +153858,7 @@ "syntaxKind": "PropertySignature", "name": "localization", "value": "Localization", - "description": "The details about the location, language, and currency of the customer. For utilities to easily format and translate content based on these details, you can use the [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n) object instead." + "description": "The buyer's language, country, currency, and timezone context. For formatting and translation helpers, use the [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#properties-propertydetail-i18n) object instead." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -153888,21 +153888,21 @@ "syntaxKind": "PropertySignature", "name": "query", "value": ">(query: string, options?: { variables?: Variables; version?: StorefrontApiVersion; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>", - "description": "The method used to query the Storefront GraphQL API with a prefetched token.\n\nRefer to [Storefront API access examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/storefront-api) for more information." + "description": "The method used to query the Storefront GraphQL API with a prefetched token." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "selectedPaymentOptions", "value": "SubscribableSignalLike", - "description": "The payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card)." + "description": "The payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\n\nEach option exposes `handle` and `type` only. Provider names, logos, fees, and installment terms aren't available." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "sessionToken", "value": "SessionToken", - "description": "The session token providing a set of claims as a signed JSON Web Token (JWT).\n\nThe token has a TTL of five minutes.\n\nIf the previous token expires, this value reflects a new session token with a new signature and expiry.\n\nRefer to [session token examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/session-token) for more information." + "description": "The session token providing a set of claims as a signed JSON Web Token (JWT).\n\nThe token has a TTL of five minutes.\n\nIf the previous token expires, this value reflects a new session token with a new signature and expiry.\n\nLearn more about [session tokens](/docs/apps/build/authentication-authorization/session-tokens)." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -153924,14 +153924,14 @@ "syntaxKind": "PropertySignature", "name": "shop", "value": "Shop", - "description": "The shop where the checkout is taking place." + "description": "The store where the checkout is taking place, including the shop name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "storage", "value": "Storage", - "description": "The key-value storage for the extension.\n\nIt uses `localStorage` and should persist across the customer's current checkout session.\n\n> Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n\nData is shared across all activated extension targets of this extension. In versions 2023-07 and earlier, each activated extension target had its own storage." + "description": "Key-value storage that persists across page loads within the current checkout session. Data is shared across all activated targets associated with this extension.\n\n> Caution: Data persistence isn't guaranteed and storage is cleared when the buyer starts a new checkout." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -153953,29 +153953,29 @@ ] } ], - "value": "export interface StandardApi {\n /**\n * The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event.\n */\n analytics: Analytics;\n\n /**\n * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\n */\n appliedGiftCards: SubscribableSignalLike;\n\n /**\n * The cart instructions used to create the checkout and possibly limit extension capabilities.\n *\n * These instructions should be checked before performing any actions that might be affected by them.\n *\n * For example, if you intend to add a discount code via the `applyDiscountCodeChange` method,\n * check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n *\n * > Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs aren't available.\n * See the [update guide](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples) for more information.\n *\n */\n instructions: SubscribableSignalLike;\n\n /**\n * The metafields requested in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration)\n * file. These metafields are updated when there's a change in the merchandise items\n * being purchased by the customer.\n *\n * App owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` isn't supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n appMetafields: SubscribableSignalLike;\n\n /**\n * The custom key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n buyerIdentity?: BuyerIdentity;\n\n /**\n * Provides details on the buyer's progression through the checkout and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/buyer-journey#examples)\n * examples for more information.\n */\n buyerJourney: BuyerJourney;\n\n /**\n * Settings applied to the buyer's checkout.\n */\n checkoutSettings: SubscribableSignalLike;\n\n /**\n * A stable ID that represents the current checkout.\n *\n * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\n *\n * This matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data)\n * and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n */\n checkoutToken: SubscribableSignalLike;\n\n /**\n * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * The meta information about the extension.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n *\n * @deprecated Deprecated as of version `2023-07`, use `extension.target` instead.\n */\n extensionPoint: Target;\n\n /**\n * Utilities for translating content and formatting values according to the current\n * [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization)\n * of the checkout.\n *\n * Refer to [`localization` examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples)\n * for more information.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The details about the location, language, and currency of the customer. For utilities to easily\n * format and translate content based on these details, you can use the\n * [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n)\n * object instead.\n */\n localization: Localization;\n\n /**\n * The metafields that apply to the current checkout.\n *\n * Metafields are stored locally on the client and are applied to the order object after the checkout completes.\n *\n * These metafields are shared by all extensions running on checkout, and\n * persist for as long as the customer is working on this checkout.\n *\n * Once the order is created, you can query these metafields using the\n * [GraphQL Admin API](/docs/admin-api/graphql/reference/orders/order#metafield-2021-01)\n *\n * > Caution:\n * `metafields` is deprecated. Use `appMetafields` with cart metafields instead.\n *\n * @deprecated Use `appMetafields` with cart metafields instead.\n */\n metafields: SubscribableSignalLike;\n\n /**\n * A note left by the customer to the merchant, either in their cart or during checkout.\n *\n * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\n */\n note: SubscribableSignalLike;\n\n /**\n * The method used to query the Storefront GraphQL API with a prefetched token.\n *\n * Refer to [Storefront API access examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/storefront-api) for more information.\n */\n query: >(\n query: string,\n options?: {variables?: Variables; version?: StorefrontApiVersion},\n ) => Promise<{data?: Data; errors?: GraphQLError[]}>;\n\n /**\n * The payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\n */\n selectedPaymentOptions: SubscribableSignalLike;\n\n /**\n * The session token providing a set of claims as a signed JSON Web Token (JWT).\n *\n * The token has a TTL of five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/session-token) for more information.\n */\n sessionToken: SessionToken;\n\n /**\n * The settings matching the settings definition written in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates in real time as a merchant fills in the settings.\n */\n settings: SubscribableSignalLike;\n\n /**\n * The proposed customer shipping address. During the information step, the address\n * updates when the field is committed (on change) rather than every keystroke.\n * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n shippingAddress?: SubscribableSignalLike;\n\n /**\n * The proposed customer billing address. The address updates when the field is\n * committed (on change) rather than every keystroke. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided yet.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n billingAddress?: SubscribableSignalLike;\n\n /** The shop where the checkout is taking place. */\n shop: Shop;\n\n /**\n * The key-value storage for the extension.\n *\n * It uses `localStorage` and should persist across the customer's current checkout session.\n *\n * > Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n *\n * Data is shared across all activated extension targets of this extension. In versions 2023-07 and earlier,\n * each activated extension target had its own storage.\n */\n storage: Storage;\n\n /**\n * The renderer version being used for the extension.\n *\n * @example '2025-10'\n */\n version: Version;\n\n /**\n * Customer privacy consent settings and a flag denoting if consent has previously been collected.\n */\n customerPrivacy: SubscribableSignalLike;\n\n /**\n * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent) to be set to `true`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyTrackingConsentChange: ApplyTrackingConsentChangeType;\n\n /**\n * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" + "value": "export interface StandardApi {\n /**\n * Tracks custom events and sends visitor information to\n * [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events\n * and `visitor()` to submit buyer contact details.\n */\n analytics: Analytics;\n\n /**\n * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\n */\n appliedGiftCards: SubscribableSignalLike;\n\n /**\n * The cart instructions used to create the checkout and possibly limit extension capabilities.\n *\n * These instructions should be checked before performing any actions that might be affected by them.\n *\n * For example, if you intend to add a discount code via the `applyDiscountCodeChange` method,\n * check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n *\n * > Caution: Check cart instructions before calling select APIs, as\n * > some may not be available. See the\n * > [Cart Instructions API](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples)\n * > for more information.\n *\n */\n instructions: SubscribableSignalLike;\n\n /**\n * The metafields requested in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration)\n * file. These metafields are updated when there's a change in the merchandise items\n * being purchased by the customer.\n *\n * App owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` isn't supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n appMetafields: SubscribableSignalLike;\n\n /**\n * The custom key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as\n * credit cards, wallets, and local payment methods. The list depends on\n * the shop's payment configuration and the buyer's region.\n *\n * The set of payment options can change when the buyer updates their\n * address or cart, so subscribe to changes rather than reading once\n * during initialization. Each option exposes `handle` and `type` only.\n * Provider names, logos, fees, and installment terms aren't available.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n buyerIdentity?: BuyerIdentity;\n\n /**\n * Provides details on the buyer's progression through the checkout and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/buyer-journey#examples)\n * examples for more information.\n */\n buyerJourney: BuyerJourney;\n\n /**\n * Settings applied to the buyer's checkout.\n */\n checkoutSettings: SubscribableSignalLike;\n\n /**\n * A stable ID that represents the current checkout.\n *\n * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\n *\n * This matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data)\n * and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n *\n * Can be `undefined`. Handle the `undefined` state before using the value.\n */\n checkoutToken: SubscribableSignalLike;\n\n /**\n * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n *\n * Empty until the buyer enters enough address information for Shopify to\n * calculate shipping rates.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * Metadata about the running extension, including the current target, API version,\n * capabilities, and editor context. Use this to conditionally render content\n * based on where the extension is running.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n *\n * @deprecated Use `extension.target` instead.\n */\n extensionPoint: Target;\n\n /**\n * Utilities for translating strings, formatting currencies, numbers, and dates\n * according to the buyer's locale. Use alongside\n * [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization)\n * to build fully localized extensions.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The buyer's language, country, currency, and timezone context. For\n * formatting and translation helpers, use the\n * [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#properties-propertydetail-i18n)\n * object instead.\n */\n localization: Localization;\n\n /**\n * The metafields that apply to the current checkout.\n *\n * Metafields are stored locally on the client and are applied to the order object after the checkout completes.\n *\n * These metafields are shared by all extensions running on checkout, and\n * persist for as long as the customer is working on this checkout.\n *\n * Once the order is created, you can query these metafields using the\n * [GraphQL Admin API](/docs/admin-api/graphql/reference/orders/order#metafield-2021-01)\n *\n * > Caution:\n * `metafields` is deprecated. Use `appMetafields` with cart metafields instead.\n *\n * @deprecated Use `appMetafields` with cart metafields instead.\n */\n metafields: SubscribableSignalLike;\n\n /**\n * A note left by the customer to the merchant, either in their cart or during checkout.\n *\n * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\n */\n note: SubscribableSignalLike;\n\n /**\n * The method used to query the Storefront GraphQL API with a prefetched token.\n *\n */\n query: >(\n query: string,\n options?: {variables?: Variables; version?: StorefrontApiVersion},\n ) => Promise<{data?: Data; errors?: GraphQLError[]}>;\n\n /**\n * The payment options the buyer has currently selected. This updates as\n * the buyer changes their payment method. The array can contain multiple\n * entries when the buyer splits payment across methods (for example, a\n * gift card and a credit card).\n *\n * Each option exposes `handle` and `type` only. Provider names, logos,\n * fees, and installment terms aren't available.\n */\n selectedPaymentOptions: SubscribableSignalLike;\n\n /**\n * The session token providing a set of claims as a signed JSON Web Token (JWT).\n *\n * The token has a TTL of five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Learn more about [session tokens](/docs/apps/build/authentication-authorization/session-tokens).\n */\n sessionToken: SessionToken;\n\n /**\n * The settings matching the settings definition written in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates in real time as a merchant fills in the settings.\n */\n settings: SubscribableSignalLike;\n\n /**\n * The proposed customer shipping address. During the information step, the address\n * updates when the field is committed (on change) rather than every keystroke.\n * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n shippingAddress?: SubscribableSignalLike;\n\n /**\n * The proposed customer billing address. The address updates when the field is\n * committed (on change) rather than every keystroke. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided yet.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n billingAddress?: SubscribableSignalLike;\n\n /**\n * The store where the checkout is taking place, including the shop name,\n * storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.\n */\n shop: Shop;\n\n /**\n * Key-value storage that persists across page loads within the current checkout\n * session. Data is shared across all activated targets associated with\n * this extension.\n *\n * > Caution: Data persistence isn't guaranteed and storage is cleared when the\n * buyer starts a new checkout.\n */\n storage: Storage;\n\n /**\n * The renderer version being used for the extension.\n *\n * @example '2025-10'\n */\n version: Version;\n\n /**\n * Customer privacy consent settings and a flag denoting if consent has previously been collected.\n */\n customerPrivacy: SubscribableSignalLike;\n\n /**\n * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`collect_buyer_consent` capability](/docs/apps/build/customer-accounts/capabilities#collect-buyer-consent) to be set to `true`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyTrackingConsentChange: ApplyTrackingConsentChangeType;\n\n /**\n * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" }, "Analytics": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Analytics", - "description": "", + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "publish", "value": "(name: string, data: Record) => Promise", - "description": "Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing)." + "description": "Publishes a custom event to [Web Pixels](/docs/apps/marketing). Returns `true` when the event is successfully dispatched.\n\nThe Promise resolves to `true` when the event was dispatched. The boolean indicates dispatch confirmation only. It doesn't indicate whether any specific web pixel processed the event." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "visitor", "value": "(data: { email?: string; phone?: string; }) => Promise", - "description": "A method for capturing details about a visitor on the online store." + "description": "Submits buyer contact details for attribution and analytics purposes." } ], - "value": "export interface Analytics {\n /**\n * Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing).\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * A method for capturing details about a visitor on the online store.\n */\n visitor(data: {email?: string; phone?: string}): Promise;\n}" + "value": "export interface Analytics {\n /**\n * Publishes a custom event to [Web Pixels](/docs/apps/marketing).\n * Returns `true` when the event is successfully dispatched.\n *\n * The Promise resolves to `true` when the event was dispatched. The boolean\n * indicates dispatch confirmation only. It doesn't indicate whether any\n * specific web pixel processed the event.\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * Submits buyer contact details for attribution and analytics purposes.\n */\n visitor(data: {email?: string; phone?: string}): Promise;\n}" }, "VisitorResult": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -154016,10 +154016,10 @@ "syntaxKind": "PropertySignature", "name": "type", "value": "'error'", - "description": "Indicates that the visitor information is invalid and wasn't submitted. Examples are using the wrong data type or missing a required property." + "description": "Indicates that the visitor information is invalid and wasn't submitted. Common causes include using the wrong data type or omitting a required property." } ], - "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Examples are using the wrong data type or missing a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Common causes include using the wrong data type or omitting a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" }, "SubscribableSignalLike": { "filePath": "src/surfaces/checkout/shared.ts", @@ -154233,10 +154233,10 @@ "syntaxKind": "PropertySignature", "name": "value", "value": "string | null", - "description": "The new value to store in the metafield. Set to `null` to delete the metafield." + "description": "The new value to store in the metafield. Set to `null` to delete the metafield.\n\nConsent metafield values are strings, not booleans. Pass `null` to delete a tracking consent metafield." } ], - "value": "export interface TrackingConsentMetafieldChange {\n /**\n * The identifier for the tracking consent metafield to update.\n */\n key: string;\n /**\n * The new value to store in the metafield. Set to `null` to delete the metafield.\n */\n value: string | null;\n}" + "value": "export interface TrackingConsentMetafieldChange {\n /**\n * The identifier for the tracking consent metafield to update.\n */\n key: string;\n /**\n * The new value to store in the metafield. Set to `null` to delete the metafield.\n *\n * Consent metafield values are strings, not booleans. Pass `null` to delete\n * a tracking consent metafield.\n */\n value: string | null;\n}" }, "VisitorConsent": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -154450,7 +154450,7 @@ "syntaxKind": "PropertySignature", "name": "value", "value": "string", - "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.", + "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.\n\nAttribute values are always strings. To store structured data, serialize it to JSON and parse it when reading.", "examples": [ { "title": "Example", @@ -154465,7 +154465,7 @@ ] } ], - "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" + "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * Attribute values are always strings. To store structured data, serialize\n * it to JSON and parse it when reading.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" }, "PaymentOption": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -154816,7 +154816,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A globally-unique identifier for the customer in the format `gid://shopify/Customer/`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", + "description": "An identifier for the customer in the format `gid://shopify/Customer/`. This value is unique per shop.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", "examples": [ { "title": "Example", @@ -154869,7 +154869,7 @@ "isPrivate": true } ], - "value": "export interface Customer {\n /**\n * A globally-unique identifier for the customer in the format `gid://shopify/Customer/`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'gid://shopify/Customer/123'\n */\n id: string;\n /**\n * The email address associated with the customer's account. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email?: string;\n /**\n * The phone number associated with the customer's account. The value is `undefined` if no phone number is on file or the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone?: string;\n /**\n * The customer's full name, typically a combination of first and last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n fullName?: string;\n /**\n * The customer's first name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n firstName?: string;\n /**\n * The customer's last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n lastName?: string;\n /**\n * The customer's profile image, such as a Gravatar avatar. Use this to personalize the extension UI for the logged-in buyer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n image: ImageDetails;\n /**\n * Whether the customer has opted in to receiving marketing communications from the merchant, such as email campaigns and promotional offers.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * > Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n *\n * @deprecated Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n */\n acceptsMarketing: boolean;\n /**\n * Whether the customer has opted in to email marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsEmailMarketing: boolean;\n /**\n * Whether the customer has opted in to SMS marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsSmsMarketing: boolean;\n /**\n * The store credit accounts owned by this customer that can be used as payment during checkout. Each account has a balance representing available store credit.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @private\n */\n storeCreditAccounts: StoreCreditAccount[];\n /**\n * The number of orders the customer has previously placed with this shop.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n ordersCount: number;\n}" + "value": "export interface Customer {\n /**\n * An identifier for the customer in the format `gid://shopify/Customer/`. This value is unique per shop.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'gid://shopify/Customer/123'\n */\n id: string;\n /**\n * The email address associated with the customer's account. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email?: string;\n /**\n * The phone number associated with the customer's account. The value is `undefined` if no phone number is on file or the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone?: string;\n /**\n * The customer's full name, typically a combination of first and last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n fullName?: string;\n /**\n * The customer's first name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n firstName?: string;\n /**\n * The customer's last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n lastName?: string;\n /**\n * The customer's profile image, such as a Gravatar avatar. Use this to personalize the extension UI for the logged-in buyer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n image: ImageDetails;\n /**\n * Whether the customer has opted in to receiving marketing communications from the merchant, such as email campaigns and promotional offers.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * > Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n *\n * @deprecated Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n */\n acceptsMarketing: boolean;\n /**\n * Whether the customer has opted in to email marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsEmailMarketing: boolean;\n /**\n * Whether the customer has opted in to SMS marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsSmsMarketing: boolean;\n /**\n * The store credit accounts owned by this customer that can be used as payment during checkout. Each account has a balance representing available store credit.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @private\n */\n storeCreditAccounts: StoreCreditAccount[];\n /**\n * The number of orders the customer has previously placed with this shop.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n ordersCount: number;\n}" }, "ImageDetails": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -155151,11 +155151,11 @@ "syntaxKind": "MethodSignature", "name": "perform", "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", + "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.\n\nRuns after all intercept results are collected. Use it for local state updates such as setting an error flag. By the time it runs, the navigation decision is final, so blocking logic belongs in the intercept handler itself, not here.", "isOptional": true } ], - "value": "interface InterceptorRequestAllow {\n /**\n * Indicates that the interceptor allows the buyer's journey to continue.\n */\n behavior: 'allow';\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" + "value": "interface InterceptorRequestAllow {\n /**\n * Indicates that the interceptor allows the buyer's journey to continue.\n */\n behavior: 'allow';\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n *\n * Runs after all intercept results are collected. Use it for local state\n * updates such as setting an error flag. By the time it runs, the navigation\n * decision is final, so blocking logic belongs in the intercept handler\n * itself, not here.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" }, "InterceptorResult": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -155219,7 +155219,7 @@ "syntaxKind": "MethodSignature", "name": "perform", "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", + "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.\n\nRuns after all intercept results are collected. Use it for local state updates such as setting an error flag. By the time it runs, the navigation decision is final, so blocking logic belongs in the intercept handler itself, not here.", "isOptional": true }, { @@ -155230,7 +155230,7 @@ "description": "The reason for blocking the interceptor request. This value isn't presented to the buyer, so it doesn't need to be localized. The value is used only for Shopify's own internal debugging and metrics." } ], - "value": "interface InterceptorRequestBlock {\n /**\n * Indicates that the interceptor blocks the buyer's journey from continuing.\n */\n behavior: 'block';\n\n /**\n * The reason for blocking the interceptor request. This value isn't presented to\n * the buyer, so it doesn't need to be localized. The value is used only for Shopify's\n * own internal debugging and metrics.\n */\n reason: string;\n\n /**\n * Used to pass errors to the checkout UI, outside your extension's UI boundaries.\n */\n errors?: ValidationError[];\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" + "value": "interface InterceptorRequestBlock {\n /**\n * Indicates that the interceptor blocks the buyer's journey from continuing.\n */\n behavior: 'block';\n\n /**\n * The reason for blocking the interceptor request. This value isn't presented to\n * the buyer, so it doesn't need to be localized. The value is used only for Shopify's\n * own internal debugging and metrics.\n */\n reason: string;\n\n /**\n * Used to pass errors to the checkout UI, outside your extension's UI boundaries.\n */\n errors?: ValidationError[];\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n *\n * Runs after all intercept results are collected. Use it for local state\n * updates such as setting an error flag. By the time it runs, the navigation\n * decision is final, so blocking logic belongs in the intercept handler\n * itself, not here.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" }, "ValidationError": { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -155451,17 +155451,17 @@ "syntaxKind": "PropertySignature", "name": "totalShippingAmount", "value": "SubscribableSignalLike", - "description": "The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step." + "description": "The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step.\n\n`undefined` until the buyer selects a shipping method (typically after the information step)." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "totalTaxAmount", "value": "SubscribableSignalLike", - "description": "The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet." + "description": "The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet.\n\n`undefined` when taxes haven't been calculated or aren't available for the buyer's region." } ], - "value": "export interface CartCost {\n /**\n * The sum of all line item prices at the current step of checkout, before shipping and taxes are applied. Use this value to display the base cost of the items the buyer purchased.\n */\n subtotalAmount: SubscribableSignalLike;\n\n /**\n * The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step.\n */\n totalShippingAmount: SubscribableSignalLike;\n\n /**\n * The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet.\n */\n totalTaxAmount: SubscribableSignalLike;\n\n /**\n * The minimum total at the current step of checkout. Costs not yet calculated, such as shipping on the information step, aren't included. Gift cards and store credits are excluded from this total.\n */\n totalAmount: SubscribableSignalLike;\n}" + "value": "export interface CartCost {\n /**\n * The sum of all line item prices at the current step of checkout, before shipping and taxes are applied. Use this value to display the base cost of the items the buyer purchased.\n */\n subtotalAmount: SubscribableSignalLike;\n\n /**\n * The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step.\n *\n * `undefined` until the buyer selects a shipping method (typically after the\n * information step).\n */\n totalShippingAmount: SubscribableSignalLike;\n\n /**\n * The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet.\n *\n * `undefined` when taxes haven't been calculated or aren't available for the\n * buyer's region.\n */\n totalTaxAmount: SubscribableSignalLike;\n\n /**\n * The minimum total at the current step of checkout. Costs not yet calculated, such as shipping on the information step, aren't included. Gift cards and store credits are excluded from this total.\n */\n totalAmount: SubscribableSignalLike;\n}" }, "CustomerPrivacy": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -155548,31 +155548,31 @@ "syntaxKind": "PropertySignature", "name": "analytics", "value": "boolean", - "description": "Whether analytics data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Analytics data includes how the shop was used and what interactions occurred." + "description": "Whether analytics data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Analytics data includes how the shop was used and what interactions occurred.\n\nWhether analytics data can be collected right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.analytics`, before calling `shopify.analytics.publish()`." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "marketing", "value": "boolean", - "description": "Whether marketing data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Marketing data includes attribution and targeted advertising preferences." + "description": "Whether marketing data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Marketing data includes attribution and targeted advertising preferences.\n\nWhether marketing data can be collected right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.marketing`, before performing marketing-related data collection." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "preferences", "value": "boolean", - "description": "Whether preference data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Preference data includes language, currency, and sizing choices." + "description": "Whether preference data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Preference data includes language, currency, and sizing choices.\n\nWhether preference data can be collected right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.preferences`, before storing or reading buyer preference data." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "saleOfData", "value": "boolean", - "description": "Whether data can be shared with third parties based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. This typically applies to behavioral advertising data." + "description": "Whether data can be shared with third parties based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. This typically applies to behavioral advertising data.\n\nWhether buyer data can be shared with or sold to third parties right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.saleOfData`, before sharing or selling buyer data with third parties." } ], - "value": "export interface AllowedProcessing {\n /**\n * Whether analytics data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Analytics\n * data includes how the shop was used and what interactions occurred.\n */\n analytics: boolean;\n /**\n * Whether marketing data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Marketing\n * data includes attribution and targeted advertising preferences.\n */\n marketing: boolean;\n /**\n * Whether preference data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Preference\n * data includes language, currency, and sizing choices.\n */\n preferences: boolean;\n /**\n * Whether data can be shared with third parties based on the visitor's\n * consent, the merchant's privacy configuration, and the visitor's region.\n * This typically applies to behavioral advertising data.\n */\n saleOfData: boolean;\n}" + "value": "export interface AllowedProcessing {\n /**\n * Whether analytics data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Analytics\n * data includes how the shop was used and what interactions occurred.\n *\n * Whether analytics data can be collected right now. Combines the buyer's\n * consent, the merchant's privacy configuration, and the buyer's region into\n * a single boolean. Check this flag, not `visitorConsent.analytics`, before\n * calling `shopify.analytics.publish()`.\n */\n analytics: boolean;\n /**\n * Whether marketing data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Marketing\n * data includes attribution and targeted advertising preferences.\n *\n * Whether marketing data can be collected right now. Combines the buyer's\n * consent, the merchant's privacy configuration, and the buyer's region into\n * a single boolean. Check this flag, not `visitorConsent.marketing`, before\n * performing marketing-related data collection.\n */\n marketing: boolean;\n /**\n * Whether preference data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Preference\n * data includes language, currency, and sizing choices.\n *\n * Whether preference data can be collected right now. Combines the buyer's\n * consent, the merchant's privacy configuration, and the buyer's region into\n * a single boolean. Check this flag, not `visitorConsent.preferences`,\n * before storing or reading buyer preference data.\n */\n preferences: boolean;\n /**\n * Whether data can be shared with third parties based on the visitor's\n * consent, the merchant's privacy configuration, and the visitor's region.\n * This typically applies to behavioral advertising data.\n *\n * Whether buyer data can be shared with or sold to third parties right now.\n * Combines the buyer's consent, the merchant's privacy configuration, and\n * the buyer's region into a single boolean. Check this flag, not\n * `visitorConsent.saleOfData`, before sharing or selling buyer data with\n * third parties.\n */\n saleOfData: boolean;\n}" }, "TrackingConsentMetafield": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -156264,7 +156264,7 @@ "Extension": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Extension", - "description": "The meta information about an extension target.", + "description": "Metadata about the running extension, including its API version, target, capabilities, and editor context. Use this to read configuration details or conditionally render content based on where the extension is running.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -156290,7 +156290,7 @@ "syntaxKind": "PropertySignature", "name": "capabilities", "value": "SubscribableSignalLike", - "description": "The allowed capabilities of the extension, defined in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n\n* [`api_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#api-access): the extension can access the Storefront API.\n\n* [`network_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access): the extension can make external network calls.\n\n* [`block_progress`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n\n* [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n\n* [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can register customer consent decisions that are honored on Shopify-managed services.\n\n* [`iframe.sources`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#iframe): the extension can embed an external URL in an iframe." + "description": "The allowed capabilities of the extension, defined in your [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -156338,7 +156338,7 @@ "syntaxKind": "PropertySignature", "name": "version", "value": "string", - "description": "The published version of the running extension target.\n\nFor unpublished extensions, the value is `undefined`.", + "description": "The published version of the running extension target.\n\nFor unpublished extensions, the value is `undefined`.\n\nDon't use this property as a stable identifier in development environments. It becomes available only after the extension is published.", "isOptional": true, "examples": [ { @@ -156354,7 +156354,7 @@ ] } ], - "value": "export interface Extension {\n /**\n * The API version that was set in the extension config file.\n *\n * @example '2024-10', '2025-01', '2025-04', '2025-07', '2025-10'\n */\n apiVersion: ApiVersion;\n\n /**\n * The allowed capabilities of the extension, defined\n * in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n *\n * * [`api_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#api-access): the extension can access the Storefront API.\n *\n * * [`network_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access): the extension can make external network calls.\n *\n * * [`block_progress`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n *\n * * [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n *\n * * [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can register customer consent decisions that are honored on Shopify-managed services.\n *\n * * [`iframe.sources`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#iframe): the extension can embed an external URL in an iframe.\n */\n capabilities: SubscribableSignalLike;\n\n /**\n * Information about the editor where the extension is being rendered.\n *\n * If the value is undefined, then the extension isn't running in an editor.\n */\n editor?: Editor;\n\n /**\n * A Boolean to show whether your extension is currently rendered to the screen.\n *\n * Shopify might render your extension before it's visible in the UI,\n * typically to pre-render extensions that appear on a later step of the\n * checkout.\n *\n * Your extension might also continue to run after the customer has navigated away\n * from where it was rendered. The extension continues running so that\n * your extension is immediately available to render if the customer navigates back.\n */\n rendered: SubscribableSignalLike;\n\n /**\n * The URL to the script that started the extension target.\n */\n scriptUrl: string;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n */\n target: Target;\n\n /**\n * The published version of the running extension target.\n *\n * For unpublished extensions, the value is `undefined`.\n *\n * @example 3.0.10\n */\n version?: string;\n}" + "value": "export interface Extension {\n /**\n * The API version that was set in the extension config file.\n *\n * @example '2024-10', '2025-01', '2025-04', '2025-07', '2025-10'\n */\n apiVersion: ApiVersion;\n\n /**\n * The allowed capabilities of the extension, defined in your\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n */\n capabilities: SubscribableSignalLike;\n\n /**\n * Information about the editor where the extension is being rendered.\n *\n * If the value is undefined, then the extension isn't running in an editor.\n */\n editor?: Editor;\n\n /**\n * A Boolean to show whether your extension is currently rendered to the screen.\n *\n * Shopify might render your extension before it's visible in the UI,\n * typically to pre-render extensions that appear on a later step of the\n * checkout.\n *\n * Your extension might also continue to run after the customer has navigated away\n * from where it was rendered. The extension continues running so that\n * your extension is immediately available to render if the customer navigates back.\n */\n rendered: SubscribableSignalLike;\n\n /**\n * The URL to the script that started the extension target.\n */\n scriptUrl: string;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n */\n target: Target;\n\n /**\n * The published version of the running extension target.\n *\n * For unpublished extensions, the value is `undefined`.\n *\n * Don't use this property as a stable identifier in development environments.\n * It becomes available only after the extension is published.\n *\n * @example 3.0.10\n */\n version?: string;\n}" }, "ApiVersion": { "filePath": "src/shared.ts", @@ -156373,7 +156373,7 @@ "Editor": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Editor", - "description": "", + "description": "Information about the editor environment when an extension is rendered inside the checkout editor. The value is `undefined` when the extension is not rendering in an editor.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -156388,7 +156388,7 @@ "I18n": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18n", - "description": "", + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use the I18n API alongside the Localization API to build fully localized extensions.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -156424,7 +156424,7 @@ "I18nTranslate": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18nTranslate", - "description": "This returns a translated string matching a key in a locale file.", + "description": "Translates a key from your extension's locale files into a localized string. Supports interpolation with placeholder replacements and pluralization via the special `count` option.", "members": [], "value": "export interface I18nTranslate {\n (\n key: string,\n options?: Record,\n ): ReplacementType extends string | number\n ? string\n : (string | ReplacementType)[];\n}" }, @@ -156988,14 +156988,14 @@ "Localization": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Localization", - "description": "", + "description": "The buyer's language, country, currency, and timezone context. Use this to adapt your extension to the buyer's region and display localized content.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "country", "value": "SubscribableSignalLike", - "description": "The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown." + "description": "The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n\nDerived from the buyer's shipping address. Returns `undefined` until the buyer enters a shipping address." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -157023,18 +157023,18 @@ "syntaxKind": "PropertySignature", "name": "market", "value": "SubscribableSignalLike", - "description": "The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n\n> Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.", - "deprecationMessage": "Deprecated as of version `2025-04`" + "description": "The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. The market context updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.", + "deprecationMessage": "Merchants now manage which extensions load for each\nmarket, so extensions no longer need to check this value." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "timezone", "value": "SubscribableSignalLike", - "description": "The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time." + "description": "The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time." } ], - "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n *\n * > Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" + "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n *\n * Derived from the buyer's shipping address. Returns `undefined` until the\n * buyer enters a shipping address.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout,\n * carried over from the cart context. Markets group countries and\n * regions with shared pricing, languages, and domains. The market\n * context updates when the buyer changes the country of their\n * shipping address. The value is `undefined` if the market is unknown.\n *\n * @deprecated Merchants now manage which extensions load for each\n * market, so extensions no longer need to check this value.\n */\n market: SubscribableSignalLike;\n}" }, "Country": { "filePath": "src/shared.ts", @@ -157235,7 +157235,7 @@ "SessionToken": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SessionToken", - "description": "", + "description": "Authenticates requests between your extension and your app backend. Use session tokens to verify the identity of the buyer and the shop context when making server-side API calls. The token is a signed JWT that contains claims such as the customer ID, shop domain, and expiration.\n\nThe `sub` claim in the decoded token is present only when the buyer is logged in and the app has permission to read customer accounts. Absent for anonymous buyers.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -157494,7 +157494,7 @@ "Shop": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Shop", - "description": "", + "description": "Metadata about the merchant's store, including its name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -157534,30 +157534,30 @@ "syntaxKind": "PropertySignature", "name": "storefrontUrl", "value": "string", - "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n\n> Caution: > As of version `2024-04` this value no longer has a trailing slash.", + "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.", "isOptional": true } ], - "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n *\n * > Caution:\n * > As of version `2024-04` this value no longer has a trailing slash.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom domain.\n */\n myshopifyDomain: string;\n}" + "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom domain.\n */\n myshopifyDomain: string;\n}" }, "Storage": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Storage", - "description": "A key-value storage object for the extension.\n\nStored data is available only to this specific extension and any of its instances.\n\nThe storage backend is implemented with `localStorage` and should persist across the buyer's checkout session. However, data persistence isn't guaranteed.", + "description": "Key-value storage for a specific extension. Use storage to save preferences or cached data that should survive page reloads without requiring a backend call. Stored data is only available to this specific extension. The storage backend is implemented with `localStorage` and data persistence isn't guaranteed.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "delete", "value": "(key: string) => Promise", - "description": "Delete stored data by key." + "description": "Deletes a previously stored value by key." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "read", "value": "(key: string) => Promise", - "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original primitive.\n\nReturns `null` if no stored data exists." + "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original type.\n\nReturns the stored value for the given key, or `null` when no value exists. Doesn't throw on a missing key." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -157567,7 +157567,7 @@ "description": "Write stored data for this key.\n\nThe data must be serializable to JSON." } ], - "value": "export interface Storage {\n /**\n * Read and return a stored value by key.\n *\n * The stored data is deserialized from JSON and returned as\n * its original primitive.\n *\n * Returns `null` if no stored data exists.\n */\n read(key: string): Promise;\n\n /**\n * Write stored data for this key.\n *\n * The data must be serializable to JSON.\n */\n write(key: string, data: any): Promise;\n\n /**\n * Delete stored data by key.\n */\n delete(key: string): Promise;\n}" + "value": "export interface Storage {\n /**\n * Read and return a stored value by key.\n *\n * The stored data is deserialized from JSON and returned as\n * its original type.\n *\n * Returns the stored value for the given key, or `null` when no value\n * exists. Doesn't throw on a missing key.\n */\n read(key: string): Promise;\n\n /**\n * Write stored data for this key.\n *\n * The data must be serializable to JSON.\n */\n write(key: string, data: any): Promise;\n\n /**\n * Deletes a previously stored value by key.\n */\n delete(key: string): Promise;\n}" }, "Version": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -157644,7 +157644,7 @@ "syntaxKind": "PropertySignature", "name": "isTargetSelected", "value": "SubscribableSignalLike", - "description": "Whether the buyer has selected the target shipping option. When `true`, the target option is the buyer's active choice. When `false`, the buyer has chosen a different shipping option." + "description": "Whether the buyer has selected the target shipping option. When `true`, the target option is the buyer's active choice. When `false`, the buyer has chosen a different shipping option.\n\nAvailable only on the corresponding item target. Shipping option item targets expose shipping option properties; pickup location item targets expose pickup location properties." }, { "filePath": "src/surfaces/checkout/api/shipping/shipping-option-item.ts", @@ -157658,10 +157658,10 @@ "syntaxKind": "PropertySignature", "name": "target", "value": "SubscribableSignalLike", - "description": "The shipping option that this extension is attached to. Use this to read the option's cost, carrier, delivery estimate, and other details." + "description": "The shipping option that this extension is attached to. Use this to read the option's cost, carrier, delivery estimate, and other details.\n\nAvailable only on the corresponding item target. Shipping option item targets expose shipping option properties; pickup location item targets expose pickup location properties." } ], - "value": "export interface ShippingOptionItemApi {\n /**\n * The shipping option that this extension is attached to. Use this to read the option's cost, carrier, delivery estimate, and other details.\n */\n target: SubscribableSignalLike;\n\n /**\n * Whether the buyer has selected the target shipping option. When `true`, the target option is the buyer's active choice. When `false`, the buyer has chosen a different shipping option.\n */\n isTargetSelected: SubscribableSignalLike;\n\n /**\n * The render mode of this shipping option, indicating how the extension is displayed in the checkout UI.\n */\n renderMode: ShippingOptionItemRenderMode;\n}" + "value": "export interface ShippingOptionItemApi {\n /**\n * The shipping option that this extension is attached to. Use this to read the option's cost, carrier, delivery estimate, and other details.\n *\n * Available only on the corresponding item target. Shipping option item\n * targets expose shipping option properties; pickup location item targets\n * expose pickup location properties.\n */\n target: SubscribableSignalLike;\n\n /**\n * Whether the buyer has selected the target shipping option. When `true`, the target option is the buyer's active choice. When `false`, the buyer has chosen a different shipping option.\n *\n * Available only on the corresponding item target. Shipping option item\n * targets expose shipping option properties; pickup location item targets\n * expose pickup location properties.\n */\n isTargetSelected: SubscribableSignalLike;\n\n /**\n * The render mode of this shipping option, indicating how the extension is displayed in the checkout UI.\n */\n renderMode: ShippingOptionItemRenderMode;\n}" }, "SubscribableSignalLike": { "filePath": "src/surfaces/checkout/shared.ts", @@ -157970,7 +157970,7 @@ "syntaxKind": "MethodSignature", "name": "applyAttributeChange", "value": "(change: AttributeChange) => Promise", - "description": "Updates or removes an attribute on the cart and checkout. On success, the [`attributes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/attributes#standardapi-propertydetail-attributes) property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.", + "description": "Updates or removes an attribute on the cart and checkout. On success, the [`attributes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/attributes#properties-propertydetail-attributes) property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.", "deprecationMessage": "Use cart metafields instead." }, { @@ -157978,42 +157978,42 @@ "syntaxKind": "MethodSignature", "name": "applyCartLinesChange", "value": "(change: CartLineChange) => Promise", - "description": "Adds, removes, or updates line items in the cart. The returned promise resolves when the change has been applied by the server, and the [`lines`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-lines#standardapi-propertydetail-lines) property updates with the new state.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Adds, removes, or updates line items in the cart. The returned promise resolves when the change has been applied by the server, and the [`lines`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-lines#properties-propertydetail-lines) property updates with the new state.\n\nAccepts a single change per call. To make multiple changes, call this method separately for each one.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyDiscountCodeChange", "value": "(change: DiscountCodeChange) => Promise", - "description": "Adds or removes a discount code on the checkout. The returned promise resolves when the change has been applied by the server, and the [`discountCodes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/discounts#standardapi-propertydetail-discountcodes) property updates with the new state.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves discount codes through a network call.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Adds or removes a discount code on the checkout. The returned promise resolves when the change has been applied by the server, and the [`discountCodes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/discounts#properties-propertydetail-discountcodes) property updates with the new state.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves discount codes through a network call.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyGiftCardChange", "value": "(change: GiftCardChange) => Promise", - "description": "Adds or removes a gift card from the checkout. The returned promise resolves when the change has been applied by the server, and the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/gift-cards#standardapi-propertydetail-appliedgiftcards) property updates with the new state.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves gift card codes through a network call.\n\n> Note: This method returns an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Adds or removes a gift card from the checkout. The returned promise resolves when the change has been applied by the server, and the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/gift-cards#properties-propertydetail-appliedgiftcards) property updates with the new state.\n\nUnlike other write operations, gift card changes aren't gated by a cart instruction flag.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves gift card codes through a network call.\n\n> Note: This method returns an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyMetafieldChange", "value": "(change: MetafieldChange) => Promise", - "description": "Creates, updates, or removes a cart metafield on the checkout. On success, the [`metafields`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/metafields#standardapi-propertydetail-metafields) property updates to reflect the change.\n\nCart metafields are copied to order metafields at order creation time if there's a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n\n> Caution: `MetafieldRemoveChange` and `MetafieldUpdateChange` are deprecated. Use cart metafields with `MetafieldRemoveCartChange` and `MetafieldUpdateCartChange` instead. If `MetafieldUpdateChange` writes a metafield with the same namespace and key as a cart metafield that's configured to copy, the cart metafield won't be copied.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Creates, updates, or removes a cart metafield on the checkout. On success, the [`metafields`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/metafields#properties-propertydetail-metafields) property updates to reflect the change.\n\nCart metafields are copied to order metafields at order creation time if there's a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n\n> Caution: `MetafieldRemoveChange` and `MetafieldUpdateChange` are deprecated. Use cart metafields with `MetafieldRemoveCartChange` and `MetafieldUpdateCartChange` instead. If `MetafieldUpdateChange` writes a metafield with the same namespace and key as a cart metafield that's configured to copy, the cart metafield won't be copied.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyNoteChange", "value": "(change: NoteChange) => Promise", - "description": "Sets or removes the buyer's note on the checkout. On success, the [`note`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/note#standardapi-propertydetail-note) property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Sets or removes the buyer's note on the checkout. On success, the [`note`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/note#properties-propertydetail-note) property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyShippingAddressChange", "value": "(change: ShippingAddressUpdateChange) => Promise", - "description": "Updates the buyer's shipping address on the checkout. The provided fields are merged into the existing address without prompting the buyer. On success, the `shippingAddress` property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", + "description": "Updates the buyer's shipping address on the checkout. The provided fields are merged into the existing address without prompting the buyer. On success, the `shippingAddress` property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", "isOptional": true }, { @@ -158026,7 +158026,7 @@ "isPrivate": true } ], - "value": "export interface CheckoutApi {\n /**\n * Updates or removes an attribute on the cart and checkout. On success, the\n * [`attributes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/attributes#standardapi-propertydetail-attributes) property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * @deprecated Use cart metafields instead.\n */\n applyAttributeChange(change: AttributeChange): Promise;\n\n /**\n * Adds, removes, or updates line items in the cart. The returned promise resolves when the change has been applied by the server, and the [`lines`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-lines#standardapi-propertydetail-lines) property updates with the new state.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyCartLinesChange(change: CartLineChange): Promise;\n\n /**\n * Adds or removes a discount code on the checkout. The returned promise resolves when the change has been applied by the server, and the [`discountCodes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/discounts#standardapi-propertydetail-discountcodes) property updates with the new state.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves discount codes through a network call.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyDiscountCodeChange(\n change: DiscountCodeChange,\n ): Promise;\n\n /**\n * Adds or removes a gift card from the checkout. The returned promise resolves when the change has been applied by the server, and the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/gift-cards#standardapi-propertydetail-appliedgiftcards) property updates with the new state.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves gift card codes through a network call.\n *\n * > Note: This method returns an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyGiftCardChange(change: GiftCardChange): Promise;\n\n /**\n * Creates, updates, or removes a cart metafield on the checkout. On success, the\n * [`metafields`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/metafields#standardapi-propertydetail-metafields) property updates to reflect the change.\n *\n * Cart metafields are copied to order metafields at order creation time if there's a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n *\n * > Caution: `MetafieldRemoveChange` and `MetafieldUpdateChange` are deprecated. Use cart metafields with `MetafieldRemoveCartChange` and `MetafieldUpdateCartChange` instead. If `MetafieldUpdateChange` writes a metafield with the same namespace and key as a cart metafield that's configured to copy, the cart metafield won't be copied.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyMetafieldChange(change: MetafieldChange): Promise;\n\n /**\n * Sets or removes the buyer's note on the checkout. On success, the\n * [`note`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/note#standardapi-propertydetail-note)\n * property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyNoteChange(change: NoteChange): Promise;\n\n /**\n * @private\n */\n experimentalIsShopAppStyle?: boolean;\n\n /**\n * Updates the buyer's shipping address on the checkout. The provided fields\n * are merged into the existing address without prompting the buyer. On success,\n * the `shippingAddress` property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyShippingAddressChange?(\n change: ShippingAddressChange,\n ): Promise;\n}" + "value": "export interface CheckoutApi {\n /**\n * Updates or removes an attribute on the cart and checkout. On success, the\n * [`attributes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/attributes#properties-propertydetail-attributes) property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * @deprecated Use cart metafields instead.\n */\n applyAttributeChange(change: AttributeChange): Promise;\n\n /**\n * Adds, removes, or updates line items in the cart. The returned promise resolves when the change has been applied by the server, and the [`lines`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-lines#properties-propertydetail-lines) property updates with the new state.\n *\n * Accepts a single change per call. To make multiple changes, call this\n * method separately for each one.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyCartLinesChange(change: CartLineChange): Promise;\n\n /**\n * Adds or removes a discount code on the checkout. The returned promise resolves when the change has been applied by the server, and the [`discountCodes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/discounts#properties-propertydetail-discountcodes) property updates with the new state.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves discount codes through a network call.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyDiscountCodeChange(\n change: DiscountCodeChange,\n ): Promise;\n\n /**\n * Adds or removes a gift card from the checkout. The returned promise resolves when the change has been applied by the server, and the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/gift-cards#properties-propertydetail-appliedgiftcards) property updates with the new state.\n *\n * Unlike other write operations, gift card changes aren't gated by a cart\n * instruction flag.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves gift card codes through a network call.\n *\n * > Note: This method returns an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyGiftCardChange(change: GiftCardChange): Promise;\n\n /**\n * Creates, updates, or removes a cart metafield on the checkout. On success, the\n * [`metafields`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/metafields#properties-propertydetail-metafields) property updates to reflect the change.\n *\n * Cart metafields are copied to order metafields at order creation time if there's a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n *\n * > Caution: `MetafieldRemoveChange` and `MetafieldUpdateChange` are deprecated. Use cart metafields with `MetafieldRemoveCartChange` and `MetafieldUpdateCartChange` instead. If `MetafieldUpdateChange` writes a metafield with the same namespace and key as a cart metafield that's configured to copy, the cart metafield won't be copied.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyMetafieldChange(change: MetafieldChange): Promise;\n\n /**\n * Sets or removes the buyer's note on the checkout. On success, the\n * [`note`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/note#properties-propertydetail-note)\n * property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyNoteChange(change: NoteChange): Promise;\n\n /**\n * @private\n */\n experimentalIsShopAppStyle?: boolean;\n\n /**\n * Updates the buyer's shipping address on the checkout. The provided fields\n * are merged into the existing address without prompting the buyer. On success,\n * the `shippingAddress` property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyShippingAddressChange?(\n change: ShippingAddressChange,\n ): Promise;\n}" }, "AttributeChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -158093,7 +158093,7 @@ "syntaxKind": "PropertySignature", "name": "value", "value": "string", - "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.", + "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.\n\nAttribute values are always strings. To store structured data, serialize it to JSON and parse it when reading.", "examples": [ { "title": "Example", @@ -158108,7 +158108,7 @@ ] } ], - "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" + "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * Attribute values are always strings. To store structured data, serialize\n * it to JSON and parse it when reading.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" }, "AttributeRemoveChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -158961,7 +158961,7 @@ "syntaxKind": "PropertySignature", "name": "message", "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer." + "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer.\n\nRender your own localized error text rather than displaying this message to the buyer." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -158971,7 +158971,7 @@ "description": "Indicates that the line item wasn't changed successfully. Refer to the `message` property for details about the error." } ], - "value": "export interface CartLineChangeResultError {\n /**\n * Indicates that the line item wasn't changed successfully. Refer to the `message` property for details about the error.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface CartLineChangeResultError {\n /**\n * Indicates that the line item wasn't changed successfully. Refer to the `message` property for details about the error.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n *\n * Render your own localized error text rather than displaying this message\n * to the buyer.\n */\n message: string;\n}" }, "DiscountCodeChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -159151,7 +159151,7 @@ "syntaxKind": "PropertySignature", "name": "message", "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer." + "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer.\n\nRender your own localized error text rather than displaying this message to the buyer." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -159161,7 +159161,7 @@ "description": "Indicates that the gift card change couldn't be applied. Check the `message` property for details." } ], - "value": "export interface GiftCardChangeResultError {\n /**\n * Indicates that the gift card change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface GiftCardChangeResultError {\n /**\n * Indicates that the gift card change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n *\n * Render your own localized error text rather than displaying this message\n * to the buyer.\n */\n message: string;\n}" }, "MetafieldChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -159422,7 +159422,7 @@ "syntaxKind": "PropertySignature", "name": "message", "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer." + "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer.\n\nRender your own localized error text rather than displaying this message to the buyer." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -159432,7 +159432,7 @@ "description": "Indicates that the metafield change couldn't be applied. Check the `message` property for details." } ], - "value": "export interface MetafieldChangeResultError {\n /**\n * Indicates that the metafield change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface MetafieldChangeResultError {\n /**\n * Indicates that the metafield change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n *\n * Render your own localized error text rather than displaying this message\n * to the buyer.\n */\n message: string;\n}" }, "NoteChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -159510,7 +159510,7 @@ "syntaxKind": "PropertySignature", "name": "message", "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer." + "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer.\n\nRender your own localized error text rather than displaying this message to the buyer." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -159520,7 +159520,7 @@ "description": "Indicates that the note change couldn't be applied. Check the `message` property for details." } ], - "value": "export interface NoteChangeResultError {\n /**\n * Indicates that the note change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface NoteChangeResultError {\n /**\n * Indicates that the note change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n *\n * Render your own localized error text rather than displaying this message\n * to the buyer.\n */\n message: string;\n}" }, "ShippingAddressUpdateChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -160106,7 +160106,7 @@ "syntaxKind": "PropertySignature", "name": "analytics", "value": "Analytics", - "description": "The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event." + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -160120,7 +160120,7 @@ "syntaxKind": "PropertySignature", "name": "applyTrackingConsentChange", "value": "ApplyTrackingConsentChangeType", - "description": "Enables setting and updating customer privacy consent settings and tracking consent metafields.\n\n> Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent) to be set to `true`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." + "description": "Enables setting and updating customer privacy consent settings and tracking consent metafields.\n\n> Note: Requires the [`collect_buyer_consent` capability](/docs/apps/build/customer-accounts/capabilities#collect-buyer-consent) to be set to `true`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -160141,7 +160141,7 @@ "syntaxKind": "PropertySignature", "name": "availablePaymentOptions", "value": "SubscribableSignalLike", - "description": "All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region." + "description": "All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n\nThe set of payment options can change when the buyer updates their address or cart, so subscribe to changes rather than reading once during initialization. Each option exposes `handle` and `type` only. Provider names, logos, fees, and installment terms aren't available." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -160178,7 +160178,7 @@ "syntaxKind": "PropertySignature", "name": "checkoutToken", "value": "SubscribableSignalLike", - "description": "A stable ID that represents the current checkout.\n\nThe value is `undefined` when the checkout hasn't been created on the server yet.\n\nUse this to correlate checkout sessions across your extension, web pixels, and backend systems.\n\nThis matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data) and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object)." + "description": "A stable ID that represents the current checkout.\n\nThe value is `undefined` when the checkout hasn't been created on the server yet.\n\nUse this to correlate checkout sessions across your extension, web pixels, and backend systems.\n\nThis matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data) and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n\nCan be `undefined`. Handle the `undefined` state before using the value." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -160199,7 +160199,7 @@ "syntaxKind": "PropertySignature", "name": "deliveryGroups", "value": "SubscribableSignalLike", - "description": "The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items." + "description": "The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n\nEmpty until the buyer enters enough address information for Shopify to calculate shipping rates." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -160220,7 +160220,7 @@ "syntaxKind": "PropertySignature", "name": "extension", "value": "Extension", - "description": "The meta information about the extension." + "description": "Metadata about the running extension, including the current target, API version, capabilities, and editor context. Use this to conditionally render content based on where the extension is running." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -160228,7 +160228,7 @@ "name": "extensionPoint", "value": "Target", "description": "The identifier that specifies where in Shopify's UI your code is being injected. This is one of the targets you've included in your extension's configuration file.", - "deprecationMessage": "Deprecated as of version `2023-07`, use `extension.target` instead.", + "deprecationMessage": "Use `extension.target` instead.", "examples": [ { "title": "Example", @@ -160247,14 +160247,14 @@ "syntaxKind": "PropertySignature", "name": "i18n", "value": "I18n", - "description": "Utilities for translating content and formatting values according to the current [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) of the checkout.\n\nRefer to [`localization` examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples) for more information." + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use alongside [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) to build fully localized extensions." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "instructions", "value": "SubscribableSignalLike", - "description": "The cart instructions used to create the checkout and possibly limit extension capabilities.\n\nThese instructions should be checked before performing any actions that might be affected by them.\n\nFor example, if you intend to add a discount code via the `applyDiscountCodeChange` method, check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n\n> Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs aren't available. See the [update guide](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples) for more information." + "description": "The cart instructions used to create the checkout and possibly limit extension capabilities.\n\nThese instructions should be checked before performing any actions that might be affected by them.\n\nFor example, if you intend to add a discount code via the `applyDiscountCodeChange` method, check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n\n> Caution: Check cart instructions before calling select APIs, as > some may not be available. See the > [Cart Instructions API](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples) > for more information." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -160268,7 +160268,7 @@ "syntaxKind": "PropertySignature", "name": "localization", "value": "Localization", - "description": "The details about the location, language, and currency of the customer. For utilities to easily format and translate content based on these details, you can use the [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n) object instead." + "description": "The buyer's language, country, currency, and timezone context. For formatting and translation helpers, use the [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#properties-propertydetail-i18n) object instead." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -160298,21 +160298,21 @@ "syntaxKind": "PropertySignature", "name": "query", "value": ">(query: string, options?: { variables?: Variables; version?: StorefrontApiVersion; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>", - "description": "The method used to query the Storefront GraphQL API with a prefetched token.\n\nRefer to [Storefront API access examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/storefront-api) for more information." + "description": "The method used to query the Storefront GraphQL API with a prefetched token." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "selectedPaymentOptions", "value": "SubscribableSignalLike", - "description": "The payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card)." + "description": "The payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\n\nEach option exposes `handle` and `type` only. Provider names, logos, fees, and installment terms aren't available." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "sessionToken", "value": "SessionToken", - "description": "The session token providing a set of claims as a signed JSON Web Token (JWT).\n\nThe token has a TTL of five minutes.\n\nIf the previous token expires, this value reflects a new session token with a new signature and expiry.\n\nRefer to [session token examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/session-token) for more information." + "description": "The session token providing a set of claims as a signed JSON Web Token (JWT).\n\nThe token has a TTL of five minutes.\n\nIf the previous token expires, this value reflects a new session token with a new signature and expiry.\n\nLearn more about [session tokens](/docs/apps/build/authentication-authorization/session-tokens)." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -160334,14 +160334,14 @@ "syntaxKind": "PropertySignature", "name": "shop", "value": "Shop", - "description": "The shop where the checkout is taking place." + "description": "The store where the checkout is taking place, including the shop name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "storage", "value": "Storage", - "description": "The key-value storage for the extension.\n\nIt uses `localStorage` and should persist across the customer's current checkout session.\n\n> Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n\nData is shared across all activated extension targets of this extension. In versions 2023-07 and earlier, each activated extension target had its own storage." + "description": "Key-value storage that persists across page loads within the current checkout session. Data is shared across all activated targets associated with this extension.\n\n> Caution: Data persistence isn't guaranteed and storage is cleared when the buyer starts a new checkout." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -160363,29 +160363,29 @@ ] } ], - "value": "export interface StandardApi {\n /**\n * The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event.\n */\n analytics: Analytics;\n\n /**\n * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\n */\n appliedGiftCards: SubscribableSignalLike;\n\n /**\n * The cart instructions used to create the checkout and possibly limit extension capabilities.\n *\n * These instructions should be checked before performing any actions that might be affected by them.\n *\n * For example, if you intend to add a discount code via the `applyDiscountCodeChange` method,\n * check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n *\n * > Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs aren't available.\n * See the [update guide](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples) for more information.\n *\n */\n instructions: SubscribableSignalLike;\n\n /**\n * The metafields requested in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration)\n * file. These metafields are updated when there's a change in the merchandise items\n * being purchased by the customer.\n *\n * App owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` isn't supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n appMetafields: SubscribableSignalLike;\n\n /**\n * The custom key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n buyerIdentity?: BuyerIdentity;\n\n /**\n * Provides details on the buyer's progression through the checkout and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/buyer-journey#examples)\n * examples for more information.\n */\n buyerJourney: BuyerJourney;\n\n /**\n * Settings applied to the buyer's checkout.\n */\n checkoutSettings: SubscribableSignalLike;\n\n /**\n * A stable ID that represents the current checkout.\n *\n * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\n *\n * This matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data)\n * and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n */\n checkoutToken: SubscribableSignalLike;\n\n /**\n * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * The meta information about the extension.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n *\n * @deprecated Deprecated as of version `2023-07`, use `extension.target` instead.\n */\n extensionPoint: Target;\n\n /**\n * Utilities for translating content and formatting values according to the current\n * [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization)\n * of the checkout.\n *\n * Refer to [`localization` examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples)\n * for more information.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The details about the location, language, and currency of the customer. For utilities to easily\n * format and translate content based on these details, you can use the\n * [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n)\n * object instead.\n */\n localization: Localization;\n\n /**\n * The metafields that apply to the current checkout.\n *\n * Metafields are stored locally on the client and are applied to the order object after the checkout completes.\n *\n * These metafields are shared by all extensions running on checkout, and\n * persist for as long as the customer is working on this checkout.\n *\n * Once the order is created, you can query these metafields using the\n * [GraphQL Admin API](/docs/admin-api/graphql/reference/orders/order#metafield-2021-01)\n *\n * > Caution:\n * `metafields` is deprecated. Use `appMetafields` with cart metafields instead.\n *\n * @deprecated Use `appMetafields` with cart metafields instead.\n */\n metafields: SubscribableSignalLike;\n\n /**\n * A note left by the customer to the merchant, either in their cart or during checkout.\n *\n * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\n */\n note: SubscribableSignalLike;\n\n /**\n * The method used to query the Storefront GraphQL API with a prefetched token.\n *\n * Refer to [Storefront API access examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/storefront-api) for more information.\n */\n query: >(\n query: string,\n options?: {variables?: Variables; version?: StorefrontApiVersion},\n ) => Promise<{data?: Data; errors?: GraphQLError[]}>;\n\n /**\n * The payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\n */\n selectedPaymentOptions: SubscribableSignalLike;\n\n /**\n * The session token providing a set of claims as a signed JSON Web Token (JWT).\n *\n * The token has a TTL of five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/session-token) for more information.\n */\n sessionToken: SessionToken;\n\n /**\n * The settings matching the settings definition written in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates in real time as a merchant fills in the settings.\n */\n settings: SubscribableSignalLike;\n\n /**\n * The proposed customer shipping address. During the information step, the address\n * updates when the field is committed (on change) rather than every keystroke.\n * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n shippingAddress?: SubscribableSignalLike;\n\n /**\n * The proposed customer billing address. The address updates when the field is\n * committed (on change) rather than every keystroke. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided yet.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n billingAddress?: SubscribableSignalLike;\n\n /** The shop where the checkout is taking place. */\n shop: Shop;\n\n /**\n * The key-value storage for the extension.\n *\n * It uses `localStorage` and should persist across the customer's current checkout session.\n *\n * > Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n *\n * Data is shared across all activated extension targets of this extension. In versions 2023-07 and earlier,\n * each activated extension target had its own storage.\n */\n storage: Storage;\n\n /**\n * The renderer version being used for the extension.\n *\n * @example '2025-10'\n */\n version: Version;\n\n /**\n * Customer privacy consent settings and a flag denoting if consent has previously been collected.\n */\n customerPrivacy: SubscribableSignalLike;\n\n /**\n * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent) to be set to `true`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyTrackingConsentChange: ApplyTrackingConsentChangeType;\n\n /**\n * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" + "value": "export interface StandardApi {\n /**\n * Tracks custom events and sends visitor information to\n * [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events\n * and `visitor()` to submit buyer contact details.\n */\n analytics: Analytics;\n\n /**\n * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\n */\n appliedGiftCards: SubscribableSignalLike;\n\n /**\n * The cart instructions used to create the checkout and possibly limit extension capabilities.\n *\n * These instructions should be checked before performing any actions that might be affected by them.\n *\n * For example, if you intend to add a discount code via the `applyDiscountCodeChange` method,\n * check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n *\n * > Caution: Check cart instructions before calling select APIs, as\n * > some may not be available. See the\n * > [Cart Instructions API](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples)\n * > for more information.\n *\n */\n instructions: SubscribableSignalLike;\n\n /**\n * The metafields requested in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration)\n * file. These metafields are updated when there's a change in the merchandise items\n * being purchased by the customer.\n *\n * App owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` isn't supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n appMetafields: SubscribableSignalLike;\n\n /**\n * The custom key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as\n * credit cards, wallets, and local payment methods. The list depends on\n * the shop's payment configuration and the buyer's region.\n *\n * The set of payment options can change when the buyer updates their\n * address or cart, so subscribe to changes rather than reading once\n * during initialization. Each option exposes `handle` and `type` only.\n * Provider names, logos, fees, and installment terms aren't available.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n buyerIdentity?: BuyerIdentity;\n\n /**\n * Provides details on the buyer's progression through the checkout and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/buyer-journey#examples)\n * examples for more information.\n */\n buyerJourney: BuyerJourney;\n\n /**\n * Settings applied to the buyer's checkout.\n */\n checkoutSettings: SubscribableSignalLike;\n\n /**\n * A stable ID that represents the current checkout.\n *\n * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\n *\n * This matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data)\n * and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n *\n * Can be `undefined`. Handle the `undefined` state before using the value.\n */\n checkoutToken: SubscribableSignalLike;\n\n /**\n * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n *\n * Empty until the buyer enters enough address information for Shopify to\n * calculate shipping rates.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * Metadata about the running extension, including the current target, API version,\n * capabilities, and editor context. Use this to conditionally render content\n * based on where the extension is running.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n *\n * @deprecated Use `extension.target` instead.\n */\n extensionPoint: Target;\n\n /**\n * Utilities for translating strings, formatting currencies, numbers, and dates\n * according to the buyer's locale. Use alongside\n * [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization)\n * to build fully localized extensions.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The buyer's language, country, currency, and timezone context. For\n * formatting and translation helpers, use the\n * [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#properties-propertydetail-i18n)\n * object instead.\n */\n localization: Localization;\n\n /**\n * The metafields that apply to the current checkout.\n *\n * Metafields are stored locally on the client and are applied to the order object after the checkout completes.\n *\n * These metafields are shared by all extensions running on checkout, and\n * persist for as long as the customer is working on this checkout.\n *\n * Once the order is created, you can query these metafields using the\n * [GraphQL Admin API](/docs/admin-api/graphql/reference/orders/order#metafield-2021-01)\n *\n * > Caution:\n * `metafields` is deprecated. Use `appMetafields` with cart metafields instead.\n *\n * @deprecated Use `appMetafields` with cart metafields instead.\n */\n metafields: SubscribableSignalLike;\n\n /**\n * A note left by the customer to the merchant, either in their cart or during checkout.\n *\n * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\n */\n note: SubscribableSignalLike;\n\n /**\n * The method used to query the Storefront GraphQL API with a prefetched token.\n *\n */\n query: >(\n query: string,\n options?: {variables?: Variables; version?: StorefrontApiVersion},\n ) => Promise<{data?: Data; errors?: GraphQLError[]}>;\n\n /**\n * The payment options the buyer has currently selected. This updates as\n * the buyer changes their payment method. The array can contain multiple\n * entries when the buyer splits payment across methods (for example, a\n * gift card and a credit card).\n *\n * Each option exposes `handle` and `type` only. Provider names, logos,\n * fees, and installment terms aren't available.\n */\n selectedPaymentOptions: SubscribableSignalLike;\n\n /**\n * The session token providing a set of claims as a signed JSON Web Token (JWT).\n *\n * The token has a TTL of five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Learn more about [session tokens](/docs/apps/build/authentication-authorization/session-tokens).\n */\n sessionToken: SessionToken;\n\n /**\n * The settings matching the settings definition written in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates in real time as a merchant fills in the settings.\n */\n settings: SubscribableSignalLike;\n\n /**\n * The proposed customer shipping address. During the information step, the address\n * updates when the field is committed (on change) rather than every keystroke.\n * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n shippingAddress?: SubscribableSignalLike;\n\n /**\n * The proposed customer billing address. The address updates when the field is\n * committed (on change) rather than every keystroke. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided yet.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n billingAddress?: SubscribableSignalLike;\n\n /**\n * The store where the checkout is taking place, including the shop name,\n * storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.\n */\n shop: Shop;\n\n /**\n * Key-value storage that persists across page loads within the current checkout\n * session. Data is shared across all activated targets associated with\n * this extension.\n *\n * > Caution: Data persistence isn't guaranteed and storage is cleared when the\n * buyer starts a new checkout.\n */\n storage: Storage;\n\n /**\n * The renderer version being used for the extension.\n *\n * @example '2025-10'\n */\n version: Version;\n\n /**\n * Customer privacy consent settings and a flag denoting if consent has previously been collected.\n */\n customerPrivacy: SubscribableSignalLike;\n\n /**\n * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`collect_buyer_consent` capability](/docs/apps/build/customer-accounts/capabilities#collect-buyer-consent) to be set to `true`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyTrackingConsentChange: ApplyTrackingConsentChangeType;\n\n /**\n * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" }, "Analytics": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Analytics", - "description": "", + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "publish", "value": "(name: string, data: Record) => Promise", - "description": "Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing)." + "description": "Publishes a custom event to [Web Pixels](/docs/apps/marketing). Returns `true` when the event is successfully dispatched.\n\nThe Promise resolves to `true` when the event was dispatched. The boolean indicates dispatch confirmation only. It doesn't indicate whether any specific web pixel processed the event." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "visitor", "value": "(data: { email?: string; phone?: string; }) => Promise", - "description": "A method for capturing details about a visitor on the online store." + "description": "Submits buyer contact details for attribution and analytics purposes." } ], - "value": "export interface Analytics {\n /**\n * Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing).\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * A method for capturing details about a visitor on the online store.\n */\n visitor(data: {email?: string; phone?: string}): Promise;\n}" + "value": "export interface Analytics {\n /**\n * Publishes a custom event to [Web Pixels](/docs/apps/marketing).\n * Returns `true` when the event is successfully dispatched.\n *\n * The Promise resolves to `true` when the event was dispatched. The boolean\n * indicates dispatch confirmation only. It doesn't indicate whether any\n * specific web pixel processed the event.\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * Submits buyer contact details for attribution and analytics purposes.\n */\n visitor(data: {email?: string; phone?: string}): Promise;\n}" }, "VisitorResult": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -160426,10 +160426,10 @@ "syntaxKind": "PropertySignature", "name": "type", "value": "'error'", - "description": "Indicates that the visitor information is invalid and wasn't submitted. Examples are using the wrong data type or missing a required property." + "description": "Indicates that the visitor information is invalid and wasn't submitted. Common causes include using the wrong data type or omitting a required property." } ], - "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Examples are using the wrong data type or missing a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Common causes include using the wrong data type or omitting a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" }, "SubscribableSignalLike": { "filePath": "src/surfaces/checkout/shared.ts", @@ -160643,10 +160643,10 @@ "syntaxKind": "PropertySignature", "name": "value", "value": "string | null", - "description": "The new value to store in the metafield. Set to `null` to delete the metafield." + "description": "The new value to store in the metafield. Set to `null` to delete the metafield.\n\nConsent metafield values are strings, not booleans. Pass `null` to delete a tracking consent metafield." } ], - "value": "export interface TrackingConsentMetafieldChange {\n /**\n * The identifier for the tracking consent metafield to update.\n */\n key: string;\n /**\n * The new value to store in the metafield. Set to `null` to delete the metafield.\n */\n value: string | null;\n}" + "value": "export interface TrackingConsentMetafieldChange {\n /**\n * The identifier for the tracking consent metafield to update.\n */\n key: string;\n /**\n * The new value to store in the metafield. Set to `null` to delete the metafield.\n *\n * Consent metafield values are strings, not booleans. Pass `null` to delete\n * a tracking consent metafield.\n */\n value: string | null;\n}" }, "VisitorConsent": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -160860,7 +160860,7 @@ "syntaxKind": "PropertySignature", "name": "value", "value": "string", - "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.", + "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.\n\nAttribute values are always strings. To store structured data, serialize it to JSON and parse it when reading.", "examples": [ { "title": "Example", @@ -160875,7 +160875,7 @@ ] } ], - "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" + "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * Attribute values are always strings. To store structured data, serialize\n * it to JSON and parse it when reading.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" }, "PaymentOption": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -161226,7 +161226,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A globally-unique identifier for the customer in the format `gid://shopify/Customer/`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", + "description": "An identifier for the customer in the format `gid://shopify/Customer/`. This value is unique per shop.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", "examples": [ { "title": "Example", @@ -161279,7 +161279,7 @@ "isPrivate": true } ], - "value": "export interface Customer {\n /**\n * A globally-unique identifier for the customer in the format `gid://shopify/Customer/`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'gid://shopify/Customer/123'\n */\n id: string;\n /**\n * The email address associated with the customer's account. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email?: string;\n /**\n * The phone number associated with the customer's account. The value is `undefined` if no phone number is on file or the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone?: string;\n /**\n * The customer's full name, typically a combination of first and last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n fullName?: string;\n /**\n * The customer's first name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n firstName?: string;\n /**\n * The customer's last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n lastName?: string;\n /**\n * The customer's profile image, such as a Gravatar avatar. Use this to personalize the extension UI for the logged-in buyer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n image: ImageDetails;\n /**\n * Whether the customer has opted in to receiving marketing communications from the merchant, such as email campaigns and promotional offers.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * > Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n *\n * @deprecated Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n */\n acceptsMarketing: boolean;\n /**\n * Whether the customer has opted in to email marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsEmailMarketing: boolean;\n /**\n * Whether the customer has opted in to SMS marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsSmsMarketing: boolean;\n /**\n * The store credit accounts owned by this customer that can be used as payment during checkout. Each account has a balance representing available store credit.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @private\n */\n storeCreditAccounts: StoreCreditAccount[];\n /**\n * The number of orders the customer has previously placed with this shop.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n ordersCount: number;\n}" + "value": "export interface Customer {\n /**\n * An identifier for the customer in the format `gid://shopify/Customer/`. This value is unique per shop.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'gid://shopify/Customer/123'\n */\n id: string;\n /**\n * The email address associated with the customer's account. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email?: string;\n /**\n * The phone number associated with the customer's account. The value is `undefined` if no phone number is on file or the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone?: string;\n /**\n * The customer's full name, typically a combination of first and last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n fullName?: string;\n /**\n * The customer's first name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n firstName?: string;\n /**\n * The customer's last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n lastName?: string;\n /**\n * The customer's profile image, such as a Gravatar avatar. Use this to personalize the extension UI for the logged-in buyer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n image: ImageDetails;\n /**\n * Whether the customer has opted in to receiving marketing communications from the merchant, such as email campaigns and promotional offers.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * > Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n *\n * @deprecated Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n */\n acceptsMarketing: boolean;\n /**\n * Whether the customer has opted in to email marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsEmailMarketing: boolean;\n /**\n * Whether the customer has opted in to SMS marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsSmsMarketing: boolean;\n /**\n * The store credit accounts owned by this customer that can be used as payment during checkout. Each account has a balance representing available store credit.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @private\n */\n storeCreditAccounts: StoreCreditAccount[];\n /**\n * The number of orders the customer has previously placed with this shop.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n ordersCount: number;\n}" }, "ImageDetails": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -161561,11 +161561,11 @@ "syntaxKind": "MethodSignature", "name": "perform", "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", + "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.\n\nRuns after all intercept results are collected. Use it for local state updates such as setting an error flag. By the time it runs, the navigation decision is final, so blocking logic belongs in the intercept handler itself, not here.", "isOptional": true } ], - "value": "interface InterceptorRequestAllow {\n /**\n * Indicates that the interceptor allows the buyer's journey to continue.\n */\n behavior: 'allow';\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" + "value": "interface InterceptorRequestAllow {\n /**\n * Indicates that the interceptor allows the buyer's journey to continue.\n */\n behavior: 'allow';\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n *\n * Runs after all intercept results are collected. Use it for local state\n * updates such as setting an error flag. By the time it runs, the navigation\n * decision is final, so blocking logic belongs in the intercept handler\n * itself, not here.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" }, "InterceptorResult": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -161629,7 +161629,7 @@ "syntaxKind": "MethodSignature", "name": "perform", "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", + "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.\n\nRuns after all intercept results are collected. Use it for local state updates such as setting an error flag. By the time it runs, the navigation decision is final, so blocking logic belongs in the intercept handler itself, not here.", "isOptional": true }, { @@ -161640,7 +161640,7 @@ "description": "The reason for blocking the interceptor request. This value isn't presented to the buyer, so it doesn't need to be localized. The value is used only for Shopify's own internal debugging and metrics." } ], - "value": "interface InterceptorRequestBlock {\n /**\n * Indicates that the interceptor blocks the buyer's journey from continuing.\n */\n behavior: 'block';\n\n /**\n * The reason for blocking the interceptor request. This value isn't presented to\n * the buyer, so it doesn't need to be localized. The value is used only for Shopify's\n * own internal debugging and metrics.\n */\n reason: string;\n\n /**\n * Used to pass errors to the checkout UI, outside your extension's UI boundaries.\n */\n errors?: ValidationError[];\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" + "value": "interface InterceptorRequestBlock {\n /**\n * Indicates that the interceptor blocks the buyer's journey from continuing.\n */\n behavior: 'block';\n\n /**\n * The reason for blocking the interceptor request. This value isn't presented to\n * the buyer, so it doesn't need to be localized. The value is used only for Shopify's\n * own internal debugging and metrics.\n */\n reason: string;\n\n /**\n * Used to pass errors to the checkout UI, outside your extension's UI boundaries.\n */\n errors?: ValidationError[];\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n *\n * Runs after all intercept results are collected. Use it for local state\n * updates such as setting an error flag. By the time it runs, the navigation\n * decision is final, so blocking logic belongs in the intercept handler\n * itself, not here.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" }, "ValidationError": { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -161861,17 +161861,17 @@ "syntaxKind": "PropertySignature", "name": "totalShippingAmount", "value": "SubscribableSignalLike", - "description": "The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step." + "description": "The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step.\n\n`undefined` until the buyer selects a shipping method (typically after the information step)." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "totalTaxAmount", "value": "SubscribableSignalLike", - "description": "The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet." + "description": "The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet.\n\n`undefined` when taxes haven't been calculated or aren't available for the buyer's region." } ], - "value": "export interface CartCost {\n /**\n * The sum of all line item prices at the current step of checkout, before shipping and taxes are applied. Use this value to display the base cost of the items the buyer purchased.\n */\n subtotalAmount: SubscribableSignalLike;\n\n /**\n * The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step.\n */\n totalShippingAmount: SubscribableSignalLike;\n\n /**\n * The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet.\n */\n totalTaxAmount: SubscribableSignalLike;\n\n /**\n * The minimum total at the current step of checkout. Costs not yet calculated, such as shipping on the information step, aren't included. Gift cards and store credits are excluded from this total.\n */\n totalAmount: SubscribableSignalLike;\n}" + "value": "export interface CartCost {\n /**\n * The sum of all line item prices at the current step of checkout, before shipping and taxes are applied. Use this value to display the base cost of the items the buyer purchased.\n */\n subtotalAmount: SubscribableSignalLike;\n\n /**\n * The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step.\n *\n * `undefined` until the buyer selects a shipping method (typically after the\n * information step).\n */\n totalShippingAmount: SubscribableSignalLike;\n\n /**\n * The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet.\n *\n * `undefined` when taxes haven't been calculated or aren't available for the\n * buyer's region.\n */\n totalTaxAmount: SubscribableSignalLike;\n\n /**\n * The minimum total at the current step of checkout. Costs not yet calculated, such as shipping on the information step, aren't included. Gift cards and store credits are excluded from this total.\n */\n totalAmount: SubscribableSignalLike;\n}" }, "CustomerPrivacy": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -161958,31 +161958,31 @@ "syntaxKind": "PropertySignature", "name": "analytics", "value": "boolean", - "description": "Whether analytics data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Analytics data includes how the shop was used and what interactions occurred." + "description": "Whether analytics data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Analytics data includes how the shop was used and what interactions occurred.\n\nWhether analytics data can be collected right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.analytics`, before calling `shopify.analytics.publish()`." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "marketing", "value": "boolean", - "description": "Whether marketing data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Marketing data includes attribution and targeted advertising preferences." + "description": "Whether marketing data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Marketing data includes attribution and targeted advertising preferences.\n\nWhether marketing data can be collected right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.marketing`, before performing marketing-related data collection." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "preferences", "value": "boolean", - "description": "Whether preference data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Preference data includes language, currency, and sizing choices." + "description": "Whether preference data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Preference data includes language, currency, and sizing choices.\n\nWhether preference data can be collected right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.preferences`, before storing or reading buyer preference data." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "saleOfData", "value": "boolean", - "description": "Whether data can be shared with third parties based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. This typically applies to behavioral advertising data." + "description": "Whether data can be shared with third parties based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. This typically applies to behavioral advertising data.\n\nWhether buyer data can be shared with or sold to third parties right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.saleOfData`, before sharing or selling buyer data with third parties." } ], - "value": "export interface AllowedProcessing {\n /**\n * Whether analytics data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Analytics\n * data includes how the shop was used and what interactions occurred.\n */\n analytics: boolean;\n /**\n * Whether marketing data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Marketing\n * data includes attribution and targeted advertising preferences.\n */\n marketing: boolean;\n /**\n * Whether preference data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Preference\n * data includes language, currency, and sizing choices.\n */\n preferences: boolean;\n /**\n * Whether data can be shared with third parties based on the visitor's\n * consent, the merchant's privacy configuration, and the visitor's region.\n * This typically applies to behavioral advertising data.\n */\n saleOfData: boolean;\n}" + "value": "export interface AllowedProcessing {\n /**\n * Whether analytics data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Analytics\n * data includes how the shop was used and what interactions occurred.\n *\n * Whether analytics data can be collected right now. Combines the buyer's\n * consent, the merchant's privacy configuration, and the buyer's region into\n * a single boolean. Check this flag, not `visitorConsent.analytics`, before\n * calling `shopify.analytics.publish()`.\n */\n analytics: boolean;\n /**\n * Whether marketing data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Marketing\n * data includes attribution and targeted advertising preferences.\n *\n * Whether marketing data can be collected right now. Combines the buyer's\n * consent, the merchant's privacy configuration, and the buyer's region into\n * a single boolean. Check this flag, not `visitorConsent.marketing`, before\n * performing marketing-related data collection.\n */\n marketing: boolean;\n /**\n * Whether preference data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Preference\n * data includes language, currency, and sizing choices.\n *\n * Whether preference data can be collected right now. Combines the buyer's\n * consent, the merchant's privacy configuration, and the buyer's region into\n * a single boolean. Check this flag, not `visitorConsent.preferences`,\n * before storing or reading buyer preference data.\n */\n preferences: boolean;\n /**\n * Whether data can be shared with third parties based on the visitor's\n * consent, the merchant's privacy configuration, and the visitor's region.\n * This typically applies to behavioral advertising data.\n *\n * Whether buyer data can be shared with or sold to third parties right now.\n * Combines the buyer's consent, the merchant's privacy configuration, and\n * the buyer's region into a single boolean. Check this flag, not\n * `visitorConsent.saleOfData`, before sharing or selling buyer data with\n * third parties.\n */\n saleOfData: boolean;\n}" }, "TrackingConsentMetafield": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -162674,7 +162674,7 @@ "Extension": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Extension", - "description": "The meta information about an extension target.", + "description": "Metadata about the running extension, including its API version, target, capabilities, and editor context. Use this to read configuration details or conditionally render content based on where the extension is running.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -162700,7 +162700,7 @@ "syntaxKind": "PropertySignature", "name": "capabilities", "value": "SubscribableSignalLike", - "description": "The allowed capabilities of the extension, defined in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n\n* [`api_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#api-access): the extension can access the Storefront API.\n\n* [`network_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access): the extension can make external network calls.\n\n* [`block_progress`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n\n* [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n\n* [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can register customer consent decisions that are honored on Shopify-managed services.\n\n* [`iframe.sources`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#iframe): the extension can embed an external URL in an iframe." + "description": "The allowed capabilities of the extension, defined in your [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -162748,7 +162748,7 @@ "syntaxKind": "PropertySignature", "name": "version", "value": "string", - "description": "The published version of the running extension target.\n\nFor unpublished extensions, the value is `undefined`.", + "description": "The published version of the running extension target.\n\nFor unpublished extensions, the value is `undefined`.\n\nDon't use this property as a stable identifier in development environments. It becomes available only after the extension is published.", "isOptional": true, "examples": [ { @@ -162764,7 +162764,7 @@ ] } ], - "value": "export interface Extension {\n /**\n * The API version that was set in the extension config file.\n *\n * @example '2024-10', '2025-01', '2025-04', '2025-07', '2025-10'\n */\n apiVersion: ApiVersion;\n\n /**\n * The allowed capabilities of the extension, defined\n * in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n *\n * * [`api_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#api-access): the extension can access the Storefront API.\n *\n * * [`network_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access): the extension can make external network calls.\n *\n * * [`block_progress`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n *\n * * [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n *\n * * [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can register customer consent decisions that are honored on Shopify-managed services.\n *\n * * [`iframe.sources`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#iframe): the extension can embed an external URL in an iframe.\n */\n capabilities: SubscribableSignalLike;\n\n /**\n * Information about the editor where the extension is being rendered.\n *\n * If the value is undefined, then the extension isn't running in an editor.\n */\n editor?: Editor;\n\n /**\n * A Boolean to show whether your extension is currently rendered to the screen.\n *\n * Shopify might render your extension before it's visible in the UI,\n * typically to pre-render extensions that appear on a later step of the\n * checkout.\n *\n * Your extension might also continue to run after the customer has navigated away\n * from where it was rendered. The extension continues running so that\n * your extension is immediately available to render if the customer navigates back.\n */\n rendered: SubscribableSignalLike;\n\n /**\n * The URL to the script that started the extension target.\n */\n scriptUrl: string;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n */\n target: Target;\n\n /**\n * The published version of the running extension target.\n *\n * For unpublished extensions, the value is `undefined`.\n *\n * @example 3.0.10\n */\n version?: string;\n}" + "value": "export interface Extension {\n /**\n * The API version that was set in the extension config file.\n *\n * @example '2024-10', '2025-01', '2025-04', '2025-07', '2025-10'\n */\n apiVersion: ApiVersion;\n\n /**\n * The allowed capabilities of the extension, defined in your\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n */\n capabilities: SubscribableSignalLike;\n\n /**\n * Information about the editor where the extension is being rendered.\n *\n * If the value is undefined, then the extension isn't running in an editor.\n */\n editor?: Editor;\n\n /**\n * A Boolean to show whether your extension is currently rendered to the screen.\n *\n * Shopify might render your extension before it's visible in the UI,\n * typically to pre-render extensions that appear on a later step of the\n * checkout.\n *\n * Your extension might also continue to run after the customer has navigated away\n * from where it was rendered. The extension continues running so that\n * your extension is immediately available to render if the customer navigates back.\n */\n rendered: SubscribableSignalLike;\n\n /**\n * The URL to the script that started the extension target.\n */\n scriptUrl: string;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n */\n target: Target;\n\n /**\n * The published version of the running extension target.\n *\n * For unpublished extensions, the value is `undefined`.\n *\n * Don't use this property as a stable identifier in development environments.\n * It becomes available only after the extension is published.\n *\n * @example 3.0.10\n */\n version?: string;\n}" }, "ApiVersion": { "filePath": "src/shared.ts", @@ -162783,7 +162783,7 @@ "Editor": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Editor", - "description": "", + "description": "Information about the editor environment when an extension is rendered inside the checkout editor. The value is `undefined` when the extension is not rendering in an editor.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -162798,7 +162798,7 @@ "I18n": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18n", - "description": "", + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use the I18n API alongside the Localization API to build fully localized extensions.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -162834,7 +162834,7 @@ "I18nTranslate": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18nTranslate", - "description": "This returns a translated string matching a key in a locale file.", + "description": "Translates a key from your extension's locale files into a localized string. Supports interpolation with placeholder replacements and pluralization via the special `count` option.", "members": [], "value": "export interface I18nTranslate {\n (\n key: string,\n options?: Record,\n ): ReplacementType extends string | number\n ? string\n : (string | ReplacementType)[];\n}" }, @@ -163398,14 +163398,14 @@ "Localization": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Localization", - "description": "", + "description": "The buyer's language, country, currency, and timezone context. Use this to adapt your extension to the buyer's region and display localized content.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "country", "value": "SubscribableSignalLike", - "description": "The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown." + "description": "The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n\nDerived from the buyer's shipping address. Returns `undefined` until the buyer enters a shipping address." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -163433,18 +163433,18 @@ "syntaxKind": "PropertySignature", "name": "market", "value": "SubscribableSignalLike", - "description": "The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n\n> Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.", - "deprecationMessage": "Deprecated as of version `2025-04`" + "description": "The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. The market context updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.", + "deprecationMessage": "Merchants now manage which extensions load for each\nmarket, so extensions no longer need to check this value." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "timezone", "value": "SubscribableSignalLike", - "description": "The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time." + "description": "The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time." } ], - "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n *\n * > Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" + "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n *\n * Derived from the buyer's shipping address. Returns `undefined` until the\n * buyer enters a shipping address.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout,\n * carried over from the cart context. Markets group countries and\n * regions with shared pricing, languages, and domains. The market\n * context updates when the buyer changes the country of their\n * shipping address. The value is `undefined` if the market is unknown.\n *\n * @deprecated Merchants now manage which extensions load for each\n * market, so extensions no longer need to check this value.\n */\n market: SubscribableSignalLike;\n}" }, "Country": { "filePath": "src/shared.ts", @@ -163645,7 +163645,7 @@ "SessionToken": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SessionToken", - "description": "", + "description": "Authenticates requests between your extension and your app backend. Use session tokens to verify the identity of the buyer and the shop context when making server-side API calls. The token is a signed JWT that contains claims such as the customer ID, shop domain, and expiration.\n\nThe `sub` claim in the decoded token is present only when the buyer is logged in and the app has permission to read customer accounts. Absent for anonymous buyers.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -163904,7 +163904,7 @@ "Shop": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Shop", - "description": "", + "description": "Metadata about the merchant's store, including its name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -163944,30 +163944,30 @@ "syntaxKind": "PropertySignature", "name": "storefrontUrl", "value": "string", - "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n\n> Caution: > As of version `2024-04` this value no longer has a trailing slash.", + "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.", "isOptional": true } ], - "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n *\n * > Caution:\n * > As of version `2024-04` this value no longer has a trailing slash.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom domain.\n */\n myshopifyDomain: string;\n}" + "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom domain.\n */\n myshopifyDomain: string;\n}" }, "Storage": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Storage", - "description": "A key-value storage object for the extension.\n\nStored data is available only to this specific extension and any of its instances.\n\nThe storage backend is implemented with `localStorage` and should persist across the buyer's checkout session. However, data persistence isn't guaranteed.", + "description": "Key-value storage for a specific extension. Use storage to save preferences or cached data that should survive page reloads without requiring a backend call. Stored data is only available to this specific extension. The storage backend is implemented with `localStorage` and data persistence isn't guaranteed.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "delete", "value": "(key: string) => Promise", - "description": "Delete stored data by key." + "description": "Deletes a previously stored value by key." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "read", "value": "(key: string) => Promise", - "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original primitive.\n\nReturns `null` if no stored data exists." + "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original type.\n\nReturns the stored value for the given key, or `null` when no value exists. Doesn't throw on a missing key." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -163977,7 +163977,7 @@ "description": "Write stored data for this key.\n\nThe data must be serializable to JSON." } ], - "value": "export interface Storage {\n /**\n * Read and return a stored value by key.\n *\n * The stored data is deserialized from JSON and returned as\n * its original primitive.\n *\n * Returns `null` if no stored data exists.\n */\n read(key: string): Promise;\n\n /**\n * Write stored data for this key.\n *\n * The data must be serializable to JSON.\n */\n write(key: string, data: any): Promise;\n\n /**\n * Delete stored data by key.\n */\n delete(key: string): Promise;\n}" + "value": "export interface Storage {\n /**\n * Read and return a stored value by key.\n *\n * The stored data is deserialized from JSON and returned as\n * its original type.\n *\n * Returns the stored value for the given key, or `null` when no value\n * exists. Doesn't throw on a missing key.\n */\n read(key: string): Promise;\n\n /**\n * Write stored data for this key.\n *\n * The data must be serializable to JSON.\n */\n write(key: string, data: any): Promise;\n\n /**\n * Deletes a previously stored value by key.\n */\n delete(key: string): Promise;\n}" }, "Version": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -164977,7 +164977,7 @@ "syntaxKind": "MethodSignature", "name": "applyAttributeChange", "value": "(change: AttributeChange) => Promise", - "description": "Updates or removes an attribute on the cart and checkout. On success, the [`attributes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/attributes#standardapi-propertydetail-attributes) property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.", + "description": "Updates or removes an attribute on the cart and checkout. On success, the [`attributes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/attributes#properties-propertydetail-attributes) property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.", "deprecationMessage": "Use cart metafields instead." }, { @@ -164985,42 +164985,42 @@ "syntaxKind": "MethodSignature", "name": "applyCartLinesChange", "value": "(change: CartLineChange) => Promise", - "description": "Adds, removes, or updates line items in the cart. The returned promise resolves when the change has been applied by the server, and the [`lines`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-lines#standardapi-propertydetail-lines) property updates with the new state.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Adds, removes, or updates line items in the cart. The returned promise resolves when the change has been applied by the server, and the [`lines`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-lines#properties-propertydetail-lines) property updates with the new state.\n\nAccepts a single change per call. To make multiple changes, call this method separately for each one.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyDiscountCodeChange", "value": "(change: DiscountCodeChange) => Promise", - "description": "Adds or removes a discount code on the checkout. The returned promise resolves when the change has been applied by the server, and the [`discountCodes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/discounts#standardapi-propertydetail-discountcodes) property updates with the new state.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves discount codes through a network call.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Adds or removes a discount code on the checkout. The returned promise resolves when the change has been applied by the server, and the [`discountCodes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/discounts#properties-propertydetail-discountcodes) property updates with the new state.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves discount codes through a network call.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyGiftCardChange", "value": "(change: GiftCardChange) => Promise", - "description": "Adds or removes a gift card from the checkout. The returned promise resolves when the change has been applied by the server, and the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/gift-cards#standardapi-propertydetail-appliedgiftcards) property updates with the new state.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves gift card codes through a network call.\n\n> Note: This method returns an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Adds or removes a gift card from the checkout. The returned promise resolves when the change has been applied by the server, and the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/gift-cards#properties-propertydetail-appliedgiftcards) property updates with the new state.\n\nUnlike other write operations, gift card changes aren't gated by a cart instruction flag.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves gift card codes through a network call.\n\n> Note: This method returns an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyMetafieldChange", "value": "(change: MetafieldChange) => Promise", - "description": "Creates, updates, or removes a cart metafield on the checkout. On success, the [`metafields`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/metafields#standardapi-propertydetail-metafields) property updates to reflect the change.\n\nCart metafields are copied to order metafields at order creation time if there's a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n\n> Caution: `MetafieldRemoveChange` and `MetafieldUpdateChange` are deprecated. Use cart metafields with `MetafieldRemoveCartChange` and `MetafieldUpdateCartChange` instead. If `MetafieldUpdateChange` writes a metafield with the same namespace and key as a cart metafield that's configured to copy, the cart metafield won't be copied.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Creates, updates, or removes a cart metafield on the checkout. On success, the [`metafields`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/metafields#properties-propertydetail-metafields) property updates to reflect the change.\n\nCart metafields are copied to order metafields at order creation time if there's a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n\n> Caution: `MetafieldRemoveChange` and `MetafieldUpdateChange` are deprecated. Use cart metafields with `MetafieldRemoveCartChange` and `MetafieldUpdateCartChange` instead. If `MetafieldUpdateChange` writes a metafield with the same namespace and key as a cart metafield that's configured to copy, the cart metafield won't be copied.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyNoteChange", "value": "(change: NoteChange) => Promise", - "description": "Sets or removes the buyer's note on the checkout. On success, the [`note`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/note#standardapi-propertydetail-note) property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Sets or removes the buyer's note on the checkout. On success, the [`note`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/note#properties-propertydetail-note) property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyShippingAddressChange", "value": "(change: ShippingAddressUpdateChange) => Promise", - "description": "Updates the buyer's shipping address on the checkout. The provided fields are merged into the existing address without prompting the buyer. On success, the `shippingAddress` property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", + "description": "Updates the buyer's shipping address on the checkout. The provided fields are merged into the existing address without prompting the buyer. On success, the `shippingAddress` property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", "isOptional": true }, { @@ -165033,7 +165033,7 @@ "isPrivate": true } ], - "value": "export interface CheckoutApi {\n /**\n * Updates or removes an attribute on the cart and checkout. On success, the\n * [`attributes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/attributes#standardapi-propertydetail-attributes) property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * @deprecated Use cart metafields instead.\n */\n applyAttributeChange(change: AttributeChange): Promise;\n\n /**\n * Adds, removes, or updates line items in the cart. The returned promise resolves when the change has been applied by the server, and the [`lines`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-lines#standardapi-propertydetail-lines) property updates with the new state.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyCartLinesChange(change: CartLineChange): Promise;\n\n /**\n * Adds or removes a discount code on the checkout. The returned promise resolves when the change has been applied by the server, and the [`discountCodes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/discounts#standardapi-propertydetail-discountcodes) property updates with the new state.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves discount codes through a network call.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyDiscountCodeChange(\n change: DiscountCodeChange,\n ): Promise;\n\n /**\n * Adds or removes a gift card from the checkout. The returned promise resolves when the change has been applied by the server, and the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/gift-cards#standardapi-propertydetail-appliedgiftcards) property updates with the new state.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves gift card codes through a network call.\n *\n * > Note: This method returns an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyGiftCardChange(change: GiftCardChange): Promise;\n\n /**\n * Creates, updates, or removes a cart metafield on the checkout. On success, the\n * [`metafields`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/metafields#standardapi-propertydetail-metafields) property updates to reflect the change.\n *\n * Cart metafields are copied to order metafields at order creation time if there's a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n *\n * > Caution: `MetafieldRemoveChange` and `MetafieldUpdateChange` are deprecated. Use cart metafields with `MetafieldRemoveCartChange` and `MetafieldUpdateCartChange` instead. If `MetafieldUpdateChange` writes a metafield with the same namespace and key as a cart metafield that's configured to copy, the cart metafield won't be copied.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyMetafieldChange(change: MetafieldChange): Promise;\n\n /**\n * Sets or removes the buyer's note on the checkout. On success, the\n * [`note`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/note#standardapi-propertydetail-note)\n * property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyNoteChange(change: NoteChange): Promise;\n\n /**\n * @private\n */\n experimentalIsShopAppStyle?: boolean;\n\n /**\n * Updates the buyer's shipping address on the checkout. The provided fields\n * are merged into the existing address without prompting the buyer. On success,\n * the `shippingAddress` property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyShippingAddressChange?(\n change: ShippingAddressChange,\n ): Promise;\n}" + "value": "export interface CheckoutApi {\n /**\n * Updates or removes an attribute on the cart and checkout. On success, the\n * [`attributes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/attributes#properties-propertydetail-attributes) property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * @deprecated Use cart metafields instead.\n */\n applyAttributeChange(change: AttributeChange): Promise;\n\n /**\n * Adds, removes, or updates line items in the cart. The returned promise resolves when the change has been applied by the server, and the [`lines`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-lines#properties-propertydetail-lines) property updates with the new state.\n *\n * Accepts a single change per call. To make multiple changes, call this\n * method separately for each one.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyCartLinesChange(change: CartLineChange): Promise;\n\n /**\n * Adds or removes a discount code on the checkout. The returned promise resolves when the change has been applied by the server, and the [`discountCodes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/discounts#properties-propertydetail-discountcodes) property updates with the new state.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves discount codes through a network call.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyDiscountCodeChange(\n change: DiscountCodeChange,\n ): Promise;\n\n /**\n * Adds or removes a gift card from the checkout. The returned promise resolves when the change has been applied by the server, and the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/gift-cards#properties-propertydetail-appliedgiftcards) property updates with the new state.\n *\n * Unlike other write operations, gift card changes aren't gated by a cart\n * instruction flag.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves gift card codes through a network call.\n *\n * > Note: This method returns an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyGiftCardChange(change: GiftCardChange): Promise;\n\n /**\n * Creates, updates, or removes a cart metafield on the checkout. On success, the\n * [`metafields`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/metafields#properties-propertydetail-metafields) property updates to reflect the change.\n *\n * Cart metafields are copied to order metafields at order creation time if there's a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n *\n * > Caution: `MetafieldRemoveChange` and `MetafieldUpdateChange` are deprecated. Use cart metafields with `MetafieldRemoveCartChange` and `MetafieldUpdateCartChange` instead. If `MetafieldUpdateChange` writes a metafield with the same namespace and key as a cart metafield that's configured to copy, the cart metafield won't be copied.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyMetafieldChange(change: MetafieldChange): Promise;\n\n /**\n * Sets or removes the buyer's note on the checkout. On success, the\n * [`note`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/note#properties-propertydetail-note)\n * property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyNoteChange(change: NoteChange): Promise;\n\n /**\n * @private\n */\n experimentalIsShopAppStyle?: boolean;\n\n /**\n * Updates the buyer's shipping address on the checkout. The provided fields\n * are merged into the existing address without prompting the buyer. On success,\n * the `shippingAddress` property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyShippingAddressChange?(\n change: ShippingAddressChange,\n ): Promise;\n}" }, "AttributeChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -165100,7 +165100,7 @@ "syntaxKind": "PropertySignature", "name": "value", "value": "string", - "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.", + "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.\n\nAttribute values are always strings. To store structured data, serialize it to JSON and parse it when reading.", "examples": [ { "title": "Example", @@ -165115,7 +165115,7 @@ ] } ], - "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" + "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * Attribute values are always strings. To store structured data, serialize\n * it to JSON and parse it when reading.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" }, "AttributeRemoveChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -165968,7 +165968,7 @@ "syntaxKind": "PropertySignature", "name": "message", "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer." + "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer.\n\nRender your own localized error text rather than displaying this message to the buyer." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -165978,7 +165978,7 @@ "description": "Indicates that the line item wasn't changed successfully. Refer to the `message` property for details about the error." } ], - "value": "export interface CartLineChangeResultError {\n /**\n * Indicates that the line item wasn't changed successfully. Refer to the `message` property for details about the error.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface CartLineChangeResultError {\n /**\n * Indicates that the line item wasn't changed successfully. Refer to the `message` property for details about the error.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n *\n * Render your own localized error text rather than displaying this message\n * to the buyer.\n */\n message: string;\n}" }, "DiscountCodeChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -166158,7 +166158,7 @@ "syntaxKind": "PropertySignature", "name": "message", "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer." + "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer.\n\nRender your own localized error text rather than displaying this message to the buyer." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -166168,7 +166168,7 @@ "description": "Indicates that the gift card change couldn't be applied. Check the `message` property for details." } ], - "value": "export interface GiftCardChangeResultError {\n /**\n * Indicates that the gift card change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface GiftCardChangeResultError {\n /**\n * Indicates that the gift card change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n *\n * Render your own localized error text rather than displaying this message\n * to the buyer.\n */\n message: string;\n}" }, "MetafieldChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -166429,7 +166429,7 @@ "syntaxKind": "PropertySignature", "name": "message", "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer." + "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer.\n\nRender your own localized error text rather than displaying this message to the buyer." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -166439,7 +166439,7 @@ "description": "Indicates that the metafield change couldn't be applied. Check the `message` property for details." } ], - "value": "export interface MetafieldChangeResultError {\n /**\n * Indicates that the metafield change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface MetafieldChangeResultError {\n /**\n * Indicates that the metafield change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n *\n * Render your own localized error text rather than displaying this message\n * to the buyer.\n */\n message: string;\n}" }, "NoteChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -166517,7 +166517,7 @@ "syntaxKind": "PropertySignature", "name": "message", "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer." + "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer.\n\nRender your own localized error text rather than displaying this message to the buyer." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -166527,7 +166527,7 @@ "description": "Indicates that the note change couldn't be applied. Check the `message` property for details." } ], - "value": "export interface NoteChangeResultError {\n /**\n * Indicates that the note change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface NoteChangeResultError {\n /**\n * Indicates that the note change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n *\n * Render your own localized error text rather than displaying this message\n * to the buyer.\n */\n message: string;\n}" }, "ShippingAddressUpdateChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -167113,7 +167113,7 @@ "syntaxKind": "PropertySignature", "name": "analytics", "value": "Analytics", - "description": "The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event." + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -167127,7 +167127,7 @@ "syntaxKind": "PropertySignature", "name": "applyTrackingConsentChange", "value": "ApplyTrackingConsentChangeType", - "description": "Enables setting and updating customer privacy consent settings and tracking consent metafields.\n\n> Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent) to be set to `true`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." + "description": "Enables setting and updating customer privacy consent settings and tracking consent metafields.\n\n> Note: Requires the [`collect_buyer_consent` capability](/docs/apps/build/customer-accounts/capabilities#collect-buyer-consent) to be set to `true`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -167148,7 +167148,7 @@ "syntaxKind": "PropertySignature", "name": "availablePaymentOptions", "value": "SubscribableSignalLike", - "description": "All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region." + "description": "All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n\nThe set of payment options can change when the buyer updates their address or cart, so subscribe to changes rather than reading once during initialization. Each option exposes `handle` and `type` only. Provider names, logos, fees, and installment terms aren't available." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -167185,7 +167185,7 @@ "syntaxKind": "PropertySignature", "name": "checkoutToken", "value": "SubscribableSignalLike", - "description": "A stable ID that represents the current checkout.\n\nThe value is `undefined` when the checkout hasn't been created on the server yet.\n\nUse this to correlate checkout sessions across your extension, web pixels, and backend systems.\n\nThis matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data) and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object)." + "description": "A stable ID that represents the current checkout.\n\nThe value is `undefined` when the checkout hasn't been created on the server yet.\n\nUse this to correlate checkout sessions across your extension, web pixels, and backend systems.\n\nThis matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data) and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n\nCan be `undefined`. Handle the `undefined` state before using the value." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -167206,7 +167206,7 @@ "syntaxKind": "PropertySignature", "name": "deliveryGroups", "value": "SubscribableSignalLike", - "description": "The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items." + "description": "The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n\nEmpty until the buyer enters enough address information for Shopify to calculate shipping rates." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -167227,7 +167227,7 @@ "syntaxKind": "PropertySignature", "name": "extension", "value": "Extension", - "description": "The meta information about the extension." + "description": "Metadata about the running extension, including the current target, API version, capabilities, and editor context. Use this to conditionally render content based on where the extension is running." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -167235,7 +167235,7 @@ "name": "extensionPoint", "value": "Target", "description": "The identifier that specifies where in Shopify's UI your code is being injected. This is one of the targets you've included in your extension's configuration file.", - "deprecationMessage": "Deprecated as of version `2023-07`, use `extension.target` instead.", + "deprecationMessage": "Use `extension.target` instead.", "examples": [ { "title": "Example", @@ -167254,14 +167254,14 @@ "syntaxKind": "PropertySignature", "name": "i18n", "value": "I18n", - "description": "Utilities for translating content and formatting values according to the current [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) of the checkout.\n\nRefer to [`localization` examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples) for more information." + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use alongside [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) to build fully localized extensions." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "instructions", "value": "SubscribableSignalLike", - "description": "The cart instructions used to create the checkout and possibly limit extension capabilities.\n\nThese instructions should be checked before performing any actions that might be affected by them.\n\nFor example, if you intend to add a discount code via the `applyDiscountCodeChange` method, check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n\n> Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs aren't available. See the [update guide](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples) for more information." + "description": "The cart instructions used to create the checkout and possibly limit extension capabilities.\n\nThese instructions should be checked before performing any actions that might be affected by them.\n\nFor example, if you intend to add a discount code via the `applyDiscountCodeChange` method, check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n\n> Caution: Check cart instructions before calling select APIs, as > some may not be available. See the > [Cart Instructions API](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples) > for more information." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -167275,7 +167275,7 @@ "syntaxKind": "PropertySignature", "name": "localization", "value": "Localization", - "description": "The details about the location, language, and currency of the customer. For utilities to easily format and translate content based on these details, you can use the [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n) object instead." + "description": "The buyer's language, country, currency, and timezone context. For formatting and translation helpers, use the [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#properties-propertydetail-i18n) object instead." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -167305,21 +167305,21 @@ "syntaxKind": "PropertySignature", "name": "query", "value": ">(query: string, options?: { variables?: Variables; version?: StorefrontApiVersion; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>", - "description": "The method used to query the Storefront GraphQL API with a prefetched token.\n\nRefer to [Storefront API access examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/storefront-api) for more information." + "description": "The method used to query the Storefront GraphQL API with a prefetched token." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "selectedPaymentOptions", "value": "SubscribableSignalLike", - "description": "The payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card)." + "description": "The payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\n\nEach option exposes `handle` and `type` only. Provider names, logos, fees, and installment terms aren't available." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "sessionToken", "value": "SessionToken", - "description": "The session token providing a set of claims as a signed JSON Web Token (JWT).\n\nThe token has a TTL of five minutes.\n\nIf the previous token expires, this value reflects a new session token with a new signature and expiry.\n\nRefer to [session token examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/session-token) for more information." + "description": "The session token providing a set of claims as a signed JSON Web Token (JWT).\n\nThe token has a TTL of five minutes.\n\nIf the previous token expires, this value reflects a new session token with a new signature and expiry.\n\nLearn more about [session tokens](/docs/apps/build/authentication-authorization/session-tokens)." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -167341,14 +167341,14 @@ "syntaxKind": "PropertySignature", "name": "shop", "value": "Shop", - "description": "The shop where the checkout is taking place." + "description": "The store where the checkout is taking place, including the shop name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "storage", "value": "Storage", - "description": "The key-value storage for the extension.\n\nIt uses `localStorage` and should persist across the customer's current checkout session.\n\n> Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n\nData is shared across all activated extension targets of this extension. In versions 2023-07 and earlier, each activated extension target had its own storage." + "description": "Key-value storage that persists across page loads within the current checkout session. Data is shared across all activated targets associated with this extension.\n\n> Caution: Data persistence isn't guaranteed and storage is cleared when the buyer starts a new checkout." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -167370,29 +167370,29 @@ ] } ], - "value": "export interface StandardApi {\n /**\n * The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event.\n */\n analytics: Analytics;\n\n /**\n * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\n */\n appliedGiftCards: SubscribableSignalLike;\n\n /**\n * The cart instructions used to create the checkout and possibly limit extension capabilities.\n *\n * These instructions should be checked before performing any actions that might be affected by them.\n *\n * For example, if you intend to add a discount code via the `applyDiscountCodeChange` method,\n * check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n *\n * > Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs aren't available.\n * See the [update guide](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples) for more information.\n *\n */\n instructions: SubscribableSignalLike;\n\n /**\n * The metafields requested in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration)\n * file. These metafields are updated when there's a change in the merchandise items\n * being purchased by the customer.\n *\n * App owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` isn't supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n appMetafields: SubscribableSignalLike;\n\n /**\n * The custom key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n buyerIdentity?: BuyerIdentity;\n\n /**\n * Provides details on the buyer's progression through the checkout and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/buyer-journey#examples)\n * examples for more information.\n */\n buyerJourney: BuyerJourney;\n\n /**\n * Settings applied to the buyer's checkout.\n */\n checkoutSettings: SubscribableSignalLike;\n\n /**\n * A stable ID that represents the current checkout.\n *\n * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\n *\n * This matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data)\n * and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n */\n checkoutToken: SubscribableSignalLike;\n\n /**\n * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * The meta information about the extension.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n *\n * @deprecated Deprecated as of version `2023-07`, use `extension.target` instead.\n */\n extensionPoint: Target;\n\n /**\n * Utilities for translating content and formatting values according to the current\n * [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization)\n * of the checkout.\n *\n * Refer to [`localization` examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples)\n * for more information.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The details about the location, language, and currency of the customer. For utilities to easily\n * format and translate content based on these details, you can use the\n * [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n)\n * object instead.\n */\n localization: Localization;\n\n /**\n * The metafields that apply to the current checkout.\n *\n * Metafields are stored locally on the client and are applied to the order object after the checkout completes.\n *\n * These metafields are shared by all extensions running on checkout, and\n * persist for as long as the customer is working on this checkout.\n *\n * Once the order is created, you can query these metafields using the\n * [GraphQL Admin API](/docs/admin-api/graphql/reference/orders/order#metafield-2021-01)\n *\n * > Caution:\n * `metafields` is deprecated. Use `appMetafields` with cart metafields instead.\n *\n * @deprecated Use `appMetafields` with cart metafields instead.\n */\n metafields: SubscribableSignalLike;\n\n /**\n * A note left by the customer to the merchant, either in their cart or during checkout.\n *\n * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\n */\n note: SubscribableSignalLike;\n\n /**\n * The method used to query the Storefront GraphQL API with a prefetched token.\n *\n * Refer to [Storefront API access examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/storefront-api) for more information.\n */\n query: >(\n query: string,\n options?: {variables?: Variables; version?: StorefrontApiVersion},\n ) => Promise<{data?: Data; errors?: GraphQLError[]}>;\n\n /**\n * The payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\n */\n selectedPaymentOptions: SubscribableSignalLike;\n\n /**\n * The session token providing a set of claims as a signed JSON Web Token (JWT).\n *\n * The token has a TTL of five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/session-token) for more information.\n */\n sessionToken: SessionToken;\n\n /**\n * The settings matching the settings definition written in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates in real time as a merchant fills in the settings.\n */\n settings: SubscribableSignalLike;\n\n /**\n * The proposed customer shipping address. During the information step, the address\n * updates when the field is committed (on change) rather than every keystroke.\n * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n shippingAddress?: SubscribableSignalLike;\n\n /**\n * The proposed customer billing address. The address updates when the field is\n * committed (on change) rather than every keystroke. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided yet.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n billingAddress?: SubscribableSignalLike;\n\n /** The shop where the checkout is taking place. */\n shop: Shop;\n\n /**\n * The key-value storage for the extension.\n *\n * It uses `localStorage` and should persist across the customer's current checkout session.\n *\n * > Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n *\n * Data is shared across all activated extension targets of this extension. In versions 2023-07 and earlier,\n * each activated extension target had its own storage.\n */\n storage: Storage;\n\n /**\n * The renderer version being used for the extension.\n *\n * @example '2025-10'\n */\n version: Version;\n\n /**\n * Customer privacy consent settings and a flag denoting if consent has previously been collected.\n */\n customerPrivacy: SubscribableSignalLike;\n\n /**\n * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent) to be set to `true`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyTrackingConsentChange: ApplyTrackingConsentChangeType;\n\n /**\n * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" + "value": "export interface StandardApi {\n /**\n * Tracks custom events and sends visitor information to\n * [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events\n * and `visitor()` to submit buyer contact details.\n */\n analytics: Analytics;\n\n /**\n * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\n */\n appliedGiftCards: SubscribableSignalLike;\n\n /**\n * The cart instructions used to create the checkout and possibly limit extension capabilities.\n *\n * These instructions should be checked before performing any actions that might be affected by them.\n *\n * For example, if you intend to add a discount code via the `applyDiscountCodeChange` method,\n * check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n *\n * > Caution: Check cart instructions before calling select APIs, as\n * > some may not be available. See the\n * > [Cart Instructions API](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples)\n * > for more information.\n *\n */\n instructions: SubscribableSignalLike;\n\n /**\n * The metafields requested in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration)\n * file. These metafields are updated when there's a change in the merchandise items\n * being purchased by the customer.\n *\n * App owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` isn't supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n appMetafields: SubscribableSignalLike;\n\n /**\n * The custom key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as\n * credit cards, wallets, and local payment methods. The list depends on\n * the shop's payment configuration and the buyer's region.\n *\n * The set of payment options can change when the buyer updates their\n * address or cart, so subscribe to changes rather than reading once\n * during initialization. Each option exposes `handle` and `type` only.\n * Provider names, logos, fees, and installment terms aren't available.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n buyerIdentity?: BuyerIdentity;\n\n /**\n * Provides details on the buyer's progression through the checkout and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/buyer-journey#examples)\n * examples for more information.\n */\n buyerJourney: BuyerJourney;\n\n /**\n * Settings applied to the buyer's checkout.\n */\n checkoutSettings: SubscribableSignalLike;\n\n /**\n * A stable ID that represents the current checkout.\n *\n * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\n *\n * This matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data)\n * and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n *\n * Can be `undefined`. Handle the `undefined` state before using the value.\n */\n checkoutToken: SubscribableSignalLike;\n\n /**\n * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n *\n * Empty until the buyer enters enough address information for Shopify to\n * calculate shipping rates.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * Metadata about the running extension, including the current target, API version,\n * capabilities, and editor context. Use this to conditionally render content\n * based on where the extension is running.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n *\n * @deprecated Use `extension.target` instead.\n */\n extensionPoint: Target;\n\n /**\n * Utilities for translating strings, formatting currencies, numbers, and dates\n * according to the buyer's locale. Use alongside\n * [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization)\n * to build fully localized extensions.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The buyer's language, country, currency, and timezone context. For\n * formatting and translation helpers, use the\n * [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#properties-propertydetail-i18n)\n * object instead.\n */\n localization: Localization;\n\n /**\n * The metafields that apply to the current checkout.\n *\n * Metafields are stored locally on the client and are applied to the order object after the checkout completes.\n *\n * These metafields are shared by all extensions running on checkout, and\n * persist for as long as the customer is working on this checkout.\n *\n * Once the order is created, you can query these metafields using the\n * [GraphQL Admin API](/docs/admin-api/graphql/reference/orders/order#metafield-2021-01)\n *\n * > Caution:\n * `metafields` is deprecated. Use `appMetafields` with cart metafields instead.\n *\n * @deprecated Use `appMetafields` with cart metafields instead.\n */\n metafields: SubscribableSignalLike;\n\n /**\n * A note left by the customer to the merchant, either in their cart or during checkout.\n *\n * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\n */\n note: SubscribableSignalLike;\n\n /**\n * The method used to query the Storefront GraphQL API with a prefetched token.\n *\n */\n query: >(\n query: string,\n options?: {variables?: Variables; version?: StorefrontApiVersion},\n ) => Promise<{data?: Data; errors?: GraphQLError[]}>;\n\n /**\n * The payment options the buyer has currently selected. This updates as\n * the buyer changes their payment method. The array can contain multiple\n * entries when the buyer splits payment across methods (for example, a\n * gift card and a credit card).\n *\n * Each option exposes `handle` and `type` only. Provider names, logos,\n * fees, and installment terms aren't available.\n */\n selectedPaymentOptions: SubscribableSignalLike;\n\n /**\n * The session token providing a set of claims as a signed JSON Web Token (JWT).\n *\n * The token has a TTL of five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Learn more about [session tokens](/docs/apps/build/authentication-authorization/session-tokens).\n */\n sessionToken: SessionToken;\n\n /**\n * The settings matching the settings definition written in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates in real time as a merchant fills in the settings.\n */\n settings: SubscribableSignalLike;\n\n /**\n * The proposed customer shipping address. During the information step, the address\n * updates when the field is committed (on change) rather than every keystroke.\n * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n shippingAddress?: SubscribableSignalLike;\n\n /**\n * The proposed customer billing address. The address updates when the field is\n * committed (on change) rather than every keystroke. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided yet.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n billingAddress?: SubscribableSignalLike;\n\n /**\n * The store where the checkout is taking place, including the shop name,\n * storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.\n */\n shop: Shop;\n\n /**\n * Key-value storage that persists across page loads within the current checkout\n * session. Data is shared across all activated targets associated with\n * this extension.\n *\n * > Caution: Data persistence isn't guaranteed and storage is cleared when the\n * buyer starts a new checkout.\n */\n storage: Storage;\n\n /**\n * The renderer version being used for the extension.\n *\n * @example '2025-10'\n */\n version: Version;\n\n /**\n * Customer privacy consent settings and a flag denoting if consent has previously been collected.\n */\n customerPrivacy: SubscribableSignalLike;\n\n /**\n * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`collect_buyer_consent` capability](/docs/apps/build/customer-accounts/capabilities#collect-buyer-consent) to be set to `true`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyTrackingConsentChange: ApplyTrackingConsentChangeType;\n\n /**\n * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" }, "Analytics": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Analytics", - "description": "", + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "publish", "value": "(name: string, data: Record) => Promise", - "description": "Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing)." + "description": "Publishes a custom event to [Web Pixels](/docs/apps/marketing). Returns `true` when the event is successfully dispatched.\n\nThe Promise resolves to `true` when the event was dispatched. The boolean indicates dispatch confirmation only. It doesn't indicate whether any specific web pixel processed the event." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "visitor", "value": "(data: { email?: string; phone?: string; }) => Promise", - "description": "A method for capturing details about a visitor on the online store." + "description": "Submits buyer contact details for attribution and analytics purposes." } ], - "value": "export interface Analytics {\n /**\n * Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing).\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * A method for capturing details about a visitor on the online store.\n */\n visitor(data: {email?: string; phone?: string}): Promise;\n}" + "value": "export interface Analytics {\n /**\n * Publishes a custom event to [Web Pixels](/docs/apps/marketing).\n * Returns `true` when the event is successfully dispatched.\n *\n * The Promise resolves to `true` when the event was dispatched. The boolean\n * indicates dispatch confirmation only. It doesn't indicate whether any\n * specific web pixel processed the event.\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * Submits buyer contact details for attribution and analytics purposes.\n */\n visitor(data: {email?: string; phone?: string}): Promise;\n}" }, "VisitorResult": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -167433,10 +167433,10 @@ "syntaxKind": "PropertySignature", "name": "type", "value": "'error'", - "description": "Indicates that the visitor information is invalid and wasn't submitted. Examples are using the wrong data type or missing a required property." + "description": "Indicates that the visitor information is invalid and wasn't submitted. Common causes include using the wrong data type or omitting a required property." } ], - "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Examples are using the wrong data type or missing a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Common causes include using the wrong data type or omitting a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" }, "SubscribableSignalLike": { "filePath": "src/surfaces/checkout/shared.ts", @@ -167650,10 +167650,10 @@ "syntaxKind": "PropertySignature", "name": "value", "value": "string | null", - "description": "The new value to store in the metafield. Set to `null` to delete the metafield." + "description": "The new value to store in the metafield. Set to `null` to delete the metafield.\n\nConsent metafield values are strings, not booleans. Pass `null` to delete a tracking consent metafield." } ], - "value": "export interface TrackingConsentMetafieldChange {\n /**\n * The identifier for the tracking consent metafield to update.\n */\n key: string;\n /**\n * The new value to store in the metafield. Set to `null` to delete the metafield.\n */\n value: string | null;\n}" + "value": "export interface TrackingConsentMetafieldChange {\n /**\n * The identifier for the tracking consent metafield to update.\n */\n key: string;\n /**\n * The new value to store in the metafield. Set to `null` to delete the metafield.\n *\n * Consent metafield values are strings, not booleans. Pass `null` to delete\n * a tracking consent metafield.\n */\n value: string | null;\n}" }, "VisitorConsent": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -167867,7 +167867,7 @@ "syntaxKind": "PropertySignature", "name": "value", "value": "string", - "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.", + "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.\n\nAttribute values are always strings. To store structured data, serialize it to JSON and parse it when reading.", "examples": [ { "title": "Example", @@ -167882,7 +167882,7 @@ ] } ], - "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" + "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * Attribute values are always strings. To store structured data, serialize\n * it to JSON and parse it when reading.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" }, "PaymentOption": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -168233,7 +168233,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A globally-unique identifier for the customer in the format `gid://shopify/Customer/`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", + "description": "An identifier for the customer in the format `gid://shopify/Customer/`. This value is unique per shop.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", "examples": [ { "title": "Example", @@ -168286,7 +168286,7 @@ "isPrivate": true } ], - "value": "export interface Customer {\n /**\n * A globally-unique identifier for the customer in the format `gid://shopify/Customer/`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'gid://shopify/Customer/123'\n */\n id: string;\n /**\n * The email address associated with the customer's account. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email?: string;\n /**\n * The phone number associated with the customer's account. The value is `undefined` if no phone number is on file or the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone?: string;\n /**\n * The customer's full name, typically a combination of first and last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n fullName?: string;\n /**\n * The customer's first name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n firstName?: string;\n /**\n * The customer's last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n lastName?: string;\n /**\n * The customer's profile image, such as a Gravatar avatar. Use this to personalize the extension UI for the logged-in buyer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n image: ImageDetails;\n /**\n * Whether the customer has opted in to receiving marketing communications from the merchant, such as email campaigns and promotional offers.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * > Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n *\n * @deprecated Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n */\n acceptsMarketing: boolean;\n /**\n * Whether the customer has opted in to email marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsEmailMarketing: boolean;\n /**\n * Whether the customer has opted in to SMS marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsSmsMarketing: boolean;\n /**\n * The store credit accounts owned by this customer that can be used as payment during checkout. Each account has a balance representing available store credit.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @private\n */\n storeCreditAccounts: StoreCreditAccount[];\n /**\n * The number of orders the customer has previously placed with this shop.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n ordersCount: number;\n}" + "value": "export interface Customer {\n /**\n * An identifier for the customer in the format `gid://shopify/Customer/`. This value is unique per shop.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'gid://shopify/Customer/123'\n */\n id: string;\n /**\n * The email address associated with the customer's account. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email?: string;\n /**\n * The phone number associated with the customer's account. The value is `undefined` if no phone number is on file or the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone?: string;\n /**\n * The customer's full name, typically a combination of first and last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n fullName?: string;\n /**\n * The customer's first name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n firstName?: string;\n /**\n * The customer's last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n lastName?: string;\n /**\n * The customer's profile image, such as a Gravatar avatar. Use this to personalize the extension UI for the logged-in buyer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n image: ImageDetails;\n /**\n * Whether the customer has opted in to receiving marketing communications from the merchant, such as email campaigns and promotional offers.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * > Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n *\n * @deprecated Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n */\n acceptsMarketing: boolean;\n /**\n * Whether the customer has opted in to email marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsEmailMarketing: boolean;\n /**\n * Whether the customer has opted in to SMS marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsSmsMarketing: boolean;\n /**\n * The store credit accounts owned by this customer that can be used as payment during checkout. Each account has a balance representing available store credit.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @private\n */\n storeCreditAccounts: StoreCreditAccount[];\n /**\n * The number of orders the customer has previously placed with this shop.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n ordersCount: number;\n}" }, "ImageDetails": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -168568,11 +168568,11 @@ "syntaxKind": "MethodSignature", "name": "perform", "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", + "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.\n\nRuns after all intercept results are collected. Use it for local state updates such as setting an error flag. By the time it runs, the navigation decision is final, so blocking logic belongs in the intercept handler itself, not here.", "isOptional": true } ], - "value": "interface InterceptorRequestAllow {\n /**\n * Indicates that the interceptor allows the buyer's journey to continue.\n */\n behavior: 'allow';\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" + "value": "interface InterceptorRequestAllow {\n /**\n * Indicates that the interceptor allows the buyer's journey to continue.\n */\n behavior: 'allow';\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n *\n * Runs after all intercept results are collected. Use it for local state\n * updates such as setting an error flag. By the time it runs, the navigation\n * decision is final, so blocking logic belongs in the intercept handler\n * itself, not here.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" }, "InterceptorResult": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -168636,7 +168636,7 @@ "syntaxKind": "MethodSignature", "name": "perform", "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", + "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.\n\nRuns after all intercept results are collected. Use it for local state updates such as setting an error flag. By the time it runs, the navigation decision is final, so blocking logic belongs in the intercept handler itself, not here.", "isOptional": true }, { @@ -168647,7 +168647,7 @@ "description": "The reason for blocking the interceptor request. This value isn't presented to the buyer, so it doesn't need to be localized. The value is used only for Shopify's own internal debugging and metrics." } ], - "value": "interface InterceptorRequestBlock {\n /**\n * Indicates that the interceptor blocks the buyer's journey from continuing.\n */\n behavior: 'block';\n\n /**\n * The reason for blocking the interceptor request. This value isn't presented to\n * the buyer, so it doesn't need to be localized. The value is used only for Shopify's\n * own internal debugging and metrics.\n */\n reason: string;\n\n /**\n * Used to pass errors to the checkout UI, outside your extension's UI boundaries.\n */\n errors?: ValidationError[];\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" + "value": "interface InterceptorRequestBlock {\n /**\n * Indicates that the interceptor blocks the buyer's journey from continuing.\n */\n behavior: 'block';\n\n /**\n * The reason for blocking the interceptor request. This value isn't presented to\n * the buyer, so it doesn't need to be localized. The value is used only for Shopify's\n * own internal debugging and metrics.\n */\n reason: string;\n\n /**\n * Used to pass errors to the checkout UI, outside your extension's UI boundaries.\n */\n errors?: ValidationError[];\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n *\n * Runs after all intercept results are collected. Use it for local state\n * updates such as setting an error flag. By the time it runs, the navigation\n * decision is final, so blocking logic belongs in the intercept handler\n * itself, not here.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" }, "ValidationError": { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -168868,17 +168868,17 @@ "syntaxKind": "PropertySignature", "name": "totalShippingAmount", "value": "SubscribableSignalLike", - "description": "The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step." + "description": "The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step.\n\n`undefined` until the buyer selects a shipping method (typically after the information step)." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "totalTaxAmount", "value": "SubscribableSignalLike", - "description": "The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet." + "description": "The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet.\n\n`undefined` when taxes haven't been calculated or aren't available for the buyer's region." } ], - "value": "export interface CartCost {\n /**\n * The sum of all line item prices at the current step of checkout, before shipping and taxes are applied. Use this value to display the base cost of the items the buyer purchased.\n */\n subtotalAmount: SubscribableSignalLike;\n\n /**\n * The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step.\n */\n totalShippingAmount: SubscribableSignalLike;\n\n /**\n * The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet.\n */\n totalTaxAmount: SubscribableSignalLike;\n\n /**\n * The minimum total at the current step of checkout. Costs not yet calculated, such as shipping on the information step, aren't included. Gift cards and store credits are excluded from this total.\n */\n totalAmount: SubscribableSignalLike;\n}" + "value": "export interface CartCost {\n /**\n * The sum of all line item prices at the current step of checkout, before shipping and taxes are applied. Use this value to display the base cost of the items the buyer purchased.\n */\n subtotalAmount: SubscribableSignalLike;\n\n /**\n * The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step.\n *\n * `undefined` until the buyer selects a shipping method (typically after the\n * information step).\n */\n totalShippingAmount: SubscribableSignalLike;\n\n /**\n * The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet.\n *\n * `undefined` when taxes haven't been calculated or aren't available for the\n * buyer's region.\n */\n totalTaxAmount: SubscribableSignalLike;\n\n /**\n * The minimum total at the current step of checkout. Costs not yet calculated, such as shipping on the information step, aren't included. Gift cards and store credits are excluded from this total.\n */\n totalAmount: SubscribableSignalLike;\n}" }, "CustomerPrivacy": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -168965,31 +168965,31 @@ "syntaxKind": "PropertySignature", "name": "analytics", "value": "boolean", - "description": "Whether analytics data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Analytics data includes how the shop was used and what interactions occurred." + "description": "Whether analytics data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Analytics data includes how the shop was used and what interactions occurred.\n\nWhether analytics data can be collected right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.analytics`, before calling `shopify.analytics.publish()`." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "marketing", "value": "boolean", - "description": "Whether marketing data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Marketing data includes attribution and targeted advertising preferences." + "description": "Whether marketing data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Marketing data includes attribution and targeted advertising preferences.\n\nWhether marketing data can be collected right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.marketing`, before performing marketing-related data collection." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "preferences", "value": "boolean", - "description": "Whether preference data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Preference data includes language, currency, and sizing choices." + "description": "Whether preference data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Preference data includes language, currency, and sizing choices.\n\nWhether preference data can be collected right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.preferences`, before storing or reading buyer preference data." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "saleOfData", "value": "boolean", - "description": "Whether data can be shared with third parties based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. This typically applies to behavioral advertising data." + "description": "Whether data can be shared with third parties based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. This typically applies to behavioral advertising data.\n\nWhether buyer data can be shared with or sold to third parties right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.saleOfData`, before sharing or selling buyer data with third parties." } ], - "value": "export interface AllowedProcessing {\n /**\n * Whether analytics data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Analytics\n * data includes how the shop was used and what interactions occurred.\n */\n analytics: boolean;\n /**\n * Whether marketing data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Marketing\n * data includes attribution and targeted advertising preferences.\n */\n marketing: boolean;\n /**\n * Whether preference data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Preference\n * data includes language, currency, and sizing choices.\n */\n preferences: boolean;\n /**\n * Whether data can be shared with third parties based on the visitor's\n * consent, the merchant's privacy configuration, and the visitor's region.\n * This typically applies to behavioral advertising data.\n */\n saleOfData: boolean;\n}" + "value": "export interface AllowedProcessing {\n /**\n * Whether analytics data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Analytics\n * data includes how the shop was used and what interactions occurred.\n *\n * Whether analytics data can be collected right now. Combines the buyer's\n * consent, the merchant's privacy configuration, and the buyer's region into\n * a single boolean. Check this flag, not `visitorConsent.analytics`, before\n * calling `shopify.analytics.publish()`.\n */\n analytics: boolean;\n /**\n * Whether marketing data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Marketing\n * data includes attribution and targeted advertising preferences.\n *\n * Whether marketing data can be collected right now. Combines the buyer's\n * consent, the merchant's privacy configuration, and the buyer's region into\n * a single boolean. Check this flag, not `visitorConsent.marketing`, before\n * performing marketing-related data collection.\n */\n marketing: boolean;\n /**\n * Whether preference data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Preference\n * data includes language, currency, and sizing choices.\n *\n * Whether preference data can be collected right now. Combines the buyer's\n * consent, the merchant's privacy configuration, and the buyer's region into\n * a single boolean. Check this flag, not `visitorConsent.preferences`,\n * before storing or reading buyer preference data.\n */\n preferences: boolean;\n /**\n * Whether data can be shared with third parties based on the visitor's\n * consent, the merchant's privacy configuration, and the visitor's region.\n * This typically applies to behavioral advertising data.\n *\n * Whether buyer data can be shared with or sold to third parties right now.\n * Combines the buyer's consent, the merchant's privacy configuration, and\n * the buyer's region into a single boolean. Check this flag, not\n * `visitorConsent.saleOfData`, before sharing or selling buyer data with\n * third parties.\n */\n saleOfData: boolean;\n}" }, "TrackingConsentMetafield": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -169681,7 +169681,7 @@ "Extension": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Extension", - "description": "The meta information about an extension target.", + "description": "Metadata about the running extension, including its API version, target, capabilities, and editor context. Use this to read configuration details or conditionally render content based on where the extension is running.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -169707,7 +169707,7 @@ "syntaxKind": "PropertySignature", "name": "capabilities", "value": "SubscribableSignalLike", - "description": "The allowed capabilities of the extension, defined in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n\n* [`api_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#api-access): the extension can access the Storefront API.\n\n* [`network_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access): the extension can make external network calls.\n\n* [`block_progress`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n\n* [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n\n* [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can register customer consent decisions that are honored on Shopify-managed services.\n\n* [`iframe.sources`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#iframe): the extension can embed an external URL in an iframe." + "description": "The allowed capabilities of the extension, defined in your [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -169755,7 +169755,7 @@ "syntaxKind": "PropertySignature", "name": "version", "value": "string", - "description": "The published version of the running extension target.\n\nFor unpublished extensions, the value is `undefined`.", + "description": "The published version of the running extension target.\n\nFor unpublished extensions, the value is `undefined`.\n\nDon't use this property as a stable identifier in development environments. It becomes available only after the extension is published.", "isOptional": true, "examples": [ { @@ -169771,7 +169771,7 @@ ] } ], - "value": "export interface Extension {\n /**\n * The API version that was set in the extension config file.\n *\n * @example '2024-10', '2025-01', '2025-04', '2025-07', '2025-10'\n */\n apiVersion: ApiVersion;\n\n /**\n * The allowed capabilities of the extension, defined\n * in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n *\n * * [`api_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#api-access): the extension can access the Storefront API.\n *\n * * [`network_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access): the extension can make external network calls.\n *\n * * [`block_progress`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n *\n * * [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n *\n * * [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can register customer consent decisions that are honored on Shopify-managed services.\n *\n * * [`iframe.sources`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#iframe): the extension can embed an external URL in an iframe.\n */\n capabilities: SubscribableSignalLike;\n\n /**\n * Information about the editor where the extension is being rendered.\n *\n * If the value is undefined, then the extension isn't running in an editor.\n */\n editor?: Editor;\n\n /**\n * A Boolean to show whether your extension is currently rendered to the screen.\n *\n * Shopify might render your extension before it's visible in the UI,\n * typically to pre-render extensions that appear on a later step of the\n * checkout.\n *\n * Your extension might also continue to run after the customer has navigated away\n * from where it was rendered. The extension continues running so that\n * your extension is immediately available to render if the customer navigates back.\n */\n rendered: SubscribableSignalLike;\n\n /**\n * The URL to the script that started the extension target.\n */\n scriptUrl: string;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n */\n target: Target;\n\n /**\n * The published version of the running extension target.\n *\n * For unpublished extensions, the value is `undefined`.\n *\n * @example 3.0.10\n */\n version?: string;\n}" + "value": "export interface Extension {\n /**\n * The API version that was set in the extension config file.\n *\n * @example '2024-10', '2025-01', '2025-04', '2025-07', '2025-10'\n */\n apiVersion: ApiVersion;\n\n /**\n * The allowed capabilities of the extension, defined in your\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n */\n capabilities: SubscribableSignalLike;\n\n /**\n * Information about the editor where the extension is being rendered.\n *\n * If the value is undefined, then the extension isn't running in an editor.\n */\n editor?: Editor;\n\n /**\n * A Boolean to show whether your extension is currently rendered to the screen.\n *\n * Shopify might render your extension before it's visible in the UI,\n * typically to pre-render extensions that appear on a later step of the\n * checkout.\n *\n * Your extension might also continue to run after the customer has navigated away\n * from where it was rendered. The extension continues running so that\n * your extension is immediately available to render if the customer navigates back.\n */\n rendered: SubscribableSignalLike;\n\n /**\n * The URL to the script that started the extension target.\n */\n scriptUrl: string;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n */\n target: Target;\n\n /**\n * The published version of the running extension target.\n *\n * For unpublished extensions, the value is `undefined`.\n *\n * Don't use this property as a stable identifier in development environments.\n * It becomes available only after the extension is published.\n *\n * @example 3.0.10\n */\n version?: string;\n}" }, "ApiVersion": { "filePath": "src/shared.ts", @@ -169790,7 +169790,7 @@ "Editor": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Editor", - "description": "", + "description": "Information about the editor environment when an extension is rendered inside the checkout editor. The value is `undefined` when the extension is not rendering in an editor.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -169805,7 +169805,7 @@ "I18n": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18n", - "description": "", + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use the I18n API alongside the Localization API to build fully localized extensions.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -169841,7 +169841,7 @@ "I18nTranslate": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18nTranslate", - "description": "This returns a translated string matching a key in a locale file.", + "description": "Translates a key from your extension's locale files into a localized string. Supports interpolation with placeholder replacements and pluralization via the special `count` option.", "members": [], "value": "export interface I18nTranslate {\n (\n key: string,\n options?: Record,\n ): ReplacementType extends string | number\n ? string\n : (string | ReplacementType)[];\n}" }, @@ -170405,14 +170405,14 @@ "Localization": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Localization", - "description": "", + "description": "The buyer's language, country, currency, and timezone context. Use this to adapt your extension to the buyer's region and display localized content.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "country", "value": "SubscribableSignalLike", - "description": "The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown." + "description": "The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n\nDerived from the buyer's shipping address. Returns `undefined` until the buyer enters a shipping address." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -170440,18 +170440,18 @@ "syntaxKind": "PropertySignature", "name": "market", "value": "SubscribableSignalLike", - "description": "The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n\n> Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.", - "deprecationMessage": "Deprecated as of version `2025-04`" + "description": "The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. The market context updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.", + "deprecationMessage": "Merchants now manage which extensions load for each\nmarket, so extensions no longer need to check this value." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "timezone", "value": "SubscribableSignalLike", - "description": "The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time." + "description": "The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time." } ], - "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n *\n * > Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" + "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n *\n * Derived from the buyer's shipping address. Returns `undefined` until the\n * buyer enters a shipping address.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout,\n * carried over from the cart context. Markets group countries and\n * regions with shared pricing, languages, and domains. The market\n * context updates when the buyer changes the country of their\n * shipping address. The value is `undefined` if the market is unknown.\n *\n * @deprecated Merchants now manage which extensions load for each\n * market, so extensions no longer need to check this value.\n */\n market: SubscribableSignalLike;\n}" }, "Country": { "filePath": "src/shared.ts", @@ -170652,7 +170652,7 @@ "SessionToken": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SessionToken", - "description": "", + "description": "Authenticates requests between your extension and your app backend. Use session tokens to verify the identity of the buyer and the shop context when making server-side API calls. The token is a signed JWT that contains claims such as the customer ID, shop domain, and expiration.\n\nThe `sub` claim in the decoded token is present only when the buyer is logged in and the app has permission to read customer accounts. Absent for anonymous buyers.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -170911,7 +170911,7 @@ "Shop": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Shop", - "description": "", + "description": "Metadata about the merchant's store, including its name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -170951,30 +170951,30 @@ "syntaxKind": "PropertySignature", "name": "storefrontUrl", "value": "string", - "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n\n> Caution: > As of version `2024-04` this value no longer has a trailing slash.", + "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.", "isOptional": true } ], - "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n *\n * > Caution:\n * > As of version `2024-04` this value no longer has a trailing slash.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom domain.\n */\n myshopifyDomain: string;\n}" + "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom domain.\n */\n myshopifyDomain: string;\n}" }, "Storage": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Storage", - "description": "A key-value storage object for the extension.\n\nStored data is available only to this specific extension and any of its instances.\n\nThe storage backend is implemented with `localStorage` and should persist across the buyer's checkout session. However, data persistence isn't guaranteed.", + "description": "Key-value storage for a specific extension. Use storage to save preferences or cached data that should survive page reloads without requiring a backend call. Stored data is only available to this specific extension. The storage backend is implemented with `localStorage` and data persistence isn't guaranteed.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "delete", "value": "(key: string) => Promise", - "description": "Delete stored data by key." + "description": "Deletes a previously stored value by key." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "read", "value": "(key: string) => Promise", - "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original primitive.\n\nReturns `null` if no stored data exists." + "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original type.\n\nReturns the stored value for the given key, or `null` when no value exists. Doesn't throw on a missing key." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -170984,7 +170984,7 @@ "description": "Write stored data for this key.\n\nThe data must be serializable to JSON." } ], - "value": "export interface Storage {\n /**\n * Read and return a stored value by key.\n *\n * The stored data is deserialized from JSON and returned as\n * its original primitive.\n *\n * Returns `null` if no stored data exists.\n */\n read(key: string): Promise;\n\n /**\n * Write stored data for this key.\n *\n * The data must be serializable to JSON.\n */\n write(key: string, data: any): Promise;\n\n /**\n * Delete stored data by key.\n */\n delete(key: string): Promise;\n}" + "value": "export interface Storage {\n /**\n * Read and return a stored value by key.\n *\n * The stored data is deserialized from JSON and returned as\n * its original type.\n *\n * Returns the stored value for the given key, or `null` when no value\n * exists. Doesn't throw on a missing key.\n */\n read(key: string): Promise;\n\n /**\n * Write stored data for this key.\n *\n * The data must be serializable to JSON.\n */\n write(key: string, data: any): Promise;\n\n /**\n * Deletes a previously stored value by key.\n */\n delete(key: string): Promise;\n}" }, "Version": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -171984,7 +171984,7 @@ "syntaxKind": "MethodSignature", "name": "applyAttributeChange", "value": "(change: AttributeChange) => Promise", - "description": "Updates or removes an attribute on the cart and checkout. On success, the [`attributes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/attributes#standardapi-propertydetail-attributes) property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.", + "description": "Updates or removes an attribute on the cart and checkout. On success, the [`attributes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/attributes#properties-propertydetail-attributes) property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.", "deprecationMessage": "Use cart metafields instead." }, { @@ -171992,42 +171992,42 @@ "syntaxKind": "MethodSignature", "name": "applyCartLinesChange", "value": "(change: CartLineChange) => Promise", - "description": "Adds, removes, or updates line items in the cart. The returned promise resolves when the change has been applied by the server, and the [`lines`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-lines#standardapi-propertydetail-lines) property updates with the new state.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Adds, removes, or updates line items in the cart. The returned promise resolves when the change has been applied by the server, and the [`lines`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-lines#properties-propertydetail-lines) property updates with the new state.\n\nAccepts a single change per call. To make multiple changes, call this method separately for each one.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyDiscountCodeChange", "value": "(change: DiscountCodeChange) => Promise", - "description": "Adds or removes a discount code on the checkout. The returned promise resolves when the change has been applied by the server, and the [`discountCodes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/discounts#standardapi-propertydetail-discountcodes) property updates with the new state.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves discount codes through a network call.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Adds or removes a discount code on the checkout. The returned promise resolves when the change has been applied by the server, and the [`discountCodes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/discounts#properties-propertydetail-discountcodes) property updates with the new state.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves discount codes through a network call.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyGiftCardChange", "value": "(change: GiftCardChange) => Promise", - "description": "Adds or removes a gift card from the checkout. The returned promise resolves when the change has been applied by the server, and the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/gift-cards#standardapi-propertydetail-appliedgiftcards) property updates with the new state.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves gift card codes through a network call.\n\n> Note: This method returns an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Adds or removes a gift card from the checkout. The returned promise resolves when the change has been applied by the server, and the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/gift-cards#properties-propertydetail-appliedgiftcards) property updates with the new state.\n\nUnlike other write operations, gift card changes aren't gated by a cart instruction flag.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves gift card codes through a network call.\n\n> Note: This method returns an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyMetafieldChange", "value": "(change: MetafieldChange) => Promise", - "description": "Creates, updates, or removes a cart metafield on the checkout. On success, the [`metafields`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/metafields#standardapi-propertydetail-metafields) property updates to reflect the change.\n\nCart metafields are copied to order metafields at order creation time if there's a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n\n> Caution: `MetafieldRemoveChange` and `MetafieldUpdateChange` are deprecated. Use cart metafields with `MetafieldRemoveCartChange` and `MetafieldUpdateCartChange` instead. If `MetafieldUpdateChange` writes a metafield with the same namespace and key as a cart metafield that's configured to copy, the cart metafield won't be copied.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Creates, updates, or removes a cart metafield on the checkout. On success, the [`metafields`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/metafields#properties-propertydetail-metafields) property updates to reflect the change.\n\nCart metafields are copied to order metafields at order creation time if there's a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n\n> Caution: `MetafieldRemoveChange` and `MetafieldUpdateChange` are deprecated. Use cart metafields with `MetafieldRemoveCartChange` and `MetafieldUpdateCartChange` instead. If `MetafieldUpdateChange` writes a metafield with the same namespace and key as a cart metafield that's configured to copy, the cart metafield won't be copied.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyNoteChange", "value": "(change: NoteChange) => Promise", - "description": "Sets or removes the buyer's note on the checkout. On success, the [`note`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/note#standardapi-propertydetail-note) property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Sets or removes the buyer's note on the checkout. On success, the [`note`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/note#properties-propertydetail-note) property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyShippingAddressChange", "value": "(change: ShippingAddressUpdateChange) => Promise", - "description": "Updates the buyer's shipping address on the checkout. The provided fields are merged into the existing address without prompting the buyer. On success, the `shippingAddress` property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", + "description": "Updates the buyer's shipping address on the checkout. The provided fields are merged into the existing address without prompting the buyer. On success, the `shippingAddress` property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", "isOptional": true }, { @@ -172040,7 +172040,7 @@ "isPrivate": true } ], - "value": "export interface CheckoutApi {\n /**\n * Updates or removes an attribute on the cart and checkout. On success, the\n * [`attributes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/attributes#standardapi-propertydetail-attributes) property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * @deprecated Use cart metafields instead.\n */\n applyAttributeChange(change: AttributeChange): Promise;\n\n /**\n * Adds, removes, or updates line items in the cart. The returned promise resolves when the change has been applied by the server, and the [`lines`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-lines#standardapi-propertydetail-lines) property updates with the new state.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyCartLinesChange(change: CartLineChange): Promise;\n\n /**\n * Adds or removes a discount code on the checkout. The returned promise resolves when the change has been applied by the server, and the [`discountCodes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/discounts#standardapi-propertydetail-discountcodes) property updates with the new state.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves discount codes through a network call.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyDiscountCodeChange(\n change: DiscountCodeChange,\n ): Promise;\n\n /**\n * Adds or removes a gift card from the checkout. The returned promise resolves when the change has been applied by the server, and the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/gift-cards#standardapi-propertydetail-appliedgiftcards) property updates with the new state.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves gift card codes through a network call.\n *\n * > Note: This method returns an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyGiftCardChange(change: GiftCardChange): Promise;\n\n /**\n * Creates, updates, or removes a cart metafield on the checkout. On success, the\n * [`metafields`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/metafields#standardapi-propertydetail-metafields) property updates to reflect the change.\n *\n * Cart metafields are copied to order metafields at order creation time if there's a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n *\n * > Caution: `MetafieldRemoveChange` and `MetafieldUpdateChange` are deprecated. Use cart metafields with `MetafieldRemoveCartChange` and `MetafieldUpdateCartChange` instead. If `MetafieldUpdateChange` writes a metafield with the same namespace and key as a cart metafield that's configured to copy, the cart metafield won't be copied.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyMetafieldChange(change: MetafieldChange): Promise;\n\n /**\n * Sets or removes the buyer's note on the checkout. On success, the\n * [`note`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/note#standardapi-propertydetail-note)\n * property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyNoteChange(change: NoteChange): Promise;\n\n /**\n * @private\n */\n experimentalIsShopAppStyle?: boolean;\n\n /**\n * Updates the buyer's shipping address on the checkout. The provided fields\n * are merged into the existing address without prompting the buyer. On success,\n * the `shippingAddress` property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyShippingAddressChange?(\n change: ShippingAddressChange,\n ): Promise;\n}" + "value": "export interface CheckoutApi {\n /**\n * Updates or removes an attribute on the cart and checkout. On success, the\n * [`attributes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/attributes#properties-propertydetail-attributes) property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * @deprecated Use cart metafields instead.\n */\n applyAttributeChange(change: AttributeChange): Promise;\n\n /**\n * Adds, removes, or updates line items in the cart. The returned promise resolves when the change has been applied by the server, and the [`lines`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-lines#properties-propertydetail-lines) property updates with the new state.\n *\n * Accepts a single change per call. To make multiple changes, call this\n * method separately for each one.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyCartLinesChange(change: CartLineChange): Promise;\n\n /**\n * Adds or removes a discount code on the checkout. The returned promise resolves when the change has been applied by the server, and the [`discountCodes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/discounts#properties-propertydetail-discountcodes) property updates with the new state.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves discount codes through a network call.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyDiscountCodeChange(\n change: DiscountCodeChange,\n ): Promise;\n\n /**\n * Adds or removes a gift card from the checkout. The returned promise resolves when the change has been applied by the server, and the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/gift-cards#properties-propertydetail-appliedgiftcards) property updates with the new state.\n *\n * Unlike other write operations, gift card changes aren't gated by a cart\n * instruction flag.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves gift card codes through a network call.\n *\n * > Note: This method returns an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyGiftCardChange(change: GiftCardChange): Promise;\n\n /**\n * Creates, updates, or removes a cart metafield on the checkout. On success, the\n * [`metafields`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/metafields#properties-propertydetail-metafields) property updates to reflect the change.\n *\n * Cart metafields are copied to order metafields at order creation time if there's a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n *\n * > Caution: `MetafieldRemoveChange` and `MetafieldUpdateChange` are deprecated. Use cart metafields with `MetafieldRemoveCartChange` and `MetafieldUpdateCartChange` instead. If `MetafieldUpdateChange` writes a metafield with the same namespace and key as a cart metafield that's configured to copy, the cart metafield won't be copied.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyMetafieldChange(change: MetafieldChange): Promise;\n\n /**\n * Sets or removes the buyer's note on the checkout. On success, the\n * [`note`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/note#properties-propertydetail-note)\n * property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyNoteChange(change: NoteChange): Promise;\n\n /**\n * @private\n */\n experimentalIsShopAppStyle?: boolean;\n\n /**\n * Updates the buyer's shipping address on the checkout. The provided fields\n * are merged into the existing address without prompting the buyer. On success,\n * the `shippingAddress` property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyShippingAddressChange?(\n change: ShippingAddressChange,\n ): Promise;\n}" }, "AttributeChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -172107,7 +172107,7 @@ "syntaxKind": "PropertySignature", "name": "value", "value": "string", - "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.", + "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.\n\nAttribute values are always strings. To store structured data, serialize it to JSON and parse it when reading.", "examples": [ { "title": "Example", @@ -172122,7 +172122,7 @@ ] } ], - "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" + "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * Attribute values are always strings. To store structured data, serialize\n * it to JSON and parse it when reading.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" }, "AttributeRemoveChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -172975,7 +172975,7 @@ "syntaxKind": "PropertySignature", "name": "message", "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer." + "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer.\n\nRender your own localized error text rather than displaying this message to the buyer." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -172985,7 +172985,7 @@ "description": "Indicates that the line item wasn't changed successfully. Refer to the `message` property for details about the error." } ], - "value": "export interface CartLineChangeResultError {\n /**\n * Indicates that the line item wasn't changed successfully. Refer to the `message` property for details about the error.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface CartLineChangeResultError {\n /**\n * Indicates that the line item wasn't changed successfully. Refer to the `message` property for details about the error.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n *\n * Render your own localized error text rather than displaying this message\n * to the buyer.\n */\n message: string;\n}" }, "DiscountCodeChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -173165,7 +173165,7 @@ "syntaxKind": "PropertySignature", "name": "message", "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer." + "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer.\n\nRender your own localized error text rather than displaying this message to the buyer." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -173175,7 +173175,7 @@ "description": "Indicates that the gift card change couldn't be applied. Check the `message` property for details." } ], - "value": "export interface GiftCardChangeResultError {\n /**\n * Indicates that the gift card change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface GiftCardChangeResultError {\n /**\n * Indicates that the gift card change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n *\n * Render your own localized error text rather than displaying this message\n * to the buyer.\n */\n message: string;\n}" }, "MetafieldChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -173436,7 +173436,7 @@ "syntaxKind": "PropertySignature", "name": "message", "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer." + "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer.\n\nRender your own localized error text rather than displaying this message to the buyer." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -173446,7 +173446,7 @@ "description": "Indicates that the metafield change couldn't be applied. Check the `message` property for details." } ], - "value": "export interface MetafieldChangeResultError {\n /**\n * Indicates that the metafield change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface MetafieldChangeResultError {\n /**\n * Indicates that the metafield change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n *\n * Render your own localized error text rather than displaying this message\n * to the buyer.\n */\n message: string;\n}" }, "NoteChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -173524,7 +173524,7 @@ "syntaxKind": "PropertySignature", "name": "message", "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer." + "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer.\n\nRender your own localized error text rather than displaying this message to the buyer." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -173534,7 +173534,7 @@ "description": "Indicates that the note change couldn't be applied. Check the `message` property for details." } ], - "value": "export interface NoteChangeResultError {\n /**\n * Indicates that the note change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface NoteChangeResultError {\n /**\n * Indicates that the note change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n *\n * Render your own localized error text rather than displaying this message\n * to the buyer.\n */\n message: string;\n}" }, "ShippingAddressUpdateChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -174120,7 +174120,7 @@ "syntaxKind": "PropertySignature", "name": "analytics", "value": "Analytics", - "description": "The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event." + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -174134,7 +174134,7 @@ "syntaxKind": "PropertySignature", "name": "applyTrackingConsentChange", "value": "ApplyTrackingConsentChangeType", - "description": "Enables setting and updating customer privacy consent settings and tracking consent metafields.\n\n> Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent) to be set to `true`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." + "description": "Enables setting and updating customer privacy consent settings and tracking consent metafields.\n\n> Note: Requires the [`collect_buyer_consent` capability](/docs/apps/build/customer-accounts/capabilities#collect-buyer-consent) to be set to `true`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -174155,7 +174155,7 @@ "syntaxKind": "PropertySignature", "name": "availablePaymentOptions", "value": "SubscribableSignalLike", - "description": "All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region." + "description": "All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n\nThe set of payment options can change when the buyer updates their address or cart, so subscribe to changes rather than reading once during initialization. Each option exposes `handle` and `type` only. Provider names, logos, fees, and installment terms aren't available." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -174192,7 +174192,7 @@ "syntaxKind": "PropertySignature", "name": "checkoutToken", "value": "SubscribableSignalLike", - "description": "A stable ID that represents the current checkout.\n\nThe value is `undefined` when the checkout hasn't been created on the server yet.\n\nUse this to correlate checkout sessions across your extension, web pixels, and backend systems.\n\nThis matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data) and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object)." + "description": "A stable ID that represents the current checkout.\n\nThe value is `undefined` when the checkout hasn't been created on the server yet.\n\nUse this to correlate checkout sessions across your extension, web pixels, and backend systems.\n\nThis matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data) and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n\nCan be `undefined`. Handle the `undefined` state before using the value." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -174213,7 +174213,7 @@ "syntaxKind": "PropertySignature", "name": "deliveryGroups", "value": "SubscribableSignalLike", - "description": "The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items." + "description": "The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n\nEmpty until the buyer enters enough address information for Shopify to calculate shipping rates." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -174234,7 +174234,7 @@ "syntaxKind": "PropertySignature", "name": "extension", "value": "Extension", - "description": "The meta information about the extension." + "description": "Metadata about the running extension, including the current target, API version, capabilities, and editor context. Use this to conditionally render content based on where the extension is running." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -174242,7 +174242,7 @@ "name": "extensionPoint", "value": "Target", "description": "The identifier that specifies where in Shopify's UI your code is being injected. This is one of the targets you've included in your extension's configuration file.", - "deprecationMessage": "Deprecated as of version `2023-07`, use `extension.target` instead.", + "deprecationMessage": "Use `extension.target` instead.", "examples": [ { "title": "Example", @@ -174261,14 +174261,14 @@ "syntaxKind": "PropertySignature", "name": "i18n", "value": "I18n", - "description": "Utilities for translating content and formatting values according to the current [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) of the checkout.\n\nRefer to [`localization` examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples) for more information." + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use alongside [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) to build fully localized extensions." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "instructions", "value": "SubscribableSignalLike", - "description": "The cart instructions used to create the checkout and possibly limit extension capabilities.\n\nThese instructions should be checked before performing any actions that might be affected by them.\n\nFor example, if you intend to add a discount code via the `applyDiscountCodeChange` method, check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n\n> Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs aren't available. See the [update guide](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples) for more information." + "description": "The cart instructions used to create the checkout and possibly limit extension capabilities.\n\nThese instructions should be checked before performing any actions that might be affected by them.\n\nFor example, if you intend to add a discount code via the `applyDiscountCodeChange` method, check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n\n> Caution: Check cart instructions before calling select APIs, as > some may not be available. See the > [Cart Instructions API](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples) > for more information." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -174282,7 +174282,7 @@ "syntaxKind": "PropertySignature", "name": "localization", "value": "Localization", - "description": "The details about the location, language, and currency of the customer. For utilities to easily format and translate content based on these details, you can use the [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n) object instead." + "description": "The buyer's language, country, currency, and timezone context. For formatting and translation helpers, use the [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#properties-propertydetail-i18n) object instead." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -174312,21 +174312,21 @@ "syntaxKind": "PropertySignature", "name": "query", "value": ">(query: string, options?: { variables?: Variables; version?: StorefrontApiVersion; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>", - "description": "The method used to query the Storefront GraphQL API with a prefetched token.\n\nRefer to [Storefront API access examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/storefront-api) for more information." + "description": "The method used to query the Storefront GraphQL API with a prefetched token." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "selectedPaymentOptions", "value": "SubscribableSignalLike", - "description": "The payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card)." + "description": "The payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\n\nEach option exposes `handle` and `type` only. Provider names, logos, fees, and installment terms aren't available." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "sessionToken", "value": "SessionToken", - "description": "The session token providing a set of claims as a signed JSON Web Token (JWT).\n\nThe token has a TTL of five minutes.\n\nIf the previous token expires, this value reflects a new session token with a new signature and expiry.\n\nRefer to [session token examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/session-token) for more information." + "description": "The session token providing a set of claims as a signed JSON Web Token (JWT).\n\nThe token has a TTL of five minutes.\n\nIf the previous token expires, this value reflects a new session token with a new signature and expiry.\n\nLearn more about [session tokens](/docs/apps/build/authentication-authorization/session-tokens)." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -174348,14 +174348,14 @@ "syntaxKind": "PropertySignature", "name": "shop", "value": "Shop", - "description": "The shop where the checkout is taking place." + "description": "The store where the checkout is taking place, including the shop name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "storage", "value": "Storage", - "description": "The key-value storage for the extension.\n\nIt uses `localStorage` and should persist across the customer's current checkout session.\n\n> Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n\nData is shared across all activated extension targets of this extension. In versions 2023-07 and earlier, each activated extension target had its own storage." + "description": "Key-value storage that persists across page loads within the current checkout session. Data is shared across all activated targets associated with this extension.\n\n> Caution: Data persistence isn't guaranteed and storage is cleared when the buyer starts a new checkout." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -174377,29 +174377,29 @@ ] } ], - "value": "export interface StandardApi {\n /**\n * The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event.\n */\n analytics: Analytics;\n\n /**\n * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\n */\n appliedGiftCards: SubscribableSignalLike;\n\n /**\n * The cart instructions used to create the checkout and possibly limit extension capabilities.\n *\n * These instructions should be checked before performing any actions that might be affected by them.\n *\n * For example, if you intend to add a discount code via the `applyDiscountCodeChange` method,\n * check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n *\n * > Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs aren't available.\n * See the [update guide](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples) for more information.\n *\n */\n instructions: SubscribableSignalLike;\n\n /**\n * The metafields requested in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration)\n * file. These metafields are updated when there's a change in the merchandise items\n * being purchased by the customer.\n *\n * App owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` isn't supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n appMetafields: SubscribableSignalLike;\n\n /**\n * The custom key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n buyerIdentity?: BuyerIdentity;\n\n /**\n * Provides details on the buyer's progression through the checkout and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/buyer-journey#examples)\n * examples for more information.\n */\n buyerJourney: BuyerJourney;\n\n /**\n * Settings applied to the buyer's checkout.\n */\n checkoutSettings: SubscribableSignalLike;\n\n /**\n * A stable ID that represents the current checkout.\n *\n * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\n *\n * This matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data)\n * and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n */\n checkoutToken: SubscribableSignalLike;\n\n /**\n * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * The meta information about the extension.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n *\n * @deprecated Deprecated as of version `2023-07`, use `extension.target` instead.\n */\n extensionPoint: Target;\n\n /**\n * Utilities for translating content and formatting values according to the current\n * [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization)\n * of the checkout.\n *\n * Refer to [`localization` examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples)\n * for more information.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The details about the location, language, and currency of the customer. For utilities to easily\n * format and translate content based on these details, you can use the\n * [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n)\n * object instead.\n */\n localization: Localization;\n\n /**\n * The metafields that apply to the current checkout.\n *\n * Metafields are stored locally on the client and are applied to the order object after the checkout completes.\n *\n * These metafields are shared by all extensions running on checkout, and\n * persist for as long as the customer is working on this checkout.\n *\n * Once the order is created, you can query these metafields using the\n * [GraphQL Admin API](/docs/admin-api/graphql/reference/orders/order#metafield-2021-01)\n *\n * > Caution:\n * `metafields` is deprecated. Use `appMetafields` with cart metafields instead.\n *\n * @deprecated Use `appMetafields` with cart metafields instead.\n */\n metafields: SubscribableSignalLike;\n\n /**\n * A note left by the customer to the merchant, either in their cart or during checkout.\n *\n * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\n */\n note: SubscribableSignalLike;\n\n /**\n * The method used to query the Storefront GraphQL API with a prefetched token.\n *\n * Refer to [Storefront API access examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/storefront-api) for more information.\n */\n query: >(\n query: string,\n options?: {variables?: Variables; version?: StorefrontApiVersion},\n ) => Promise<{data?: Data; errors?: GraphQLError[]}>;\n\n /**\n * The payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\n */\n selectedPaymentOptions: SubscribableSignalLike;\n\n /**\n * The session token providing a set of claims as a signed JSON Web Token (JWT).\n *\n * The token has a TTL of five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/session-token) for more information.\n */\n sessionToken: SessionToken;\n\n /**\n * The settings matching the settings definition written in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates in real time as a merchant fills in the settings.\n */\n settings: SubscribableSignalLike;\n\n /**\n * The proposed customer shipping address. During the information step, the address\n * updates when the field is committed (on change) rather than every keystroke.\n * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n shippingAddress?: SubscribableSignalLike;\n\n /**\n * The proposed customer billing address. The address updates when the field is\n * committed (on change) rather than every keystroke. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided yet.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n billingAddress?: SubscribableSignalLike;\n\n /** The shop where the checkout is taking place. */\n shop: Shop;\n\n /**\n * The key-value storage for the extension.\n *\n * It uses `localStorage` and should persist across the customer's current checkout session.\n *\n * > Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n *\n * Data is shared across all activated extension targets of this extension. In versions 2023-07 and earlier,\n * each activated extension target had its own storage.\n */\n storage: Storage;\n\n /**\n * The renderer version being used for the extension.\n *\n * @example '2025-10'\n */\n version: Version;\n\n /**\n * Customer privacy consent settings and a flag denoting if consent has previously been collected.\n */\n customerPrivacy: SubscribableSignalLike;\n\n /**\n * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent) to be set to `true`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyTrackingConsentChange: ApplyTrackingConsentChangeType;\n\n /**\n * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" + "value": "export interface StandardApi {\n /**\n * Tracks custom events and sends visitor information to\n * [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events\n * and `visitor()` to submit buyer contact details.\n */\n analytics: Analytics;\n\n /**\n * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\n */\n appliedGiftCards: SubscribableSignalLike;\n\n /**\n * The cart instructions used to create the checkout and possibly limit extension capabilities.\n *\n * These instructions should be checked before performing any actions that might be affected by them.\n *\n * For example, if you intend to add a discount code via the `applyDiscountCodeChange` method,\n * check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n *\n * > Caution: Check cart instructions before calling select APIs, as\n * > some may not be available. See the\n * > [Cart Instructions API](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples)\n * > for more information.\n *\n */\n instructions: SubscribableSignalLike;\n\n /**\n * The metafields requested in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration)\n * file. These metafields are updated when there's a change in the merchandise items\n * being purchased by the customer.\n *\n * App owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` isn't supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n appMetafields: SubscribableSignalLike;\n\n /**\n * The custom key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as\n * credit cards, wallets, and local payment methods. The list depends on\n * the shop's payment configuration and the buyer's region.\n *\n * The set of payment options can change when the buyer updates their\n * address or cart, so subscribe to changes rather than reading once\n * during initialization. Each option exposes `handle` and `type` only.\n * Provider names, logos, fees, and installment terms aren't available.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n buyerIdentity?: BuyerIdentity;\n\n /**\n * Provides details on the buyer's progression through the checkout and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/buyer-journey#examples)\n * examples for more information.\n */\n buyerJourney: BuyerJourney;\n\n /**\n * Settings applied to the buyer's checkout.\n */\n checkoutSettings: SubscribableSignalLike;\n\n /**\n * A stable ID that represents the current checkout.\n *\n * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\n *\n * This matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data)\n * and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n *\n * Can be `undefined`. Handle the `undefined` state before using the value.\n */\n checkoutToken: SubscribableSignalLike;\n\n /**\n * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n *\n * Empty until the buyer enters enough address information for Shopify to\n * calculate shipping rates.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * Metadata about the running extension, including the current target, API version,\n * capabilities, and editor context. Use this to conditionally render content\n * based on where the extension is running.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n *\n * @deprecated Use `extension.target` instead.\n */\n extensionPoint: Target;\n\n /**\n * Utilities for translating strings, formatting currencies, numbers, and dates\n * according to the buyer's locale. Use alongside\n * [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization)\n * to build fully localized extensions.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The buyer's language, country, currency, and timezone context. For\n * formatting and translation helpers, use the\n * [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#properties-propertydetail-i18n)\n * object instead.\n */\n localization: Localization;\n\n /**\n * The metafields that apply to the current checkout.\n *\n * Metafields are stored locally on the client and are applied to the order object after the checkout completes.\n *\n * These metafields are shared by all extensions running on checkout, and\n * persist for as long as the customer is working on this checkout.\n *\n * Once the order is created, you can query these metafields using the\n * [GraphQL Admin API](/docs/admin-api/graphql/reference/orders/order#metafield-2021-01)\n *\n * > Caution:\n * `metafields` is deprecated. Use `appMetafields` with cart metafields instead.\n *\n * @deprecated Use `appMetafields` with cart metafields instead.\n */\n metafields: SubscribableSignalLike;\n\n /**\n * A note left by the customer to the merchant, either in their cart or during checkout.\n *\n * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\n */\n note: SubscribableSignalLike;\n\n /**\n * The method used to query the Storefront GraphQL API with a prefetched token.\n *\n */\n query: >(\n query: string,\n options?: {variables?: Variables; version?: StorefrontApiVersion},\n ) => Promise<{data?: Data; errors?: GraphQLError[]}>;\n\n /**\n * The payment options the buyer has currently selected. This updates as\n * the buyer changes their payment method. The array can contain multiple\n * entries when the buyer splits payment across methods (for example, a\n * gift card and a credit card).\n *\n * Each option exposes `handle` and `type` only. Provider names, logos,\n * fees, and installment terms aren't available.\n */\n selectedPaymentOptions: SubscribableSignalLike;\n\n /**\n * The session token providing a set of claims as a signed JSON Web Token (JWT).\n *\n * The token has a TTL of five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Learn more about [session tokens](/docs/apps/build/authentication-authorization/session-tokens).\n */\n sessionToken: SessionToken;\n\n /**\n * The settings matching the settings definition written in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates in real time as a merchant fills in the settings.\n */\n settings: SubscribableSignalLike;\n\n /**\n * The proposed customer shipping address. During the information step, the address\n * updates when the field is committed (on change) rather than every keystroke.\n * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n shippingAddress?: SubscribableSignalLike;\n\n /**\n * The proposed customer billing address. The address updates when the field is\n * committed (on change) rather than every keystroke. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided yet.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n billingAddress?: SubscribableSignalLike;\n\n /**\n * The store where the checkout is taking place, including the shop name,\n * storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.\n */\n shop: Shop;\n\n /**\n * Key-value storage that persists across page loads within the current checkout\n * session. Data is shared across all activated targets associated with\n * this extension.\n *\n * > Caution: Data persistence isn't guaranteed and storage is cleared when the\n * buyer starts a new checkout.\n */\n storage: Storage;\n\n /**\n * The renderer version being used for the extension.\n *\n * @example '2025-10'\n */\n version: Version;\n\n /**\n * Customer privacy consent settings and a flag denoting if consent has previously been collected.\n */\n customerPrivacy: SubscribableSignalLike;\n\n /**\n * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`collect_buyer_consent` capability](/docs/apps/build/customer-accounts/capabilities#collect-buyer-consent) to be set to `true`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyTrackingConsentChange: ApplyTrackingConsentChangeType;\n\n /**\n * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" }, "Analytics": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Analytics", - "description": "", + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "publish", "value": "(name: string, data: Record) => Promise", - "description": "Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing)." + "description": "Publishes a custom event to [Web Pixels](/docs/apps/marketing). Returns `true` when the event is successfully dispatched.\n\nThe Promise resolves to `true` when the event was dispatched. The boolean indicates dispatch confirmation only. It doesn't indicate whether any specific web pixel processed the event." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "visitor", "value": "(data: { email?: string; phone?: string; }) => Promise", - "description": "A method for capturing details about a visitor on the online store." + "description": "Submits buyer contact details for attribution and analytics purposes." } ], - "value": "export interface Analytics {\n /**\n * Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing).\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * A method for capturing details about a visitor on the online store.\n */\n visitor(data: {email?: string; phone?: string}): Promise;\n}" + "value": "export interface Analytics {\n /**\n * Publishes a custom event to [Web Pixels](/docs/apps/marketing).\n * Returns `true` when the event is successfully dispatched.\n *\n * The Promise resolves to `true` when the event was dispatched. The boolean\n * indicates dispatch confirmation only. It doesn't indicate whether any\n * specific web pixel processed the event.\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * Submits buyer contact details for attribution and analytics purposes.\n */\n visitor(data: {email?: string; phone?: string}): Promise;\n}" }, "VisitorResult": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -174440,10 +174440,10 @@ "syntaxKind": "PropertySignature", "name": "type", "value": "'error'", - "description": "Indicates that the visitor information is invalid and wasn't submitted. Examples are using the wrong data type or missing a required property." + "description": "Indicates that the visitor information is invalid and wasn't submitted. Common causes include using the wrong data type or omitting a required property." } ], - "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Examples are using the wrong data type or missing a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Common causes include using the wrong data type or omitting a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" }, "SubscribableSignalLike": { "filePath": "src/surfaces/checkout/shared.ts", @@ -174657,10 +174657,10 @@ "syntaxKind": "PropertySignature", "name": "value", "value": "string | null", - "description": "The new value to store in the metafield. Set to `null` to delete the metafield." + "description": "The new value to store in the metafield. Set to `null` to delete the metafield.\n\nConsent metafield values are strings, not booleans. Pass `null` to delete a tracking consent metafield." } ], - "value": "export interface TrackingConsentMetafieldChange {\n /**\n * The identifier for the tracking consent metafield to update.\n */\n key: string;\n /**\n * The new value to store in the metafield. Set to `null` to delete the metafield.\n */\n value: string | null;\n}" + "value": "export interface TrackingConsentMetafieldChange {\n /**\n * The identifier for the tracking consent metafield to update.\n */\n key: string;\n /**\n * The new value to store in the metafield. Set to `null` to delete the metafield.\n *\n * Consent metafield values are strings, not booleans. Pass `null` to delete\n * a tracking consent metafield.\n */\n value: string | null;\n}" }, "VisitorConsent": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -174874,7 +174874,7 @@ "syntaxKind": "PropertySignature", "name": "value", "value": "string", - "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.", + "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.\n\nAttribute values are always strings. To store structured data, serialize it to JSON and parse it when reading.", "examples": [ { "title": "Example", @@ -174889,7 +174889,7 @@ ] } ], - "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" + "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * Attribute values are always strings. To store structured data, serialize\n * it to JSON and parse it when reading.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" }, "PaymentOption": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -175240,7 +175240,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A globally-unique identifier for the customer in the format `gid://shopify/Customer/`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", + "description": "An identifier for the customer in the format `gid://shopify/Customer/`. This value is unique per shop.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", "examples": [ { "title": "Example", @@ -175293,7 +175293,7 @@ "isPrivate": true } ], - "value": "export interface Customer {\n /**\n * A globally-unique identifier for the customer in the format `gid://shopify/Customer/`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'gid://shopify/Customer/123'\n */\n id: string;\n /**\n * The email address associated with the customer's account. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email?: string;\n /**\n * The phone number associated with the customer's account. The value is `undefined` if no phone number is on file or the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone?: string;\n /**\n * The customer's full name, typically a combination of first and last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n fullName?: string;\n /**\n * The customer's first name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n firstName?: string;\n /**\n * The customer's last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n lastName?: string;\n /**\n * The customer's profile image, such as a Gravatar avatar. Use this to personalize the extension UI for the logged-in buyer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n image: ImageDetails;\n /**\n * Whether the customer has opted in to receiving marketing communications from the merchant, such as email campaigns and promotional offers.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * > Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n *\n * @deprecated Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n */\n acceptsMarketing: boolean;\n /**\n * Whether the customer has opted in to email marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsEmailMarketing: boolean;\n /**\n * Whether the customer has opted in to SMS marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsSmsMarketing: boolean;\n /**\n * The store credit accounts owned by this customer that can be used as payment during checkout. Each account has a balance representing available store credit.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @private\n */\n storeCreditAccounts: StoreCreditAccount[];\n /**\n * The number of orders the customer has previously placed with this shop.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n ordersCount: number;\n}" + "value": "export interface Customer {\n /**\n * An identifier for the customer in the format `gid://shopify/Customer/`. This value is unique per shop.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'gid://shopify/Customer/123'\n */\n id: string;\n /**\n * The email address associated with the customer's account. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email?: string;\n /**\n * The phone number associated with the customer's account. The value is `undefined` if no phone number is on file or the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone?: string;\n /**\n * The customer's full name, typically a combination of first and last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n fullName?: string;\n /**\n * The customer's first name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n firstName?: string;\n /**\n * The customer's last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n lastName?: string;\n /**\n * The customer's profile image, such as a Gravatar avatar. Use this to personalize the extension UI for the logged-in buyer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n image: ImageDetails;\n /**\n * Whether the customer has opted in to receiving marketing communications from the merchant, such as email campaigns and promotional offers.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * > Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n *\n * @deprecated Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n */\n acceptsMarketing: boolean;\n /**\n * Whether the customer has opted in to email marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsEmailMarketing: boolean;\n /**\n * Whether the customer has opted in to SMS marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsSmsMarketing: boolean;\n /**\n * The store credit accounts owned by this customer that can be used as payment during checkout. Each account has a balance representing available store credit.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @private\n */\n storeCreditAccounts: StoreCreditAccount[];\n /**\n * The number of orders the customer has previously placed with this shop.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n ordersCount: number;\n}" }, "ImageDetails": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -175575,11 +175575,11 @@ "syntaxKind": "MethodSignature", "name": "perform", "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", + "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.\n\nRuns after all intercept results are collected. Use it for local state updates such as setting an error flag. By the time it runs, the navigation decision is final, so blocking logic belongs in the intercept handler itself, not here.", "isOptional": true } ], - "value": "interface InterceptorRequestAllow {\n /**\n * Indicates that the interceptor allows the buyer's journey to continue.\n */\n behavior: 'allow';\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" + "value": "interface InterceptorRequestAllow {\n /**\n * Indicates that the interceptor allows the buyer's journey to continue.\n */\n behavior: 'allow';\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n *\n * Runs after all intercept results are collected. Use it for local state\n * updates such as setting an error flag. By the time it runs, the navigation\n * decision is final, so blocking logic belongs in the intercept handler\n * itself, not here.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" }, "InterceptorResult": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -175643,7 +175643,7 @@ "syntaxKind": "MethodSignature", "name": "perform", "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", + "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.\n\nRuns after all intercept results are collected. Use it for local state updates such as setting an error flag. By the time it runs, the navigation decision is final, so blocking logic belongs in the intercept handler itself, not here.", "isOptional": true }, { @@ -175654,7 +175654,7 @@ "description": "The reason for blocking the interceptor request. This value isn't presented to the buyer, so it doesn't need to be localized. The value is used only for Shopify's own internal debugging and metrics." } ], - "value": "interface InterceptorRequestBlock {\n /**\n * Indicates that the interceptor blocks the buyer's journey from continuing.\n */\n behavior: 'block';\n\n /**\n * The reason for blocking the interceptor request. This value isn't presented to\n * the buyer, so it doesn't need to be localized. The value is used only for Shopify's\n * own internal debugging and metrics.\n */\n reason: string;\n\n /**\n * Used to pass errors to the checkout UI, outside your extension's UI boundaries.\n */\n errors?: ValidationError[];\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" + "value": "interface InterceptorRequestBlock {\n /**\n * Indicates that the interceptor blocks the buyer's journey from continuing.\n */\n behavior: 'block';\n\n /**\n * The reason for blocking the interceptor request. This value isn't presented to\n * the buyer, so it doesn't need to be localized. The value is used only for Shopify's\n * own internal debugging and metrics.\n */\n reason: string;\n\n /**\n * Used to pass errors to the checkout UI, outside your extension's UI boundaries.\n */\n errors?: ValidationError[];\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n *\n * Runs after all intercept results are collected. Use it for local state\n * updates such as setting an error flag. By the time it runs, the navigation\n * decision is final, so blocking logic belongs in the intercept handler\n * itself, not here.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" }, "ValidationError": { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -175875,17 +175875,17 @@ "syntaxKind": "PropertySignature", "name": "totalShippingAmount", "value": "SubscribableSignalLike", - "description": "The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step." + "description": "The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step.\n\n`undefined` until the buyer selects a shipping method (typically after the information step)." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "totalTaxAmount", "value": "SubscribableSignalLike", - "description": "The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet." + "description": "The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet.\n\n`undefined` when taxes haven't been calculated or aren't available for the buyer's region." } ], - "value": "export interface CartCost {\n /**\n * The sum of all line item prices at the current step of checkout, before shipping and taxes are applied. Use this value to display the base cost of the items the buyer purchased.\n */\n subtotalAmount: SubscribableSignalLike;\n\n /**\n * The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step.\n */\n totalShippingAmount: SubscribableSignalLike;\n\n /**\n * The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet.\n */\n totalTaxAmount: SubscribableSignalLike;\n\n /**\n * The minimum total at the current step of checkout. Costs not yet calculated, such as shipping on the information step, aren't included. Gift cards and store credits are excluded from this total.\n */\n totalAmount: SubscribableSignalLike;\n}" + "value": "export interface CartCost {\n /**\n * The sum of all line item prices at the current step of checkout, before shipping and taxes are applied. Use this value to display the base cost of the items the buyer purchased.\n */\n subtotalAmount: SubscribableSignalLike;\n\n /**\n * The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step.\n *\n * `undefined` until the buyer selects a shipping method (typically after the\n * information step).\n */\n totalShippingAmount: SubscribableSignalLike;\n\n /**\n * The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet.\n *\n * `undefined` when taxes haven't been calculated or aren't available for the\n * buyer's region.\n */\n totalTaxAmount: SubscribableSignalLike;\n\n /**\n * The minimum total at the current step of checkout. Costs not yet calculated, such as shipping on the information step, aren't included. Gift cards and store credits are excluded from this total.\n */\n totalAmount: SubscribableSignalLike;\n}" }, "CustomerPrivacy": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -175972,31 +175972,31 @@ "syntaxKind": "PropertySignature", "name": "analytics", "value": "boolean", - "description": "Whether analytics data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Analytics data includes how the shop was used and what interactions occurred." + "description": "Whether analytics data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Analytics data includes how the shop was used and what interactions occurred.\n\nWhether analytics data can be collected right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.analytics`, before calling `shopify.analytics.publish()`." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "marketing", "value": "boolean", - "description": "Whether marketing data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Marketing data includes attribution and targeted advertising preferences." + "description": "Whether marketing data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Marketing data includes attribution and targeted advertising preferences.\n\nWhether marketing data can be collected right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.marketing`, before performing marketing-related data collection." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "preferences", "value": "boolean", - "description": "Whether preference data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Preference data includes language, currency, and sizing choices." + "description": "Whether preference data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Preference data includes language, currency, and sizing choices.\n\nWhether preference data can be collected right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.preferences`, before storing or reading buyer preference data." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "saleOfData", "value": "boolean", - "description": "Whether data can be shared with third parties based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. This typically applies to behavioral advertising data." + "description": "Whether data can be shared with third parties based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. This typically applies to behavioral advertising data.\n\nWhether buyer data can be shared with or sold to third parties right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.saleOfData`, before sharing or selling buyer data with third parties." } ], - "value": "export interface AllowedProcessing {\n /**\n * Whether analytics data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Analytics\n * data includes how the shop was used and what interactions occurred.\n */\n analytics: boolean;\n /**\n * Whether marketing data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Marketing\n * data includes attribution and targeted advertising preferences.\n */\n marketing: boolean;\n /**\n * Whether preference data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Preference\n * data includes language, currency, and sizing choices.\n */\n preferences: boolean;\n /**\n * Whether data can be shared with third parties based on the visitor's\n * consent, the merchant's privacy configuration, and the visitor's region.\n * This typically applies to behavioral advertising data.\n */\n saleOfData: boolean;\n}" + "value": "export interface AllowedProcessing {\n /**\n * Whether analytics data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Analytics\n * data includes how the shop was used and what interactions occurred.\n *\n * Whether analytics data can be collected right now. Combines the buyer's\n * consent, the merchant's privacy configuration, and the buyer's region into\n * a single boolean. Check this flag, not `visitorConsent.analytics`, before\n * calling `shopify.analytics.publish()`.\n */\n analytics: boolean;\n /**\n * Whether marketing data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Marketing\n * data includes attribution and targeted advertising preferences.\n *\n * Whether marketing data can be collected right now. Combines the buyer's\n * consent, the merchant's privacy configuration, and the buyer's region into\n * a single boolean. Check this flag, not `visitorConsent.marketing`, before\n * performing marketing-related data collection.\n */\n marketing: boolean;\n /**\n * Whether preference data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Preference\n * data includes language, currency, and sizing choices.\n *\n * Whether preference data can be collected right now. Combines the buyer's\n * consent, the merchant's privacy configuration, and the buyer's region into\n * a single boolean. Check this flag, not `visitorConsent.preferences`,\n * before storing or reading buyer preference data.\n */\n preferences: boolean;\n /**\n * Whether data can be shared with third parties based on the visitor's\n * consent, the merchant's privacy configuration, and the visitor's region.\n * This typically applies to behavioral advertising data.\n *\n * Whether buyer data can be shared with or sold to third parties right now.\n * Combines the buyer's consent, the merchant's privacy configuration, and\n * the buyer's region into a single boolean. Check this flag, not\n * `visitorConsent.saleOfData`, before sharing or selling buyer data with\n * third parties.\n */\n saleOfData: boolean;\n}" }, "TrackingConsentMetafield": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -176688,7 +176688,7 @@ "Extension": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Extension", - "description": "The meta information about an extension target.", + "description": "Metadata about the running extension, including its API version, target, capabilities, and editor context. Use this to read configuration details or conditionally render content based on where the extension is running.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -176714,7 +176714,7 @@ "syntaxKind": "PropertySignature", "name": "capabilities", "value": "SubscribableSignalLike", - "description": "The allowed capabilities of the extension, defined in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n\n* [`api_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#api-access): the extension can access the Storefront API.\n\n* [`network_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access): the extension can make external network calls.\n\n* [`block_progress`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n\n* [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n\n* [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can register customer consent decisions that are honored on Shopify-managed services.\n\n* [`iframe.sources`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#iframe): the extension can embed an external URL in an iframe." + "description": "The allowed capabilities of the extension, defined in your [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -176762,7 +176762,7 @@ "syntaxKind": "PropertySignature", "name": "version", "value": "string", - "description": "The published version of the running extension target.\n\nFor unpublished extensions, the value is `undefined`.", + "description": "The published version of the running extension target.\n\nFor unpublished extensions, the value is `undefined`.\n\nDon't use this property as a stable identifier in development environments. It becomes available only after the extension is published.", "isOptional": true, "examples": [ { @@ -176778,7 +176778,7 @@ ] } ], - "value": "export interface Extension {\n /**\n * The API version that was set in the extension config file.\n *\n * @example '2024-10', '2025-01', '2025-04', '2025-07', '2025-10'\n */\n apiVersion: ApiVersion;\n\n /**\n * The allowed capabilities of the extension, defined\n * in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n *\n * * [`api_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#api-access): the extension can access the Storefront API.\n *\n * * [`network_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access): the extension can make external network calls.\n *\n * * [`block_progress`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n *\n * * [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n *\n * * [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can register customer consent decisions that are honored on Shopify-managed services.\n *\n * * [`iframe.sources`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#iframe): the extension can embed an external URL in an iframe.\n */\n capabilities: SubscribableSignalLike;\n\n /**\n * Information about the editor where the extension is being rendered.\n *\n * If the value is undefined, then the extension isn't running in an editor.\n */\n editor?: Editor;\n\n /**\n * A Boolean to show whether your extension is currently rendered to the screen.\n *\n * Shopify might render your extension before it's visible in the UI,\n * typically to pre-render extensions that appear on a later step of the\n * checkout.\n *\n * Your extension might also continue to run after the customer has navigated away\n * from where it was rendered. The extension continues running so that\n * your extension is immediately available to render if the customer navigates back.\n */\n rendered: SubscribableSignalLike;\n\n /**\n * The URL to the script that started the extension target.\n */\n scriptUrl: string;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n */\n target: Target;\n\n /**\n * The published version of the running extension target.\n *\n * For unpublished extensions, the value is `undefined`.\n *\n * @example 3.0.10\n */\n version?: string;\n}" + "value": "export interface Extension {\n /**\n * The API version that was set in the extension config file.\n *\n * @example '2024-10', '2025-01', '2025-04', '2025-07', '2025-10'\n */\n apiVersion: ApiVersion;\n\n /**\n * The allowed capabilities of the extension, defined in your\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n */\n capabilities: SubscribableSignalLike;\n\n /**\n * Information about the editor where the extension is being rendered.\n *\n * If the value is undefined, then the extension isn't running in an editor.\n */\n editor?: Editor;\n\n /**\n * A Boolean to show whether your extension is currently rendered to the screen.\n *\n * Shopify might render your extension before it's visible in the UI,\n * typically to pre-render extensions that appear on a later step of the\n * checkout.\n *\n * Your extension might also continue to run after the customer has navigated away\n * from where it was rendered. The extension continues running so that\n * your extension is immediately available to render if the customer navigates back.\n */\n rendered: SubscribableSignalLike;\n\n /**\n * The URL to the script that started the extension target.\n */\n scriptUrl: string;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n */\n target: Target;\n\n /**\n * The published version of the running extension target.\n *\n * For unpublished extensions, the value is `undefined`.\n *\n * Don't use this property as a stable identifier in development environments.\n * It becomes available only after the extension is published.\n *\n * @example 3.0.10\n */\n version?: string;\n}" }, "ApiVersion": { "filePath": "src/shared.ts", @@ -176797,7 +176797,7 @@ "Editor": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Editor", - "description": "", + "description": "Information about the editor environment when an extension is rendered inside the checkout editor. The value is `undefined` when the extension is not rendering in an editor.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -176812,7 +176812,7 @@ "I18n": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18n", - "description": "", + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use the I18n API alongside the Localization API to build fully localized extensions.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -176848,7 +176848,7 @@ "I18nTranslate": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18nTranslate", - "description": "This returns a translated string matching a key in a locale file.", + "description": "Translates a key from your extension's locale files into a localized string. Supports interpolation with placeholder replacements and pluralization via the special `count` option.", "members": [], "value": "export interface I18nTranslate {\n (\n key: string,\n options?: Record,\n ): ReplacementType extends string | number\n ? string\n : (string | ReplacementType)[];\n}" }, @@ -177412,14 +177412,14 @@ "Localization": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Localization", - "description": "", + "description": "The buyer's language, country, currency, and timezone context. Use this to adapt your extension to the buyer's region and display localized content.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "country", "value": "SubscribableSignalLike", - "description": "The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown." + "description": "The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n\nDerived from the buyer's shipping address. Returns `undefined` until the buyer enters a shipping address." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -177447,18 +177447,18 @@ "syntaxKind": "PropertySignature", "name": "market", "value": "SubscribableSignalLike", - "description": "The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n\n> Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.", - "deprecationMessage": "Deprecated as of version `2025-04`" + "description": "The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. The market context updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.", + "deprecationMessage": "Merchants now manage which extensions load for each\nmarket, so extensions no longer need to check this value." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "timezone", "value": "SubscribableSignalLike", - "description": "The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time." + "description": "The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time." } ], - "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n *\n * > Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" + "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n *\n * Derived from the buyer's shipping address. Returns `undefined` until the\n * buyer enters a shipping address.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout,\n * carried over from the cart context. Markets group countries and\n * regions with shared pricing, languages, and domains. The market\n * context updates when the buyer changes the country of their\n * shipping address. The value is `undefined` if the market is unknown.\n *\n * @deprecated Merchants now manage which extensions load for each\n * market, so extensions no longer need to check this value.\n */\n market: SubscribableSignalLike;\n}" }, "Country": { "filePath": "src/shared.ts", @@ -177659,7 +177659,7 @@ "SessionToken": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SessionToken", - "description": "", + "description": "Authenticates requests between your extension and your app backend. Use session tokens to verify the identity of the buyer and the shop context when making server-side API calls. The token is a signed JWT that contains claims such as the customer ID, shop domain, and expiration.\n\nThe `sub` claim in the decoded token is present only when the buyer is logged in and the app has permission to read customer accounts. Absent for anonymous buyers.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -177918,7 +177918,7 @@ "Shop": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Shop", - "description": "", + "description": "Metadata about the merchant's store, including its name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -177958,30 +177958,30 @@ "syntaxKind": "PropertySignature", "name": "storefrontUrl", "value": "string", - "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n\n> Caution: > As of version `2024-04` this value no longer has a trailing slash.", + "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.", "isOptional": true } ], - "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n *\n * > Caution:\n * > As of version `2024-04` this value no longer has a trailing slash.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom domain.\n */\n myshopifyDomain: string;\n}" + "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom domain.\n */\n myshopifyDomain: string;\n}" }, "Storage": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Storage", - "description": "A key-value storage object for the extension.\n\nStored data is available only to this specific extension and any of its instances.\n\nThe storage backend is implemented with `localStorage` and should persist across the buyer's checkout session. However, data persistence isn't guaranteed.", + "description": "Key-value storage for a specific extension. Use storage to save preferences or cached data that should survive page reloads without requiring a backend call. Stored data is only available to this specific extension. The storage backend is implemented with `localStorage` and data persistence isn't guaranteed.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "delete", "value": "(key: string) => Promise", - "description": "Delete stored data by key." + "description": "Deletes a previously stored value by key." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "read", "value": "(key: string) => Promise", - "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original primitive.\n\nReturns `null` if no stored data exists." + "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original type.\n\nReturns the stored value for the given key, or `null` when no value exists. Doesn't throw on a missing key." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -177991,7 +177991,7 @@ "description": "Write stored data for this key.\n\nThe data must be serializable to JSON." } ], - "value": "export interface Storage {\n /**\n * Read and return a stored value by key.\n *\n * The stored data is deserialized from JSON and returned as\n * its original primitive.\n *\n * Returns `null` if no stored data exists.\n */\n read(key: string): Promise;\n\n /**\n * Write stored data for this key.\n *\n * The data must be serializable to JSON.\n */\n write(key: string, data: any): Promise;\n\n /**\n * Delete stored data by key.\n */\n delete(key: string): Promise;\n}" + "value": "export interface Storage {\n /**\n * Read and return a stored value by key.\n *\n * The stored data is deserialized from JSON and returned as\n * its original type.\n *\n * Returns the stored value for the given key, or `null` when no value\n * exists. Doesn't throw on a missing key.\n */\n read(key: string): Promise;\n\n /**\n * Write stored data for this key.\n *\n * The data must be serializable to JSON.\n */\n write(key: string, data: any): Promise;\n\n /**\n * Deletes a previously stored value by key.\n */\n delete(key: string): Promise;\n}" }, "Version": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -178127,7 +178127,7 @@ "syntaxKind": "PropertySignature", "name": "number", "value": "string", - "description": "A randomly generated alpha-numeric identifier for the order, distinct from `order.id`. The value is `undefined` for orders that were created before this field was introduced. All recent orders have a number.", + "description": "A randomly generated alpha-numeric identifier for the order, distinct from `order.id`. The value is `undefined` for orders that were created before this field was introduced. All recent orders have a number.\n\nOptional. Might not be present for orders created before 2024.", "isOptional": true }, { @@ -178138,7 +178138,7 @@ "description": "" } ], - "value": "export interface OrderConfirmation {\n order: {\n /**\n * A globally unique identifier for the order. This becomes the\n * [`Order`](/docs/api/admin-graphql/latest/objects/Order) object ID in the\n * GraphQL Admin API after the order is created.\n *\n * @example 'gid://shopify/Order/123'\n */\n id: string;\n };\n /**\n * A randomly generated alpha-numeric identifier for the order, distinct\n * from `order.id`. The value is `undefined` for orders that were created\n * before this field was introduced. All recent orders have a number.\n */\n number?: string;\n\n /**\n * Whether this is the customer's first completed order with this shop. `true` means the buyer hasn't placed an order here before. Use this to show first-purchase messaging or trigger welcome offers.\n */\n isFirstOrder: boolean;\n}" + "value": "export interface OrderConfirmation {\n order: {\n /**\n * A globally unique identifier for the order. This becomes the\n * [`Order`](/docs/api/admin-graphql/latest/objects/Order) object ID in the\n * GraphQL Admin API after the order is created.\n *\n * @example 'gid://shopify/Order/123'\n */\n id: string;\n };\n /**\n * A randomly generated alpha-numeric identifier for the order, distinct\n * from `order.id`. The value is `undefined` for orders that were created\n * before this field was introduced. All recent orders have a number.\n *\n * Optional. Might not be present for orders created before 2024.\n */\n number?: string;\n\n /**\n * Whether this is the customer's first completed order with this shop. `true` means the buyer hasn't placed an order here before. Use this to show first-purchase messaging or trigger welcome offers.\n */\n isFirstOrder: boolean;\n}" } } }, @@ -178157,7 +178157,7 @@ "syntaxKind": "PropertySignature", "name": "analytics", "value": "Analytics", - "description": "The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event." + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -178171,7 +178171,7 @@ "syntaxKind": "PropertySignature", "name": "applyTrackingConsentChange", "value": "ApplyTrackingConsentChangeType", - "description": "Enables setting and updating customer privacy consent settings and tracking consent metafields.\n\n> Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent) to be set to `true`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." + "description": "Enables setting and updating customer privacy consent settings and tracking consent metafields.\n\n> Note: Requires the [`collect_buyer_consent` capability](/docs/apps/build/customer-accounts/capabilities#collect-buyer-consent) to be set to `true`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -178192,7 +178192,7 @@ "syntaxKind": "PropertySignature", "name": "availablePaymentOptions", "value": "SubscribableSignalLike", - "description": "All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region." + "description": "All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n\nThe set of payment options can change when the buyer updates their address or cart, so subscribe to changes rather than reading once during initialization. Each option exposes `handle` and `type` only. Provider names, logos, fees, and installment terms aren't available." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -178229,7 +178229,7 @@ "syntaxKind": "PropertySignature", "name": "checkoutToken", "value": "SubscribableSignalLike", - "description": "A stable ID that represents the current checkout.\n\nThe value is `undefined` when the checkout hasn't been created on the server yet.\n\nUse this to correlate checkout sessions across your extension, web pixels, and backend systems.\n\nThis matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data) and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object)." + "description": "A stable ID that represents the current checkout.\n\nThe value is `undefined` when the checkout hasn't been created on the server yet.\n\nUse this to correlate checkout sessions across your extension, web pixels, and backend systems.\n\nThis matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data) and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n\nCan be `undefined`. Handle the `undefined` state before using the value." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -178250,7 +178250,7 @@ "syntaxKind": "PropertySignature", "name": "deliveryGroups", "value": "SubscribableSignalLike", - "description": "The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items." + "description": "The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n\nEmpty until the buyer enters enough address information for Shopify to calculate shipping rates." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -178271,7 +178271,7 @@ "syntaxKind": "PropertySignature", "name": "extension", "value": "Extension", - "description": "The meta information about the extension." + "description": "Metadata about the running extension, including the current target, API version, capabilities, and editor context. Use this to conditionally render content based on where the extension is running." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -178279,7 +178279,7 @@ "name": "extensionPoint", "value": "Target", "description": "The identifier that specifies where in Shopify's UI your code is being injected. This is one of the targets you've included in your extension's configuration file.", - "deprecationMessage": "Deprecated as of version `2023-07`, use `extension.target` instead.", + "deprecationMessage": "Use `extension.target` instead.", "examples": [ { "title": "Example", @@ -178298,14 +178298,14 @@ "syntaxKind": "PropertySignature", "name": "i18n", "value": "I18n", - "description": "Utilities for translating content and formatting values according to the current [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) of the checkout.\n\nRefer to [`localization` examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples) for more information." + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use alongside [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) to build fully localized extensions." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "instructions", "value": "SubscribableSignalLike", - "description": "The cart instructions used to create the checkout and possibly limit extension capabilities.\n\nThese instructions should be checked before performing any actions that might be affected by them.\n\nFor example, if you intend to add a discount code via the `applyDiscountCodeChange` method, check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n\n> Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs aren't available. See the [update guide](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples) for more information." + "description": "The cart instructions used to create the checkout and possibly limit extension capabilities.\n\nThese instructions should be checked before performing any actions that might be affected by them.\n\nFor example, if you intend to add a discount code via the `applyDiscountCodeChange` method, check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n\n> Caution: Check cart instructions before calling select APIs, as > some may not be available. See the > [Cart Instructions API](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples) > for more information." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -178319,7 +178319,7 @@ "syntaxKind": "PropertySignature", "name": "localization", "value": "Localization", - "description": "The details about the location, language, and currency of the customer. For utilities to easily format and translate content based on these details, you can use the [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n) object instead." + "description": "The buyer's language, country, currency, and timezone context. For formatting and translation helpers, use the [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#properties-propertydetail-i18n) object instead." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -178349,21 +178349,21 @@ "syntaxKind": "PropertySignature", "name": "query", "value": ">(query: string, options?: { variables?: Variables; version?: StorefrontApiVersion; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>", - "description": "The method used to query the Storefront GraphQL API with a prefetched token.\n\nRefer to [Storefront API access examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/storefront-api) for more information." + "description": "The method used to query the Storefront GraphQL API with a prefetched token." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "selectedPaymentOptions", "value": "SubscribableSignalLike", - "description": "The payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card)." + "description": "The payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\n\nEach option exposes `handle` and `type` only. Provider names, logos, fees, and installment terms aren't available." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "sessionToken", "value": "SessionToken", - "description": "The session token providing a set of claims as a signed JSON Web Token (JWT).\n\nThe token has a TTL of five minutes.\n\nIf the previous token expires, this value reflects a new session token with a new signature and expiry.\n\nRefer to [session token examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/session-token) for more information." + "description": "The session token providing a set of claims as a signed JSON Web Token (JWT).\n\nThe token has a TTL of five minutes.\n\nIf the previous token expires, this value reflects a new session token with a new signature and expiry.\n\nLearn more about [session tokens](/docs/apps/build/authentication-authorization/session-tokens)." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -178385,14 +178385,14 @@ "syntaxKind": "PropertySignature", "name": "shop", "value": "Shop", - "description": "The shop where the checkout is taking place." + "description": "The store where the checkout is taking place, including the shop name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "storage", "value": "Storage", - "description": "The key-value storage for the extension.\n\nIt uses `localStorage` and should persist across the customer's current checkout session.\n\n> Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n\nData is shared across all activated extension targets of this extension. In versions 2023-07 and earlier, each activated extension target had its own storage." + "description": "Key-value storage that persists across page loads within the current checkout session. Data is shared across all activated targets associated with this extension.\n\n> Caution: Data persistence isn't guaranteed and storage is cleared when the buyer starts a new checkout." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -178414,29 +178414,29 @@ ] } ], - "value": "export interface StandardApi {\n /**\n * The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event.\n */\n analytics: Analytics;\n\n /**\n * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\n */\n appliedGiftCards: SubscribableSignalLike;\n\n /**\n * The cart instructions used to create the checkout and possibly limit extension capabilities.\n *\n * These instructions should be checked before performing any actions that might be affected by them.\n *\n * For example, if you intend to add a discount code via the `applyDiscountCodeChange` method,\n * check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n *\n * > Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs aren't available.\n * See the [update guide](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples) for more information.\n *\n */\n instructions: SubscribableSignalLike;\n\n /**\n * The metafields requested in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration)\n * file. These metafields are updated when there's a change in the merchandise items\n * being purchased by the customer.\n *\n * App owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` isn't supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n appMetafields: SubscribableSignalLike;\n\n /**\n * The custom key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n buyerIdentity?: BuyerIdentity;\n\n /**\n * Provides details on the buyer's progression through the checkout and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/buyer-journey#examples)\n * examples for more information.\n */\n buyerJourney: BuyerJourney;\n\n /**\n * Settings applied to the buyer's checkout.\n */\n checkoutSettings: SubscribableSignalLike;\n\n /**\n * A stable ID that represents the current checkout.\n *\n * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\n *\n * This matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data)\n * and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n */\n checkoutToken: SubscribableSignalLike;\n\n /**\n * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * The meta information about the extension.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n *\n * @deprecated Deprecated as of version `2023-07`, use `extension.target` instead.\n */\n extensionPoint: Target;\n\n /**\n * Utilities for translating content and formatting values according to the current\n * [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization)\n * of the checkout.\n *\n * Refer to [`localization` examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples)\n * for more information.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The details about the location, language, and currency of the customer. For utilities to easily\n * format and translate content based on these details, you can use the\n * [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n)\n * object instead.\n */\n localization: Localization;\n\n /**\n * The metafields that apply to the current checkout.\n *\n * Metafields are stored locally on the client and are applied to the order object after the checkout completes.\n *\n * These metafields are shared by all extensions running on checkout, and\n * persist for as long as the customer is working on this checkout.\n *\n * Once the order is created, you can query these metafields using the\n * [GraphQL Admin API](/docs/admin-api/graphql/reference/orders/order#metafield-2021-01)\n *\n * > Caution:\n * `metafields` is deprecated. Use `appMetafields` with cart metafields instead.\n *\n * @deprecated Use `appMetafields` with cart metafields instead.\n */\n metafields: SubscribableSignalLike;\n\n /**\n * A note left by the customer to the merchant, either in their cart or during checkout.\n *\n * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\n */\n note: SubscribableSignalLike;\n\n /**\n * The method used to query the Storefront GraphQL API with a prefetched token.\n *\n * Refer to [Storefront API access examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/storefront-api) for more information.\n */\n query: >(\n query: string,\n options?: {variables?: Variables; version?: StorefrontApiVersion},\n ) => Promise<{data?: Data; errors?: GraphQLError[]}>;\n\n /**\n * The payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\n */\n selectedPaymentOptions: SubscribableSignalLike;\n\n /**\n * The session token providing a set of claims as a signed JSON Web Token (JWT).\n *\n * The token has a TTL of five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/session-token) for more information.\n */\n sessionToken: SessionToken;\n\n /**\n * The settings matching the settings definition written in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates in real time as a merchant fills in the settings.\n */\n settings: SubscribableSignalLike;\n\n /**\n * The proposed customer shipping address. During the information step, the address\n * updates when the field is committed (on change) rather than every keystroke.\n * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n shippingAddress?: SubscribableSignalLike;\n\n /**\n * The proposed customer billing address. The address updates when the field is\n * committed (on change) rather than every keystroke. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided yet.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n billingAddress?: SubscribableSignalLike;\n\n /** The shop where the checkout is taking place. */\n shop: Shop;\n\n /**\n * The key-value storage for the extension.\n *\n * It uses `localStorage` and should persist across the customer's current checkout session.\n *\n * > Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n *\n * Data is shared across all activated extension targets of this extension. In versions 2023-07 and earlier,\n * each activated extension target had its own storage.\n */\n storage: Storage;\n\n /**\n * The renderer version being used for the extension.\n *\n * @example '2025-10'\n */\n version: Version;\n\n /**\n * Customer privacy consent settings and a flag denoting if consent has previously been collected.\n */\n customerPrivacy: SubscribableSignalLike;\n\n /**\n * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent) to be set to `true`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyTrackingConsentChange: ApplyTrackingConsentChangeType;\n\n /**\n * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" + "value": "export interface StandardApi {\n /**\n * Tracks custom events and sends visitor information to\n * [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events\n * and `visitor()` to submit buyer contact details.\n */\n analytics: Analytics;\n\n /**\n * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\n */\n appliedGiftCards: SubscribableSignalLike;\n\n /**\n * The cart instructions used to create the checkout and possibly limit extension capabilities.\n *\n * These instructions should be checked before performing any actions that might be affected by them.\n *\n * For example, if you intend to add a discount code via the `applyDiscountCodeChange` method,\n * check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n *\n * > Caution: Check cart instructions before calling select APIs, as\n * > some may not be available. See the\n * > [Cart Instructions API](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples)\n * > for more information.\n *\n */\n instructions: SubscribableSignalLike;\n\n /**\n * The metafields requested in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration)\n * file. These metafields are updated when there's a change in the merchandise items\n * being purchased by the customer.\n *\n * App owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` isn't supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n appMetafields: SubscribableSignalLike;\n\n /**\n * The custom key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as\n * credit cards, wallets, and local payment methods. The list depends on\n * the shop's payment configuration and the buyer's region.\n *\n * The set of payment options can change when the buyer updates their\n * address or cart, so subscribe to changes rather than reading once\n * during initialization. Each option exposes `handle` and `type` only.\n * Provider names, logos, fees, and installment terms aren't available.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n buyerIdentity?: BuyerIdentity;\n\n /**\n * Provides details on the buyer's progression through the checkout and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/buyer-journey#examples)\n * examples for more information.\n */\n buyerJourney: BuyerJourney;\n\n /**\n * Settings applied to the buyer's checkout.\n */\n checkoutSettings: SubscribableSignalLike;\n\n /**\n * A stable ID that represents the current checkout.\n *\n * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\n *\n * This matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data)\n * and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n *\n * Can be `undefined`. Handle the `undefined` state before using the value.\n */\n checkoutToken: SubscribableSignalLike;\n\n /**\n * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n *\n * Empty until the buyer enters enough address information for Shopify to\n * calculate shipping rates.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * Metadata about the running extension, including the current target, API version,\n * capabilities, and editor context. Use this to conditionally render content\n * based on where the extension is running.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n *\n * @deprecated Use `extension.target` instead.\n */\n extensionPoint: Target;\n\n /**\n * Utilities for translating strings, formatting currencies, numbers, and dates\n * according to the buyer's locale. Use alongside\n * [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization)\n * to build fully localized extensions.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The buyer's language, country, currency, and timezone context. For\n * formatting and translation helpers, use the\n * [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#properties-propertydetail-i18n)\n * object instead.\n */\n localization: Localization;\n\n /**\n * The metafields that apply to the current checkout.\n *\n * Metafields are stored locally on the client and are applied to the order object after the checkout completes.\n *\n * These metafields are shared by all extensions running on checkout, and\n * persist for as long as the customer is working on this checkout.\n *\n * Once the order is created, you can query these metafields using the\n * [GraphQL Admin API](/docs/admin-api/graphql/reference/orders/order#metafield-2021-01)\n *\n * > Caution:\n * `metafields` is deprecated. Use `appMetafields` with cart metafields instead.\n *\n * @deprecated Use `appMetafields` with cart metafields instead.\n */\n metafields: SubscribableSignalLike;\n\n /**\n * A note left by the customer to the merchant, either in their cart or during checkout.\n *\n * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\n */\n note: SubscribableSignalLike;\n\n /**\n * The method used to query the Storefront GraphQL API with a prefetched token.\n *\n */\n query: >(\n query: string,\n options?: {variables?: Variables; version?: StorefrontApiVersion},\n ) => Promise<{data?: Data; errors?: GraphQLError[]}>;\n\n /**\n * The payment options the buyer has currently selected. This updates as\n * the buyer changes their payment method. The array can contain multiple\n * entries when the buyer splits payment across methods (for example, a\n * gift card and a credit card).\n *\n * Each option exposes `handle` and `type` only. Provider names, logos,\n * fees, and installment terms aren't available.\n */\n selectedPaymentOptions: SubscribableSignalLike;\n\n /**\n * The session token providing a set of claims as a signed JSON Web Token (JWT).\n *\n * The token has a TTL of five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Learn more about [session tokens](/docs/apps/build/authentication-authorization/session-tokens).\n */\n sessionToken: SessionToken;\n\n /**\n * The settings matching the settings definition written in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates in real time as a merchant fills in the settings.\n */\n settings: SubscribableSignalLike;\n\n /**\n * The proposed customer shipping address. During the information step, the address\n * updates when the field is committed (on change) rather than every keystroke.\n * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n shippingAddress?: SubscribableSignalLike;\n\n /**\n * The proposed customer billing address. The address updates when the field is\n * committed (on change) rather than every keystroke. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided yet.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n billingAddress?: SubscribableSignalLike;\n\n /**\n * The store where the checkout is taking place, including the shop name,\n * storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.\n */\n shop: Shop;\n\n /**\n * Key-value storage that persists across page loads within the current checkout\n * session. Data is shared across all activated targets associated with\n * this extension.\n *\n * > Caution: Data persistence isn't guaranteed and storage is cleared when the\n * buyer starts a new checkout.\n */\n storage: Storage;\n\n /**\n * The renderer version being used for the extension.\n *\n * @example '2025-10'\n */\n version: Version;\n\n /**\n * Customer privacy consent settings and a flag denoting if consent has previously been collected.\n */\n customerPrivacy: SubscribableSignalLike;\n\n /**\n * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`collect_buyer_consent` capability](/docs/apps/build/customer-accounts/capabilities#collect-buyer-consent) to be set to `true`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyTrackingConsentChange: ApplyTrackingConsentChangeType;\n\n /**\n * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" }, "Analytics": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Analytics", - "description": "", + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "publish", "value": "(name: string, data: Record) => Promise", - "description": "Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing)." + "description": "Publishes a custom event to [Web Pixels](/docs/apps/marketing). Returns `true` when the event is successfully dispatched.\n\nThe Promise resolves to `true` when the event was dispatched. The boolean indicates dispatch confirmation only. It doesn't indicate whether any specific web pixel processed the event." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "visitor", "value": "(data: { email?: string; phone?: string; }) => Promise", - "description": "A method for capturing details about a visitor on the online store." + "description": "Submits buyer contact details for attribution and analytics purposes." } ], - "value": "export interface Analytics {\n /**\n * Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing).\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * A method for capturing details about a visitor on the online store.\n */\n visitor(data: {email?: string; phone?: string}): Promise;\n}" + "value": "export interface Analytics {\n /**\n * Publishes a custom event to [Web Pixels](/docs/apps/marketing).\n * Returns `true` when the event is successfully dispatched.\n *\n * The Promise resolves to `true` when the event was dispatched. The boolean\n * indicates dispatch confirmation only. It doesn't indicate whether any\n * specific web pixel processed the event.\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * Submits buyer contact details for attribution and analytics purposes.\n */\n visitor(data: {email?: string; phone?: string}): Promise;\n}" }, "VisitorResult": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -178477,10 +178477,10 @@ "syntaxKind": "PropertySignature", "name": "type", "value": "'error'", - "description": "Indicates that the visitor information is invalid and wasn't submitted. Examples are using the wrong data type or missing a required property." + "description": "Indicates that the visitor information is invalid and wasn't submitted. Common causes include using the wrong data type or omitting a required property." } ], - "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Examples are using the wrong data type or missing a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Common causes include using the wrong data type or omitting a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" }, "SubscribableSignalLike": { "filePath": "src/surfaces/checkout/shared.ts", @@ -178694,10 +178694,10 @@ "syntaxKind": "PropertySignature", "name": "value", "value": "string | null", - "description": "The new value to store in the metafield. Set to `null` to delete the metafield." + "description": "The new value to store in the metafield. Set to `null` to delete the metafield.\n\nConsent metafield values are strings, not booleans. Pass `null` to delete a tracking consent metafield." } ], - "value": "export interface TrackingConsentMetafieldChange {\n /**\n * The identifier for the tracking consent metafield to update.\n */\n key: string;\n /**\n * The new value to store in the metafield. Set to `null` to delete the metafield.\n */\n value: string | null;\n}" + "value": "export interface TrackingConsentMetafieldChange {\n /**\n * The identifier for the tracking consent metafield to update.\n */\n key: string;\n /**\n * The new value to store in the metafield. Set to `null` to delete the metafield.\n *\n * Consent metafield values are strings, not booleans. Pass `null` to delete\n * a tracking consent metafield.\n */\n value: string | null;\n}" }, "VisitorConsent": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -178911,7 +178911,7 @@ "syntaxKind": "PropertySignature", "name": "value", "value": "string", - "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.", + "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.\n\nAttribute values are always strings. To store structured data, serialize it to JSON and parse it when reading.", "examples": [ { "title": "Example", @@ -178926,7 +178926,7 @@ ] } ], - "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" + "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * Attribute values are always strings. To store structured data, serialize\n * it to JSON and parse it when reading.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" }, "PaymentOption": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -179277,7 +179277,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A globally-unique identifier for the customer in the format `gid://shopify/Customer/`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", + "description": "An identifier for the customer in the format `gid://shopify/Customer/`. This value is unique per shop.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", "examples": [ { "title": "Example", @@ -179330,7 +179330,7 @@ "isPrivate": true } ], - "value": "export interface Customer {\n /**\n * A globally-unique identifier for the customer in the format `gid://shopify/Customer/`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'gid://shopify/Customer/123'\n */\n id: string;\n /**\n * The email address associated with the customer's account. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email?: string;\n /**\n * The phone number associated with the customer's account. The value is `undefined` if no phone number is on file or the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone?: string;\n /**\n * The customer's full name, typically a combination of first and last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n fullName?: string;\n /**\n * The customer's first name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n firstName?: string;\n /**\n * The customer's last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n lastName?: string;\n /**\n * The customer's profile image, such as a Gravatar avatar. Use this to personalize the extension UI for the logged-in buyer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n image: ImageDetails;\n /**\n * Whether the customer has opted in to receiving marketing communications from the merchant, such as email campaigns and promotional offers.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * > Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n *\n * @deprecated Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n */\n acceptsMarketing: boolean;\n /**\n * Whether the customer has opted in to email marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsEmailMarketing: boolean;\n /**\n * Whether the customer has opted in to SMS marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsSmsMarketing: boolean;\n /**\n * The store credit accounts owned by this customer that can be used as payment during checkout. Each account has a balance representing available store credit.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @private\n */\n storeCreditAccounts: StoreCreditAccount[];\n /**\n * The number of orders the customer has previously placed with this shop.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n ordersCount: number;\n}" + "value": "export interface Customer {\n /**\n * An identifier for the customer in the format `gid://shopify/Customer/`. This value is unique per shop.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'gid://shopify/Customer/123'\n */\n id: string;\n /**\n * The email address associated with the customer's account. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email?: string;\n /**\n * The phone number associated with the customer's account. The value is `undefined` if no phone number is on file or the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone?: string;\n /**\n * The customer's full name, typically a combination of first and last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n fullName?: string;\n /**\n * The customer's first name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n firstName?: string;\n /**\n * The customer's last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n lastName?: string;\n /**\n * The customer's profile image, such as a Gravatar avatar. Use this to personalize the extension UI for the logged-in buyer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n image: ImageDetails;\n /**\n * Whether the customer has opted in to receiving marketing communications from the merchant, such as email campaigns and promotional offers.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * > Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n *\n * @deprecated Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n */\n acceptsMarketing: boolean;\n /**\n * Whether the customer has opted in to email marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsEmailMarketing: boolean;\n /**\n * Whether the customer has opted in to SMS marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsSmsMarketing: boolean;\n /**\n * The store credit accounts owned by this customer that can be used as payment during checkout. Each account has a balance representing available store credit.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @private\n */\n storeCreditAccounts: StoreCreditAccount[];\n /**\n * The number of orders the customer has previously placed with this shop.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n ordersCount: number;\n}" }, "ImageDetails": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -179612,11 +179612,11 @@ "syntaxKind": "MethodSignature", "name": "perform", "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", + "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.\n\nRuns after all intercept results are collected. Use it for local state updates such as setting an error flag. By the time it runs, the navigation decision is final, so blocking logic belongs in the intercept handler itself, not here.", "isOptional": true } ], - "value": "interface InterceptorRequestAllow {\n /**\n * Indicates that the interceptor allows the buyer's journey to continue.\n */\n behavior: 'allow';\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" + "value": "interface InterceptorRequestAllow {\n /**\n * Indicates that the interceptor allows the buyer's journey to continue.\n */\n behavior: 'allow';\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n *\n * Runs after all intercept results are collected. Use it for local state\n * updates such as setting an error flag. By the time it runs, the navigation\n * decision is final, so blocking logic belongs in the intercept handler\n * itself, not here.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" }, "InterceptorResult": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -179680,7 +179680,7 @@ "syntaxKind": "MethodSignature", "name": "perform", "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", + "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.\n\nRuns after all intercept results are collected. Use it for local state updates such as setting an error flag. By the time it runs, the navigation decision is final, so blocking logic belongs in the intercept handler itself, not here.", "isOptional": true }, { @@ -179691,7 +179691,7 @@ "description": "The reason for blocking the interceptor request. This value isn't presented to the buyer, so it doesn't need to be localized. The value is used only for Shopify's own internal debugging and metrics." } ], - "value": "interface InterceptorRequestBlock {\n /**\n * Indicates that the interceptor blocks the buyer's journey from continuing.\n */\n behavior: 'block';\n\n /**\n * The reason for blocking the interceptor request. This value isn't presented to\n * the buyer, so it doesn't need to be localized. The value is used only for Shopify's\n * own internal debugging and metrics.\n */\n reason: string;\n\n /**\n * Used to pass errors to the checkout UI, outside your extension's UI boundaries.\n */\n errors?: ValidationError[];\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" + "value": "interface InterceptorRequestBlock {\n /**\n * Indicates that the interceptor blocks the buyer's journey from continuing.\n */\n behavior: 'block';\n\n /**\n * The reason for blocking the interceptor request. This value isn't presented to\n * the buyer, so it doesn't need to be localized. The value is used only for Shopify's\n * own internal debugging and metrics.\n */\n reason: string;\n\n /**\n * Used to pass errors to the checkout UI, outside your extension's UI boundaries.\n */\n errors?: ValidationError[];\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n *\n * Runs after all intercept results are collected. Use it for local state\n * updates such as setting an error flag. By the time it runs, the navigation\n * decision is final, so blocking logic belongs in the intercept handler\n * itself, not here.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" }, "ValidationError": { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -179912,17 +179912,17 @@ "syntaxKind": "PropertySignature", "name": "totalShippingAmount", "value": "SubscribableSignalLike", - "description": "The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step." + "description": "The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step.\n\n`undefined` until the buyer selects a shipping method (typically after the information step)." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "totalTaxAmount", "value": "SubscribableSignalLike", - "description": "The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet." + "description": "The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet.\n\n`undefined` when taxes haven't been calculated or aren't available for the buyer's region." } ], - "value": "export interface CartCost {\n /**\n * The sum of all line item prices at the current step of checkout, before shipping and taxes are applied. Use this value to display the base cost of the items the buyer purchased.\n */\n subtotalAmount: SubscribableSignalLike;\n\n /**\n * The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step.\n */\n totalShippingAmount: SubscribableSignalLike;\n\n /**\n * The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet.\n */\n totalTaxAmount: SubscribableSignalLike;\n\n /**\n * The minimum total at the current step of checkout. Costs not yet calculated, such as shipping on the information step, aren't included. Gift cards and store credits are excluded from this total.\n */\n totalAmount: SubscribableSignalLike;\n}" + "value": "export interface CartCost {\n /**\n * The sum of all line item prices at the current step of checkout, before shipping and taxes are applied. Use this value to display the base cost of the items the buyer purchased.\n */\n subtotalAmount: SubscribableSignalLike;\n\n /**\n * The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step.\n *\n * `undefined` until the buyer selects a shipping method (typically after the\n * information step).\n */\n totalShippingAmount: SubscribableSignalLike;\n\n /**\n * The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet.\n *\n * `undefined` when taxes haven't been calculated or aren't available for the\n * buyer's region.\n */\n totalTaxAmount: SubscribableSignalLike;\n\n /**\n * The minimum total at the current step of checkout. Costs not yet calculated, such as shipping on the information step, aren't included. Gift cards and store credits are excluded from this total.\n */\n totalAmount: SubscribableSignalLike;\n}" }, "CustomerPrivacy": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -180009,31 +180009,31 @@ "syntaxKind": "PropertySignature", "name": "analytics", "value": "boolean", - "description": "Whether analytics data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Analytics data includes how the shop was used and what interactions occurred." + "description": "Whether analytics data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Analytics data includes how the shop was used and what interactions occurred.\n\nWhether analytics data can be collected right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.analytics`, before calling `shopify.analytics.publish()`." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "marketing", "value": "boolean", - "description": "Whether marketing data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Marketing data includes attribution and targeted advertising preferences." + "description": "Whether marketing data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Marketing data includes attribution and targeted advertising preferences.\n\nWhether marketing data can be collected right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.marketing`, before performing marketing-related data collection." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "preferences", "value": "boolean", - "description": "Whether preference data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Preference data includes language, currency, and sizing choices." + "description": "Whether preference data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Preference data includes language, currency, and sizing choices.\n\nWhether preference data can be collected right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.preferences`, before storing or reading buyer preference data." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "saleOfData", "value": "boolean", - "description": "Whether data can be shared with third parties based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. This typically applies to behavioral advertising data." + "description": "Whether data can be shared with third parties based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. This typically applies to behavioral advertising data.\n\nWhether buyer data can be shared with or sold to third parties right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.saleOfData`, before sharing or selling buyer data with third parties." } ], - "value": "export interface AllowedProcessing {\n /**\n * Whether analytics data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Analytics\n * data includes how the shop was used and what interactions occurred.\n */\n analytics: boolean;\n /**\n * Whether marketing data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Marketing\n * data includes attribution and targeted advertising preferences.\n */\n marketing: boolean;\n /**\n * Whether preference data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Preference\n * data includes language, currency, and sizing choices.\n */\n preferences: boolean;\n /**\n * Whether data can be shared with third parties based on the visitor's\n * consent, the merchant's privacy configuration, and the visitor's region.\n * This typically applies to behavioral advertising data.\n */\n saleOfData: boolean;\n}" + "value": "export interface AllowedProcessing {\n /**\n * Whether analytics data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Analytics\n * data includes how the shop was used and what interactions occurred.\n *\n * Whether analytics data can be collected right now. Combines the buyer's\n * consent, the merchant's privacy configuration, and the buyer's region into\n * a single boolean. Check this flag, not `visitorConsent.analytics`, before\n * calling `shopify.analytics.publish()`.\n */\n analytics: boolean;\n /**\n * Whether marketing data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Marketing\n * data includes attribution and targeted advertising preferences.\n *\n * Whether marketing data can be collected right now. Combines the buyer's\n * consent, the merchant's privacy configuration, and the buyer's region into\n * a single boolean. Check this flag, not `visitorConsent.marketing`, before\n * performing marketing-related data collection.\n */\n marketing: boolean;\n /**\n * Whether preference data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Preference\n * data includes language, currency, and sizing choices.\n *\n * Whether preference data can be collected right now. Combines the buyer's\n * consent, the merchant's privacy configuration, and the buyer's region into\n * a single boolean. Check this flag, not `visitorConsent.preferences`,\n * before storing or reading buyer preference data.\n */\n preferences: boolean;\n /**\n * Whether data can be shared with third parties based on the visitor's\n * consent, the merchant's privacy configuration, and the visitor's region.\n * This typically applies to behavioral advertising data.\n *\n * Whether buyer data can be shared with or sold to third parties right now.\n * Combines the buyer's consent, the merchant's privacy configuration, and\n * the buyer's region into a single boolean. Check this flag, not\n * `visitorConsent.saleOfData`, before sharing or selling buyer data with\n * third parties.\n */\n saleOfData: boolean;\n}" }, "TrackingConsentMetafield": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -180725,7 +180725,7 @@ "Extension": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Extension", - "description": "The meta information about an extension target.", + "description": "Metadata about the running extension, including its API version, target, capabilities, and editor context. Use this to read configuration details or conditionally render content based on where the extension is running.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -180751,7 +180751,7 @@ "syntaxKind": "PropertySignature", "name": "capabilities", "value": "SubscribableSignalLike", - "description": "The allowed capabilities of the extension, defined in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n\n* [`api_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#api-access): the extension can access the Storefront API.\n\n* [`network_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access): the extension can make external network calls.\n\n* [`block_progress`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n\n* [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n\n* [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can register customer consent decisions that are honored on Shopify-managed services.\n\n* [`iframe.sources`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#iframe): the extension can embed an external URL in an iframe." + "description": "The allowed capabilities of the extension, defined in your [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -180799,7 +180799,7 @@ "syntaxKind": "PropertySignature", "name": "version", "value": "string", - "description": "The published version of the running extension target.\n\nFor unpublished extensions, the value is `undefined`.", + "description": "The published version of the running extension target.\n\nFor unpublished extensions, the value is `undefined`.\n\nDon't use this property as a stable identifier in development environments. It becomes available only after the extension is published.", "isOptional": true, "examples": [ { @@ -180815,7 +180815,7 @@ ] } ], - "value": "export interface Extension {\n /**\n * The API version that was set in the extension config file.\n *\n * @example '2024-10', '2025-01', '2025-04', '2025-07', '2025-10'\n */\n apiVersion: ApiVersion;\n\n /**\n * The allowed capabilities of the extension, defined\n * in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n *\n * * [`api_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#api-access): the extension can access the Storefront API.\n *\n * * [`network_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access): the extension can make external network calls.\n *\n * * [`block_progress`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n *\n * * [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n *\n * * [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can register customer consent decisions that are honored on Shopify-managed services.\n *\n * * [`iframe.sources`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#iframe): the extension can embed an external URL in an iframe.\n */\n capabilities: SubscribableSignalLike;\n\n /**\n * Information about the editor where the extension is being rendered.\n *\n * If the value is undefined, then the extension isn't running in an editor.\n */\n editor?: Editor;\n\n /**\n * A Boolean to show whether your extension is currently rendered to the screen.\n *\n * Shopify might render your extension before it's visible in the UI,\n * typically to pre-render extensions that appear on a later step of the\n * checkout.\n *\n * Your extension might also continue to run after the customer has navigated away\n * from where it was rendered. The extension continues running so that\n * your extension is immediately available to render if the customer navigates back.\n */\n rendered: SubscribableSignalLike;\n\n /**\n * The URL to the script that started the extension target.\n */\n scriptUrl: string;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n */\n target: Target;\n\n /**\n * The published version of the running extension target.\n *\n * For unpublished extensions, the value is `undefined`.\n *\n * @example 3.0.10\n */\n version?: string;\n}" + "value": "export interface Extension {\n /**\n * The API version that was set in the extension config file.\n *\n * @example '2024-10', '2025-01', '2025-04', '2025-07', '2025-10'\n */\n apiVersion: ApiVersion;\n\n /**\n * The allowed capabilities of the extension, defined in your\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n */\n capabilities: SubscribableSignalLike;\n\n /**\n * Information about the editor where the extension is being rendered.\n *\n * If the value is undefined, then the extension isn't running in an editor.\n */\n editor?: Editor;\n\n /**\n * A Boolean to show whether your extension is currently rendered to the screen.\n *\n * Shopify might render your extension before it's visible in the UI,\n * typically to pre-render extensions that appear on a later step of the\n * checkout.\n *\n * Your extension might also continue to run after the customer has navigated away\n * from where it was rendered. The extension continues running so that\n * your extension is immediately available to render if the customer navigates back.\n */\n rendered: SubscribableSignalLike;\n\n /**\n * The URL to the script that started the extension target.\n */\n scriptUrl: string;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n */\n target: Target;\n\n /**\n * The published version of the running extension target.\n *\n * For unpublished extensions, the value is `undefined`.\n *\n * Don't use this property as a stable identifier in development environments.\n * It becomes available only after the extension is published.\n *\n * @example 3.0.10\n */\n version?: string;\n}" }, "ApiVersion": { "filePath": "src/shared.ts", @@ -180834,7 +180834,7 @@ "Editor": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Editor", - "description": "", + "description": "Information about the editor environment when an extension is rendered inside the checkout editor. The value is `undefined` when the extension is not rendering in an editor.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -180849,7 +180849,7 @@ "I18n": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18n", - "description": "", + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use the I18n API alongside the Localization API to build fully localized extensions.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -180885,7 +180885,7 @@ "I18nTranslate": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18nTranslate", - "description": "This returns a translated string matching a key in a locale file.", + "description": "Translates a key from your extension's locale files into a localized string. Supports interpolation with placeholder replacements and pluralization via the special `count` option.", "members": [], "value": "export interface I18nTranslate {\n (\n key: string,\n options?: Record,\n ): ReplacementType extends string | number\n ? string\n : (string | ReplacementType)[];\n}" }, @@ -181449,14 +181449,14 @@ "Localization": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Localization", - "description": "", + "description": "The buyer's language, country, currency, and timezone context. Use this to adapt your extension to the buyer's region and display localized content.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "country", "value": "SubscribableSignalLike", - "description": "The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown." + "description": "The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n\nDerived from the buyer's shipping address. Returns `undefined` until the buyer enters a shipping address." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -181484,18 +181484,18 @@ "syntaxKind": "PropertySignature", "name": "market", "value": "SubscribableSignalLike", - "description": "The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n\n> Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.", - "deprecationMessage": "Deprecated as of version `2025-04`" + "description": "The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. The market context updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.", + "deprecationMessage": "Merchants now manage which extensions load for each\nmarket, so extensions no longer need to check this value." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "timezone", "value": "SubscribableSignalLike", - "description": "The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time." + "description": "The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time." } ], - "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n *\n * > Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" + "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n *\n * Derived from the buyer's shipping address. Returns `undefined` until the\n * buyer enters a shipping address.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout,\n * carried over from the cart context. Markets group countries and\n * regions with shared pricing, languages, and domains. The market\n * context updates when the buyer changes the country of their\n * shipping address. The value is `undefined` if the market is unknown.\n *\n * @deprecated Merchants now manage which extensions load for each\n * market, so extensions no longer need to check this value.\n */\n market: SubscribableSignalLike;\n}" }, "Country": { "filePath": "src/shared.ts", @@ -181696,7 +181696,7 @@ "SessionToken": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SessionToken", - "description": "", + "description": "Authenticates requests between your extension and your app backend. Use session tokens to verify the identity of the buyer and the shop context when making server-side API calls. The token is a signed JWT that contains claims such as the customer ID, shop domain, and expiration.\n\nThe `sub` claim in the decoded token is present only when the buyer is logged in and the app has permission to read customer accounts. Absent for anonymous buyers.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -181955,7 +181955,7 @@ "Shop": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Shop", - "description": "", + "description": "Metadata about the merchant's store, including its name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -181995,30 +181995,30 @@ "syntaxKind": "PropertySignature", "name": "storefrontUrl", "value": "string", - "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n\n> Caution: > As of version `2024-04` this value no longer has a trailing slash.", + "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.", "isOptional": true } ], - "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n *\n * > Caution:\n * > As of version `2024-04` this value no longer has a trailing slash.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom domain.\n */\n myshopifyDomain: string;\n}" + "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom domain.\n */\n myshopifyDomain: string;\n}" }, "Storage": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Storage", - "description": "A key-value storage object for the extension.\n\nStored data is available only to this specific extension and any of its instances.\n\nThe storage backend is implemented with `localStorage` and should persist across the buyer's checkout session. However, data persistence isn't guaranteed.", + "description": "Key-value storage for a specific extension. Use storage to save preferences or cached data that should survive page reloads without requiring a backend call. Stored data is only available to this specific extension. The storage backend is implemented with `localStorage` and data persistence isn't guaranteed.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "delete", "value": "(key: string) => Promise", - "description": "Delete stored data by key." + "description": "Deletes a previously stored value by key." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "read", "value": "(key: string) => Promise", - "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original primitive.\n\nReturns `null` if no stored data exists." + "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original type.\n\nReturns the stored value for the given key, or `null` when no value exists. Doesn't throw on a missing key." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -182028,7 +182028,7 @@ "description": "Write stored data for this key.\n\nThe data must be serializable to JSON." } ], - "value": "export interface Storage {\n /**\n * Read and return a stored value by key.\n *\n * The stored data is deserialized from JSON and returned as\n * its original primitive.\n *\n * Returns `null` if no stored data exists.\n */\n read(key: string): Promise;\n\n /**\n * Write stored data for this key.\n *\n * The data must be serializable to JSON.\n */\n write(key: string, data: any): Promise;\n\n /**\n * Delete stored data by key.\n */\n delete(key: string): Promise;\n}" + "value": "export interface Storage {\n /**\n * Read and return a stored value by key.\n *\n * The stored data is deserialized from JSON and returned as\n * its original type.\n *\n * Returns the stored value for the given key, or `null` when no value\n * exists. Doesn't throw on a missing key.\n */\n read(key: string): Promise;\n\n /**\n * Write stored data for this key.\n *\n * The data must be serializable to JSON.\n */\n write(key: string, data: any): Promise;\n\n /**\n * Deletes a previously stored value by key.\n */\n delete(key: string): Promise;\n}" }, "Version": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -182164,7 +182164,7 @@ "syntaxKind": "PropertySignature", "name": "number", "value": "string", - "description": "A randomly generated alpha-numeric identifier for the order, distinct from `order.id`. The value is `undefined` for orders that were created before this field was introduced. All recent orders have a number.", + "description": "A randomly generated alpha-numeric identifier for the order, distinct from `order.id`. The value is `undefined` for orders that were created before this field was introduced. All recent orders have a number.\n\nOptional. Might not be present for orders created before 2024.", "isOptional": true }, { @@ -182175,7 +182175,7 @@ "description": "" } ], - "value": "export interface OrderConfirmation {\n order: {\n /**\n * A globally unique identifier for the order. This becomes the\n * [`Order`](/docs/api/admin-graphql/latest/objects/Order) object ID in the\n * GraphQL Admin API after the order is created.\n *\n * @example 'gid://shopify/Order/123'\n */\n id: string;\n };\n /**\n * A randomly generated alpha-numeric identifier for the order, distinct\n * from `order.id`. The value is `undefined` for orders that were created\n * before this field was introduced. All recent orders have a number.\n */\n number?: string;\n\n /**\n * Whether this is the customer's first completed order with this shop. `true` means the buyer hasn't placed an order here before. Use this to show first-purchase messaging or trigger welcome offers.\n */\n isFirstOrder: boolean;\n}" + "value": "export interface OrderConfirmation {\n order: {\n /**\n * A globally unique identifier for the order. This becomes the\n * [`Order`](/docs/api/admin-graphql/latest/objects/Order) object ID in the\n * GraphQL Admin API after the order is created.\n *\n * @example 'gid://shopify/Order/123'\n */\n id: string;\n };\n /**\n * A randomly generated alpha-numeric identifier for the order, distinct\n * from `order.id`. The value is `undefined` for orders that were created\n * before this field was introduced. All recent orders have a number.\n *\n * Optional. Might not be present for orders created before 2024.\n */\n number?: string;\n\n /**\n * Whether this is the customer's first completed order with this shop. `true` means the buyer hasn't placed an order here before. Use this to show first-purchase messaging or trigger welcome offers.\n */\n isFirstOrder: boolean;\n}" } } }, @@ -182194,7 +182194,7 @@ "syntaxKind": "PropertySignature", "name": "analytics", "value": "Analytics", - "description": "The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event." + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -182208,7 +182208,7 @@ "syntaxKind": "PropertySignature", "name": "applyTrackingConsentChange", "value": "ApplyTrackingConsentChangeType", - "description": "Enables setting and updating customer privacy consent settings and tracking consent metafields.\n\n> Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent) to be set to `true`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." + "description": "Enables setting and updating customer privacy consent settings and tracking consent metafields.\n\n> Note: Requires the [`collect_buyer_consent` capability](/docs/apps/build/customer-accounts/capabilities#collect-buyer-consent) to be set to `true`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -182229,7 +182229,7 @@ "syntaxKind": "PropertySignature", "name": "availablePaymentOptions", "value": "SubscribableSignalLike", - "description": "All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region." + "description": "All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n\nThe set of payment options can change when the buyer updates their address or cart, so subscribe to changes rather than reading once during initialization. Each option exposes `handle` and `type` only. Provider names, logos, fees, and installment terms aren't available." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -182266,7 +182266,7 @@ "syntaxKind": "PropertySignature", "name": "checkoutToken", "value": "SubscribableSignalLike", - "description": "A stable ID that represents the current checkout.\n\nThe value is `undefined` when the checkout hasn't been created on the server yet.\n\nUse this to correlate checkout sessions across your extension, web pixels, and backend systems.\n\nThis matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data) and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object)." + "description": "A stable ID that represents the current checkout.\n\nThe value is `undefined` when the checkout hasn't been created on the server yet.\n\nUse this to correlate checkout sessions across your extension, web pixels, and backend systems.\n\nThis matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data) and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n\nCan be `undefined`. Handle the `undefined` state before using the value." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -182287,7 +182287,7 @@ "syntaxKind": "PropertySignature", "name": "deliveryGroups", "value": "SubscribableSignalLike", - "description": "The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items." + "description": "The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n\nEmpty until the buyer enters enough address information for Shopify to calculate shipping rates." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -182308,7 +182308,7 @@ "syntaxKind": "PropertySignature", "name": "extension", "value": "Extension", - "description": "The meta information about the extension." + "description": "Metadata about the running extension, including the current target, API version, capabilities, and editor context. Use this to conditionally render content based on where the extension is running." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -182316,7 +182316,7 @@ "name": "extensionPoint", "value": "Target", "description": "The identifier that specifies where in Shopify's UI your code is being injected. This is one of the targets you've included in your extension's configuration file.", - "deprecationMessage": "Deprecated as of version `2023-07`, use `extension.target` instead.", + "deprecationMessage": "Use `extension.target` instead.", "examples": [ { "title": "Example", @@ -182335,14 +182335,14 @@ "syntaxKind": "PropertySignature", "name": "i18n", "value": "I18n", - "description": "Utilities for translating content and formatting values according to the current [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) of the checkout.\n\nRefer to [`localization` examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples) for more information." + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use alongside [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) to build fully localized extensions." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "instructions", "value": "SubscribableSignalLike", - "description": "The cart instructions used to create the checkout and possibly limit extension capabilities.\n\nThese instructions should be checked before performing any actions that might be affected by them.\n\nFor example, if you intend to add a discount code via the `applyDiscountCodeChange` method, check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n\n> Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs aren't available. See the [update guide](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples) for more information." + "description": "The cart instructions used to create the checkout and possibly limit extension capabilities.\n\nThese instructions should be checked before performing any actions that might be affected by them.\n\nFor example, if you intend to add a discount code via the `applyDiscountCodeChange` method, check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n\n> Caution: Check cart instructions before calling select APIs, as > some may not be available. See the > [Cart Instructions API](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples) > for more information." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -182356,7 +182356,7 @@ "syntaxKind": "PropertySignature", "name": "localization", "value": "Localization", - "description": "The details about the location, language, and currency of the customer. For utilities to easily format and translate content based on these details, you can use the [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n) object instead." + "description": "The buyer's language, country, currency, and timezone context. For formatting and translation helpers, use the [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#properties-propertydetail-i18n) object instead." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -182386,21 +182386,21 @@ "syntaxKind": "PropertySignature", "name": "query", "value": ">(query: string, options?: { variables?: Variables; version?: StorefrontApiVersion; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>", - "description": "The method used to query the Storefront GraphQL API with a prefetched token.\n\nRefer to [Storefront API access examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/storefront-api) for more information." + "description": "The method used to query the Storefront GraphQL API with a prefetched token." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "selectedPaymentOptions", "value": "SubscribableSignalLike", - "description": "The payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card)." + "description": "The payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\n\nEach option exposes `handle` and `type` only. Provider names, logos, fees, and installment terms aren't available." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "sessionToken", "value": "SessionToken", - "description": "The session token providing a set of claims as a signed JSON Web Token (JWT).\n\nThe token has a TTL of five minutes.\n\nIf the previous token expires, this value reflects a new session token with a new signature and expiry.\n\nRefer to [session token examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/session-token) for more information." + "description": "The session token providing a set of claims as a signed JSON Web Token (JWT).\n\nThe token has a TTL of five minutes.\n\nIf the previous token expires, this value reflects a new session token with a new signature and expiry.\n\nLearn more about [session tokens](/docs/apps/build/authentication-authorization/session-tokens)." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -182422,14 +182422,14 @@ "syntaxKind": "PropertySignature", "name": "shop", "value": "Shop", - "description": "The shop where the checkout is taking place." + "description": "The store where the checkout is taking place, including the shop name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "storage", "value": "Storage", - "description": "The key-value storage for the extension.\n\nIt uses `localStorage` and should persist across the customer's current checkout session.\n\n> Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n\nData is shared across all activated extension targets of this extension. In versions 2023-07 and earlier, each activated extension target had its own storage." + "description": "Key-value storage that persists across page loads within the current checkout session. Data is shared across all activated targets associated with this extension.\n\n> Caution: Data persistence isn't guaranteed and storage is cleared when the buyer starts a new checkout." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -182451,29 +182451,29 @@ ] } ], - "value": "export interface StandardApi {\n /**\n * The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event.\n */\n analytics: Analytics;\n\n /**\n * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\n */\n appliedGiftCards: SubscribableSignalLike;\n\n /**\n * The cart instructions used to create the checkout and possibly limit extension capabilities.\n *\n * These instructions should be checked before performing any actions that might be affected by them.\n *\n * For example, if you intend to add a discount code via the `applyDiscountCodeChange` method,\n * check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n *\n * > Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs aren't available.\n * See the [update guide](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples) for more information.\n *\n */\n instructions: SubscribableSignalLike;\n\n /**\n * The metafields requested in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration)\n * file. These metafields are updated when there's a change in the merchandise items\n * being purchased by the customer.\n *\n * App owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` isn't supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n appMetafields: SubscribableSignalLike;\n\n /**\n * The custom key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n buyerIdentity?: BuyerIdentity;\n\n /**\n * Provides details on the buyer's progression through the checkout and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/buyer-journey#examples)\n * examples for more information.\n */\n buyerJourney: BuyerJourney;\n\n /**\n * Settings applied to the buyer's checkout.\n */\n checkoutSettings: SubscribableSignalLike;\n\n /**\n * A stable ID that represents the current checkout.\n *\n * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\n *\n * This matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data)\n * and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n */\n checkoutToken: SubscribableSignalLike;\n\n /**\n * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * The meta information about the extension.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n *\n * @deprecated Deprecated as of version `2023-07`, use `extension.target` instead.\n */\n extensionPoint: Target;\n\n /**\n * Utilities for translating content and formatting values according to the current\n * [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization)\n * of the checkout.\n *\n * Refer to [`localization` examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples)\n * for more information.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The details about the location, language, and currency of the customer. For utilities to easily\n * format and translate content based on these details, you can use the\n * [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n)\n * object instead.\n */\n localization: Localization;\n\n /**\n * The metafields that apply to the current checkout.\n *\n * Metafields are stored locally on the client and are applied to the order object after the checkout completes.\n *\n * These metafields are shared by all extensions running on checkout, and\n * persist for as long as the customer is working on this checkout.\n *\n * Once the order is created, you can query these metafields using the\n * [GraphQL Admin API](/docs/admin-api/graphql/reference/orders/order#metafield-2021-01)\n *\n * > Caution:\n * `metafields` is deprecated. Use `appMetafields` with cart metafields instead.\n *\n * @deprecated Use `appMetafields` with cart metafields instead.\n */\n metafields: SubscribableSignalLike;\n\n /**\n * A note left by the customer to the merchant, either in their cart or during checkout.\n *\n * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\n */\n note: SubscribableSignalLike;\n\n /**\n * The method used to query the Storefront GraphQL API with a prefetched token.\n *\n * Refer to [Storefront API access examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/storefront-api) for more information.\n */\n query: >(\n query: string,\n options?: {variables?: Variables; version?: StorefrontApiVersion},\n ) => Promise<{data?: Data; errors?: GraphQLError[]}>;\n\n /**\n * The payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\n */\n selectedPaymentOptions: SubscribableSignalLike;\n\n /**\n * The session token providing a set of claims as a signed JSON Web Token (JWT).\n *\n * The token has a TTL of five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/session-token) for more information.\n */\n sessionToken: SessionToken;\n\n /**\n * The settings matching the settings definition written in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates in real time as a merchant fills in the settings.\n */\n settings: SubscribableSignalLike;\n\n /**\n * The proposed customer shipping address. During the information step, the address\n * updates when the field is committed (on change) rather than every keystroke.\n * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n shippingAddress?: SubscribableSignalLike;\n\n /**\n * The proposed customer billing address. The address updates when the field is\n * committed (on change) rather than every keystroke. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided yet.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n billingAddress?: SubscribableSignalLike;\n\n /** The shop where the checkout is taking place. */\n shop: Shop;\n\n /**\n * The key-value storage for the extension.\n *\n * It uses `localStorage` and should persist across the customer's current checkout session.\n *\n * > Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n *\n * Data is shared across all activated extension targets of this extension. In versions 2023-07 and earlier,\n * each activated extension target had its own storage.\n */\n storage: Storage;\n\n /**\n * The renderer version being used for the extension.\n *\n * @example '2025-10'\n */\n version: Version;\n\n /**\n * Customer privacy consent settings and a flag denoting if consent has previously been collected.\n */\n customerPrivacy: SubscribableSignalLike;\n\n /**\n * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent) to be set to `true`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyTrackingConsentChange: ApplyTrackingConsentChangeType;\n\n /**\n * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" + "value": "export interface StandardApi {\n /**\n * Tracks custom events and sends visitor information to\n * [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events\n * and `visitor()` to submit buyer contact details.\n */\n analytics: Analytics;\n\n /**\n * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\n */\n appliedGiftCards: SubscribableSignalLike;\n\n /**\n * The cart instructions used to create the checkout and possibly limit extension capabilities.\n *\n * These instructions should be checked before performing any actions that might be affected by them.\n *\n * For example, if you intend to add a discount code via the `applyDiscountCodeChange` method,\n * check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n *\n * > Caution: Check cart instructions before calling select APIs, as\n * > some may not be available. See the\n * > [Cart Instructions API](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples)\n * > for more information.\n *\n */\n instructions: SubscribableSignalLike;\n\n /**\n * The metafields requested in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration)\n * file. These metafields are updated when there's a change in the merchandise items\n * being purchased by the customer.\n *\n * App owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` isn't supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n appMetafields: SubscribableSignalLike;\n\n /**\n * The custom key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as\n * credit cards, wallets, and local payment methods. The list depends on\n * the shop's payment configuration and the buyer's region.\n *\n * The set of payment options can change when the buyer updates their\n * address or cart, so subscribe to changes rather than reading once\n * during initialization. Each option exposes `handle` and `type` only.\n * Provider names, logos, fees, and installment terms aren't available.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n buyerIdentity?: BuyerIdentity;\n\n /**\n * Provides details on the buyer's progression through the checkout and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/buyer-journey#examples)\n * examples for more information.\n */\n buyerJourney: BuyerJourney;\n\n /**\n * Settings applied to the buyer's checkout.\n */\n checkoutSettings: SubscribableSignalLike;\n\n /**\n * A stable ID that represents the current checkout.\n *\n * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\n *\n * This matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data)\n * and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n *\n * Can be `undefined`. Handle the `undefined` state before using the value.\n */\n checkoutToken: SubscribableSignalLike;\n\n /**\n * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n *\n * Empty until the buyer enters enough address information for Shopify to\n * calculate shipping rates.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * Metadata about the running extension, including the current target, API version,\n * capabilities, and editor context. Use this to conditionally render content\n * based on where the extension is running.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n *\n * @deprecated Use `extension.target` instead.\n */\n extensionPoint: Target;\n\n /**\n * Utilities for translating strings, formatting currencies, numbers, and dates\n * according to the buyer's locale. Use alongside\n * [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization)\n * to build fully localized extensions.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The buyer's language, country, currency, and timezone context. For\n * formatting and translation helpers, use the\n * [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#properties-propertydetail-i18n)\n * object instead.\n */\n localization: Localization;\n\n /**\n * The metafields that apply to the current checkout.\n *\n * Metafields are stored locally on the client and are applied to the order object after the checkout completes.\n *\n * These metafields are shared by all extensions running on checkout, and\n * persist for as long as the customer is working on this checkout.\n *\n * Once the order is created, you can query these metafields using the\n * [GraphQL Admin API](/docs/admin-api/graphql/reference/orders/order#metafield-2021-01)\n *\n * > Caution:\n * `metafields` is deprecated. Use `appMetafields` with cart metafields instead.\n *\n * @deprecated Use `appMetafields` with cart metafields instead.\n */\n metafields: SubscribableSignalLike;\n\n /**\n * A note left by the customer to the merchant, either in their cart or during checkout.\n *\n * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\n */\n note: SubscribableSignalLike;\n\n /**\n * The method used to query the Storefront GraphQL API with a prefetched token.\n *\n */\n query: >(\n query: string,\n options?: {variables?: Variables; version?: StorefrontApiVersion},\n ) => Promise<{data?: Data; errors?: GraphQLError[]}>;\n\n /**\n * The payment options the buyer has currently selected. This updates as\n * the buyer changes their payment method. The array can contain multiple\n * entries when the buyer splits payment across methods (for example, a\n * gift card and a credit card).\n *\n * Each option exposes `handle` and `type` only. Provider names, logos,\n * fees, and installment terms aren't available.\n */\n selectedPaymentOptions: SubscribableSignalLike;\n\n /**\n * The session token providing a set of claims as a signed JSON Web Token (JWT).\n *\n * The token has a TTL of five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Learn more about [session tokens](/docs/apps/build/authentication-authorization/session-tokens).\n */\n sessionToken: SessionToken;\n\n /**\n * The settings matching the settings definition written in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates in real time as a merchant fills in the settings.\n */\n settings: SubscribableSignalLike;\n\n /**\n * The proposed customer shipping address. During the information step, the address\n * updates when the field is committed (on change) rather than every keystroke.\n * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n shippingAddress?: SubscribableSignalLike;\n\n /**\n * The proposed customer billing address. The address updates when the field is\n * committed (on change) rather than every keystroke. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided yet.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n billingAddress?: SubscribableSignalLike;\n\n /**\n * The store where the checkout is taking place, including the shop name,\n * storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.\n */\n shop: Shop;\n\n /**\n * Key-value storage that persists across page loads within the current checkout\n * session. Data is shared across all activated targets associated with\n * this extension.\n *\n * > Caution: Data persistence isn't guaranteed and storage is cleared when the\n * buyer starts a new checkout.\n */\n storage: Storage;\n\n /**\n * The renderer version being used for the extension.\n *\n * @example '2025-10'\n */\n version: Version;\n\n /**\n * Customer privacy consent settings and a flag denoting if consent has previously been collected.\n */\n customerPrivacy: SubscribableSignalLike;\n\n /**\n * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`collect_buyer_consent` capability](/docs/apps/build/customer-accounts/capabilities#collect-buyer-consent) to be set to `true`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyTrackingConsentChange: ApplyTrackingConsentChangeType;\n\n /**\n * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" }, "Analytics": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Analytics", - "description": "", + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "publish", "value": "(name: string, data: Record) => Promise", - "description": "Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing)." + "description": "Publishes a custom event to [Web Pixels](/docs/apps/marketing). Returns `true` when the event is successfully dispatched.\n\nThe Promise resolves to `true` when the event was dispatched. The boolean indicates dispatch confirmation only. It doesn't indicate whether any specific web pixel processed the event." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "visitor", "value": "(data: { email?: string; phone?: string; }) => Promise", - "description": "A method for capturing details about a visitor on the online store." + "description": "Submits buyer contact details for attribution and analytics purposes." } ], - "value": "export interface Analytics {\n /**\n * Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing).\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * A method for capturing details about a visitor on the online store.\n */\n visitor(data: {email?: string; phone?: string}): Promise;\n}" + "value": "export interface Analytics {\n /**\n * Publishes a custom event to [Web Pixels](/docs/apps/marketing).\n * Returns `true` when the event is successfully dispatched.\n *\n * The Promise resolves to `true` when the event was dispatched. The boolean\n * indicates dispatch confirmation only. It doesn't indicate whether any\n * specific web pixel processed the event.\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * Submits buyer contact details for attribution and analytics purposes.\n */\n visitor(data: {email?: string; phone?: string}): Promise;\n}" }, "VisitorResult": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -182514,10 +182514,10 @@ "syntaxKind": "PropertySignature", "name": "type", "value": "'error'", - "description": "Indicates that the visitor information is invalid and wasn't submitted. Examples are using the wrong data type or missing a required property." + "description": "Indicates that the visitor information is invalid and wasn't submitted. Common causes include using the wrong data type or omitting a required property." } ], - "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Examples are using the wrong data type or missing a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Common causes include using the wrong data type or omitting a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" }, "SubscribableSignalLike": { "filePath": "src/surfaces/checkout/shared.ts", @@ -182731,10 +182731,10 @@ "syntaxKind": "PropertySignature", "name": "value", "value": "string | null", - "description": "The new value to store in the metafield. Set to `null` to delete the metafield." + "description": "The new value to store in the metafield. Set to `null` to delete the metafield.\n\nConsent metafield values are strings, not booleans. Pass `null` to delete a tracking consent metafield." } ], - "value": "export interface TrackingConsentMetafieldChange {\n /**\n * The identifier for the tracking consent metafield to update.\n */\n key: string;\n /**\n * The new value to store in the metafield. Set to `null` to delete the metafield.\n */\n value: string | null;\n}" + "value": "export interface TrackingConsentMetafieldChange {\n /**\n * The identifier for the tracking consent metafield to update.\n */\n key: string;\n /**\n * The new value to store in the metafield. Set to `null` to delete the metafield.\n *\n * Consent metafield values are strings, not booleans. Pass `null` to delete\n * a tracking consent metafield.\n */\n value: string | null;\n}" }, "VisitorConsent": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -182948,7 +182948,7 @@ "syntaxKind": "PropertySignature", "name": "value", "value": "string", - "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.", + "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.\n\nAttribute values are always strings. To store structured data, serialize it to JSON and parse it when reading.", "examples": [ { "title": "Example", @@ -182963,7 +182963,7 @@ ] } ], - "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" + "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * Attribute values are always strings. To store structured data, serialize\n * it to JSON and parse it when reading.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" }, "PaymentOption": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -183314,7 +183314,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A globally-unique identifier for the customer in the format `gid://shopify/Customer/`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", + "description": "An identifier for the customer in the format `gid://shopify/Customer/`. This value is unique per shop.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", "examples": [ { "title": "Example", @@ -183367,7 +183367,7 @@ "isPrivate": true } ], - "value": "export interface Customer {\n /**\n * A globally-unique identifier for the customer in the format `gid://shopify/Customer/`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'gid://shopify/Customer/123'\n */\n id: string;\n /**\n * The email address associated with the customer's account. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email?: string;\n /**\n * The phone number associated with the customer's account. The value is `undefined` if no phone number is on file or the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone?: string;\n /**\n * The customer's full name, typically a combination of first and last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n fullName?: string;\n /**\n * The customer's first name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n firstName?: string;\n /**\n * The customer's last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n lastName?: string;\n /**\n * The customer's profile image, such as a Gravatar avatar. Use this to personalize the extension UI for the logged-in buyer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n image: ImageDetails;\n /**\n * Whether the customer has opted in to receiving marketing communications from the merchant, such as email campaigns and promotional offers.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * > Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n *\n * @deprecated Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n */\n acceptsMarketing: boolean;\n /**\n * Whether the customer has opted in to email marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsEmailMarketing: boolean;\n /**\n * Whether the customer has opted in to SMS marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsSmsMarketing: boolean;\n /**\n * The store credit accounts owned by this customer that can be used as payment during checkout. Each account has a balance representing available store credit.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @private\n */\n storeCreditAccounts: StoreCreditAccount[];\n /**\n * The number of orders the customer has previously placed with this shop.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n ordersCount: number;\n}" + "value": "export interface Customer {\n /**\n * An identifier for the customer in the format `gid://shopify/Customer/`. This value is unique per shop.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'gid://shopify/Customer/123'\n */\n id: string;\n /**\n * The email address associated with the customer's account. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email?: string;\n /**\n * The phone number associated with the customer's account. The value is `undefined` if no phone number is on file or the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone?: string;\n /**\n * The customer's full name, typically a combination of first and last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n fullName?: string;\n /**\n * The customer's first name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n firstName?: string;\n /**\n * The customer's last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n lastName?: string;\n /**\n * The customer's profile image, such as a Gravatar avatar. Use this to personalize the extension UI for the logged-in buyer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n image: ImageDetails;\n /**\n * Whether the customer has opted in to receiving marketing communications from the merchant, such as email campaigns and promotional offers.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * > Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n *\n * @deprecated Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n */\n acceptsMarketing: boolean;\n /**\n * Whether the customer has opted in to email marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsEmailMarketing: boolean;\n /**\n * Whether the customer has opted in to SMS marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsSmsMarketing: boolean;\n /**\n * The store credit accounts owned by this customer that can be used as payment during checkout. Each account has a balance representing available store credit.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @private\n */\n storeCreditAccounts: StoreCreditAccount[];\n /**\n * The number of orders the customer has previously placed with this shop.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n ordersCount: number;\n}" }, "ImageDetails": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -183649,11 +183649,11 @@ "syntaxKind": "MethodSignature", "name": "perform", "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", + "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.\n\nRuns after all intercept results are collected. Use it for local state updates such as setting an error flag. By the time it runs, the navigation decision is final, so blocking logic belongs in the intercept handler itself, not here.", "isOptional": true } ], - "value": "interface InterceptorRequestAllow {\n /**\n * Indicates that the interceptor allows the buyer's journey to continue.\n */\n behavior: 'allow';\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" + "value": "interface InterceptorRequestAllow {\n /**\n * Indicates that the interceptor allows the buyer's journey to continue.\n */\n behavior: 'allow';\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n *\n * Runs after all intercept results are collected. Use it for local state\n * updates such as setting an error flag. By the time it runs, the navigation\n * decision is final, so blocking logic belongs in the intercept handler\n * itself, not here.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" }, "InterceptorResult": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -183717,7 +183717,7 @@ "syntaxKind": "MethodSignature", "name": "perform", "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", + "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.\n\nRuns after all intercept results are collected. Use it for local state updates such as setting an error flag. By the time it runs, the navigation decision is final, so blocking logic belongs in the intercept handler itself, not here.", "isOptional": true }, { @@ -183728,7 +183728,7 @@ "description": "The reason for blocking the interceptor request. This value isn't presented to the buyer, so it doesn't need to be localized. The value is used only for Shopify's own internal debugging and metrics." } ], - "value": "interface InterceptorRequestBlock {\n /**\n * Indicates that the interceptor blocks the buyer's journey from continuing.\n */\n behavior: 'block';\n\n /**\n * The reason for blocking the interceptor request. This value isn't presented to\n * the buyer, so it doesn't need to be localized. The value is used only for Shopify's\n * own internal debugging and metrics.\n */\n reason: string;\n\n /**\n * Used to pass errors to the checkout UI, outside your extension's UI boundaries.\n */\n errors?: ValidationError[];\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" + "value": "interface InterceptorRequestBlock {\n /**\n * Indicates that the interceptor blocks the buyer's journey from continuing.\n */\n behavior: 'block';\n\n /**\n * The reason for blocking the interceptor request. This value isn't presented to\n * the buyer, so it doesn't need to be localized. The value is used only for Shopify's\n * own internal debugging and metrics.\n */\n reason: string;\n\n /**\n * Used to pass errors to the checkout UI, outside your extension's UI boundaries.\n */\n errors?: ValidationError[];\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n *\n * Runs after all intercept results are collected. Use it for local state\n * updates such as setting an error flag. By the time it runs, the navigation\n * decision is final, so blocking logic belongs in the intercept handler\n * itself, not here.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" }, "ValidationError": { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -183949,17 +183949,17 @@ "syntaxKind": "PropertySignature", "name": "totalShippingAmount", "value": "SubscribableSignalLike", - "description": "The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step." + "description": "The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step.\n\n`undefined` until the buyer selects a shipping method (typically after the information step)." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "totalTaxAmount", "value": "SubscribableSignalLike", - "description": "The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet." + "description": "The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet.\n\n`undefined` when taxes haven't been calculated or aren't available for the buyer's region." } ], - "value": "export interface CartCost {\n /**\n * The sum of all line item prices at the current step of checkout, before shipping and taxes are applied. Use this value to display the base cost of the items the buyer purchased.\n */\n subtotalAmount: SubscribableSignalLike;\n\n /**\n * The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step.\n */\n totalShippingAmount: SubscribableSignalLike;\n\n /**\n * The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet.\n */\n totalTaxAmount: SubscribableSignalLike;\n\n /**\n * The minimum total at the current step of checkout. Costs not yet calculated, such as shipping on the information step, aren't included. Gift cards and store credits are excluded from this total.\n */\n totalAmount: SubscribableSignalLike;\n}" + "value": "export interface CartCost {\n /**\n * The sum of all line item prices at the current step of checkout, before shipping and taxes are applied. Use this value to display the base cost of the items the buyer purchased.\n */\n subtotalAmount: SubscribableSignalLike;\n\n /**\n * The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step.\n *\n * `undefined` until the buyer selects a shipping method (typically after the\n * information step).\n */\n totalShippingAmount: SubscribableSignalLike;\n\n /**\n * The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet.\n *\n * `undefined` when taxes haven't been calculated or aren't available for the\n * buyer's region.\n */\n totalTaxAmount: SubscribableSignalLike;\n\n /**\n * The minimum total at the current step of checkout. Costs not yet calculated, such as shipping on the information step, aren't included. Gift cards and store credits are excluded from this total.\n */\n totalAmount: SubscribableSignalLike;\n}" }, "CustomerPrivacy": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -184046,31 +184046,31 @@ "syntaxKind": "PropertySignature", "name": "analytics", "value": "boolean", - "description": "Whether analytics data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Analytics data includes how the shop was used and what interactions occurred." + "description": "Whether analytics data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Analytics data includes how the shop was used and what interactions occurred.\n\nWhether analytics data can be collected right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.analytics`, before calling `shopify.analytics.publish()`." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "marketing", "value": "boolean", - "description": "Whether marketing data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Marketing data includes attribution and targeted advertising preferences." + "description": "Whether marketing data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Marketing data includes attribution and targeted advertising preferences.\n\nWhether marketing data can be collected right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.marketing`, before performing marketing-related data collection." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "preferences", "value": "boolean", - "description": "Whether preference data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Preference data includes language, currency, and sizing choices." + "description": "Whether preference data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Preference data includes language, currency, and sizing choices.\n\nWhether preference data can be collected right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.preferences`, before storing or reading buyer preference data." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "saleOfData", "value": "boolean", - "description": "Whether data can be shared with third parties based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. This typically applies to behavioral advertising data." + "description": "Whether data can be shared with third parties based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. This typically applies to behavioral advertising data.\n\nWhether buyer data can be shared with or sold to third parties right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.saleOfData`, before sharing or selling buyer data with third parties." } ], - "value": "export interface AllowedProcessing {\n /**\n * Whether analytics data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Analytics\n * data includes how the shop was used and what interactions occurred.\n */\n analytics: boolean;\n /**\n * Whether marketing data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Marketing\n * data includes attribution and targeted advertising preferences.\n */\n marketing: boolean;\n /**\n * Whether preference data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Preference\n * data includes language, currency, and sizing choices.\n */\n preferences: boolean;\n /**\n * Whether data can be shared with third parties based on the visitor's\n * consent, the merchant's privacy configuration, and the visitor's region.\n * This typically applies to behavioral advertising data.\n */\n saleOfData: boolean;\n}" + "value": "export interface AllowedProcessing {\n /**\n * Whether analytics data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Analytics\n * data includes how the shop was used and what interactions occurred.\n *\n * Whether analytics data can be collected right now. Combines the buyer's\n * consent, the merchant's privacy configuration, and the buyer's region into\n * a single boolean. Check this flag, not `visitorConsent.analytics`, before\n * calling `shopify.analytics.publish()`.\n */\n analytics: boolean;\n /**\n * Whether marketing data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Marketing\n * data includes attribution and targeted advertising preferences.\n *\n * Whether marketing data can be collected right now. Combines the buyer's\n * consent, the merchant's privacy configuration, and the buyer's region into\n * a single boolean. Check this flag, not `visitorConsent.marketing`, before\n * performing marketing-related data collection.\n */\n marketing: boolean;\n /**\n * Whether preference data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Preference\n * data includes language, currency, and sizing choices.\n *\n * Whether preference data can be collected right now. Combines the buyer's\n * consent, the merchant's privacy configuration, and the buyer's region into\n * a single boolean. Check this flag, not `visitorConsent.preferences`,\n * before storing or reading buyer preference data.\n */\n preferences: boolean;\n /**\n * Whether data can be shared with third parties based on the visitor's\n * consent, the merchant's privacy configuration, and the visitor's region.\n * This typically applies to behavioral advertising data.\n *\n * Whether buyer data can be shared with or sold to third parties right now.\n * Combines the buyer's consent, the merchant's privacy configuration, and\n * the buyer's region into a single boolean. Check this flag, not\n * `visitorConsent.saleOfData`, before sharing or selling buyer data with\n * third parties.\n */\n saleOfData: boolean;\n}" }, "TrackingConsentMetafield": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -184762,7 +184762,7 @@ "Extension": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Extension", - "description": "The meta information about an extension target.", + "description": "Metadata about the running extension, including its API version, target, capabilities, and editor context. Use this to read configuration details or conditionally render content based on where the extension is running.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -184788,7 +184788,7 @@ "syntaxKind": "PropertySignature", "name": "capabilities", "value": "SubscribableSignalLike", - "description": "The allowed capabilities of the extension, defined in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n\n* [`api_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#api-access): the extension can access the Storefront API.\n\n* [`network_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access): the extension can make external network calls.\n\n* [`block_progress`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n\n* [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n\n* [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can register customer consent decisions that are honored on Shopify-managed services.\n\n* [`iframe.sources`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#iframe): the extension can embed an external URL in an iframe." + "description": "The allowed capabilities of the extension, defined in your [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -184836,7 +184836,7 @@ "syntaxKind": "PropertySignature", "name": "version", "value": "string", - "description": "The published version of the running extension target.\n\nFor unpublished extensions, the value is `undefined`.", + "description": "The published version of the running extension target.\n\nFor unpublished extensions, the value is `undefined`.\n\nDon't use this property as a stable identifier in development environments. It becomes available only after the extension is published.", "isOptional": true, "examples": [ { @@ -184852,7 +184852,7 @@ ] } ], - "value": "export interface Extension {\n /**\n * The API version that was set in the extension config file.\n *\n * @example '2024-10', '2025-01', '2025-04', '2025-07', '2025-10'\n */\n apiVersion: ApiVersion;\n\n /**\n * The allowed capabilities of the extension, defined\n * in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n *\n * * [`api_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#api-access): the extension can access the Storefront API.\n *\n * * [`network_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access): the extension can make external network calls.\n *\n * * [`block_progress`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n *\n * * [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n *\n * * [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can register customer consent decisions that are honored on Shopify-managed services.\n *\n * * [`iframe.sources`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#iframe): the extension can embed an external URL in an iframe.\n */\n capabilities: SubscribableSignalLike;\n\n /**\n * Information about the editor where the extension is being rendered.\n *\n * If the value is undefined, then the extension isn't running in an editor.\n */\n editor?: Editor;\n\n /**\n * A Boolean to show whether your extension is currently rendered to the screen.\n *\n * Shopify might render your extension before it's visible in the UI,\n * typically to pre-render extensions that appear on a later step of the\n * checkout.\n *\n * Your extension might also continue to run after the customer has navigated away\n * from where it was rendered. The extension continues running so that\n * your extension is immediately available to render if the customer navigates back.\n */\n rendered: SubscribableSignalLike;\n\n /**\n * The URL to the script that started the extension target.\n */\n scriptUrl: string;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n */\n target: Target;\n\n /**\n * The published version of the running extension target.\n *\n * For unpublished extensions, the value is `undefined`.\n *\n * @example 3.0.10\n */\n version?: string;\n}" + "value": "export interface Extension {\n /**\n * The API version that was set in the extension config file.\n *\n * @example '2024-10', '2025-01', '2025-04', '2025-07', '2025-10'\n */\n apiVersion: ApiVersion;\n\n /**\n * The allowed capabilities of the extension, defined in your\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n */\n capabilities: SubscribableSignalLike;\n\n /**\n * Information about the editor where the extension is being rendered.\n *\n * If the value is undefined, then the extension isn't running in an editor.\n */\n editor?: Editor;\n\n /**\n * A Boolean to show whether your extension is currently rendered to the screen.\n *\n * Shopify might render your extension before it's visible in the UI,\n * typically to pre-render extensions that appear on a later step of the\n * checkout.\n *\n * Your extension might also continue to run after the customer has navigated away\n * from where it was rendered. The extension continues running so that\n * your extension is immediately available to render if the customer navigates back.\n */\n rendered: SubscribableSignalLike;\n\n /**\n * The URL to the script that started the extension target.\n */\n scriptUrl: string;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n */\n target: Target;\n\n /**\n * The published version of the running extension target.\n *\n * For unpublished extensions, the value is `undefined`.\n *\n * Don't use this property as a stable identifier in development environments.\n * It becomes available only after the extension is published.\n *\n * @example 3.0.10\n */\n version?: string;\n}" }, "ApiVersion": { "filePath": "src/shared.ts", @@ -184871,7 +184871,7 @@ "Editor": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Editor", - "description": "", + "description": "Information about the editor environment when an extension is rendered inside the checkout editor. The value is `undefined` when the extension is not rendering in an editor.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -184886,7 +184886,7 @@ "I18n": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18n", - "description": "", + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use the I18n API alongside the Localization API to build fully localized extensions.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -184922,7 +184922,7 @@ "I18nTranslate": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18nTranslate", - "description": "This returns a translated string matching a key in a locale file.", + "description": "Translates a key from your extension's locale files into a localized string. Supports interpolation with placeholder replacements and pluralization via the special `count` option.", "members": [], "value": "export interface I18nTranslate {\n (\n key: string,\n options?: Record,\n ): ReplacementType extends string | number\n ? string\n : (string | ReplacementType)[];\n}" }, @@ -185486,14 +185486,14 @@ "Localization": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Localization", - "description": "", + "description": "The buyer's language, country, currency, and timezone context. Use this to adapt your extension to the buyer's region and display localized content.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "country", "value": "SubscribableSignalLike", - "description": "The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown." + "description": "The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n\nDerived from the buyer's shipping address. Returns `undefined` until the buyer enters a shipping address." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -185521,18 +185521,18 @@ "syntaxKind": "PropertySignature", "name": "market", "value": "SubscribableSignalLike", - "description": "The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n\n> Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.", - "deprecationMessage": "Deprecated as of version `2025-04`" + "description": "The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. The market context updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.", + "deprecationMessage": "Merchants now manage which extensions load for each\nmarket, so extensions no longer need to check this value." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "timezone", "value": "SubscribableSignalLike", - "description": "The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time." + "description": "The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time." } ], - "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n *\n * > Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" + "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n *\n * Derived from the buyer's shipping address. Returns `undefined` until the\n * buyer enters a shipping address.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout,\n * carried over from the cart context. Markets group countries and\n * regions with shared pricing, languages, and domains. The market\n * context updates when the buyer changes the country of their\n * shipping address. The value is `undefined` if the market is unknown.\n *\n * @deprecated Merchants now manage which extensions load for each\n * market, so extensions no longer need to check this value.\n */\n market: SubscribableSignalLike;\n}" }, "Country": { "filePath": "src/shared.ts", @@ -185733,7 +185733,7 @@ "SessionToken": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SessionToken", - "description": "", + "description": "Authenticates requests between your extension and your app backend. Use session tokens to verify the identity of the buyer and the shop context when making server-side API calls. The token is a signed JWT that contains claims such as the customer ID, shop domain, and expiration.\n\nThe `sub` claim in the decoded token is present only when the buyer is logged in and the app has permission to read customer accounts. Absent for anonymous buyers.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -185992,7 +185992,7 @@ "Shop": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Shop", - "description": "", + "description": "Metadata about the merchant's store, including its name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -186032,30 +186032,30 @@ "syntaxKind": "PropertySignature", "name": "storefrontUrl", "value": "string", - "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n\n> Caution: > As of version `2024-04` this value no longer has a trailing slash.", + "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.", "isOptional": true } ], - "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n *\n * > Caution:\n * > As of version `2024-04` this value no longer has a trailing slash.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom domain.\n */\n myshopifyDomain: string;\n}" + "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom domain.\n */\n myshopifyDomain: string;\n}" }, "Storage": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Storage", - "description": "A key-value storage object for the extension.\n\nStored data is available only to this specific extension and any of its instances.\n\nThe storage backend is implemented with `localStorage` and should persist across the buyer's checkout session. However, data persistence isn't guaranteed.", + "description": "Key-value storage for a specific extension. Use storage to save preferences or cached data that should survive page reloads without requiring a backend call. Stored data is only available to this specific extension. The storage backend is implemented with `localStorage` and data persistence isn't guaranteed.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "delete", "value": "(key: string) => Promise", - "description": "Delete stored data by key." + "description": "Deletes a previously stored value by key." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "read", "value": "(key: string) => Promise", - "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original primitive.\n\nReturns `null` if no stored data exists." + "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original type.\n\nReturns the stored value for the given key, or `null` when no value exists. Doesn't throw on a missing key." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -186065,7 +186065,7 @@ "description": "Write stored data for this key.\n\nThe data must be serializable to JSON." } ], - "value": "export interface Storage {\n /**\n * Read and return a stored value by key.\n *\n * The stored data is deserialized from JSON and returned as\n * its original primitive.\n *\n * Returns `null` if no stored data exists.\n */\n read(key: string): Promise;\n\n /**\n * Write stored data for this key.\n *\n * The data must be serializable to JSON.\n */\n write(key: string, data: any): Promise;\n\n /**\n * Delete stored data by key.\n */\n delete(key: string): Promise;\n}" + "value": "export interface Storage {\n /**\n * Read and return a stored value by key.\n *\n * The stored data is deserialized from JSON and returned as\n * its original type.\n *\n * Returns the stored value for the given key, or `null` when no value\n * exists. Doesn't throw on a missing key.\n */\n read(key: string): Promise;\n\n /**\n * Write stored data for this key.\n *\n * The data must be serializable to JSON.\n */\n write(key: string, data: any): Promise;\n\n /**\n * Deletes a previously stored value by key.\n */\n delete(key: string): Promise;\n}" }, "Version": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -186201,7 +186201,7 @@ "syntaxKind": "PropertySignature", "name": "number", "value": "string", - "description": "A randomly generated alpha-numeric identifier for the order, distinct from `order.id`. The value is `undefined` for orders that were created before this field was introduced. All recent orders have a number.", + "description": "A randomly generated alpha-numeric identifier for the order, distinct from `order.id`. The value is `undefined` for orders that were created before this field was introduced. All recent orders have a number.\n\nOptional. Might not be present for orders created before 2024.", "isOptional": true }, { @@ -186212,7 +186212,7 @@ "description": "" } ], - "value": "export interface OrderConfirmation {\n order: {\n /**\n * A globally unique identifier for the order. This becomes the\n * [`Order`](/docs/api/admin-graphql/latest/objects/Order) object ID in the\n * GraphQL Admin API after the order is created.\n *\n * @example 'gid://shopify/Order/123'\n */\n id: string;\n };\n /**\n * A randomly generated alpha-numeric identifier for the order, distinct\n * from `order.id`. The value is `undefined` for orders that were created\n * before this field was introduced. All recent orders have a number.\n */\n number?: string;\n\n /**\n * Whether this is the customer's first completed order with this shop. `true` means the buyer hasn't placed an order here before. Use this to show first-purchase messaging or trigger welcome offers.\n */\n isFirstOrder: boolean;\n}" + "value": "export interface OrderConfirmation {\n order: {\n /**\n * A globally unique identifier for the order. This becomes the\n * [`Order`](/docs/api/admin-graphql/latest/objects/Order) object ID in the\n * GraphQL Admin API after the order is created.\n *\n * @example 'gid://shopify/Order/123'\n */\n id: string;\n };\n /**\n * A randomly generated alpha-numeric identifier for the order, distinct\n * from `order.id`. The value is `undefined` for orders that were created\n * before this field was introduced. All recent orders have a number.\n *\n * Optional. Might not be present for orders created before 2024.\n */\n number?: string;\n\n /**\n * Whether this is the customer's first completed order with this shop. `true` means the buyer hasn't placed an order here before. Use this to show first-purchase messaging or trigger welcome offers.\n */\n isFirstOrder: boolean;\n}" } } }, @@ -186232,10 +186232,10 @@ "syntaxKind": "PropertySignature", "name": "target", "value": "SubscribableSignalLike", - "description": "The cart line that this extension is attached to. Use this to read the line item's merchandise, quantity, cost, and attributes.\n\n> Note: Until version `2023-04`, this property was a `ReadonlySignalLike`." + "description": "The cart line that this extension is attached to. Use this to read the line item's merchandise, quantity, cost, and attributes.\n\nAvailable only on the corresponding item target. Shipping option item targets expose shipping option properties; pickup location item targets expose pickup location properties.\n\n> Note: Until version `2023-04`, this property was a `ReadonlySignalLike`." } ], - "value": "export interface CartLineItemApi {\n /**\n * The cart line that this extension is attached to. Use this to read the\n * line item's merchandise, quantity, cost, and attributes.\n *\n * > Note: Until version `2023-04`, this property was a `ReadonlySignalLike`.\n */\n target: SubscribableSignalLike;\n}" + "value": "export interface CartLineItemApi {\n /**\n * The cart line that this extension is attached to. Use this to read the\n * line item's merchandise, quantity, cost, and attributes.\n *\n * Available only on the corresponding item target. Shipping option item\n * targets expose shipping option properties; pickup location item targets\n * expose pickup location properties.\n *\n * > Note: Until version `2023-04`, this property was a `ReadonlySignalLike`.\n */\n target: SubscribableSignalLike;\n}" }, "SubscribableSignalLike": { "filePath": "src/surfaces/checkout/shared.ts", @@ -186380,7 +186380,7 @@ "syntaxKind": "PropertySignature", "name": "value", "value": "string", - "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.", + "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.\n\nAttribute values are always strings. To store structured data, serialize it to JSON and parse it when reading.", "examples": [ { "title": "Example", @@ -186395,7 +186395,7 @@ ] } ], - "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" + "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * Attribute values are always strings. To store structured data, serialize\n * it to JSON and parse it when reading.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" }, "CartLineCost": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -186892,7 +186892,7 @@ "syntaxKind": "PropertySignature", "name": "analytics", "value": "Analytics", - "description": "The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event." + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -186906,7 +186906,7 @@ "syntaxKind": "PropertySignature", "name": "applyTrackingConsentChange", "value": "ApplyTrackingConsentChangeType", - "description": "Enables setting and updating customer privacy consent settings and tracking consent metafields.\n\n> Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent) to be set to `true`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." + "description": "Enables setting and updating customer privacy consent settings and tracking consent metafields.\n\n> Note: Requires the [`collect_buyer_consent` capability](/docs/apps/build/customer-accounts/capabilities#collect-buyer-consent) to be set to `true`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -186927,7 +186927,7 @@ "syntaxKind": "PropertySignature", "name": "availablePaymentOptions", "value": "SubscribableSignalLike", - "description": "All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region." + "description": "All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n\nThe set of payment options can change when the buyer updates their address or cart, so subscribe to changes rather than reading once during initialization. Each option exposes `handle` and `type` only. Provider names, logos, fees, and installment terms aren't available." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -186964,7 +186964,7 @@ "syntaxKind": "PropertySignature", "name": "checkoutToken", "value": "SubscribableSignalLike", - "description": "A stable ID that represents the current checkout.\n\nThe value is `undefined` when the checkout hasn't been created on the server yet.\n\nUse this to correlate checkout sessions across your extension, web pixels, and backend systems.\n\nThis matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data) and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object)." + "description": "A stable ID that represents the current checkout.\n\nThe value is `undefined` when the checkout hasn't been created on the server yet.\n\nUse this to correlate checkout sessions across your extension, web pixels, and backend systems.\n\nThis matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data) and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n\nCan be `undefined`. Handle the `undefined` state before using the value." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -186985,7 +186985,7 @@ "syntaxKind": "PropertySignature", "name": "deliveryGroups", "value": "SubscribableSignalLike", - "description": "The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items." + "description": "The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n\nEmpty until the buyer enters enough address information for Shopify to calculate shipping rates." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -187006,7 +187006,7 @@ "syntaxKind": "PropertySignature", "name": "extension", "value": "Extension", - "description": "The meta information about the extension." + "description": "Metadata about the running extension, including the current target, API version, capabilities, and editor context. Use this to conditionally render content based on where the extension is running." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -187014,7 +187014,7 @@ "name": "extensionPoint", "value": "Target", "description": "The identifier that specifies where in Shopify's UI your code is being injected. This is one of the targets you've included in your extension's configuration file.", - "deprecationMessage": "Deprecated as of version `2023-07`, use `extension.target` instead.", + "deprecationMessage": "Use `extension.target` instead.", "examples": [ { "title": "Example", @@ -187033,14 +187033,14 @@ "syntaxKind": "PropertySignature", "name": "i18n", "value": "I18n", - "description": "Utilities for translating content and formatting values according to the current [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) of the checkout.\n\nRefer to [`localization` examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples) for more information." + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use alongside [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) to build fully localized extensions." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "instructions", "value": "SubscribableSignalLike", - "description": "The cart instructions used to create the checkout and possibly limit extension capabilities.\n\nThese instructions should be checked before performing any actions that might be affected by them.\n\nFor example, if you intend to add a discount code via the `applyDiscountCodeChange` method, check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n\n> Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs aren't available. See the [update guide](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples) for more information." + "description": "The cart instructions used to create the checkout and possibly limit extension capabilities.\n\nThese instructions should be checked before performing any actions that might be affected by them.\n\nFor example, if you intend to add a discount code via the `applyDiscountCodeChange` method, check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n\n> Caution: Check cart instructions before calling select APIs, as > some may not be available. See the > [Cart Instructions API](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples) > for more information." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -187054,7 +187054,7 @@ "syntaxKind": "PropertySignature", "name": "localization", "value": "Localization", - "description": "The details about the location, language, and currency of the customer. For utilities to easily format and translate content based on these details, you can use the [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n) object instead." + "description": "The buyer's language, country, currency, and timezone context. For formatting and translation helpers, use the [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#properties-propertydetail-i18n) object instead." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -187084,21 +187084,21 @@ "syntaxKind": "PropertySignature", "name": "query", "value": ">(query: string, options?: { variables?: Variables; version?: StorefrontApiVersion; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>", - "description": "The method used to query the Storefront GraphQL API with a prefetched token.\n\nRefer to [Storefront API access examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/storefront-api) for more information." + "description": "The method used to query the Storefront GraphQL API with a prefetched token." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "selectedPaymentOptions", "value": "SubscribableSignalLike", - "description": "The payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card)." + "description": "The payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\n\nEach option exposes `handle` and `type` only. Provider names, logos, fees, and installment terms aren't available." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "sessionToken", "value": "SessionToken", - "description": "The session token providing a set of claims as a signed JSON Web Token (JWT).\n\nThe token has a TTL of five minutes.\n\nIf the previous token expires, this value reflects a new session token with a new signature and expiry.\n\nRefer to [session token examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/session-token) for more information." + "description": "The session token providing a set of claims as a signed JSON Web Token (JWT).\n\nThe token has a TTL of five minutes.\n\nIf the previous token expires, this value reflects a new session token with a new signature and expiry.\n\nLearn more about [session tokens](/docs/apps/build/authentication-authorization/session-tokens)." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -187120,14 +187120,14 @@ "syntaxKind": "PropertySignature", "name": "shop", "value": "Shop", - "description": "The shop where the checkout is taking place." + "description": "The store where the checkout is taking place, including the shop name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "storage", "value": "Storage", - "description": "The key-value storage for the extension.\n\nIt uses `localStorage` and should persist across the customer's current checkout session.\n\n> Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n\nData is shared across all activated extension targets of this extension. In versions 2023-07 and earlier, each activated extension target had its own storage." + "description": "Key-value storage that persists across page loads within the current checkout session. Data is shared across all activated targets associated with this extension.\n\n> Caution: Data persistence isn't guaranteed and storage is cleared when the buyer starts a new checkout." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -187149,29 +187149,29 @@ ] } ], - "value": "export interface StandardApi {\n /**\n * The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event.\n */\n analytics: Analytics;\n\n /**\n * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\n */\n appliedGiftCards: SubscribableSignalLike;\n\n /**\n * The cart instructions used to create the checkout and possibly limit extension capabilities.\n *\n * These instructions should be checked before performing any actions that might be affected by them.\n *\n * For example, if you intend to add a discount code via the `applyDiscountCodeChange` method,\n * check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n *\n * > Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs aren't available.\n * See the [update guide](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples) for more information.\n *\n */\n instructions: SubscribableSignalLike;\n\n /**\n * The metafields requested in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration)\n * file. These metafields are updated when there's a change in the merchandise items\n * being purchased by the customer.\n *\n * App owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` isn't supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n appMetafields: SubscribableSignalLike;\n\n /**\n * The custom key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n buyerIdentity?: BuyerIdentity;\n\n /**\n * Provides details on the buyer's progression through the checkout and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/buyer-journey#examples)\n * examples for more information.\n */\n buyerJourney: BuyerJourney;\n\n /**\n * Settings applied to the buyer's checkout.\n */\n checkoutSettings: SubscribableSignalLike;\n\n /**\n * A stable ID that represents the current checkout.\n *\n * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\n *\n * This matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data)\n * and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n */\n checkoutToken: SubscribableSignalLike;\n\n /**\n * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * The meta information about the extension.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n *\n * @deprecated Deprecated as of version `2023-07`, use `extension.target` instead.\n */\n extensionPoint: Target;\n\n /**\n * Utilities for translating content and formatting values according to the current\n * [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization)\n * of the checkout.\n *\n * Refer to [`localization` examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples)\n * for more information.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The details about the location, language, and currency of the customer. For utilities to easily\n * format and translate content based on these details, you can use the\n * [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n)\n * object instead.\n */\n localization: Localization;\n\n /**\n * The metafields that apply to the current checkout.\n *\n * Metafields are stored locally on the client and are applied to the order object after the checkout completes.\n *\n * These metafields are shared by all extensions running on checkout, and\n * persist for as long as the customer is working on this checkout.\n *\n * Once the order is created, you can query these metafields using the\n * [GraphQL Admin API](/docs/admin-api/graphql/reference/orders/order#metafield-2021-01)\n *\n * > Caution:\n * `metafields` is deprecated. Use `appMetafields` with cart metafields instead.\n *\n * @deprecated Use `appMetafields` with cart metafields instead.\n */\n metafields: SubscribableSignalLike;\n\n /**\n * A note left by the customer to the merchant, either in their cart or during checkout.\n *\n * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\n */\n note: SubscribableSignalLike;\n\n /**\n * The method used to query the Storefront GraphQL API with a prefetched token.\n *\n * Refer to [Storefront API access examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/storefront-api) for more information.\n */\n query: >(\n query: string,\n options?: {variables?: Variables; version?: StorefrontApiVersion},\n ) => Promise<{data?: Data; errors?: GraphQLError[]}>;\n\n /**\n * The payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\n */\n selectedPaymentOptions: SubscribableSignalLike;\n\n /**\n * The session token providing a set of claims as a signed JSON Web Token (JWT).\n *\n * The token has a TTL of five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/session-token) for more information.\n */\n sessionToken: SessionToken;\n\n /**\n * The settings matching the settings definition written in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates in real time as a merchant fills in the settings.\n */\n settings: SubscribableSignalLike;\n\n /**\n * The proposed customer shipping address. During the information step, the address\n * updates when the field is committed (on change) rather than every keystroke.\n * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n shippingAddress?: SubscribableSignalLike;\n\n /**\n * The proposed customer billing address. The address updates when the field is\n * committed (on change) rather than every keystroke. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided yet.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n billingAddress?: SubscribableSignalLike;\n\n /** The shop where the checkout is taking place. */\n shop: Shop;\n\n /**\n * The key-value storage for the extension.\n *\n * It uses `localStorage` and should persist across the customer's current checkout session.\n *\n * > Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n *\n * Data is shared across all activated extension targets of this extension. In versions 2023-07 and earlier,\n * each activated extension target had its own storage.\n */\n storage: Storage;\n\n /**\n * The renderer version being used for the extension.\n *\n * @example '2025-10'\n */\n version: Version;\n\n /**\n * Customer privacy consent settings and a flag denoting if consent has previously been collected.\n */\n customerPrivacy: SubscribableSignalLike;\n\n /**\n * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent) to be set to `true`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyTrackingConsentChange: ApplyTrackingConsentChangeType;\n\n /**\n * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" + "value": "export interface StandardApi {\n /**\n * Tracks custom events and sends visitor information to\n * [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events\n * and `visitor()` to submit buyer contact details.\n */\n analytics: Analytics;\n\n /**\n * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\n */\n appliedGiftCards: SubscribableSignalLike;\n\n /**\n * The cart instructions used to create the checkout and possibly limit extension capabilities.\n *\n * These instructions should be checked before performing any actions that might be affected by them.\n *\n * For example, if you intend to add a discount code via the `applyDiscountCodeChange` method,\n * check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n *\n * > Caution: Check cart instructions before calling select APIs, as\n * > some may not be available. See the\n * > [Cart Instructions API](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples)\n * > for more information.\n *\n */\n instructions: SubscribableSignalLike;\n\n /**\n * The metafields requested in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration)\n * file. These metafields are updated when there's a change in the merchandise items\n * being purchased by the customer.\n *\n * App owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` isn't supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n appMetafields: SubscribableSignalLike;\n\n /**\n * The custom key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as\n * credit cards, wallets, and local payment methods. The list depends on\n * the shop's payment configuration and the buyer's region.\n *\n * The set of payment options can change when the buyer updates their\n * address or cart, so subscribe to changes rather than reading once\n * during initialization. Each option exposes `handle` and `type` only.\n * Provider names, logos, fees, and installment terms aren't available.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n buyerIdentity?: BuyerIdentity;\n\n /**\n * Provides details on the buyer's progression through the checkout and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/buyer-journey#examples)\n * examples for more information.\n */\n buyerJourney: BuyerJourney;\n\n /**\n * Settings applied to the buyer's checkout.\n */\n checkoutSettings: SubscribableSignalLike;\n\n /**\n * A stable ID that represents the current checkout.\n *\n * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\n *\n * This matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data)\n * and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n *\n * Can be `undefined`. Handle the `undefined` state before using the value.\n */\n checkoutToken: SubscribableSignalLike;\n\n /**\n * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n *\n * Empty until the buyer enters enough address information for Shopify to\n * calculate shipping rates.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * Metadata about the running extension, including the current target, API version,\n * capabilities, and editor context. Use this to conditionally render content\n * based on where the extension is running.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n *\n * @deprecated Use `extension.target` instead.\n */\n extensionPoint: Target;\n\n /**\n * Utilities for translating strings, formatting currencies, numbers, and dates\n * according to the buyer's locale. Use alongside\n * [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization)\n * to build fully localized extensions.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The buyer's language, country, currency, and timezone context. For\n * formatting and translation helpers, use the\n * [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#properties-propertydetail-i18n)\n * object instead.\n */\n localization: Localization;\n\n /**\n * The metafields that apply to the current checkout.\n *\n * Metafields are stored locally on the client and are applied to the order object after the checkout completes.\n *\n * These metafields are shared by all extensions running on checkout, and\n * persist for as long as the customer is working on this checkout.\n *\n * Once the order is created, you can query these metafields using the\n * [GraphQL Admin API](/docs/admin-api/graphql/reference/orders/order#metafield-2021-01)\n *\n * > Caution:\n * `metafields` is deprecated. Use `appMetafields` with cart metafields instead.\n *\n * @deprecated Use `appMetafields` with cart metafields instead.\n */\n metafields: SubscribableSignalLike;\n\n /**\n * A note left by the customer to the merchant, either in their cart or during checkout.\n *\n * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\n */\n note: SubscribableSignalLike;\n\n /**\n * The method used to query the Storefront GraphQL API with a prefetched token.\n *\n */\n query: >(\n query: string,\n options?: {variables?: Variables; version?: StorefrontApiVersion},\n ) => Promise<{data?: Data; errors?: GraphQLError[]}>;\n\n /**\n * The payment options the buyer has currently selected. This updates as\n * the buyer changes their payment method. The array can contain multiple\n * entries when the buyer splits payment across methods (for example, a\n * gift card and a credit card).\n *\n * Each option exposes `handle` and `type` only. Provider names, logos,\n * fees, and installment terms aren't available.\n */\n selectedPaymentOptions: SubscribableSignalLike;\n\n /**\n * The session token providing a set of claims as a signed JSON Web Token (JWT).\n *\n * The token has a TTL of five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Learn more about [session tokens](/docs/apps/build/authentication-authorization/session-tokens).\n */\n sessionToken: SessionToken;\n\n /**\n * The settings matching the settings definition written in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates in real time as a merchant fills in the settings.\n */\n settings: SubscribableSignalLike;\n\n /**\n * The proposed customer shipping address. During the information step, the address\n * updates when the field is committed (on change) rather than every keystroke.\n * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n shippingAddress?: SubscribableSignalLike;\n\n /**\n * The proposed customer billing address. The address updates when the field is\n * committed (on change) rather than every keystroke. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided yet.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n billingAddress?: SubscribableSignalLike;\n\n /**\n * The store where the checkout is taking place, including the shop name,\n * storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.\n */\n shop: Shop;\n\n /**\n * Key-value storage that persists across page loads within the current checkout\n * session. Data is shared across all activated targets associated with\n * this extension.\n *\n * > Caution: Data persistence isn't guaranteed and storage is cleared when the\n * buyer starts a new checkout.\n */\n storage: Storage;\n\n /**\n * The renderer version being used for the extension.\n *\n * @example '2025-10'\n */\n version: Version;\n\n /**\n * Customer privacy consent settings and a flag denoting if consent has previously been collected.\n */\n customerPrivacy: SubscribableSignalLike;\n\n /**\n * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`collect_buyer_consent` capability](/docs/apps/build/customer-accounts/capabilities#collect-buyer-consent) to be set to `true`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyTrackingConsentChange: ApplyTrackingConsentChangeType;\n\n /**\n * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" }, "Analytics": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Analytics", - "description": "", + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "publish", "value": "(name: string, data: Record) => Promise", - "description": "Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing)." + "description": "Publishes a custom event to [Web Pixels](/docs/apps/marketing). Returns `true` when the event is successfully dispatched.\n\nThe Promise resolves to `true` when the event was dispatched. The boolean indicates dispatch confirmation only. It doesn't indicate whether any specific web pixel processed the event." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "visitor", "value": "(data: { email?: string; phone?: string; }) => Promise", - "description": "A method for capturing details about a visitor on the online store." + "description": "Submits buyer contact details for attribution and analytics purposes." } ], - "value": "export interface Analytics {\n /**\n * Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing).\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * A method for capturing details about a visitor on the online store.\n */\n visitor(data: {email?: string; phone?: string}): Promise;\n}" + "value": "export interface Analytics {\n /**\n * Publishes a custom event to [Web Pixels](/docs/apps/marketing).\n * Returns `true` when the event is successfully dispatched.\n *\n * The Promise resolves to `true` when the event was dispatched. The boolean\n * indicates dispatch confirmation only. It doesn't indicate whether any\n * specific web pixel processed the event.\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * Submits buyer contact details for attribution and analytics purposes.\n */\n visitor(data: {email?: string; phone?: string}): Promise;\n}" }, "VisitorResult": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -187212,10 +187212,10 @@ "syntaxKind": "PropertySignature", "name": "type", "value": "'error'", - "description": "Indicates that the visitor information is invalid and wasn't submitted. Examples are using the wrong data type or missing a required property." + "description": "Indicates that the visitor information is invalid and wasn't submitted. Common causes include using the wrong data type or omitting a required property." } ], - "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Examples are using the wrong data type or missing a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Common causes include using the wrong data type or omitting a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" }, "SubscribableSignalLike": { "filePath": "src/surfaces/checkout/shared.ts", @@ -187429,10 +187429,10 @@ "syntaxKind": "PropertySignature", "name": "value", "value": "string | null", - "description": "The new value to store in the metafield. Set to `null` to delete the metafield." + "description": "The new value to store in the metafield. Set to `null` to delete the metafield.\n\nConsent metafield values are strings, not booleans. Pass `null` to delete a tracking consent metafield." } ], - "value": "export interface TrackingConsentMetafieldChange {\n /**\n * The identifier for the tracking consent metafield to update.\n */\n key: string;\n /**\n * The new value to store in the metafield. Set to `null` to delete the metafield.\n */\n value: string | null;\n}" + "value": "export interface TrackingConsentMetafieldChange {\n /**\n * The identifier for the tracking consent metafield to update.\n */\n key: string;\n /**\n * The new value to store in the metafield. Set to `null` to delete the metafield.\n *\n * Consent metafield values are strings, not booleans. Pass `null` to delete\n * a tracking consent metafield.\n */\n value: string | null;\n}" }, "VisitorConsent": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -187646,7 +187646,7 @@ "syntaxKind": "PropertySignature", "name": "value", "value": "string", - "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.", + "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.\n\nAttribute values are always strings. To store structured data, serialize it to JSON and parse it when reading.", "examples": [ { "title": "Example", @@ -187661,7 +187661,7 @@ ] } ], - "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" + "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * Attribute values are always strings. To store structured data, serialize\n * it to JSON and parse it when reading.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" }, "PaymentOption": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -188012,7 +188012,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A globally-unique identifier for the customer in the format `gid://shopify/Customer/`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", + "description": "An identifier for the customer in the format `gid://shopify/Customer/`. This value is unique per shop.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", "examples": [ { "title": "Example", @@ -188065,7 +188065,7 @@ "isPrivate": true } ], - "value": "export interface Customer {\n /**\n * A globally-unique identifier for the customer in the format `gid://shopify/Customer/`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'gid://shopify/Customer/123'\n */\n id: string;\n /**\n * The email address associated with the customer's account. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email?: string;\n /**\n * The phone number associated with the customer's account. The value is `undefined` if no phone number is on file or the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone?: string;\n /**\n * The customer's full name, typically a combination of first and last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n fullName?: string;\n /**\n * The customer's first name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n firstName?: string;\n /**\n * The customer's last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n lastName?: string;\n /**\n * The customer's profile image, such as a Gravatar avatar. Use this to personalize the extension UI for the logged-in buyer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n image: ImageDetails;\n /**\n * Whether the customer has opted in to receiving marketing communications from the merchant, such as email campaigns and promotional offers.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * > Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n *\n * @deprecated Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n */\n acceptsMarketing: boolean;\n /**\n * Whether the customer has opted in to email marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsEmailMarketing: boolean;\n /**\n * Whether the customer has opted in to SMS marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsSmsMarketing: boolean;\n /**\n * The store credit accounts owned by this customer that can be used as payment during checkout. Each account has a balance representing available store credit.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @private\n */\n storeCreditAccounts: StoreCreditAccount[];\n /**\n * The number of orders the customer has previously placed with this shop.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n ordersCount: number;\n}" + "value": "export interface Customer {\n /**\n * An identifier for the customer in the format `gid://shopify/Customer/`. This value is unique per shop.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'gid://shopify/Customer/123'\n */\n id: string;\n /**\n * The email address associated with the customer's account. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email?: string;\n /**\n * The phone number associated with the customer's account. The value is `undefined` if no phone number is on file or the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone?: string;\n /**\n * The customer's full name, typically a combination of first and last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n fullName?: string;\n /**\n * The customer's first name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n firstName?: string;\n /**\n * The customer's last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n lastName?: string;\n /**\n * The customer's profile image, such as a Gravatar avatar. Use this to personalize the extension UI for the logged-in buyer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n image: ImageDetails;\n /**\n * Whether the customer has opted in to receiving marketing communications from the merchant, such as email campaigns and promotional offers.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * > Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n *\n * @deprecated Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n */\n acceptsMarketing: boolean;\n /**\n * Whether the customer has opted in to email marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsEmailMarketing: boolean;\n /**\n * Whether the customer has opted in to SMS marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsSmsMarketing: boolean;\n /**\n * The store credit accounts owned by this customer that can be used as payment during checkout. Each account has a balance representing available store credit.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @private\n */\n storeCreditAccounts: StoreCreditAccount[];\n /**\n * The number of orders the customer has previously placed with this shop.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n ordersCount: number;\n}" }, "ImageDetails": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -188347,11 +188347,11 @@ "syntaxKind": "MethodSignature", "name": "perform", "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", + "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.\n\nRuns after all intercept results are collected. Use it for local state updates such as setting an error flag. By the time it runs, the navigation decision is final, so blocking logic belongs in the intercept handler itself, not here.", "isOptional": true } ], - "value": "interface InterceptorRequestAllow {\n /**\n * Indicates that the interceptor allows the buyer's journey to continue.\n */\n behavior: 'allow';\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" + "value": "interface InterceptorRequestAllow {\n /**\n * Indicates that the interceptor allows the buyer's journey to continue.\n */\n behavior: 'allow';\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n *\n * Runs after all intercept results are collected. Use it for local state\n * updates such as setting an error flag. By the time it runs, the navigation\n * decision is final, so blocking logic belongs in the intercept handler\n * itself, not here.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" }, "InterceptorResult": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -188415,7 +188415,7 @@ "syntaxKind": "MethodSignature", "name": "perform", "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", + "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.\n\nRuns after all intercept results are collected. Use it for local state updates such as setting an error flag. By the time it runs, the navigation decision is final, so blocking logic belongs in the intercept handler itself, not here.", "isOptional": true }, { @@ -188426,7 +188426,7 @@ "description": "The reason for blocking the interceptor request. This value isn't presented to the buyer, so it doesn't need to be localized. The value is used only for Shopify's own internal debugging and metrics." } ], - "value": "interface InterceptorRequestBlock {\n /**\n * Indicates that the interceptor blocks the buyer's journey from continuing.\n */\n behavior: 'block';\n\n /**\n * The reason for blocking the interceptor request. This value isn't presented to\n * the buyer, so it doesn't need to be localized. The value is used only for Shopify's\n * own internal debugging and metrics.\n */\n reason: string;\n\n /**\n * Used to pass errors to the checkout UI, outside your extension's UI boundaries.\n */\n errors?: ValidationError[];\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" + "value": "interface InterceptorRequestBlock {\n /**\n * Indicates that the interceptor blocks the buyer's journey from continuing.\n */\n behavior: 'block';\n\n /**\n * The reason for blocking the interceptor request. This value isn't presented to\n * the buyer, so it doesn't need to be localized. The value is used only for Shopify's\n * own internal debugging and metrics.\n */\n reason: string;\n\n /**\n * Used to pass errors to the checkout UI, outside your extension's UI boundaries.\n */\n errors?: ValidationError[];\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n *\n * Runs after all intercept results are collected. Use it for local state\n * updates such as setting an error flag. By the time it runs, the navigation\n * decision is final, so blocking logic belongs in the intercept handler\n * itself, not here.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" }, "ValidationError": { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -188647,17 +188647,17 @@ "syntaxKind": "PropertySignature", "name": "totalShippingAmount", "value": "SubscribableSignalLike", - "description": "The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step." + "description": "The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step.\n\n`undefined` until the buyer selects a shipping method (typically after the information step)." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "totalTaxAmount", "value": "SubscribableSignalLike", - "description": "The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet." + "description": "The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet.\n\n`undefined` when taxes haven't been calculated or aren't available for the buyer's region." } ], - "value": "export interface CartCost {\n /**\n * The sum of all line item prices at the current step of checkout, before shipping and taxes are applied. Use this value to display the base cost of the items the buyer purchased.\n */\n subtotalAmount: SubscribableSignalLike;\n\n /**\n * The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step.\n */\n totalShippingAmount: SubscribableSignalLike;\n\n /**\n * The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet.\n */\n totalTaxAmount: SubscribableSignalLike;\n\n /**\n * The minimum total at the current step of checkout. Costs not yet calculated, such as shipping on the information step, aren't included. Gift cards and store credits are excluded from this total.\n */\n totalAmount: SubscribableSignalLike;\n}" + "value": "export interface CartCost {\n /**\n * The sum of all line item prices at the current step of checkout, before shipping and taxes are applied. Use this value to display the base cost of the items the buyer purchased.\n */\n subtotalAmount: SubscribableSignalLike;\n\n /**\n * The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step.\n *\n * `undefined` until the buyer selects a shipping method (typically after the\n * information step).\n */\n totalShippingAmount: SubscribableSignalLike;\n\n /**\n * The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet.\n *\n * `undefined` when taxes haven't been calculated or aren't available for the\n * buyer's region.\n */\n totalTaxAmount: SubscribableSignalLike;\n\n /**\n * The minimum total at the current step of checkout. Costs not yet calculated, such as shipping on the information step, aren't included. Gift cards and store credits are excluded from this total.\n */\n totalAmount: SubscribableSignalLike;\n}" }, "CustomerPrivacy": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -188744,31 +188744,31 @@ "syntaxKind": "PropertySignature", "name": "analytics", "value": "boolean", - "description": "Whether analytics data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Analytics data includes how the shop was used and what interactions occurred." + "description": "Whether analytics data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Analytics data includes how the shop was used and what interactions occurred.\n\nWhether analytics data can be collected right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.analytics`, before calling `shopify.analytics.publish()`." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "marketing", "value": "boolean", - "description": "Whether marketing data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Marketing data includes attribution and targeted advertising preferences." + "description": "Whether marketing data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Marketing data includes attribution and targeted advertising preferences.\n\nWhether marketing data can be collected right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.marketing`, before performing marketing-related data collection." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "preferences", "value": "boolean", - "description": "Whether preference data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Preference data includes language, currency, and sizing choices." + "description": "Whether preference data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Preference data includes language, currency, and sizing choices.\n\nWhether preference data can be collected right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.preferences`, before storing or reading buyer preference data." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "saleOfData", "value": "boolean", - "description": "Whether data can be shared with third parties based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. This typically applies to behavioral advertising data." + "description": "Whether data can be shared with third parties based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. This typically applies to behavioral advertising data.\n\nWhether buyer data can be shared with or sold to third parties right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.saleOfData`, before sharing or selling buyer data with third parties." } ], - "value": "export interface AllowedProcessing {\n /**\n * Whether analytics data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Analytics\n * data includes how the shop was used and what interactions occurred.\n */\n analytics: boolean;\n /**\n * Whether marketing data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Marketing\n * data includes attribution and targeted advertising preferences.\n */\n marketing: boolean;\n /**\n * Whether preference data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Preference\n * data includes language, currency, and sizing choices.\n */\n preferences: boolean;\n /**\n * Whether data can be shared with third parties based on the visitor's\n * consent, the merchant's privacy configuration, and the visitor's region.\n * This typically applies to behavioral advertising data.\n */\n saleOfData: boolean;\n}" + "value": "export interface AllowedProcessing {\n /**\n * Whether analytics data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Analytics\n * data includes how the shop was used and what interactions occurred.\n *\n * Whether analytics data can be collected right now. Combines the buyer's\n * consent, the merchant's privacy configuration, and the buyer's region into\n * a single boolean. Check this flag, not `visitorConsent.analytics`, before\n * calling `shopify.analytics.publish()`.\n */\n analytics: boolean;\n /**\n * Whether marketing data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Marketing\n * data includes attribution and targeted advertising preferences.\n *\n * Whether marketing data can be collected right now. Combines the buyer's\n * consent, the merchant's privacy configuration, and the buyer's region into\n * a single boolean. Check this flag, not `visitorConsent.marketing`, before\n * performing marketing-related data collection.\n */\n marketing: boolean;\n /**\n * Whether preference data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Preference\n * data includes language, currency, and sizing choices.\n *\n * Whether preference data can be collected right now. Combines the buyer's\n * consent, the merchant's privacy configuration, and the buyer's region into\n * a single boolean. Check this flag, not `visitorConsent.preferences`,\n * before storing or reading buyer preference data.\n */\n preferences: boolean;\n /**\n * Whether data can be shared with third parties based on the visitor's\n * consent, the merchant's privacy configuration, and the visitor's region.\n * This typically applies to behavioral advertising data.\n *\n * Whether buyer data can be shared with or sold to third parties right now.\n * Combines the buyer's consent, the merchant's privacy configuration, and\n * the buyer's region into a single boolean. Check this flag, not\n * `visitorConsent.saleOfData`, before sharing or selling buyer data with\n * third parties.\n */\n saleOfData: boolean;\n}" }, "TrackingConsentMetafield": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -189460,7 +189460,7 @@ "Extension": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Extension", - "description": "The meta information about an extension target.", + "description": "Metadata about the running extension, including its API version, target, capabilities, and editor context. Use this to read configuration details or conditionally render content based on where the extension is running.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -189486,7 +189486,7 @@ "syntaxKind": "PropertySignature", "name": "capabilities", "value": "SubscribableSignalLike", - "description": "The allowed capabilities of the extension, defined in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n\n* [`api_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#api-access): the extension can access the Storefront API.\n\n* [`network_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access): the extension can make external network calls.\n\n* [`block_progress`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n\n* [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n\n* [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can register customer consent decisions that are honored on Shopify-managed services.\n\n* [`iframe.sources`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#iframe): the extension can embed an external URL in an iframe." + "description": "The allowed capabilities of the extension, defined in your [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -189534,7 +189534,7 @@ "syntaxKind": "PropertySignature", "name": "version", "value": "string", - "description": "The published version of the running extension target.\n\nFor unpublished extensions, the value is `undefined`.", + "description": "The published version of the running extension target.\n\nFor unpublished extensions, the value is `undefined`.\n\nDon't use this property as a stable identifier in development environments. It becomes available only after the extension is published.", "isOptional": true, "examples": [ { @@ -189550,7 +189550,7 @@ ] } ], - "value": "export interface Extension {\n /**\n * The API version that was set in the extension config file.\n *\n * @example '2024-10', '2025-01', '2025-04', '2025-07', '2025-10'\n */\n apiVersion: ApiVersion;\n\n /**\n * The allowed capabilities of the extension, defined\n * in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n *\n * * [`api_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#api-access): the extension can access the Storefront API.\n *\n * * [`network_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access): the extension can make external network calls.\n *\n * * [`block_progress`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n *\n * * [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n *\n * * [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can register customer consent decisions that are honored on Shopify-managed services.\n *\n * * [`iframe.sources`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#iframe): the extension can embed an external URL in an iframe.\n */\n capabilities: SubscribableSignalLike;\n\n /**\n * Information about the editor where the extension is being rendered.\n *\n * If the value is undefined, then the extension isn't running in an editor.\n */\n editor?: Editor;\n\n /**\n * A Boolean to show whether your extension is currently rendered to the screen.\n *\n * Shopify might render your extension before it's visible in the UI,\n * typically to pre-render extensions that appear on a later step of the\n * checkout.\n *\n * Your extension might also continue to run after the customer has navigated away\n * from where it was rendered. The extension continues running so that\n * your extension is immediately available to render if the customer navigates back.\n */\n rendered: SubscribableSignalLike;\n\n /**\n * The URL to the script that started the extension target.\n */\n scriptUrl: string;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n */\n target: Target;\n\n /**\n * The published version of the running extension target.\n *\n * For unpublished extensions, the value is `undefined`.\n *\n * @example 3.0.10\n */\n version?: string;\n}" + "value": "export interface Extension {\n /**\n * The API version that was set in the extension config file.\n *\n * @example '2024-10', '2025-01', '2025-04', '2025-07', '2025-10'\n */\n apiVersion: ApiVersion;\n\n /**\n * The allowed capabilities of the extension, defined in your\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n */\n capabilities: SubscribableSignalLike;\n\n /**\n * Information about the editor where the extension is being rendered.\n *\n * If the value is undefined, then the extension isn't running in an editor.\n */\n editor?: Editor;\n\n /**\n * A Boolean to show whether your extension is currently rendered to the screen.\n *\n * Shopify might render your extension before it's visible in the UI,\n * typically to pre-render extensions that appear on a later step of the\n * checkout.\n *\n * Your extension might also continue to run after the customer has navigated away\n * from where it was rendered. The extension continues running so that\n * your extension is immediately available to render if the customer navigates back.\n */\n rendered: SubscribableSignalLike;\n\n /**\n * The URL to the script that started the extension target.\n */\n scriptUrl: string;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n */\n target: Target;\n\n /**\n * The published version of the running extension target.\n *\n * For unpublished extensions, the value is `undefined`.\n *\n * Don't use this property as a stable identifier in development environments.\n * It becomes available only after the extension is published.\n *\n * @example 3.0.10\n */\n version?: string;\n}" }, "ApiVersion": { "filePath": "src/shared.ts", @@ -189569,7 +189569,7 @@ "Editor": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Editor", - "description": "", + "description": "Information about the editor environment when an extension is rendered inside the checkout editor. The value is `undefined` when the extension is not rendering in an editor.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -189584,7 +189584,7 @@ "I18n": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18n", - "description": "", + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use the I18n API alongside the Localization API to build fully localized extensions.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -189620,7 +189620,7 @@ "I18nTranslate": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18nTranslate", - "description": "This returns a translated string matching a key in a locale file.", + "description": "Translates a key from your extension's locale files into a localized string. Supports interpolation with placeholder replacements and pluralization via the special `count` option.", "members": [], "value": "export interface I18nTranslate {\n (\n key: string,\n options?: Record,\n ): ReplacementType extends string | number\n ? string\n : (string | ReplacementType)[];\n}" }, @@ -190184,14 +190184,14 @@ "Localization": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Localization", - "description": "", + "description": "The buyer's language, country, currency, and timezone context. Use this to adapt your extension to the buyer's region and display localized content.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "country", "value": "SubscribableSignalLike", - "description": "The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown." + "description": "The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n\nDerived from the buyer's shipping address. Returns `undefined` until the buyer enters a shipping address." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -190219,18 +190219,18 @@ "syntaxKind": "PropertySignature", "name": "market", "value": "SubscribableSignalLike", - "description": "The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n\n> Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.", - "deprecationMessage": "Deprecated as of version `2025-04`" + "description": "The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. The market context updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.", + "deprecationMessage": "Merchants now manage which extensions load for each\nmarket, so extensions no longer need to check this value." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "timezone", "value": "SubscribableSignalLike", - "description": "The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time." + "description": "The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time." } ], - "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n *\n * > Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" + "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n *\n * Derived from the buyer's shipping address. Returns `undefined` until the\n * buyer enters a shipping address.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout,\n * carried over from the cart context. Markets group countries and\n * regions with shared pricing, languages, and domains. The market\n * context updates when the buyer changes the country of their\n * shipping address. The value is `undefined` if the market is unknown.\n *\n * @deprecated Merchants now manage which extensions load for each\n * market, so extensions no longer need to check this value.\n */\n market: SubscribableSignalLike;\n}" }, "Country": { "filePath": "src/shared.ts", @@ -190431,7 +190431,7 @@ "SessionToken": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SessionToken", - "description": "", + "description": "Authenticates requests between your extension and your app backend. Use session tokens to verify the identity of the buyer and the shop context when making server-side API calls. The token is a signed JWT that contains claims such as the customer ID, shop domain, and expiration.\n\nThe `sub` claim in the decoded token is present only when the buyer is logged in and the app has permission to read customer accounts. Absent for anonymous buyers.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -190690,7 +190690,7 @@ "Shop": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Shop", - "description": "", + "description": "Metadata about the merchant's store, including its name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -190730,30 +190730,30 @@ "syntaxKind": "PropertySignature", "name": "storefrontUrl", "value": "string", - "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n\n> Caution: > As of version `2024-04` this value no longer has a trailing slash.", + "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.", "isOptional": true } ], - "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n *\n * > Caution:\n * > As of version `2024-04` this value no longer has a trailing slash.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom domain.\n */\n myshopifyDomain: string;\n}" + "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom domain.\n */\n myshopifyDomain: string;\n}" }, "Storage": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Storage", - "description": "A key-value storage object for the extension.\n\nStored data is available only to this specific extension and any of its instances.\n\nThe storage backend is implemented with `localStorage` and should persist across the buyer's checkout session. However, data persistence isn't guaranteed.", + "description": "Key-value storage for a specific extension. Use storage to save preferences or cached data that should survive page reloads without requiring a backend call. Stored data is only available to this specific extension. The storage backend is implemented with `localStorage` and data persistence isn't guaranteed.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "delete", "value": "(key: string) => Promise", - "description": "Delete stored data by key." + "description": "Deletes a previously stored value by key." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "read", "value": "(key: string) => Promise", - "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original primitive.\n\nReturns `null` if no stored data exists." + "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original type.\n\nReturns the stored value for the given key, or `null` when no value exists. Doesn't throw on a missing key." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -190763,7 +190763,7 @@ "description": "Write stored data for this key.\n\nThe data must be serializable to JSON." } ], - "value": "export interface Storage {\n /**\n * Read and return a stored value by key.\n *\n * The stored data is deserialized from JSON and returned as\n * its original primitive.\n *\n * Returns `null` if no stored data exists.\n */\n read(key: string): Promise;\n\n /**\n * Write stored data for this key.\n *\n * The data must be serializable to JSON.\n */\n write(key: string, data: any): Promise;\n\n /**\n * Delete stored data by key.\n */\n delete(key: string): Promise;\n}" + "value": "export interface Storage {\n /**\n * Read and return a stored value by key.\n *\n * The stored data is deserialized from JSON and returned as\n * its original type.\n *\n * Returns the stored value for the given key, or `null` when no value\n * exists. Doesn't throw on a missing key.\n */\n read(key: string): Promise;\n\n /**\n * Write stored data for this key.\n *\n * The data must be serializable to JSON.\n */\n write(key: string, data: any): Promise;\n\n /**\n * Deletes a previously stored value by key.\n */\n delete(key: string): Promise;\n}" }, "Version": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -190899,7 +190899,7 @@ "syntaxKind": "PropertySignature", "name": "number", "value": "string", - "description": "A randomly generated alpha-numeric identifier for the order, distinct from `order.id`. The value is `undefined` for orders that were created before this field was introduced. All recent orders have a number.", + "description": "A randomly generated alpha-numeric identifier for the order, distinct from `order.id`. The value is `undefined` for orders that were created before this field was introduced. All recent orders have a number.\n\nOptional. Might not be present for orders created before 2024.", "isOptional": true }, { @@ -190910,7 +190910,7 @@ "description": "" } ], - "value": "export interface OrderConfirmation {\n order: {\n /**\n * A globally unique identifier for the order. This becomes the\n * [`Order`](/docs/api/admin-graphql/latest/objects/Order) object ID in the\n * GraphQL Admin API after the order is created.\n *\n * @example 'gid://shopify/Order/123'\n */\n id: string;\n };\n /**\n * A randomly generated alpha-numeric identifier for the order, distinct\n * from `order.id`. The value is `undefined` for orders that were created\n * before this field was introduced. All recent orders have a number.\n */\n number?: string;\n\n /**\n * Whether this is the customer's first completed order with this shop. `true` means the buyer hasn't placed an order here before. Use this to show first-purchase messaging or trigger welcome offers.\n */\n isFirstOrder: boolean;\n}" + "value": "export interface OrderConfirmation {\n order: {\n /**\n * A globally unique identifier for the order. This becomes the\n * [`Order`](/docs/api/admin-graphql/latest/objects/Order) object ID in the\n * GraphQL Admin API after the order is created.\n *\n * @example 'gid://shopify/Order/123'\n */\n id: string;\n };\n /**\n * A randomly generated alpha-numeric identifier for the order, distinct\n * from `order.id`. The value is `undefined` for orders that were created\n * before this field was introduced. All recent orders have a number.\n *\n * Optional. Might not be present for orders created before 2024.\n */\n number?: string;\n\n /**\n * Whether this is the customer's first completed order with this shop. `true` means the buyer hasn't placed an order here before. Use this to show first-purchase messaging or trigger welcome offers.\n */\n isFirstOrder: boolean;\n}" } } }, @@ -190929,7 +190929,7 @@ "syntaxKind": "PropertySignature", "name": "analytics", "value": "Analytics", - "description": "The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event." + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -190943,7 +190943,7 @@ "syntaxKind": "PropertySignature", "name": "applyTrackingConsentChange", "value": "ApplyTrackingConsentChangeType", - "description": "Enables setting and updating customer privacy consent settings and tracking consent metafields.\n\n> Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent) to be set to `true`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." + "description": "Enables setting and updating customer privacy consent settings and tracking consent metafields.\n\n> Note: Requires the [`collect_buyer_consent` capability](/docs/apps/build/customer-accounts/capabilities#collect-buyer-consent) to be set to `true`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -190964,7 +190964,7 @@ "syntaxKind": "PropertySignature", "name": "availablePaymentOptions", "value": "SubscribableSignalLike", - "description": "All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region." + "description": "All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n\nThe set of payment options can change when the buyer updates their address or cart, so subscribe to changes rather than reading once during initialization. Each option exposes `handle` and `type` only. Provider names, logos, fees, and installment terms aren't available." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -191001,7 +191001,7 @@ "syntaxKind": "PropertySignature", "name": "checkoutToken", "value": "SubscribableSignalLike", - "description": "A stable ID that represents the current checkout.\n\nThe value is `undefined` when the checkout hasn't been created on the server yet.\n\nUse this to correlate checkout sessions across your extension, web pixels, and backend systems.\n\nThis matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data) and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object)." + "description": "A stable ID that represents the current checkout.\n\nThe value is `undefined` when the checkout hasn't been created on the server yet.\n\nUse this to correlate checkout sessions across your extension, web pixels, and backend systems.\n\nThis matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data) and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n\nCan be `undefined`. Handle the `undefined` state before using the value." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -191022,7 +191022,7 @@ "syntaxKind": "PropertySignature", "name": "deliveryGroups", "value": "SubscribableSignalLike", - "description": "The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items." + "description": "The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n\nEmpty until the buyer enters enough address information for Shopify to calculate shipping rates." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -191043,7 +191043,7 @@ "syntaxKind": "PropertySignature", "name": "extension", "value": "Extension", - "description": "The meta information about the extension." + "description": "Metadata about the running extension, including the current target, API version, capabilities, and editor context. Use this to conditionally render content based on where the extension is running." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -191051,7 +191051,7 @@ "name": "extensionPoint", "value": "Target", "description": "The identifier that specifies where in Shopify's UI your code is being injected. This is one of the targets you've included in your extension's configuration file.", - "deprecationMessage": "Deprecated as of version `2023-07`, use `extension.target` instead.", + "deprecationMessage": "Use `extension.target` instead.", "examples": [ { "title": "Example", @@ -191070,14 +191070,14 @@ "syntaxKind": "PropertySignature", "name": "i18n", "value": "I18n", - "description": "Utilities for translating content and formatting values according to the current [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) of the checkout.\n\nRefer to [`localization` examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples) for more information." + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use alongside [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) to build fully localized extensions." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "instructions", "value": "SubscribableSignalLike", - "description": "The cart instructions used to create the checkout and possibly limit extension capabilities.\n\nThese instructions should be checked before performing any actions that might be affected by them.\n\nFor example, if you intend to add a discount code via the `applyDiscountCodeChange` method, check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n\n> Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs aren't available. See the [update guide](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples) for more information." + "description": "The cart instructions used to create the checkout and possibly limit extension capabilities.\n\nThese instructions should be checked before performing any actions that might be affected by them.\n\nFor example, if you intend to add a discount code via the `applyDiscountCodeChange` method, check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n\n> Caution: Check cart instructions before calling select APIs, as > some may not be available. See the > [Cart Instructions API](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples) > for more information." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -191091,7 +191091,7 @@ "syntaxKind": "PropertySignature", "name": "localization", "value": "Localization", - "description": "The details about the location, language, and currency of the customer. For utilities to easily format and translate content based on these details, you can use the [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n) object instead." + "description": "The buyer's language, country, currency, and timezone context. For formatting and translation helpers, use the [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#properties-propertydetail-i18n) object instead." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -191121,21 +191121,21 @@ "syntaxKind": "PropertySignature", "name": "query", "value": ">(query: string, options?: { variables?: Variables; version?: StorefrontApiVersion; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>", - "description": "The method used to query the Storefront GraphQL API with a prefetched token.\n\nRefer to [Storefront API access examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/storefront-api) for more information." + "description": "The method used to query the Storefront GraphQL API with a prefetched token." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "selectedPaymentOptions", "value": "SubscribableSignalLike", - "description": "The payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card)." + "description": "The payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\n\nEach option exposes `handle` and `type` only. Provider names, logos, fees, and installment terms aren't available." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "sessionToken", "value": "SessionToken", - "description": "The session token providing a set of claims as a signed JSON Web Token (JWT).\n\nThe token has a TTL of five minutes.\n\nIf the previous token expires, this value reflects a new session token with a new signature and expiry.\n\nRefer to [session token examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/session-token) for more information." + "description": "The session token providing a set of claims as a signed JSON Web Token (JWT).\n\nThe token has a TTL of five minutes.\n\nIf the previous token expires, this value reflects a new session token with a new signature and expiry.\n\nLearn more about [session tokens](/docs/apps/build/authentication-authorization/session-tokens)." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -191157,14 +191157,14 @@ "syntaxKind": "PropertySignature", "name": "shop", "value": "Shop", - "description": "The shop where the checkout is taking place." + "description": "The store where the checkout is taking place, including the shop name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "storage", "value": "Storage", - "description": "The key-value storage for the extension.\n\nIt uses `localStorage` and should persist across the customer's current checkout session.\n\n> Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n\nData is shared across all activated extension targets of this extension. In versions 2023-07 and earlier, each activated extension target had its own storage." + "description": "Key-value storage that persists across page loads within the current checkout session. Data is shared across all activated targets associated with this extension.\n\n> Caution: Data persistence isn't guaranteed and storage is cleared when the buyer starts a new checkout." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -191186,29 +191186,29 @@ ] } ], - "value": "export interface StandardApi {\n /**\n * The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event.\n */\n analytics: Analytics;\n\n /**\n * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\n */\n appliedGiftCards: SubscribableSignalLike;\n\n /**\n * The cart instructions used to create the checkout and possibly limit extension capabilities.\n *\n * These instructions should be checked before performing any actions that might be affected by them.\n *\n * For example, if you intend to add a discount code via the `applyDiscountCodeChange` method,\n * check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n *\n * > Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs aren't available.\n * See the [update guide](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples) for more information.\n *\n */\n instructions: SubscribableSignalLike;\n\n /**\n * The metafields requested in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration)\n * file. These metafields are updated when there's a change in the merchandise items\n * being purchased by the customer.\n *\n * App owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` isn't supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n appMetafields: SubscribableSignalLike;\n\n /**\n * The custom key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n buyerIdentity?: BuyerIdentity;\n\n /**\n * Provides details on the buyer's progression through the checkout and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/buyer-journey#examples)\n * examples for more information.\n */\n buyerJourney: BuyerJourney;\n\n /**\n * Settings applied to the buyer's checkout.\n */\n checkoutSettings: SubscribableSignalLike;\n\n /**\n * A stable ID that represents the current checkout.\n *\n * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\n *\n * This matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data)\n * and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n */\n checkoutToken: SubscribableSignalLike;\n\n /**\n * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * The meta information about the extension.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n *\n * @deprecated Deprecated as of version `2023-07`, use `extension.target` instead.\n */\n extensionPoint: Target;\n\n /**\n * Utilities for translating content and formatting values according to the current\n * [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization)\n * of the checkout.\n *\n * Refer to [`localization` examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples)\n * for more information.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The details about the location, language, and currency of the customer. For utilities to easily\n * format and translate content based on these details, you can use the\n * [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n)\n * object instead.\n */\n localization: Localization;\n\n /**\n * The metafields that apply to the current checkout.\n *\n * Metafields are stored locally on the client and are applied to the order object after the checkout completes.\n *\n * These metafields are shared by all extensions running on checkout, and\n * persist for as long as the customer is working on this checkout.\n *\n * Once the order is created, you can query these metafields using the\n * [GraphQL Admin API](/docs/admin-api/graphql/reference/orders/order#metafield-2021-01)\n *\n * > Caution:\n * `metafields` is deprecated. Use `appMetafields` with cart metafields instead.\n *\n * @deprecated Use `appMetafields` with cart metafields instead.\n */\n metafields: SubscribableSignalLike;\n\n /**\n * A note left by the customer to the merchant, either in their cart or during checkout.\n *\n * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\n */\n note: SubscribableSignalLike;\n\n /**\n * The method used to query the Storefront GraphQL API with a prefetched token.\n *\n * Refer to [Storefront API access examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/storefront-api) for more information.\n */\n query: >(\n query: string,\n options?: {variables?: Variables; version?: StorefrontApiVersion},\n ) => Promise<{data?: Data; errors?: GraphQLError[]}>;\n\n /**\n * The payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\n */\n selectedPaymentOptions: SubscribableSignalLike;\n\n /**\n * The session token providing a set of claims as a signed JSON Web Token (JWT).\n *\n * The token has a TTL of five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/session-token) for more information.\n */\n sessionToken: SessionToken;\n\n /**\n * The settings matching the settings definition written in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates in real time as a merchant fills in the settings.\n */\n settings: SubscribableSignalLike;\n\n /**\n * The proposed customer shipping address. During the information step, the address\n * updates when the field is committed (on change) rather than every keystroke.\n * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n shippingAddress?: SubscribableSignalLike;\n\n /**\n * The proposed customer billing address. The address updates when the field is\n * committed (on change) rather than every keystroke. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided yet.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n billingAddress?: SubscribableSignalLike;\n\n /** The shop where the checkout is taking place. */\n shop: Shop;\n\n /**\n * The key-value storage for the extension.\n *\n * It uses `localStorage` and should persist across the customer's current checkout session.\n *\n * > Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n *\n * Data is shared across all activated extension targets of this extension. In versions 2023-07 and earlier,\n * each activated extension target had its own storage.\n */\n storage: Storage;\n\n /**\n * The renderer version being used for the extension.\n *\n * @example '2025-10'\n */\n version: Version;\n\n /**\n * Customer privacy consent settings and a flag denoting if consent has previously been collected.\n */\n customerPrivacy: SubscribableSignalLike;\n\n /**\n * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent) to be set to `true`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyTrackingConsentChange: ApplyTrackingConsentChangeType;\n\n /**\n * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" + "value": "export interface StandardApi {\n /**\n * Tracks custom events and sends visitor information to\n * [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events\n * and `visitor()` to submit buyer contact details.\n */\n analytics: Analytics;\n\n /**\n * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\n */\n appliedGiftCards: SubscribableSignalLike;\n\n /**\n * The cart instructions used to create the checkout and possibly limit extension capabilities.\n *\n * These instructions should be checked before performing any actions that might be affected by them.\n *\n * For example, if you intend to add a discount code via the `applyDiscountCodeChange` method,\n * check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n *\n * > Caution: Check cart instructions before calling select APIs, as\n * > some may not be available. See the\n * > [Cart Instructions API](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples)\n * > for more information.\n *\n */\n instructions: SubscribableSignalLike;\n\n /**\n * The metafields requested in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration)\n * file. These metafields are updated when there's a change in the merchandise items\n * being purchased by the customer.\n *\n * App owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` isn't supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n appMetafields: SubscribableSignalLike;\n\n /**\n * The custom key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as\n * credit cards, wallets, and local payment methods. The list depends on\n * the shop's payment configuration and the buyer's region.\n *\n * The set of payment options can change when the buyer updates their\n * address or cart, so subscribe to changes rather than reading once\n * during initialization. Each option exposes `handle` and `type` only.\n * Provider names, logos, fees, and installment terms aren't available.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n buyerIdentity?: BuyerIdentity;\n\n /**\n * Provides details on the buyer's progression through the checkout and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/buyer-journey#examples)\n * examples for more information.\n */\n buyerJourney: BuyerJourney;\n\n /**\n * Settings applied to the buyer's checkout.\n */\n checkoutSettings: SubscribableSignalLike;\n\n /**\n * A stable ID that represents the current checkout.\n *\n * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\n *\n * This matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data)\n * and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n *\n * Can be `undefined`. Handle the `undefined` state before using the value.\n */\n checkoutToken: SubscribableSignalLike;\n\n /**\n * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n *\n * Empty until the buyer enters enough address information for Shopify to\n * calculate shipping rates.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * Metadata about the running extension, including the current target, API version,\n * capabilities, and editor context. Use this to conditionally render content\n * based on where the extension is running.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n *\n * @deprecated Use `extension.target` instead.\n */\n extensionPoint: Target;\n\n /**\n * Utilities for translating strings, formatting currencies, numbers, and dates\n * according to the buyer's locale. Use alongside\n * [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization)\n * to build fully localized extensions.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The buyer's language, country, currency, and timezone context. For\n * formatting and translation helpers, use the\n * [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#properties-propertydetail-i18n)\n * object instead.\n */\n localization: Localization;\n\n /**\n * The metafields that apply to the current checkout.\n *\n * Metafields are stored locally on the client and are applied to the order object after the checkout completes.\n *\n * These metafields are shared by all extensions running on checkout, and\n * persist for as long as the customer is working on this checkout.\n *\n * Once the order is created, you can query these metafields using the\n * [GraphQL Admin API](/docs/admin-api/graphql/reference/orders/order#metafield-2021-01)\n *\n * > Caution:\n * `metafields` is deprecated. Use `appMetafields` with cart metafields instead.\n *\n * @deprecated Use `appMetafields` with cart metafields instead.\n */\n metafields: SubscribableSignalLike;\n\n /**\n * A note left by the customer to the merchant, either in their cart or during checkout.\n *\n * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\n */\n note: SubscribableSignalLike;\n\n /**\n * The method used to query the Storefront GraphQL API with a prefetched token.\n *\n */\n query: >(\n query: string,\n options?: {variables?: Variables; version?: StorefrontApiVersion},\n ) => Promise<{data?: Data; errors?: GraphQLError[]}>;\n\n /**\n * The payment options the buyer has currently selected. This updates as\n * the buyer changes their payment method. The array can contain multiple\n * entries when the buyer splits payment across methods (for example, a\n * gift card and a credit card).\n *\n * Each option exposes `handle` and `type` only. Provider names, logos,\n * fees, and installment terms aren't available.\n */\n selectedPaymentOptions: SubscribableSignalLike;\n\n /**\n * The session token providing a set of claims as a signed JSON Web Token (JWT).\n *\n * The token has a TTL of five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Learn more about [session tokens](/docs/apps/build/authentication-authorization/session-tokens).\n */\n sessionToken: SessionToken;\n\n /**\n * The settings matching the settings definition written in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates in real time as a merchant fills in the settings.\n */\n settings: SubscribableSignalLike;\n\n /**\n * The proposed customer shipping address. During the information step, the address\n * updates when the field is committed (on change) rather than every keystroke.\n * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n shippingAddress?: SubscribableSignalLike;\n\n /**\n * The proposed customer billing address. The address updates when the field is\n * committed (on change) rather than every keystroke. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided yet.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n billingAddress?: SubscribableSignalLike;\n\n /**\n * The store where the checkout is taking place, including the shop name,\n * storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.\n */\n shop: Shop;\n\n /**\n * Key-value storage that persists across page loads within the current checkout\n * session. Data is shared across all activated targets associated with\n * this extension.\n *\n * > Caution: Data persistence isn't guaranteed and storage is cleared when the\n * buyer starts a new checkout.\n */\n storage: Storage;\n\n /**\n * The renderer version being used for the extension.\n *\n * @example '2025-10'\n */\n version: Version;\n\n /**\n * Customer privacy consent settings and a flag denoting if consent has previously been collected.\n */\n customerPrivacy: SubscribableSignalLike;\n\n /**\n * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`collect_buyer_consent` capability](/docs/apps/build/customer-accounts/capabilities#collect-buyer-consent) to be set to `true`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyTrackingConsentChange: ApplyTrackingConsentChangeType;\n\n /**\n * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" }, "Analytics": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Analytics", - "description": "", + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "publish", "value": "(name: string, data: Record) => Promise", - "description": "Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing)." + "description": "Publishes a custom event to [Web Pixels](/docs/apps/marketing). Returns `true` when the event is successfully dispatched.\n\nThe Promise resolves to `true` when the event was dispatched. The boolean indicates dispatch confirmation only. It doesn't indicate whether any specific web pixel processed the event." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "visitor", "value": "(data: { email?: string; phone?: string; }) => Promise", - "description": "A method for capturing details about a visitor on the online store." + "description": "Submits buyer contact details for attribution and analytics purposes." } ], - "value": "export interface Analytics {\n /**\n * Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing).\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * A method for capturing details about a visitor on the online store.\n */\n visitor(data: {email?: string; phone?: string}): Promise;\n}" + "value": "export interface Analytics {\n /**\n * Publishes a custom event to [Web Pixels](/docs/apps/marketing).\n * Returns `true` when the event is successfully dispatched.\n *\n * The Promise resolves to `true` when the event was dispatched. The boolean\n * indicates dispatch confirmation only. It doesn't indicate whether any\n * specific web pixel processed the event.\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * Submits buyer contact details for attribution and analytics purposes.\n */\n visitor(data: {email?: string; phone?: string}): Promise;\n}" }, "VisitorResult": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -191249,10 +191249,10 @@ "syntaxKind": "PropertySignature", "name": "type", "value": "'error'", - "description": "Indicates that the visitor information is invalid and wasn't submitted. Examples are using the wrong data type or missing a required property." + "description": "Indicates that the visitor information is invalid and wasn't submitted. Common causes include using the wrong data type or omitting a required property." } ], - "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Examples are using the wrong data type or missing a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Common causes include using the wrong data type or omitting a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" }, "SubscribableSignalLike": { "filePath": "src/surfaces/checkout/shared.ts", @@ -191466,10 +191466,10 @@ "syntaxKind": "PropertySignature", "name": "value", "value": "string | null", - "description": "The new value to store in the metafield. Set to `null` to delete the metafield." + "description": "The new value to store in the metafield. Set to `null` to delete the metafield.\n\nConsent metafield values are strings, not booleans. Pass `null` to delete a tracking consent metafield." } ], - "value": "export interface TrackingConsentMetafieldChange {\n /**\n * The identifier for the tracking consent metafield to update.\n */\n key: string;\n /**\n * The new value to store in the metafield. Set to `null` to delete the metafield.\n */\n value: string | null;\n}" + "value": "export interface TrackingConsentMetafieldChange {\n /**\n * The identifier for the tracking consent metafield to update.\n */\n key: string;\n /**\n * The new value to store in the metafield. Set to `null` to delete the metafield.\n *\n * Consent metafield values are strings, not booleans. Pass `null` to delete\n * a tracking consent metafield.\n */\n value: string | null;\n}" }, "VisitorConsent": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -191683,7 +191683,7 @@ "syntaxKind": "PropertySignature", "name": "value", "value": "string", - "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.", + "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.\n\nAttribute values are always strings. To store structured data, serialize it to JSON and parse it when reading.", "examples": [ { "title": "Example", @@ -191698,7 +191698,7 @@ ] } ], - "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" + "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * Attribute values are always strings. To store structured data, serialize\n * it to JSON and parse it when reading.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" }, "PaymentOption": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -192049,7 +192049,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A globally-unique identifier for the customer in the format `gid://shopify/Customer/`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", + "description": "An identifier for the customer in the format `gid://shopify/Customer/`. This value is unique per shop.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", "examples": [ { "title": "Example", @@ -192102,7 +192102,7 @@ "isPrivate": true } ], - "value": "export interface Customer {\n /**\n * A globally-unique identifier for the customer in the format `gid://shopify/Customer/`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'gid://shopify/Customer/123'\n */\n id: string;\n /**\n * The email address associated with the customer's account. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email?: string;\n /**\n * The phone number associated with the customer's account. The value is `undefined` if no phone number is on file or the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone?: string;\n /**\n * The customer's full name, typically a combination of first and last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n fullName?: string;\n /**\n * The customer's first name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n firstName?: string;\n /**\n * The customer's last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n lastName?: string;\n /**\n * The customer's profile image, such as a Gravatar avatar. Use this to personalize the extension UI for the logged-in buyer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n image: ImageDetails;\n /**\n * Whether the customer has opted in to receiving marketing communications from the merchant, such as email campaigns and promotional offers.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * > Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n *\n * @deprecated Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n */\n acceptsMarketing: boolean;\n /**\n * Whether the customer has opted in to email marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsEmailMarketing: boolean;\n /**\n * Whether the customer has opted in to SMS marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsSmsMarketing: boolean;\n /**\n * The store credit accounts owned by this customer that can be used as payment during checkout. Each account has a balance representing available store credit.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @private\n */\n storeCreditAccounts: StoreCreditAccount[];\n /**\n * The number of orders the customer has previously placed with this shop.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n ordersCount: number;\n}" + "value": "export interface Customer {\n /**\n * An identifier for the customer in the format `gid://shopify/Customer/`. This value is unique per shop.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'gid://shopify/Customer/123'\n */\n id: string;\n /**\n * The email address associated with the customer's account. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email?: string;\n /**\n * The phone number associated with the customer's account. The value is `undefined` if no phone number is on file or the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone?: string;\n /**\n * The customer's full name, typically a combination of first and last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n fullName?: string;\n /**\n * The customer's first name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n firstName?: string;\n /**\n * The customer's last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n lastName?: string;\n /**\n * The customer's profile image, such as a Gravatar avatar. Use this to personalize the extension UI for the logged-in buyer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n image: ImageDetails;\n /**\n * Whether the customer has opted in to receiving marketing communications from the merchant, such as email campaigns and promotional offers.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * > Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n *\n * @deprecated Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n */\n acceptsMarketing: boolean;\n /**\n * Whether the customer has opted in to email marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsEmailMarketing: boolean;\n /**\n * Whether the customer has opted in to SMS marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsSmsMarketing: boolean;\n /**\n * The store credit accounts owned by this customer that can be used as payment during checkout. Each account has a balance representing available store credit.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @private\n */\n storeCreditAccounts: StoreCreditAccount[];\n /**\n * The number of orders the customer has previously placed with this shop.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n ordersCount: number;\n}" }, "ImageDetails": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -192384,11 +192384,11 @@ "syntaxKind": "MethodSignature", "name": "perform", "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", + "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.\n\nRuns after all intercept results are collected. Use it for local state updates such as setting an error flag. By the time it runs, the navigation decision is final, so blocking logic belongs in the intercept handler itself, not here.", "isOptional": true } ], - "value": "interface InterceptorRequestAllow {\n /**\n * Indicates that the interceptor allows the buyer's journey to continue.\n */\n behavior: 'allow';\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" + "value": "interface InterceptorRequestAllow {\n /**\n * Indicates that the interceptor allows the buyer's journey to continue.\n */\n behavior: 'allow';\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n *\n * Runs after all intercept results are collected. Use it for local state\n * updates such as setting an error flag. By the time it runs, the navigation\n * decision is final, so blocking logic belongs in the intercept handler\n * itself, not here.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" }, "InterceptorResult": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -192452,7 +192452,7 @@ "syntaxKind": "MethodSignature", "name": "perform", "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", + "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.\n\nRuns after all intercept results are collected. Use it for local state updates such as setting an error flag. By the time it runs, the navigation decision is final, so blocking logic belongs in the intercept handler itself, not here.", "isOptional": true }, { @@ -192463,7 +192463,7 @@ "description": "The reason for blocking the interceptor request. This value isn't presented to the buyer, so it doesn't need to be localized. The value is used only for Shopify's own internal debugging and metrics." } ], - "value": "interface InterceptorRequestBlock {\n /**\n * Indicates that the interceptor blocks the buyer's journey from continuing.\n */\n behavior: 'block';\n\n /**\n * The reason for blocking the interceptor request. This value isn't presented to\n * the buyer, so it doesn't need to be localized. The value is used only for Shopify's\n * own internal debugging and metrics.\n */\n reason: string;\n\n /**\n * Used to pass errors to the checkout UI, outside your extension's UI boundaries.\n */\n errors?: ValidationError[];\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" + "value": "interface InterceptorRequestBlock {\n /**\n * Indicates that the interceptor blocks the buyer's journey from continuing.\n */\n behavior: 'block';\n\n /**\n * The reason for blocking the interceptor request. This value isn't presented to\n * the buyer, so it doesn't need to be localized. The value is used only for Shopify's\n * own internal debugging and metrics.\n */\n reason: string;\n\n /**\n * Used to pass errors to the checkout UI, outside your extension's UI boundaries.\n */\n errors?: ValidationError[];\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n *\n * Runs after all intercept results are collected. Use it for local state\n * updates such as setting an error flag. By the time it runs, the navigation\n * decision is final, so blocking logic belongs in the intercept handler\n * itself, not here.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" }, "ValidationError": { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -192684,17 +192684,17 @@ "syntaxKind": "PropertySignature", "name": "totalShippingAmount", "value": "SubscribableSignalLike", - "description": "The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step." + "description": "The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step.\n\n`undefined` until the buyer selects a shipping method (typically after the information step)." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "totalTaxAmount", "value": "SubscribableSignalLike", - "description": "The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet." + "description": "The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet.\n\n`undefined` when taxes haven't been calculated or aren't available for the buyer's region." } ], - "value": "export interface CartCost {\n /**\n * The sum of all line item prices at the current step of checkout, before shipping and taxes are applied. Use this value to display the base cost of the items the buyer purchased.\n */\n subtotalAmount: SubscribableSignalLike;\n\n /**\n * The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step.\n */\n totalShippingAmount: SubscribableSignalLike;\n\n /**\n * The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet.\n */\n totalTaxAmount: SubscribableSignalLike;\n\n /**\n * The minimum total at the current step of checkout. Costs not yet calculated, such as shipping on the information step, aren't included. Gift cards and store credits are excluded from this total.\n */\n totalAmount: SubscribableSignalLike;\n}" + "value": "export interface CartCost {\n /**\n * The sum of all line item prices at the current step of checkout, before shipping and taxes are applied. Use this value to display the base cost of the items the buyer purchased.\n */\n subtotalAmount: SubscribableSignalLike;\n\n /**\n * The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step.\n *\n * `undefined` until the buyer selects a shipping method (typically after the\n * information step).\n */\n totalShippingAmount: SubscribableSignalLike;\n\n /**\n * The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet.\n *\n * `undefined` when taxes haven't been calculated or aren't available for the\n * buyer's region.\n */\n totalTaxAmount: SubscribableSignalLike;\n\n /**\n * The minimum total at the current step of checkout. Costs not yet calculated, such as shipping on the information step, aren't included. Gift cards and store credits are excluded from this total.\n */\n totalAmount: SubscribableSignalLike;\n}" }, "CustomerPrivacy": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -192781,31 +192781,31 @@ "syntaxKind": "PropertySignature", "name": "analytics", "value": "boolean", - "description": "Whether analytics data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Analytics data includes how the shop was used and what interactions occurred." + "description": "Whether analytics data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Analytics data includes how the shop was used and what interactions occurred.\n\nWhether analytics data can be collected right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.analytics`, before calling `shopify.analytics.publish()`." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "marketing", "value": "boolean", - "description": "Whether marketing data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Marketing data includes attribution and targeted advertising preferences." + "description": "Whether marketing data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Marketing data includes attribution and targeted advertising preferences.\n\nWhether marketing data can be collected right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.marketing`, before performing marketing-related data collection." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "preferences", "value": "boolean", - "description": "Whether preference data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Preference data includes language, currency, and sizing choices." + "description": "Whether preference data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Preference data includes language, currency, and sizing choices.\n\nWhether preference data can be collected right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.preferences`, before storing or reading buyer preference data." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "saleOfData", "value": "boolean", - "description": "Whether data can be shared with third parties based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. This typically applies to behavioral advertising data." + "description": "Whether data can be shared with third parties based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. This typically applies to behavioral advertising data.\n\nWhether buyer data can be shared with or sold to third parties right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.saleOfData`, before sharing or selling buyer data with third parties." } ], - "value": "export interface AllowedProcessing {\n /**\n * Whether analytics data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Analytics\n * data includes how the shop was used and what interactions occurred.\n */\n analytics: boolean;\n /**\n * Whether marketing data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Marketing\n * data includes attribution and targeted advertising preferences.\n */\n marketing: boolean;\n /**\n * Whether preference data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Preference\n * data includes language, currency, and sizing choices.\n */\n preferences: boolean;\n /**\n * Whether data can be shared with third parties based on the visitor's\n * consent, the merchant's privacy configuration, and the visitor's region.\n * This typically applies to behavioral advertising data.\n */\n saleOfData: boolean;\n}" + "value": "export interface AllowedProcessing {\n /**\n * Whether analytics data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Analytics\n * data includes how the shop was used and what interactions occurred.\n *\n * Whether analytics data can be collected right now. Combines the buyer's\n * consent, the merchant's privacy configuration, and the buyer's region into\n * a single boolean. Check this flag, not `visitorConsent.analytics`, before\n * calling `shopify.analytics.publish()`.\n */\n analytics: boolean;\n /**\n * Whether marketing data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Marketing\n * data includes attribution and targeted advertising preferences.\n *\n * Whether marketing data can be collected right now. Combines the buyer's\n * consent, the merchant's privacy configuration, and the buyer's region into\n * a single boolean. Check this flag, not `visitorConsent.marketing`, before\n * performing marketing-related data collection.\n */\n marketing: boolean;\n /**\n * Whether preference data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Preference\n * data includes language, currency, and sizing choices.\n *\n * Whether preference data can be collected right now. Combines the buyer's\n * consent, the merchant's privacy configuration, and the buyer's region into\n * a single boolean. Check this flag, not `visitorConsent.preferences`,\n * before storing or reading buyer preference data.\n */\n preferences: boolean;\n /**\n * Whether data can be shared with third parties based on the visitor's\n * consent, the merchant's privacy configuration, and the visitor's region.\n * This typically applies to behavioral advertising data.\n *\n * Whether buyer data can be shared with or sold to third parties right now.\n * Combines the buyer's consent, the merchant's privacy configuration, and\n * the buyer's region into a single boolean. Check this flag, not\n * `visitorConsent.saleOfData`, before sharing or selling buyer data with\n * third parties.\n */\n saleOfData: boolean;\n}" }, "TrackingConsentMetafield": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -193497,7 +193497,7 @@ "Extension": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Extension", - "description": "The meta information about an extension target.", + "description": "Metadata about the running extension, including its API version, target, capabilities, and editor context. Use this to read configuration details or conditionally render content based on where the extension is running.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -193523,7 +193523,7 @@ "syntaxKind": "PropertySignature", "name": "capabilities", "value": "SubscribableSignalLike", - "description": "The allowed capabilities of the extension, defined in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n\n* [`api_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#api-access): the extension can access the Storefront API.\n\n* [`network_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access): the extension can make external network calls.\n\n* [`block_progress`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n\n* [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n\n* [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can register customer consent decisions that are honored on Shopify-managed services.\n\n* [`iframe.sources`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#iframe): the extension can embed an external URL in an iframe." + "description": "The allowed capabilities of the extension, defined in your [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -193571,7 +193571,7 @@ "syntaxKind": "PropertySignature", "name": "version", "value": "string", - "description": "The published version of the running extension target.\n\nFor unpublished extensions, the value is `undefined`.", + "description": "The published version of the running extension target.\n\nFor unpublished extensions, the value is `undefined`.\n\nDon't use this property as a stable identifier in development environments. It becomes available only after the extension is published.", "isOptional": true, "examples": [ { @@ -193587,7 +193587,7 @@ ] } ], - "value": "export interface Extension {\n /**\n * The API version that was set in the extension config file.\n *\n * @example '2024-10', '2025-01', '2025-04', '2025-07', '2025-10'\n */\n apiVersion: ApiVersion;\n\n /**\n * The allowed capabilities of the extension, defined\n * in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n *\n * * [`api_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#api-access): the extension can access the Storefront API.\n *\n * * [`network_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access): the extension can make external network calls.\n *\n * * [`block_progress`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n *\n * * [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n *\n * * [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can register customer consent decisions that are honored on Shopify-managed services.\n *\n * * [`iframe.sources`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#iframe): the extension can embed an external URL in an iframe.\n */\n capabilities: SubscribableSignalLike;\n\n /**\n * Information about the editor where the extension is being rendered.\n *\n * If the value is undefined, then the extension isn't running in an editor.\n */\n editor?: Editor;\n\n /**\n * A Boolean to show whether your extension is currently rendered to the screen.\n *\n * Shopify might render your extension before it's visible in the UI,\n * typically to pre-render extensions that appear on a later step of the\n * checkout.\n *\n * Your extension might also continue to run after the customer has navigated away\n * from where it was rendered. The extension continues running so that\n * your extension is immediately available to render if the customer navigates back.\n */\n rendered: SubscribableSignalLike;\n\n /**\n * The URL to the script that started the extension target.\n */\n scriptUrl: string;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n */\n target: Target;\n\n /**\n * The published version of the running extension target.\n *\n * For unpublished extensions, the value is `undefined`.\n *\n * @example 3.0.10\n */\n version?: string;\n}" + "value": "export interface Extension {\n /**\n * The API version that was set in the extension config file.\n *\n * @example '2024-10', '2025-01', '2025-04', '2025-07', '2025-10'\n */\n apiVersion: ApiVersion;\n\n /**\n * The allowed capabilities of the extension, defined in your\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n */\n capabilities: SubscribableSignalLike;\n\n /**\n * Information about the editor where the extension is being rendered.\n *\n * If the value is undefined, then the extension isn't running in an editor.\n */\n editor?: Editor;\n\n /**\n * A Boolean to show whether your extension is currently rendered to the screen.\n *\n * Shopify might render your extension before it's visible in the UI,\n * typically to pre-render extensions that appear on a later step of the\n * checkout.\n *\n * Your extension might also continue to run after the customer has navigated away\n * from where it was rendered. The extension continues running so that\n * your extension is immediately available to render if the customer navigates back.\n */\n rendered: SubscribableSignalLike;\n\n /**\n * The URL to the script that started the extension target.\n */\n scriptUrl: string;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n */\n target: Target;\n\n /**\n * The published version of the running extension target.\n *\n * For unpublished extensions, the value is `undefined`.\n *\n * Don't use this property as a stable identifier in development environments.\n * It becomes available only after the extension is published.\n *\n * @example 3.0.10\n */\n version?: string;\n}" }, "ApiVersion": { "filePath": "src/shared.ts", @@ -193606,7 +193606,7 @@ "Editor": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Editor", - "description": "", + "description": "Information about the editor environment when an extension is rendered inside the checkout editor. The value is `undefined` when the extension is not rendering in an editor.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -193621,7 +193621,7 @@ "I18n": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18n", - "description": "", + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use the I18n API alongside the Localization API to build fully localized extensions.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -193657,7 +193657,7 @@ "I18nTranslate": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18nTranslate", - "description": "This returns a translated string matching a key in a locale file.", + "description": "Translates a key from your extension's locale files into a localized string. Supports interpolation with placeholder replacements and pluralization via the special `count` option.", "members": [], "value": "export interface I18nTranslate {\n (\n key: string,\n options?: Record,\n ): ReplacementType extends string | number\n ? string\n : (string | ReplacementType)[];\n}" }, @@ -194221,14 +194221,14 @@ "Localization": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Localization", - "description": "", + "description": "The buyer's language, country, currency, and timezone context. Use this to adapt your extension to the buyer's region and display localized content.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "country", "value": "SubscribableSignalLike", - "description": "The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown." + "description": "The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n\nDerived from the buyer's shipping address. Returns `undefined` until the buyer enters a shipping address." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -194256,18 +194256,18 @@ "syntaxKind": "PropertySignature", "name": "market", "value": "SubscribableSignalLike", - "description": "The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n\n> Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.", - "deprecationMessage": "Deprecated as of version `2025-04`" + "description": "The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. The market context updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.", + "deprecationMessage": "Merchants now manage which extensions load for each\nmarket, so extensions no longer need to check this value." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "timezone", "value": "SubscribableSignalLike", - "description": "The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time." + "description": "The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time." } ], - "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n *\n * > Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" + "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n *\n * Derived from the buyer's shipping address. Returns `undefined` until the\n * buyer enters a shipping address.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout,\n * carried over from the cart context. Markets group countries and\n * regions with shared pricing, languages, and domains. The market\n * context updates when the buyer changes the country of their\n * shipping address. The value is `undefined` if the market is unknown.\n *\n * @deprecated Merchants now manage which extensions load for each\n * market, so extensions no longer need to check this value.\n */\n market: SubscribableSignalLike;\n}" }, "Country": { "filePath": "src/shared.ts", @@ -194468,7 +194468,7 @@ "SessionToken": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SessionToken", - "description": "", + "description": "Authenticates requests between your extension and your app backend. Use session tokens to verify the identity of the buyer and the shop context when making server-side API calls. The token is a signed JWT that contains claims such as the customer ID, shop domain, and expiration.\n\nThe `sub` claim in the decoded token is present only when the buyer is logged in and the app has permission to read customer accounts. Absent for anonymous buyers.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -194727,7 +194727,7 @@ "Shop": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Shop", - "description": "", + "description": "Metadata about the merchant's store, including its name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -194767,30 +194767,30 @@ "syntaxKind": "PropertySignature", "name": "storefrontUrl", "value": "string", - "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n\n> Caution: > As of version `2024-04` this value no longer has a trailing slash.", + "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.", "isOptional": true } ], - "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n *\n * > Caution:\n * > As of version `2024-04` this value no longer has a trailing slash.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom domain.\n */\n myshopifyDomain: string;\n}" + "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom domain.\n */\n myshopifyDomain: string;\n}" }, "Storage": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Storage", - "description": "A key-value storage object for the extension.\n\nStored data is available only to this specific extension and any of its instances.\n\nThe storage backend is implemented with `localStorage` and should persist across the buyer's checkout session. However, data persistence isn't guaranteed.", + "description": "Key-value storage for a specific extension. Use storage to save preferences or cached data that should survive page reloads without requiring a backend call. Stored data is only available to this specific extension. The storage backend is implemented with `localStorage` and data persistence isn't guaranteed.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "delete", "value": "(key: string) => Promise", - "description": "Delete stored data by key." + "description": "Deletes a previously stored value by key." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "read", "value": "(key: string) => Promise", - "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original primitive.\n\nReturns `null` if no stored data exists." + "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original type.\n\nReturns the stored value for the given key, or `null` when no value exists. Doesn't throw on a missing key." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -194800,7 +194800,7 @@ "description": "Write stored data for this key.\n\nThe data must be serializable to JSON." } ], - "value": "export interface Storage {\n /**\n * Read and return a stored value by key.\n *\n * The stored data is deserialized from JSON and returned as\n * its original primitive.\n *\n * Returns `null` if no stored data exists.\n */\n read(key: string): Promise;\n\n /**\n * Write stored data for this key.\n *\n * The data must be serializable to JSON.\n */\n write(key: string, data: any): Promise;\n\n /**\n * Delete stored data by key.\n */\n delete(key: string): Promise;\n}" + "value": "export interface Storage {\n /**\n * Read and return a stored value by key.\n *\n * The stored data is deserialized from JSON and returned as\n * its original type.\n *\n * Returns the stored value for the given key, or `null` when no value\n * exists. Doesn't throw on a missing key.\n */\n read(key: string): Promise;\n\n /**\n * Write stored data for this key.\n *\n * The data must be serializable to JSON.\n */\n write(key: string, data: any): Promise;\n\n /**\n * Deletes a previously stored value by key.\n */\n delete(key: string): Promise;\n}" }, "Version": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -194936,7 +194936,7 @@ "syntaxKind": "PropertySignature", "name": "number", "value": "string", - "description": "A randomly generated alpha-numeric identifier for the order, distinct from `order.id`. The value is `undefined` for orders that were created before this field was introduced. All recent orders have a number.", + "description": "A randomly generated alpha-numeric identifier for the order, distinct from `order.id`. The value is `undefined` for orders that were created before this field was introduced. All recent orders have a number.\n\nOptional. Might not be present for orders created before 2024.", "isOptional": true }, { @@ -194947,7 +194947,7 @@ "description": "" } ], - "value": "export interface OrderConfirmation {\n order: {\n /**\n * A globally unique identifier for the order. This becomes the\n * [`Order`](/docs/api/admin-graphql/latest/objects/Order) object ID in the\n * GraphQL Admin API after the order is created.\n *\n * @example 'gid://shopify/Order/123'\n */\n id: string;\n };\n /**\n * A randomly generated alpha-numeric identifier for the order, distinct\n * from `order.id`. The value is `undefined` for orders that were created\n * before this field was introduced. All recent orders have a number.\n */\n number?: string;\n\n /**\n * Whether this is the customer's first completed order with this shop. `true` means the buyer hasn't placed an order here before. Use this to show first-purchase messaging or trigger welcome offers.\n */\n isFirstOrder: boolean;\n}" + "value": "export interface OrderConfirmation {\n order: {\n /**\n * A globally unique identifier for the order. This becomes the\n * [`Order`](/docs/api/admin-graphql/latest/objects/Order) object ID in the\n * GraphQL Admin API after the order is created.\n *\n * @example 'gid://shopify/Order/123'\n */\n id: string;\n };\n /**\n * A randomly generated alpha-numeric identifier for the order, distinct\n * from `order.id`. The value is `undefined` for orders that were created\n * before this field was introduced. All recent orders have a number.\n *\n * Optional. Might not be present for orders created before 2024.\n */\n number?: string;\n\n /**\n * Whether this is the customer's first completed order with this shop. `true` means the buyer hasn't placed an order here before. Use this to show first-purchase messaging or trigger welcome offers.\n */\n isFirstOrder: boolean;\n}" } } }, @@ -194966,7 +194966,7 @@ "syntaxKind": "PropertySignature", "name": "analytics", "value": "Analytics", - "description": "The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event." + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -194980,7 +194980,7 @@ "syntaxKind": "PropertySignature", "name": "applyTrackingConsentChange", "value": "ApplyTrackingConsentChangeType", - "description": "Enables setting and updating customer privacy consent settings and tracking consent metafields.\n\n> Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent) to be set to `true`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." + "description": "Enables setting and updating customer privacy consent settings and tracking consent metafields.\n\n> Note: Requires the [`collect_buyer_consent` capability](/docs/apps/build/customer-accounts/capabilities#collect-buyer-consent) to be set to `true`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -195001,7 +195001,7 @@ "syntaxKind": "PropertySignature", "name": "availablePaymentOptions", "value": "SubscribableSignalLike", - "description": "All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region." + "description": "All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n\nThe set of payment options can change when the buyer updates their address or cart, so subscribe to changes rather than reading once during initialization. Each option exposes `handle` and `type` only. Provider names, logos, fees, and installment terms aren't available." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -195038,7 +195038,7 @@ "syntaxKind": "PropertySignature", "name": "checkoutToken", "value": "SubscribableSignalLike", - "description": "A stable ID that represents the current checkout.\n\nThe value is `undefined` when the checkout hasn't been created on the server yet.\n\nUse this to correlate checkout sessions across your extension, web pixels, and backend systems.\n\nThis matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data) and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object)." + "description": "A stable ID that represents the current checkout.\n\nThe value is `undefined` when the checkout hasn't been created on the server yet.\n\nUse this to correlate checkout sessions across your extension, web pixels, and backend systems.\n\nThis matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data) and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n\nCan be `undefined`. Handle the `undefined` state before using the value." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -195059,7 +195059,7 @@ "syntaxKind": "PropertySignature", "name": "deliveryGroups", "value": "SubscribableSignalLike", - "description": "The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items." + "description": "The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n\nEmpty until the buyer enters enough address information for Shopify to calculate shipping rates." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -195080,7 +195080,7 @@ "syntaxKind": "PropertySignature", "name": "extension", "value": "Extension", - "description": "The meta information about the extension." + "description": "Metadata about the running extension, including the current target, API version, capabilities, and editor context. Use this to conditionally render content based on where the extension is running." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -195088,7 +195088,7 @@ "name": "extensionPoint", "value": "Target", "description": "The identifier that specifies where in Shopify's UI your code is being injected. This is one of the targets you've included in your extension's configuration file.", - "deprecationMessage": "Deprecated as of version `2023-07`, use `extension.target` instead.", + "deprecationMessage": "Use `extension.target` instead.", "examples": [ { "title": "Example", @@ -195107,14 +195107,14 @@ "syntaxKind": "PropertySignature", "name": "i18n", "value": "I18n", - "description": "Utilities for translating content and formatting values according to the current [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) of the checkout.\n\nRefer to [`localization` examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples) for more information." + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use alongside [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) to build fully localized extensions." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "instructions", "value": "SubscribableSignalLike", - "description": "The cart instructions used to create the checkout and possibly limit extension capabilities.\n\nThese instructions should be checked before performing any actions that might be affected by them.\n\nFor example, if you intend to add a discount code via the `applyDiscountCodeChange` method, check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n\n> Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs aren't available. See the [update guide](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples) for more information." + "description": "The cart instructions used to create the checkout and possibly limit extension capabilities.\n\nThese instructions should be checked before performing any actions that might be affected by them.\n\nFor example, if you intend to add a discount code via the `applyDiscountCodeChange` method, check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n\n> Caution: Check cart instructions before calling select APIs, as > some may not be available. See the > [Cart Instructions API](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples) > for more information." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -195128,7 +195128,7 @@ "syntaxKind": "PropertySignature", "name": "localization", "value": "Localization", - "description": "The details about the location, language, and currency of the customer. For utilities to easily format and translate content based on these details, you can use the [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n) object instead." + "description": "The buyer's language, country, currency, and timezone context. For formatting and translation helpers, use the [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#properties-propertydetail-i18n) object instead." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -195158,21 +195158,21 @@ "syntaxKind": "PropertySignature", "name": "query", "value": ">(query: string, options?: { variables?: Variables; version?: StorefrontApiVersion; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>", - "description": "The method used to query the Storefront GraphQL API with a prefetched token.\n\nRefer to [Storefront API access examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/storefront-api) for more information." + "description": "The method used to query the Storefront GraphQL API with a prefetched token." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "selectedPaymentOptions", "value": "SubscribableSignalLike", - "description": "The payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card)." + "description": "The payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\n\nEach option exposes `handle` and `type` only. Provider names, logos, fees, and installment terms aren't available." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "sessionToken", "value": "SessionToken", - "description": "The session token providing a set of claims as a signed JSON Web Token (JWT).\n\nThe token has a TTL of five minutes.\n\nIf the previous token expires, this value reflects a new session token with a new signature and expiry.\n\nRefer to [session token examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/session-token) for more information." + "description": "The session token providing a set of claims as a signed JSON Web Token (JWT).\n\nThe token has a TTL of five minutes.\n\nIf the previous token expires, this value reflects a new session token with a new signature and expiry.\n\nLearn more about [session tokens](/docs/apps/build/authentication-authorization/session-tokens)." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -195194,14 +195194,14 @@ "syntaxKind": "PropertySignature", "name": "shop", "value": "Shop", - "description": "The shop where the checkout is taking place." + "description": "The store where the checkout is taking place, including the shop name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "storage", "value": "Storage", - "description": "The key-value storage for the extension.\n\nIt uses `localStorage` and should persist across the customer's current checkout session.\n\n> Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n\nData is shared across all activated extension targets of this extension. In versions 2023-07 and earlier, each activated extension target had its own storage." + "description": "Key-value storage that persists across page loads within the current checkout session. Data is shared across all activated targets associated with this extension.\n\n> Caution: Data persistence isn't guaranteed and storage is cleared when the buyer starts a new checkout." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -195223,29 +195223,29 @@ ] } ], - "value": "export interface StandardApi {\n /**\n * The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event.\n */\n analytics: Analytics;\n\n /**\n * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\n */\n appliedGiftCards: SubscribableSignalLike;\n\n /**\n * The cart instructions used to create the checkout and possibly limit extension capabilities.\n *\n * These instructions should be checked before performing any actions that might be affected by them.\n *\n * For example, if you intend to add a discount code via the `applyDiscountCodeChange` method,\n * check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n *\n * > Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs aren't available.\n * See the [update guide](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples) for more information.\n *\n */\n instructions: SubscribableSignalLike;\n\n /**\n * The metafields requested in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration)\n * file. These metafields are updated when there's a change in the merchandise items\n * being purchased by the customer.\n *\n * App owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` isn't supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n appMetafields: SubscribableSignalLike;\n\n /**\n * The custom key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n buyerIdentity?: BuyerIdentity;\n\n /**\n * Provides details on the buyer's progression through the checkout and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/buyer-journey#examples)\n * examples for more information.\n */\n buyerJourney: BuyerJourney;\n\n /**\n * Settings applied to the buyer's checkout.\n */\n checkoutSettings: SubscribableSignalLike;\n\n /**\n * A stable ID that represents the current checkout.\n *\n * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\n *\n * This matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data)\n * and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n */\n checkoutToken: SubscribableSignalLike;\n\n /**\n * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * The meta information about the extension.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n *\n * @deprecated Deprecated as of version `2023-07`, use `extension.target` instead.\n */\n extensionPoint: Target;\n\n /**\n * Utilities for translating content and formatting values according to the current\n * [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization)\n * of the checkout.\n *\n * Refer to [`localization` examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples)\n * for more information.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The details about the location, language, and currency of the customer. For utilities to easily\n * format and translate content based on these details, you can use the\n * [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n)\n * object instead.\n */\n localization: Localization;\n\n /**\n * The metafields that apply to the current checkout.\n *\n * Metafields are stored locally on the client and are applied to the order object after the checkout completes.\n *\n * These metafields are shared by all extensions running on checkout, and\n * persist for as long as the customer is working on this checkout.\n *\n * Once the order is created, you can query these metafields using the\n * [GraphQL Admin API](/docs/admin-api/graphql/reference/orders/order#metafield-2021-01)\n *\n * > Caution:\n * `metafields` is deprecated. Use `appMetafields` with cart metafields instead.\n *\n * @deprecated Use `appMetafields` with cart metafields instead.\n */\n metafields: SubscribableSignalLike;\n\n /**\n * A note left by the customer to the merchant, either in their cart or during checkout.\n *\n * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\n */\n note: SubscribableSignalLike;\n\n /**\n * The method used to query the Storefront GraphQL API with a prefetched token.\n *\n * Refer to [Storefront API access examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/storefront-api) for more information.\n */\n query: >(\n query: string,\n options?: {variables?: Variables; version?: StorefrontApiVersion},\n ) => Promise<{data?: Data; errors?: GraphQLError[]}>;\n\n /**\n * The payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\n */\n selectedPaymentOptions: SubscribableSignalLike;\n\n /**\n * The session token providing a set of claims as a signed JSON Web Token (JWT).\n *\n * The token has a TTL of five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/session-token) for more information.\n */\n sessionToken: SessionToken;\n\n /**\n * The settings matching the settings definition written in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates in real time as a merchant fills in the settings.\n */\n settings: SubscribableSignalLike;\n\n /**\n * The proposed customer shipping address. During the information step, the address\n * updates when the field is committed (on change) rather than every keystroke.\n * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n shippingAddress?: SubscribableSignalLike;\n\n /**\n * The proposed customer billing address. The address updates when the field is\n * committed (on change) rather than every keystroke. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided yet.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n billingAddress?: SubscribableSignalLike;\n\n /** The shop where the checkout is taking place. */\n shop: Shop;\n\n /**\n * The key-value storage for the extension.\n *\n * It uses `localStorage` and should persist across the customer's current checkout session.\n *\n * > Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n *\n * Data is shared across all activated extension targets of this extension. In versions 2023-07 and earlier,\n * each activated extension target had its own storage.\n */\n storage: Storage;\n\n /**\n * The renderer version being used for the extension.\n *\n * @example '2025-10'\n */\n version: Version;\n\n /**\n * Customer privacy consent settings and a flag denoting if consent has previously been collected.\n */\n customerPrivacy: SubscribableSignalLike;\n\n /**\n * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent) to be set to `true`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyTrackingConsentChange: ApplyTrackingConsentChangeType;\n\n /**\n * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" + "value": "export interface StandardApi {\n /**\n * Tracks custom events and sends visitor information to\n * [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events\n * and `visitor()` to submit buyer contact details.\n */\n analytics: Analytics;\n\n /**\n * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\n */\n appliedGiftCards: SubscribableSignalLike;\n\n /**\n * The cart instructions used to create the checkout and possibly limit extension capabilities.\n *\n * These instructions should be checked before performing any actions that might be affected by them.\n *\n * For example, if you intend to add a discount code via the `applyDiscountCodeChange` method,\n * check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n *\n * > Caution: Check cart instructions before calling select APIs, as\n * > some may not be available. See the\n * > [Cart Instructions API](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples)\n * > for more information.\n *\n */\n instructions: SubscribableSignalLike;\n\n /**\n * The metafields requested in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration)\n * file. These metafields are updated when there's a change in the merchandise items\n * being purchased by the customer.\n *\n * App owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` isn't supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n appMetafields: SubscribableSignalLike;\n\n /**\n * The custom key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as\n * credit cards, wallets, and local payment methods. The list depends on\n * the shop's payment configuration and the buyer's region.\n *\n * The set of payment options can change when the buyer updates their\n * address or cart, so subscribe to changes rather than reading once\n * during initialization. Each option exposes `handle` and `type` only.\n * Provider names, logos, fees, and installment terms aren't available.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n buyerIdentity?: BuyerIdentity;\n\n /**\n * Provides details on the buyer's progression through the checkout and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/buyer-journey#examples)\n * examples for more information.\n */\n buyerJourney: BuyerJourney;\n\n /**\n * Settings applied to the buyer's checkout.\n */\n checkoutSettings: SubscribableSignalLike;\n\n /**\n * A stable ID that represents the current checkout.\n *\n * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\n *\n * This matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data)\n * and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n *\n * Can be `undefined`. Handle the `undefined` state before using the value.\n */\n checkoutToken: SubscribableSignalLike;\n\n /**\n * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n *\n * Empty until the buyer enters enough address information for Shopify to\n * calculate shipping rates.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * Metadata about the running extension, including the current target, API version,\n * capabilities, and editor context. Use this to conditionally render content\n * based on where the extension is running.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n *\n * @deprecated Use `extension.target` instead.\n */\n extensionPoint: Target;\n\n /**\n * Utilities for translating strings, formatting currencies, numbers, and dates\n * according to the buyer's locale. Use alongside\n * [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization)\n * to build fully localized extensions.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The buyer's language, country, currency, and timezone context. For\n * formatting and translation helpers, use the\n * [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#properties-propertydetail-i18n)\n * object instead.\n */\n localization: Localization;\n\n /**\n * The metafields that apply to the current checkout.\n *\n * Metafields are stored locally on the client and are applied to the order object after the checkout completes.\n *\n * These metafields are shared by all extensions running on checkout, and\n * persist for as long as the customer is working on this checkout.\n *\n * Once the order is created, you can query these metafields using the\n * [GraphQL Admin API](/docs/admin-api/graphql/reference/orders/order#metafield-2021-01)\n *\n * > Caution:\n * `metafields` is deprecated. Use `appMetafields` with cart metafields instead.\n *\n * @deprecated Use `appMetafields` with cart metafields instead.\n */\n metafields: SubscribableSignalLike;\n\n /**\n * A note left by the customer to the merchant, either in their cart or during checkout.\n *\n * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\n */\n note: SubscribableSignalLike;\n\n /**\n * The method used to query the Storefront GraphQL API with a prefetched token.\n *\n */\n query: >(\n query: string,\n options?: {variables?: Variables; version?: StorefrontApiVersion},\n ) => Promise<{data?: Data; errors?: GraphQLError[]}>;\n\n /**\n * The payment options the buyer has currently selected. This updates as\n * the buyer changes their payment method. The array can contain multiple\n * entries when the buyer splits payment across methods (for example, a\n * gift card and a credit card).\n *\n * Each option exposes `handle` and `type` only. Provider names, logos,\n * fees, and installment terms aren't available.\n */\n selectedPaymentOptions: SubscribableSignalLike;\n\n /**\n * The session token providing a set of claims as a signed JSON Web Token (JWT).\n *\n * The token has a TTL of five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Learn more about [session tokens](/docs/apps/build/authentication-authorization/session-tokens).\n */\n sessionToken: SessionToken;\n\n /**\n * The settings matching the settings definition written in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates in real time as a merchant fills in the settings.\n */\n settings: SubscribableSignalLike;\n\n /**\n * The proposed customer shipping address. During the information step, the address\n * updates when the field is committed (on change) rather than every keystroke.\n * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n shippingAddress?: SubscribableSignalLike;\n\n /**\n * The proposed customer billing address. The address updates when the field is\n * committed (on change) rather than every keystroke. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided yet.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n billingAddress?: SubscribableSignalLike;\n\n /**\n * The store where the checkout is taking place, including the shop name,\n * storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.\n */\n shop: Shop;\n\n /**\n * Key-value storage that persists across page loads within the current checkout\n * session. Data is shared across all activated targets associated with\n * this extension.\n *\n * > Caution: Data persistence isn't guaranteed and storage is cleared when the\n * buyer starts a new checkout.\n */\n storage: Storage;\n\n /**\n * The renderer version being used for the extension.\n *\n * @example '2025-10'\n */\n version: Version;\n\n /**\n * Customer privacy consent settings and a flag denoting if consent has previously been collected.\n */\n customerPrivacy: SubscribableSignalLike;\n\n /**\n * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`collect_buyer_consent` capability](/docs/apps/build/customer-accounts/capabilities#collect-buyer-consent) to be set to `true`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyTrackingConsentChange: ApplyTrackingConsentChangeType;\n\n /**\n * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" }, "Analytics": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Analytics", - "description": "", + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "publish", "value": "(name: string, data: Record) => Promise", - "description": "Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing)." + "description": "Publishes a custom event to [Web Pixels](/docs/apps/marketing). Returns `true` when the event is successfully dispatched.\n\nThe Promise resolves to `true` when the event was dispatched. The boolean indicates dispatch confirmation only. It doesn't indicate whether any specific web pixel processed the event." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "visitor", "value": "(data: { email?: string; phone?: string; }) => Promise", - "description": "A method for capturing details about a visitor on the online store." + "description": "Submits buyer contact details for attribution and analytics purposes." } ], - "value": "export interface Analytics {\n /**\n * Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing).\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * A method for capturing details about a visitor on the online store.\n */\n visitor(data: {email?: string; phone?: string}): Promise;\n}" + "value": "export interface Analytics {\n /**\n * Publishes a custom event to [Web Pixels](/docs/apps/marketing).\n * Returns `true` when the event is successfully dispatched.\n *\n * The Promise resolves to `true` when the event was dispatched. The boolean\n * indicates dispatch confirmation only. It doesn't indicate whether any\n * specific web pixel processed the event.\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * Submits buyer contact details for attribution and analytics purposes.\n */\n visitor(data: {email?: string; phone?: string}): Promise;\n}" }, "VisitorResult": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -195286,10 +195286,10 @@ "syntaxKind": "PropertySignature", "name": "type", "value": "'error'", - "description": "Indicates that the visitor information is invalid and wasn't submitted. Examples are using the wrong data type or missing a required property." + "description": "Indicates that the visitor information is invalid and wasn't submitted. Common causes include using the wrong data type or omitting a required property." } ], - "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Examples are using the wrong data type or missing a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Common causes include using the wrong data type or omitting a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" }, "SubscribableSignalLike": { "filePath": "src/surfaces/checkout/shared.ts", @@ -195503,10 +195503,10 @@ "syntaxKind": "PropertySignature", "name": "value", "value": "string | null", - "description": "The new value to store in the metafield. Set to `null` to delete the metafield." + "description": "The new value to store in the metafield. Set to `null` to delete the metafield.\n\nConsent metafield values are strings, not booleans. Pass `null` to delete a tracking consent metafield." } ], - "value": "export interface TrackingConsentMetafieldChange {\n /**\n * The identifier for the tracking consent metafield to update.\n */\n key: string;\n /**\n * The new value to store in the metafield. Set to `null` to delete the metafield.\n */\n value: string | null;\n}" + "value": "export interface TrackingConsentMetafieldChange {\n /**\n * The identifier for the tracking consent metafield to update.\n */\n key: string;\n /**\n * The new value to store in the metafield. Set to `null` to delete the metafield.\n *\n * Consent metafield values are strings, not booleans. Pass `null` to delete\n * a tracking consent metafield.\n */\n value: string | null;\n}" }, "VisitorConsent": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -195720,7 +195720,7 @@ "syntaxKind": "PropertySignature", "name": "value", "value": "string", - "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.", + "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.\n\nAttribute values are always strings. To store structured data, serialize it to JSON and parse it when reading.", "examples": [ { "title": "Example", @@ -195735,7 +195735,7 @@ ] } ], - "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" + "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * Attribute values are always strings. To store structured data, serialize\n * it to JSON and parse it when reading.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" }, "PaymentOption": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -196086,7 +196086,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A globally-unique identifier for the customer in the format `gid://shopify/Customer/`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", + "description": "An identifier for the customer in the format `gid://shopify/Customer/`. This value is unique per shop.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", "examples": [ { "title": "Example", @@ -196139,7 +196139,7 @@ "isPrivate": true } ], - "value": "export interface Customer {\n /**\n * A globally-unique identifier for the customer in the format `gid://shopify/Customer/`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'gid://shopify/Customer/123'\n */\n id: string;\n /**\n * The email address associated with the customer's account. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email?: string;\n /**\n * The phone number associated with the customer's account. The value is `undefined` if no phone number is on file or the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone?: string;\n /**\n * The customer's full name, typically a combination of first and last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n fullName?: string;\n /**\n * The customer's first name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n firstName?: string;\n /**\n * The customer's last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n lastName?: string;\n /**\n * The customer's profile image, such as a Gravatar avatar. Use this to personalize the extension UI for the logged-in buyer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n image: ImageDetails;\n /**\n * Whether the customer has opted in to receiving marketing communications from the merchant, such as email campaigns and promotional offers.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * > Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n *\n * @deprecated Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n */\n acceptsMarketing: boolean;\n /**\n * Whether the customer has opted in to email marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsEmailMarketing: boolean;\n /**\n * Whether the customer has opted in to SMS marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsSmsMarketing: boolean;\n /**\n * The store credit accounts owned by this customer that can be used as payment during checkout. Each account has a balance representing available store credit.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @private\n */\n storeCreditAccounts: StoreCreditAccount[];\n /**\n * The number of orders the customer has previously placed with this shop.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n ordersCount: number;\n}" + "value": "export interface Customer {\n /**\n * An identifier for the customer in the format `gid://shopify/Customer/`. This value is unique per shop.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'gid://shopify/Customer/123'\n */\n id: string;\n /**\n * The email address associated with the customer's account. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email?: string;\n /**\n * The phone number associated with the customer's account. The value is `undefined` if no phone number is on file or the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone?: string;\n /**\n * The customer's full name, typically a combination of first and last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n fullName?: string;\n /**\n * The customer's first name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n firstName?: string;\n /**\n * The customer's last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n lastName?: string;\n /**\n * The customer's profile image, such as a Gravatar avatar. Use this to personalize the extension UI for the logged-in buyer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n image: ImageDetails;\n /**\n * Whether the customer has opted in to receiving marketing communications from the merchant, such as email campaigns and promotional offers.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * > Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n *\n * @deprecated Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n */\n acceptsMarketing: boolean;\n /**\n * Whether the customer has opted in to email marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsEmailMarketing: boolean;\n /**\n * Whether the customer has opted in to SMS marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsSmsMarketing: boolean;\n /**\n * The store credit accounts owned by this customer that can be used as payment during checkout. Each account has a balance representing available store credit.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @private\n */\n storeCreditAccounts: StoreCreditAccount[];\n /**\n * The number of orders the customer has previously placed with this shop.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n ordersCount: number;\n}" }, "ImageDetails": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -196421,11 +196421,11 @@ "syntaxKind": "MethodSignature", "name": "perform", "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", + "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.\n\nRuns after all intercept results are collected. Use it for local state updates such as setting an error flag. By the time it runs, the navigation decision is final, so blocking logic belongs in the intercept handler itself, not here.", "isOptional": true } ], - "value": "interface InterceptorRequestAllow {\n /**\n * Indicates that the interceptor allows the buyer's journey to continue.\n */\n behavior: 'allow';\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" + "value": "interface InterceptorRequestAllow {\n /**\n * Indicates that the interceptor allows the buyer's journey to continue.\n */\n behavior: 'allow';\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n *\n * Runs after all intercept results are collected. Use it for local state\n * updates such as setting an error flag. By the time it runs, the navigation\n * decision is final, so blocking logic belongs in the intercept handler\n * itself, not here.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" }, "InterceptorResult": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -196489,7 +196489,7 @@ "syntaxKind": "MethodSignature", "name": "perform", "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", + "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.\n\nRuns after all intercept results are collected. Use it for local state updates such as setting an error flag. By the time it runs, the navigation decision is final, so blocking logic belongs in the intercept handler itself, not here.", "isOptional": true }, { @@ -196500,7 +196500,7 @@ "description": "The reason for blocking the interceptor request. This value isn't presented to the buyer, so it doesn't need to be localized. The value is used only for Shopify's own internal debugging and metrics." } ], - "value": "interface InterceptorRequestBlock {\n /**\n * Indicates that the interceptor blocks the buyer's journey from continuing.\n */\n behavior: 'block';\n\n /**\n * The reason for blocking the interceptor request. This value isn't presented to\n * the buyer, so it doesn't need to be localized. The value is used only for Shopify's\n * own internal debugging and metrics.\n */\n reason: string;\n\n /**\n * Used to pass errors to the checkout UI, outside your extension's UI boundaries.\n */\n errors?: ValidationError[];\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" + "value": "interface InterceptorRequestBlock {\n /**\n * Indicates that the interceptor blocks the buyer's journey from continuing.\n */\n behavior: 'block';\n\n /**\n * The reason for blocking the interceptor request. This value isn't presented to\n * the buyer, so it doesn't need to be localized. The value is used only for Shopify's\n * own internal debugging and metrics.\n */\n reason: string;\n\n /**\n * Used to pass errors to the checkout UI, outside your extension's UI boundaries.\n */\n errors?: ValidationError[];\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n *\n * Runs after all intercept results are collected. Use it for local state\n * updates such as setting an error flag. By the time it runs, the navigation\n * decision is final, so blocking logic belongs in the intercept handler\n * itself, not here.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" }, "ValidationError": { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -196721,17 +196721,17 @@ "syntaxKind": "PropertySignature", "name": "totalShippingAmount", "value": "SubscribableSignalLike", - "description": "The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step." + "description": "The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step.\n\n`undefined` until the buyer selects a shipping method (typically after the information step)." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "totalTaxAmount", "value": "SubscribableSignalLike", - "description": "The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet." + "description": "The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet.\n\n`undefined` when taxes haven't been calculated or aren't available for the buyer's region." } ], - "value": "export interface CartCost {\n /**\n * The sum of all line item prices at the current step of checkout, before shipping and taxes are applied. Use this value to display the base cost of the items the buyer purchased.\n */\n subtotalAmount: SubscribableSignalLike;\n\n /**\n * The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step.\n */\n totalShippingAmount: SubscribableSignalLike;\n\n /**\n * The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet.\n */\n totalTaxAmount: SubscribableSignalLike;\n\n /**\n * The minimum total at the current step of checkout. Costs not yet calculated, such as shipping on the information step, aren't included. Gift cards and store credits are excluded from this total.\n */\n totalAmount: SubscribableSignalLike;\n}" + "value": "export interface CartCost {\n /**\n * The sum of all line item prices at the current step of checkout, before shipping and taxes are applied. Use this value to display the base cost of the items the buyer purchased.\n */\n subtotalAmount: SubscribableSignalLike;\n\n /**\n * The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step.\n *\n * `undefined` until the buyer selects a shipping method (typically after the\n * information step).\n */\n totalShippingAmount: SubscribableSignalLike;\n\n /**\n * The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet.\n *\n * `undefined` when taxes haven't been calculated or aren't available for the\n * buyer's region.\n */\n totalTaxAmount: SubscribableSignalLike;\n\n /**\n * The minimum total at the current step of checkout. Costs not yet calculated, such as shipping on the information step, aren't included. Gift cards and store credits are excluded from this total.\n */\n totalAmount: SubscribableSignalLike;\n}" }, "CustomerPrivacy": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -196818,31 +196818,31 @@ "syntaxKind": "PropertySignature", "name": "analytics", "value": "boolean", - "description": "Whether analytics data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Analytics data includes how the shop was used and what interactions occurred." + "description": "Whether analytics data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Analytics data includes how the shop was used and what interactions occurred.\n\nWhether analytics data can be collected right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.analytics`, before calling `shopify.analytics.publish()`." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "marketing", "value": "boolean", - "description": "Whether marketing data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Marketing data includes attribution and targeted advertising preferences." + "description": "Whether marketing data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Marketing data includes attribution and targeted advertising preferences.\n\nWhether marketing data can be collected right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.marketing`, before performing marketing-related data collection." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "preferences", "value": "boolean", - "description": "Whether preference data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Preference data includes language, currency, and sizing choices." + "description": "Whether preference data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Preference data includes language, currency, and sizing choices.\n\nWhether preference data can be collected right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.preferences`, before storing or reading buyer preference data." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "saleOfData", "value": "boolean", - "description": "Whether data can be shared with third parties based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. This typically applies to behavioral advertising data." + "description": "Whether data can be shared with third parties based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. This typically applies to behavioral advertising data.\n\nWhether buyer data can be shared with or sold to third parties right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.saleOfData`, before sharing or selling buyer data with third parties." } ], - "value": "export interface AllowedProcessing {\n /**\n * Whether analytics data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Analytics\n * data includes how the shop was used and what interactions occurred.\n */\n analytics: boolean;\n /**\n * Whether marketing data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Marketing\n * data includes attribution and targeted advertising preferences.\n */\n marketing: boolean;\n /**\n * Whether preference data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Preference\n * data includes language, currency, and sizing choices.\n */\n preferences: boolean;\n /**\n * Whether data can be shared with third parties based on the visitor's\n * consent, the merchant's privacy configuration, and the visitor's region.\n * This typically applies to behavioral advertising data.\n */\n saleOfData: boolean;\n}" + "value": "export interface AllowedProcessing {\n /**\n * Whether analytics data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Analytics\n * data includes how the shop was used and what interactions occurred.\n *\n * Whether analytics data can be collected right now. Combines the buyer's\n * consent, the merchant's privacy configuration, and the buyer's region into\n * a single boolean. Check this flag, not `visitorConsent.analytics`, before\n * calling `shopify.analytics.publish()`.\n */\n analytics: boolean;\n /**\n * Whether marketing data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Marketing\n * data includes attribution and targeted advertising preferences.\n *\n * Whether marketing data can be collected right now. Combines the buyer's\n * consent, the merchant's privacy configuration, and the buyer's region into\n * a single boolean. Check this flag, not `visitorConsent.marketing`, before\n * performing marketing-related data collection.\n */\n marketing: boolean;\n /**\n * Whether preference data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Preference\n * data includes language, currency, and sizing choices.\n *\n * Whether preference data can be collected right now. Combines the buyer's\n * consent, the merchant's privacy configuration, and the buyer's region into\n * a single boolean. Check this flag, not `visitorConsent.preferences`,\n * before storing or reading buyer preference data.\n */\n preferences: boolean;\n /**\n * Whether data can be shared with third parties based on the visitor's\n * consent, the merchant's privacy configuration, and the visitor's region.\n * This typically applies to behavioral advertising data.\n *\n * Whether buyer data can be shared with or sold to third parties right now.\n * Combines the buyer's consent, the merchant's privacy configuration, and\n * the buyer's region into a single boolean. Check this flag, not\n * `visitorConsent.saleOfData`, before sharing or selling buyer data with\n * third parties.\n */\n saleOfData: boolean;\n}" }, "TrackingConsentMetafield": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -197534,7 +197534,7 @@ "Extension": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Extension", - "description": "The meta information about an extension target.", + "description": "Metadata about the running extension, including its API version, target, capabilities, and editor context. Use this to read configuration details or conditionally render content based on where the extension is running.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -197560,7 +197560,7 @@ "syntaxKind": "PropertySignature", "name": "capabilities", "value": "SubscribableSignalLike", - "description": "The allowed capabilities of the extension, defined in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n\n* [`api_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#api-access): the extension can access the Storefront API.\n\n* [`network_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access): the extension can make external network calls.\n\n* [`block_progress`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n\n* [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n\n* [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can register customer consent decisions that are honored on Shopify-managed services.\n\n* [`iframe.sources`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#iframe): the extension can embed an external URL in an iframe." + "description": "The allowed capabilities of the extension, defined in your [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -197608,7 +197608,7 @@ "syntaxKind": "PropertySignature", "name": "version", "value": "string", - "description": "The published version of the running extension target.\n\nFor unpublished extensions, the value is `undefined`.", + "description": "The published version of the running extension target.\n\nFor unpublished extensions, the value is `undefined`.\n\nDon't use this property as a stable identifier in development environments. It becomes available only after the extension is published.", "isOptional": true, "examples": [ { @@ -197624,7 +197624,7 @@ ] } ], - "value": "export interface Extension {\n /**\n * The API version that was set in the extension config file.\n *\n * @example '2024-10', '2025-01', '2025-04', '2025-07', '2025-10'\n */\n apiVersion: ApiVersion;\n\n /**\n * The allowed capabilities of the extension, defined\n * in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n *\n * * [`api_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#api-access): the extension can access the Storefront API.\n *\n * * [`network_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access): the extension can make external network calls.\n *\n * * [`block_progress`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n *\n * * [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n *\n * * [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can register customer consent decisions that are honored on Shopify-managed services.\n *\n * * [`iframe.sources`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#iframe): the extension can embed an external URL in an iframe.\n */\n capabilities: SubscribableSignalLike;\n\n /**\n * Information about the editor where the extension is being rendered.\n *\n * If the value is undefined, then the extension isn't running in an editor.\n */\n editor?: Editor;\n\n /**\n * A Boolean to show whether your extension is currently rendered to the screen.\n *\n * Shopify might render your extension before it's visible in the UI,\n * typically to pre-render extensions that appear on a later step of the\n * checkout.\n *\n * Your extension might also continue to run after the customer has navigated away\n * from where it was rendered. The extension continues running so that\n * your extension is immediately available to render if the customer navigates back.\n */\n rendered: SubscribableSignalLike;\n\n /**\n * The URL to the script that started the extension target.\n */\n scriptUrl: string;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n */\n target: Target;\n\n /**\n * The published version of the running extension target.\n *\n * For unpublished extensions, the value is `undefined`.\n *\n * @example 3.0.10\n */\n version?: string;\n}" + "value": "export interface Extension {\n /**\n * The API version that was set in the extension config file.\n *\n * @example '2024-10', '2025-01', '2025-04', '2025-07', '2025-10'\n */\n apiVersion: ApiVersion;\n\n /**\n * The allowed capabilities of the extension, defined in your\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n */\n capabilities: SubscribableSignalLike;\n\n /**\n * Information about the editor where the extension is being rendered.\n *\n * If the value is undefined, then the extension isn't running in an editor.\n */\n editor?: Editor;\n\n /**\n * A Boolean to show whether your extension is currently rendered to the screen.\n *\n * Shopify might render your extension before it's visible in the UI,\n * typically to pre-render extensions that appear on a later step of the\n * checkout.\n *\n * Your extension might also continue to run after the customer has navigated away\n * from where it was rendered. The extension continues running so that\n * your extension is immediately available to render if the customer navigates back.\n */\n rendered: SubscribableSignalLike;\n\n /**\n * The URL to the script that started the extension target.\n */\n scriptUrl: string;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n */\n target: Target;\n\n /**\n * The published version of the running extension target.\n *\n * For unpublished extensions, the value is `undefined`.\n *\n * Don't use this property as a stable identifier in development environments.\n * It becomes available only after the extension is published.\n *\n * @example 3.0.10\n */\n version?: string;\n}" }, "ApiVersion": { "filePath": "src/shared.ts", @@ -197643,7 +197643,7 @@ "Editor": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Editor", - "description": "", + "description": "Information about the editor environment when an extension is rendered inside the checkout editor. The value is `undefined` when the extension is not rendering in an editor.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -197658,7 +197658,7 @@ "I18n": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18n", - "description": "", + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use the I18n API alongside the Localization API to build fully localized extensions.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -197694,7 +197694,7 @@ "I18nTranslate": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18nTranslate", - "description": "This returns a translated string matching a key in a locale file.", + "description": "Translates a key from your extension's locale files into a localized string. Supports interpolation with placeholder replacements and pluralization via the special `count` option.", "members": [], "value": "export interface I18nTranslate {\n (\n key: string,\n options?: Record,\n ): ReplacementType extends string | number\n ? string\n : (string | ReplacementType)[];\n}" }, @@ -198258,14 +198258,14 @@ "Localization": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Localization", - "description": "", + "description": "The buyer's language, country, currency, and timezone context. Use this to adapt your extension to the buyer's region and display localized content.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "country", "value": "SubscribableSignalLike", - "description": "The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown." + "description": "The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n\nDerived from the buyer's shipping address. Returns `undefined` until the buyer enters a shipping address." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -198293,18 +198293,18 @@ "syntaxKind": "PropertySignature", "name": "market", "value": "SubscribableSignalLike", - "description": "The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n\n> Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.", - "deprecationMessage": "Deprecated as of version `2025-04`" + "description": "The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. The market context updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.", + "deprecationMessage": "Merchants now manage which extensions load for each\nmarket, so extensions no longer need to check this value." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "timezone", "value": "SubscribableSignalLike", - "description": "The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time." + "description": "The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time." } ], - "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n *\n * > Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" + "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n *\n * Derived from the buyer's shipping address. Returns `undefined` until the\n * buyer enters a shipping address.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout,\n * carried over from the cart context. Markets group countries and\n * regions with shared pricing, languages, and domains. The market\n * context updates when the buyer changes the country of their\n * shipping address. The value is `undefined` if the market is unknown.\n *\n * @deprecated Merchants now manage which extensions load for each\n * market, so extensions no longer need to check this value.\n */\n market: SubscribableSignalLike;\n}" }, "Country": { "filePath": "src/shared.ts", @@ -198505,7 +198505,7 @@ "SessionToken": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SessionToken", - "description": "", + "description": "Authenticates requests between your extension and your app backend. Use session tokens to verify the identity of the buyer and the shop context when making server-side API calls. The token is a signed JWT that contains claims such as the customer ID, shop domain, and expiration.\n\nThe `sub` claim in the decoded token is present only when the buyer is logged in and the app has permission to read customer accounts. Absent for anonymous buyers.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -198764,7 +198764,7 @@ "Shop": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Shop", - "description": "", + "description": "Metadata about the merchant's store, including its name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -198804,30 +198804,30 @@ "syntaxKind": "PropertySignature", "name": "storefrontUrl", "value": "string", - "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n\n> Caution: > As of version `2024-04` this value no longer has a trailing slash.", + "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.", "isOptional": true } ], - "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n *\n * > Caution:\n * > As of version `2024-04` this value no longer has a trailing slash.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom domain.\n */\n myshopifyDomain: string;\n}" + "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom domain.\n */\n myshopifyDomain: string;\n}" }, "Storage": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Storage", - "description": "A key-value storage object for the extension.\n\nStored data is available only to this specific extension and any of its instances.\n\nThe storage backend is implemented with `localStorage` and should persist across the buyer's checkout session. However, data persistence isn't guaranteed.", + "description": "Key-value storage for a specific extension. Use storage to save preferences or cached data that should survive page reloads without requiring a backend call. Stored data is only available to this specific extension. The storage backend is implemented with `localStorage` and data persistence isn't guaranteed.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "delete", "value": "(key: string) => Promise", - "description": "Delete stored data by key." + "description": "Deletes a previously stored value by key." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "read", "value": "(key: string) => Promise", - "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original primitive.\n\nReturns `null` if no stored data exists." + "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original type.\n\nReturns the stored value for the given key, or `null` when no value exists. Doesn't throw on a missing key." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -198837,7 +198837,7 @@ "description": "Write stored data for this key.\n\nThe data must be serializable to JSON." } ], - "value": "export interface Storage {\n /**\n * Read and return a stored value by key.\n *\n * The stored data is deserialized from JSON and returned as\n * its original primitive.\n *\n * Returns `null` if no stored data exists.\n */\n read(key: string): Promise;\n\n /**\n * Write stored data for this key.\n *\n * The data must be serializable to JSON.\n */\n write(key: string, data: any): Promise;\n\n /**\n * Delete stored data by key.\n */\n delete(key: string): Promise;\n}" + "value": "export interface Storage {\n /**\n * Read and return a stored value by key.\n *\n * The stored data is deserialized from JSON and returned as\n * its original type.\n *\n * Returns the stored value for the given key, or `null` when no value\n * exists. Doesn't throw on a missing key.\n */\n read(key: string): Promise;\n\n /**\n * Write stored data for this key.\n *\n * The data must be serializable to JSON.\n */\n write(key: string, data: any): Promise;\n\n /**\n * Deletes a previously stored value by key.\n */\n delete(key: string): Promise;\n}" }, "Version": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -198973,7 +198973,7 @@ "syntaxKind": "PropertySignature", "name": "number", "value": "string", - "description": "A randomly generated alpha-numeric identifier for the order, distinct from `order.id`. The value is `undefined` for orders that were created before this field was introduced. All recent orders have a number.", + "description": "A randomly generated alpha-numeric identifier for the order, distinct from `order.id`. The value is `undefined` for orders that were created before this field was introduced. All recent orders have a number.\n\nOptional. Might not be present for orders created before 2024.", "isOptional": true }, { @@ -198984,7 +198984,7 @@ "description": "" } ], - "value": "export interface OrderConfirmation {\n order: {\n /**\n * A globally unique identifier for the order. This becomes the\n * [`Order`](/docs/api/admin-graphql/latest/objects/Order) object ID in the\n * GraphQL Admin API after the order is created.\n *\n * @example 'gid://shopify/Order/123'\n */\n id: string;\n };\n /**\n * A randomly generated alpha-numeric identifier for the order, distinct\n * from `order.id`. The value is `undefined` for orders that were created\n * before this field was introduced. All recent orders have a number.\n */\n number?: string;\n\n /**\n * Whether this is the customer's first completed order with this shop. `true` means the buyer hasn't placed an order here before. Use this to show first-purchase messaging or trigger welcome offers.\n */\n isFirstOrder: boolean;\n}" + "value": "export interface OrderConfirmation {\n order: {\n /**\n * A globally unique identifier for the order. This becomes the\n * [`Order`](/docs/api/admin-graphql/latest/objects/Order) object ID in the\n * GraphQL Admin API after the order is created.\n *\n * @example 'gid://shopify/Order/123'\n */\n id: string;\n };\n /**\n * A randomly generated alpha-numeric identifier for the order, distinct\n * from `order.id`. The value is `undefined` for orders that were created\n * before this field was introduced. All recent orders have a number.\n *\n * Optional. Might not be present for orders created before 2024.\n */\n number?: string;\n\n /**\n * Whether this is the customer's first completed order with this shop. `true` means the buyer hasn't placed an order here before. Use this to show first-purchase messaging or trigger welcome offers.\n */\n isFirstOrder: boolean;\n}" } } }, @@ -199003,7 +199003,7 @@ "syntaxKind": "PropertySignature", "name": "analytics", "value": "Analytics", - "description": "The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event." + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -199017,7 +199017,7 @@ "syntaxKind": "PropertySignature", "name": "applyTrackingConsentChange", "value": "ApplyTrackingConsentChangeType", - "description": "Enables setting and updating customer privacy consent settings and tracking consent metafields.\n\n> Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent) to be set to `true`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." + "description": "Enables setting and updating customer privacy consent settings and tracking consent metafields.\n\n> Note: Requires the [`collect_buyer_consent` capability](/docs/apps/build/customer-accounts/capabilities#collect-buyer-consent) to be set to `true`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -199038,7 +199038,7 @@ "syntaxKind": "PropertySignature", "name": "availablePaymentOptions", "value": "SubscribableSignalLike", - "description": "All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region." + "description": "All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n\nThe set of payment options can change when the buyer updates their address or cart, so subscribe to changes rather than reading once during initialization. Each option exposes `handle` and `type` only. Provider names, logos, fees, and installment terms aren't available." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -199075,7 +199075,7 @@ "syntaxKind": "PropertySignature", "name": "checkoutToken", "value": "SubscribableSignalLike", - "description": "A stable ID that represents the current checkout.\n\nThe value is `undefined` when the checkout hasn't been created on the server yet.\n\nUse this to correlate checkout sessions across your extension, web pixels, and backend systems.\n\nThis matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data) and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object)." + "description": "A stable ID that represents the current checkout.\n\nThe value is `undefined` when the checkout hasn't been created on the server yet.\n\nUse this to correlate checkout sessions across your extension, web pixels, and backend systems.\n\nThis matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data) and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n\nCan be `undefined`. Handle the `undefined` state before using the value." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -199096,7 +199096,7 @@ "syntaxKind": "PropertySignature", "name": "deliveryGroups", "value": "SubscribableSignalLike", - "description": "The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items." + "description": "The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n\nEmpty until the buyer enters enough address information for Shopify to calculate shipping rates." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -199117,7 +199117,7 @@ "syntaxKind": "PropertySignature", "name": "extension", "value": "Extension", - "description": "The meta information about the extension." + "description": "Metadata about the running extension, including the current target, API version, capabilities, and editor context. Use this to conditionally render content based on where the extension is running." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -199125,7 +199125,7 @@ "name": "extensionPoint", "value": "Target", "description": "The identifier that specifies where in Shopify's UI your code is being injected. This is one of the targets you've included in your extension's configuration file.", - "deprecationMessage": "Deprecated as of version `2023-07`, use `extension.target` instead.", + "deprecationMessage": "Use `extension.target` instead.", "examples": [ { "title": "Example", @@ -199144,14 +199144,14 @@ "syntaxKind": "PropertySignature", "name": "i18n", "value": "I18n", - "description": "Utilities for translating content and formatting values according to the current [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) of the checkout.\n\nRefer to [`localization` examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples) for more information." + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use alongside [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) to build fully localized extensions." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "instructions", "value": "SubscribableSignalLike", - "description": "The cart instructions used to create the checkout and possibly limit extension capabilities.\n\nThese instructions should be checked before performing any actions that might be affected by them.\n\nFor example, if you intend to add a discount code via the `applyDiscountCodeChange` method, check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n\n> Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs aren't available. See the [update guide](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples) for more information." + "description": "The cart instructions used to create the checkout and possibly limit extension capabilities.\n\nThese instructions should be checked before performing any actions that might be affected by them.\n\nFor example, if you intend to add a discount code via the `applyDiscountCodeChange` method, check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n\n> Caution: Check cart instructions before calling select APIs, as > some may not be available. See the > [Cart Instructions API](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples) > for more information." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -199165,7 +199165,7 @@ "syntaxKind": "PropertySignature", "name": "localization", "value": "Localization", - "description": "The details about the location, language, and currency of the customer. For utilities to easily format and translate content based on these details, you can use the [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n) object instead." + "description": "The buyer's language, country, currency, and timezone context. For formatting and translation helpers, use the [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#properties-propertydetail-i18n) object instead." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -199195,21 +199195,21 @@ "syntaxKind": "PropertySignature", "name": "query", "value": ">(query: string, options?: { variables?: Variables; version?: StorefrontApiVersion; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>", - "description": "The method used to query the Storefront GraphQL API with a prefetched token.\n\nRefer to [Storefront API access examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/storefront-api) for more information." + "description": "The method used to query the Storefront GraphQL API with a prefetched token." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "selectedPaymentOptions", "value": "SubscribableSignalLike", - "description": "The payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card)." + "description": "The payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\n\nEach option exposes `handle` and `type` only. Provider names, logos, fees, and installment terms aren't available." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "sessionToken", "value": "SessionToken", - "description": "The session token providing a set of claims as a signed JSON Web Token (JWT).\n\nThe token has a TTL of five minutes.\n\nIf the previous token expires, this value reflects a new session token with a new signature and expiry.\n\nRefer to [session token examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/session-token) for more information." + "description": "The session token providing a set of claims as a signed JSON Web Token (JWT).\n\nThe token has a TTL of five minutes.\n\nIf the previous token expires, this value reflects a new session token with a new signature and expiry.\n\nLearn more about [session tokens](/docs/apps/build/authentication-authorization/session-tokens)." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -199231,14 +199231,14 @@ "syntaxKind": "PropertySignature", "name": "shop", "value": "Shop", - "description": "The shop where the checkout is taking place." + "description": "The store where the checkout is taking place, including the shop name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "storage", "value": "Storage", - "description": "The key-value storage for the extension.\n\nIt uses `localStorage` and should persist across the customer's current checkout session.\n\n> Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n\nData is shared across all activated extension targets of this extension. In versions 2023-07 and earlier, each activated extension target had its own storage." + "description": "Key-value storage that persists across page loads within the current checkout session. Data is shared across all activated targets associated with this extension.\n\n> Caution: Data persistence isn't guaranteed and storage is cleared when the buyer starts a new checkout." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -199260,29 +199260,29 @@ ] } ], - "value": "export interface StandardApi {\n /**\n * The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event.\n */\n analytics: Analytics;\n\n /**\n * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\n */\n appliedGiftCards: SubscribableSignalLike;\n\n /**\n * The cart instructions used to create the checkout and possibly limit extension capabilities.\n *\n * These instructions should be checked before performing any actions that might be affected by them.\n *\n * For example, if you intend to add a discount code via the `applyDiscountCodeChange` method,\n * check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n *\n * > Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs aren't available.\n * See the [update guide](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples) for more information.\n *\n */\n instructions: SubscribableSignalLike;\n\n /**\n * The metafields requested in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration)\n * file. These metafields are updated when there's a change in the merchandise items\n * being purchased by the customer.\n *\n * App owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` isn't supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n appMetafields: SubscribableSignalLike;\n\n /**\n * The custom key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n buyerIdentity?: BuyerIdentity;\n\n /**\n * Provides details on the buyer's progression through the checkout and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/buyer-journey#examples)\n * examples for more information.\n */\n buyerJourney: BuyerJourney;\n\n /**\n * Settings applied to the buyer's checkout.\n */\n checkoutSettings: SubscribableSignalLike;\n\n /**\n * A stable ID that represents the current checkout.\n *\n * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\n *\n * This matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data)\n * and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n */\n checkoutToken: SubscribableSignalLike;\n\n /**\n * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * The meta information about the extension.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n *\n * @deprecated Deprecated as of version `2023-07`, use `extension.target` instead.\n */\n extensionPoint: Target;\n\n /**\n * Utilities for translating content and formatting values according to the current\n * [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization)\n * of the checkout.\n *\n * Refer to [`localization` examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples)\n * for more information.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The details about the location, language, and currency of the customer. For utilities to easily\n * format and translate content based on these details, you can use the\n * [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n)\n * object instead.\n */\n localization: Localization;\n\n /**\n * The metafields that apply to the current checkout.\n *\n * Metafields are stored locally on the client and are applied to the order object after the checkout completes.\n *\n * These metafields are shared by all extensions running on checkout, and\n * persist for as long as the customer is working on this checkout.\n *\n * Once the order is created, you can query these metafields using the\n * [GraphQL Admin API](/docs/admin-api/graphql/reference/orders/order#metafield-2021-01)\n *\n * > Caution:\n * `metafields` is deprecated. Use `appMetafields` with cart metafields instead.\n *\n * @deprecated Use `appMetafields` with cart metafields instead.\n */\n metafields: SubscribableSignalLike;\n\n /**\n * A note left by the customer to the merchant, either in their cart or during checkout.\n *\n * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\n */\n note: SubscribableSignalLike;\n\n /**\n * The method used to query the Storefront GraphQL API with a prefetched token.\n *\n * Refer to [Storefront API access examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/storefront-api) for more information.\n */\n query: >(\n query: string,\n options?: {variables?: Variables; version?: StorefrontApiVersion},\n ) => Promise<{data?: Data; errors?: GraphQLError[]}>;\n\n /**\n * The payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\n */\n selectedPaymentOptions: SubscribableSignalLike;\n\n /**\n * The session token providing a set of claims as a signed JSON Web Token (JWT).\n *\n * The token has a TTL of five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/session-token) for more information.\n */\n sessionToken: SessionToken;\n\n /**\n * The settings matching the settings definition written in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates in real time as a merchant fills in the settings.\n */\n settings: SubscribableSignalLike;\n\n /**\n * The proposed customer shipping address. During the information step, the address\n * updates when the field is committed (on change) rather than every keystroke.\n * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n shippingAddress?: SubscribableSignalLike;\n\n /**\n * The proposed customer billing address. The address updates when the field is\n * committed (on change) rather than every keystroke. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided yet.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n billingAddress?: SubscribableSignalLike;\n\n /** The shop where the checkout is taking place. */\n shop: Shop;\n\n /**\n * The key-value storage for the extension.\n *\n * It uses `localStorage` and should persist across the customer's current checkout session.\n *\n * > Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n *\n * Data is shared across all activated extension targets of this extension. In versions 2023-07 and earlier,\n * each activated extension target had its own storage.\n */\n storage: Storage;\n\n /**\n * The renderer version being used for the extension.\n *\n * @example '2025-10'\n */\n version: Version;\n\n /**\n * Customer privacy consent settings and a flag denoting if consent has previously been collected.\n */\n customerPrivacy: SubscribableSignalLike;\n\n /**\n * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent) to be set to `true`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyTrackingConsentChange: ApplyTrackingConsentChangeType;\n\n /**\n * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" + "value": "export interface StandardApi {\n /**\n * Tracks custom events and sends visitor information to\n * [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events\n * and `visitor()` to submit buyer contact details.\n */\n analytics: Analytics;\n\n /**\n * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\n */\n appliedGiftCards: SubscribableSignalLike;\n\n /**\n * The cart instructions used to create the checkout and possibly limit extension capabilities.\n *\n * These instructions should be checked before performing any actions that might be affected by them.\n *\n * For example, if you intend to add a discount code via the `applyDiscountCodeChange` method,\n * check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n *\n * > Caution: Check cart instructions before calling select APIs, as\n * > some may not be available. See the\n * > [Cart Instructions API](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples)\n * > for more information.\n *\n */\n instructions: SubscribableSignalLike;\n\n /**\n * The metafields requested in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration)\n * file. These metafields are updated when there's a change in the merchandise items\n * being purchased by the customer.\n *\n * App owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` isn't supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n appMetafields: SubscribableSignalLike;\n\n /**\n * The custom key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as\n * credit cards, wallets, and local payment methods. The list depends on\n * the shop's payment configuration and the buyer's region.\n *\n * The set of payment options can change when the buyer updates their\n * address or cart, so subscribe to changes rather than reading once\n * during initialization. Each option exposes `handle` and `type` only.\n * Provider names, logos, fees, and installment terms aren't available.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n buyerIdentity?: BuyerIdentity;\n\n /**\n * Provides details on the buyer's progression through the checkout and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/buyer-journey#examples)\n * examples for more information.\n */\n buyerJourney: BuyerJourney;\n\n /**\n * Settings applied to the buyer's checkout.\n */\n checkoutSettings: SubscribableSignalLike;\n\n /**\n * A stable ID that represents the current checkout.\n *\n * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\n *\n * This matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data)\n * and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n *\n * Can be `undefined`. Handle the `undefined` state before using the value.\n */\n checkoutToken: SubscribableSignalLike;\n\n /**\n * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n *\n * Empty until the buyer enters enough address information for Shopify to\n * calculate shipping rates.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * Metadata about the running extension, including the current target, API version,\n * capabilities, and editor context. Use this to conditionally render content\n * based on where the extension is running.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n *\n * @deprecated Use `extension.target` instead.\n */\n extensionPoint: Target;\n\n /**\n * Utilities for translating strings, formatting currencies, numbers, and dates\n * according to the buyer's locale. Use alongside\n * [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization)\n * to build fully localized extensions.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The buyer's language, country, currency, and timezone context. For\n * formatting and translation helpers, use the\n * [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#properties-propertydetail-i18n)\n * object instead.\n */\n localization: Localization;\n\n /**\n * The metafields that apply to the current checkout.\n *\n * Metafields are stored locally on the client and are applied to the order object after the checkout completes.\n *\n * These metafields are shared by all extensions running on checkout, and\n * persist for as long as the customer is working on this checkout.\n *\n * Once the order is created, you can query these metafields using the\n * [GraphQL Admin API](/docs/admin-api/graphql/reference/orders/order#metafield-2021-01)\n *\n * > Caution:\n * `metafields` is deprecated. Use `appMetafields` with cart metafields instead.\n *\n * @deprecated Use `appMetafields` with cart metafields instead.\n */\n metafields: SubscribableSignalLike;\n\n /**\n * A note left by the customer to the merchant, either in their cart or during checkout.\n *\n * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\n */\n note: SubscribableSignalLike;\n\n /**\n * The method used to query the Storefront GraphQL API with a prefetched token.\n *\n */\n query: >(\n query: string,\n options?: {variables?: Variables; version?: StorefrontApiVersion},\n ) => Promise<{data?: Data; errors?: GraphQLError[]}>;\n\n /**\n * The payment options the buyer has currently selected. This updates as\n * the buyer changes their payment method. The array can contain multiple\n * entries when the buyer splits payment across methods (for example, a\n * gift card and a credit card).\n *\n * Each option exposes `handle` and `type` only. Provider names, logos,\n * fees, and installment terms aren't available.\n */\n selectedPaymentOptions: SubscribableSignalLike;\n\n /**\n * The session token providing a set of claims as a signed JSON Web Token (JWT).\n *\n * The token has a TTL of five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Learn more about [session tokens](/docs/apps/build/authentication-authorization/session-tokens).\n */\n sessionToken: SessionToken;\n\n /**\n * The settings matching the settings definition written in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates in real time as a merchant fills in the settings.\n */\n settings: SubscribableSignalLike;\n\n /**\n * The proposed customer shipping address. During the information step, the address\n * updates when the field is committed (on change) rather than every keystroke.\n * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n shippingAddress?: SubscribableSignalLike;\n\n /**\n * The proposed customer billing address. The address updates when the field is\n * committed (on change) rather than every keystroke. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided yet.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n billingAddress?: SubscribableSignalLike;\n\n /**\n * The store where the checkout is taking place, including the shop name,\n * storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.\n */\n shop: Shop;\n\n /**\n * Key-value storage that persists across page loads within the current checkout\n * session. Data is shared across all activated targets associated with\n * this extension.\n *\n * > Caution: Data persistence isn't guaranteed and storage is cleared when the\n * buyer starts a new checkout.\n */\n storage: Storage;\n\n /**\n * The renderer version being used for the extension.\n *\n * @example '2025-10'\n */\n version: Version;\n\n /**\n * Customer privacy consent settings and a flag denoting if consent has previously been collected.\n */\n customerPrivacy: SubscribableSignalLike;\n\n /**\n * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`collect_buyer_consent` capability](/docs/apps/build/customer-accounts/capabilities#collect-buyer-consent) to be set to `true`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyTrackingConsentChange: ApplyTrackingConsentChangeType;\n\n /**\n * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" }, "Analytics": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Analytics", - "description": "", + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "publish", "value": "(name: string, data: Record) => Promise", - "description": "Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing)." + "description": "Publishes a custom event to [Web Pixels](/docs/apps/marketing). Returns `true` when the event is successfully dispatched.\n\nThe Promise resolves to `true` when the event was dispatched. The boolean indicates dispatch confirmation only. It doesn't indicate whether any specific web pixel processed the event." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "visitor", "value": "(data: { email?: string; phone?: string; }) => Promise", - "description": "A method for capturing details about a visitor on the online store." + "description": "Submits buyer contact details for attribution and analytics purposes." } ], - "value": "export interface Analytics {\n /**\n * Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing).\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * A method for capturing details about a visitor on the online store.\n */\n visitor(data: {email?: string; phone?: string}): Promise;\n}" + "value": "export interface Analytics {\n /**\n * Publishes a custom event to [Web Pixels](/docs/apps/marketing).\n * Returns `true` when the event is successfully dispatched.\n *\n * The Promise resolves to `true` when the event was dispatched. The boolean\n * indicates dispatch confirmation only. It doesn't indicate whether any\n * specific web pixel processed the event.\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * Submits buyer contact details for attribution and analytics purposes.\n */\n visitor(data: {email?: string; phone?: string}): Promise;\n}" }, "VisitorResult": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -199323,10 +199323,10 @@ "syntaxKind": "PropertySignature", "name": "type", "value": "'error'", - "description": "Indicates that the visitor information is invalid and wasn't submitted. Examples are using the wrong data type or missing a required property." + "description": "Indicates that the visitor information is invalid and wasn't submitted. Common causes include using the wrong data type or omitting a required property." } ], - "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Examples are using the wrong data type or missing a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Common causes include using the wrong data type or omitting a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" }, "SubscribableSignalLike": { "filePath": "src/surfaces/checkout/shared.ts", @@ -199540,10 +199540,10 @@ "syntaxKind": "PropertySignature", "name": "value", "value": "string | null", - "description": "The new value to store in the metafield. Set to `null` to delete the metafield." + "description": "The new value to store in the metafield. Set to `null` to delete the metafield.\n\nConsent metafield values are strings, not booleans. Pass `null` to delete a tracking consent metafield." } ], - "value": "export interface TrackingConsentMetafieldChange {\n /**\n * The identifier for the tracking consent metafield to update.\n */\n key: string;\n /**\n * The new value to store in the metafield. Set to `null` to delete the metafield.\n */\n value: string | null;\n}" + "value": "export interface TrackingConsentMetafieldChange {\n /**\n * The identifier for the tracking consent metafield to update.\n */\n key: string;\n /**\n * The new value to store in the metafield. Set to `null` to delete the metafield.\n *\n * Consent metafield values are strings, not booleans. Pass `null` to delete\n * a tracking consent metafield.\n */\n value: string | null;\n}" }, "VisitorConsent": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -199757,7 +199757,7 @@ "syntaxKind": "PropertySignature", "name": "value", "value": "string", - "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.", + "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.\n\nAttribute values are always strings. To store structured data, serialize it to JSON and parse it when reading.", "examples": [ { "title": "Example", @@ -199772,7 +199772,7 @@ ] } ], - "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" + "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * Attribute values are always strings. To store structured data, serialize\n * it to JSON and parse it when reading.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" }, "PaymentOption": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -200123,7 +200123,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A globally-unique identifier for the customer in the format `gid://shopify/Customer/`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", + "description": "An identifier for the customer in the format `gid://shopify/Customer/`. This value is unique per shop.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", "examples": [ { "title": "Example", @@ -200176,7 +200176,7 @@ "isPrivate": true } ], - "value": "export interface Customer {\n /**\n * A globally-unique identifier for the customer in the format `gid://shopify/Customer/`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'gid://shopify/Customer/123'\n */\n id: string;\n /**\n * The email address associated with the customer's account. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email?: string;\n /**\n * The phone number associated with the customer's account. The value is `undefined` if no phone number is on file or the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone?: string;\n /**\n * The customer's full name, typically a combination of first and last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n fullName?: string;\n /**\n * The customer's first name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n firstName?: string;\n /**\n * The customer's last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n lastName?: string;\n /**\n * The customer's profile image, such as a Gravatar avatar. Use this to personalize the extension UI for the logged-in buyer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n image: ImageDetails;\n /**\n * Whether the customer has opted in to receiving marketing communications from the merchant, such as email campaigns and promotional offers.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * > Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n *\n * @deprecated Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n */\n acceptsMarketing: boolean;\n /**\n * Whether the customer has opted in to email marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsEmailMarketing: boolean;\n /**\n * Whether the customer has opted in to SMS marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsSmsMarketing: boolean;\n /**\n * The store credit accounts owned by this customer that can be used as payment during checkout. Each account has a balance representing available store credit.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @private\n */\n storeCreditAccounts: StoreCreditAccount[];\n /**\n * The number of orders the customer has previously placed with this shop.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n ordersCount: number;\n}" + "value": "export interface Customer {\n /**\n * An identifier for the customer in the format `gid://shopify/Customer/`. This value is unique per shop.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'gid://shopify/Customer/123'\n */\n id: string;\n /**\n * The email address associated with the customer's account. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email?: string;\n /**\n * The phone number associated with the customer's account. The value is `undefined` if no phone number is on file or the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone?: string;\n /**\n * The customer's full name, typically a combination of first and last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n fullName?: string;\n /**\n * The customer's first name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n firstName?: string;\n /**\n * The customer's last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n lastName?: string;\n /**\n * The customer's profile image, such as a Gravatar avatar. Use this to personalize the extension UI for the logged-in buyer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n image: ImageDetails;\n /**\n * Whether the customer has opted in to receiving marketing communications from the merchant, such as email campaigns and promotional offers.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * > Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n *\n * @deprecated Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n */\n acceptsMarketing: boolean;\n /**\n * Whether the customer has opted in to email marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsEmailMarketing: boolean;\n /**\n * Whether the customer has opted in to SMS marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsSmsMarketing: boolean;\n /**\n * The store credit accounts owned by this customer that can be used as payment during checkout. Each account has a balance representing available store credit.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @private\n */\n storeCreditAccounts: StoreCreditAccount[];\n /**\n * The number of orders the customer has previously placed with this shop.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n ordersCount: number;\n}" }, "ImageDetails": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -200458,11 +200458,11 @@ "syntaxKind": "MethodSignature", "name": "perform", "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", + "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.\n\nRuns after all intercept results are collected. Use it for local state updates such as setting an error flag. By the time it runs, the navigation decision is final, so blocking logic belongs in the intercept handler itself, not here.", "isOptional": true } ], - "value": "interface InterceptorRequestAllow {\n /**\n * Indicates that the interceptor allows the buyer's journey to continue.\n */\n behavior: 'allow';\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" + "value": "interface InterceptorRequestAllow {\n /**\n * Indicates that the interceptor allows the buyer's journey to continue.\n */\n behavior: 'allow';\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n *\n * Runs after all intercept results are collected. Use it for local state\n * updates such as setting an error flag. By the time it runs, the navigation\n * decision is final, so blocking logic belongs in the intercept handler\n * itself, not here.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" }, "InterceptorResult": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -200526,7 +200526,7 @@ "syntaxKind": "MethodSignature", "name": "perform", "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", + "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.\n\nRuns after all intercept results are collected. Use it for local state updates such as setting an error flag. By the time it runs, the navigation decision is final, so blocking logic belongs in the intercept handler itself, not here.", "isOptional": true }, { @@ -200537,7 +200537,7 @@ "description": "The reason for blocking the interceptor request. This value isn't presented to the buyer, so it doesn't need to be localized. The value is used only for Shopify's own internal debugging and metrics." } ], - "value": "interface InterceptorRequestBlock {\n /**\n * Indicates that the interceptor blocks the buyer's journey from continuing.\n */\n behavior: 'block';\n\n /**\n * The reason for blocking the interceptor request. This value isn't presented to\n * the buyer, so it doesn't need to be localized. The value is used only for Shopify's\n * own internal debugging and metrics.\n */\n reason: string;\n\n /**\n * Used to pass errors to the checkout UI, outside your extension's UI boundaries.\n */\n errors?: ValidationError[];\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" + "value": "interface InterceptorRequestBlock {\n /**\n * Indicates that the interceptor blocks the buyer's journey from continuing.\n */\n behavior: 'block';\n\n /**\n * The reason for blocking the interceptor request. This value isn't presented to\n * the buyer, so it doesn't need to be localized. The value is used only for Shopify's\n * own internal debugging and metrics.\n */\n reason: string;\n\n /**\n * Used to pass errors to the checkout UI, outside your extension's UI boundaries.\n */\n errors?: ValidationError[];\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n *\n * Runs after all intercept results are collected. Use it for local state\n * updates such as setting an error flag. By the time it runs, the navigation\n * decision is final, so blocking logic belongs in the intercept handler\n * itself, not here.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" }, "ValidationError": { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -200758,17 +200758,17 @@ "syntaxKind": "PropertySignature", "name": "totalShippingAmount", "value": "SubscribableSignalLike", - "description": "The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step." + "description": "The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step.\n\n`undefined` until the buyer selects a shipping method (typically after the information step)." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "totalTaxAmount", "value": "SubscribableSignalLike", - "description": "The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet." + "description": "The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet.\n\n`undefined` when taxes haven't been calculated or aren't available for the buyer's region." } ], - "value": "export interface CartCost {\n /**\n * The sum of all line item prices at the current step of checkout, before shipping and taxes are applied. Use this value to display the base cost of the items the buyer purchased.\n */\n subtotalAmount: SubscribableSignalLike;\n\n /**\n * The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step.\n */\n totalShippingAmount: SubscribableSignalLike;\n\n /**\n * The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet.\n */\n totalTaxAmount: SubscribableSignalLike;\n\n /**\n * The minimum total at the current step of checkout. Costs not yet calculated, such as shipping on the information step, aren't included. Gift cards and store credits are excluded from this total.\n */\n totalAmount: SubscribableSignalLike;\n}" + "value": "export interface CartCost {\n /**\n * The sum of all line item prices at the current step of checkout, before shipping and taxes are applied. Use this value to display the base cost of the items the buyer purchased.\n */\n subtotalAmount: SubscribableSignalLike;\n\n /**\n * The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step.\n *\n * `undefined` until the buyer selects a shipping method (typically after the\n * information step).\n */\n totalShippingAmount: SubscribableSignalLike;\n\n /**\n * The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet.\n *\n * `undefined` when taxes haven't been calculated or aren't available for the\n * buyer's region.\n */\n totalTaxAmount: SubscribableSignalLike;\n\n /**\n * The minimum total at the current step of checkout. Costs not yet calculated, such as shipping on the information step, aren't included. Gift cards and store credits are excluded from this total.\n */\n totalAmount: SubscribableSignalLike;\n}" }, "CustomerPrivacy": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -200855,31 +200855,31 @@ "syntaxKind": "PropertySignature", "name": "analytics", "value": "boolean", - "description": "Whether analytics data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Analytics data includes how the shop was used and what interactions occurred." + "description": "Whether analytics data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Analytics data includes how the shop was used and what interactions occurred.\n\nWhether analytics data can be collected right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.analytics`, before calling `shopify.analytics.publish()`." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "marketing", "value": "boolean", - "description": "Whether marketing data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Marketing data includes attribution and targeted advertising preferences." + "description": "Whether marketing data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Marketing data includes attribution and targeted advertising preferences.\n\nWhether marketing data can be collected right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.marketing`, before performing marketing-related data collection." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "preferences", "value": "boolean", - "description": "Whether preference data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Preference data includes language, currency, and sizing choices." + "description": "Whether preference data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Preference data includes language, currency, and sizing choices.\n\nWhether preference data can be collected right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.preferences`, before storing or reading buyer preference data." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "saleOfData", "value": "boolean", - "description": "Whether data can be shared with third parties based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. This typically applies to behavioral advertising data." + "description": "Whether data can be shared with third parties based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. This typically applies to behavioral advertising data.\n\nWhether buyer data can be shared with or sold to third parties right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.saleOfData`, before sharing or selling buyer data with third parties." } ], - "value": "export interface AllowedProcessing {\n /**\n * Whether analytics data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Analytics\n * data includes how the shop was used and what interactions occurred.\n */\n analytics: boolean;\n /**\n * Whether marketing data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Marketing\n * data includes attribution and targeted advertising preferences.\n */\n marketing: boolean;\n /**\n * Whether preference data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Preference\n * data includes language, currency, and sizing choices.\n */\n preferences: boolean;\n /**\n * Whether data can be shared with third parties based on the visitor's\n * consent, the merchant's privacy configuration, and the visitor's region.\n * This typically applies to behavioral advertising data.\n */\n saleOfData: boolean;\n}" + "value": "export interface AllowedProcessing {\n /**\n * Whether analytics data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Analytics\n * data includes how the shop was used and what interactions occurred.\n *\n * Whether analytics data can be collected right now. Combines the buyer's\n * consent, the merchant's privacy configuration, and the buyer's region into\n * a single boolean. Check this flag, not `visitorConsent.analytics`, before\n * calling `shopify.analytics.publish()`.\n */\n analytics: boolean;\n /**\n * Whether marketing data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Marketing\n * data includes attribution and targeted advertising preferences.\n *\n * Whether marketing data can be collected right now. Combines the buyer's\n * consent, the merchant's privacy configuration, and the buyer's region into\n * a single boolean. Check this flag, not `visitorConsent.marketing`, before\n * performing marketing-related data collection.\n */\n marketing: boolean;\n /**\n * Whether preference data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Preference\n * data includes language, currency, and sizing choices.\n *\n * Whether preference data can be collected right now. Combines the buyer's\n * consent, the merchant's privacy configuration, and the buyer's region into\n * a single boolean. Check this flag, not `visitorConsent.preferences`,\n * before storing or reading buyer preference data.\n */\n preferences: boolean;\n /**\n * Whether data can be shared with third parties based on the visitor's\n * consent, the merchant's privacy configuration, and the visitor's region.\n * This typically applies to behavioral advertising data.\n *\n * Whether buyer data can be shared with or sold to third parties right now.\n * Combines the buyer's consent, the merchant's privacy configuration, and\n * the buyer's region into a single boolean. Check this flag, not\n * `visitorConsent.saleOfData`, before sharing or selling buyer data with\n * third parties.\n */\n saleOfData: boolean;\n}" }, "TrackingConsentMetafield": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -201571,7 +201571,7 @@ "Extension": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Extension", - "description": "The meta information about an extension target.", + "description": "Metadata about the running extension, including its API version, target, capabilities, and editor context. Use this to read configuration details or conditionally render content based on where the extension is running.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -201597,7 +201597,7 @@ "syntaxKind": "PropertySignature", "name": "capabilities", "value": "SubscribableSignalLike", - "description": "The allowed capabilities of the extension, defined in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n\n* [`api_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#api-access): the extension can access the Storefront API.\n\n* [`network_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access): the extension can make external network calls.\n\n* [`block_progress`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n\n* [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n\n* [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can register customer consent decisions that are honored on Shopify-managed services.\n\n* [`iframe.sources`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#iframe): the extension can embed an external URL in an iframe." + "description": "The allowed capabilities of the extension, defined in your [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -201645,7 +201645,7 @@ "syntaxKind": "PropertySignature", "name": "version", "value": "string", - "description": "The published version of the running extension target.\n\nFor unpublished extensions, the value is `undefined`.", + "description": "The published version of the running extension target.\n\nFor unpublished extensions, the value is `undefined`.\n\nDon't use this property as a stable identifier in development environments. It becomes available only after the extension is published.", "isOptional": true, "examples": [ { @@ -201661,7 +201661,7 @@ ] } ], - "value": "export interface Extension {\n /**\n * The API version that was set in the extension config file.\n *\n * @example '2024-10', '2025-01', '2025-04', '2025-07', '2025-10'\n */\n apiVersion: ApiVersion;\n\n /**\n * The allowed capabilities of the extension, defined\n * in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n *\n * * [`api_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#api-access): the extension can access the Storefront API.\n *\n * * [`network_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access): the extension can make external network calls.\n *\n * * [`block_progress`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n *\n * * [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n *\n * * [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can register customer consent decisions that are honored on Shopify-managed services.\n *\n * * [`iframe.sources`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#iframe): the extension can embed an external URL in an iframe.\n */\n capabilities: SubscribableSignalLike;\n\n /**\n * Information about the editor where the extension is being rendered.\n *\n * If the value is undefined, then the extension isn't running in an editor.\n */\n editor?: Editor;\n\n /**\n * A Boolean to show whether your extension is currently rendered to the screen.\n *\n * Shopify might render your extension before it's visible in the UI,\n * typically to pre-render extensions that appear on a later step of the\n * checkout.\n *\n * Your extension might also continue to run after the customer has navigated away\n * from where it was rendered. The extension continues running so that\n * your extension is immediately available to render if the customer navigates back.\n */\n rendered: SubscribableSignalLike;\n\n /**\n * The URL to the script that started the extension target.\n */\n scriptUrl: string;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n */\n target: Target;\n\n /**\n * The published version of the running extension target.\n *\n * For unpublished extensions, the value is `undefined`.\n *\n * @example 3.0.10\n */\n version?: string;\n}" + "value": "export interface Extension {\n /**\n * The API version that was set in the extension config file.\n *\n * @example '2024-10', '2025-01', '2025-04', '2025-07', '2025-10'\n */\n apiVersion: ApiVersion;\n\n /**\n * The allowed capabilities of the extension, defined in your\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n */\n capabilities: SubscribableSignalLike;\n\n /**\n * Information about the editor where the extension is being rendered.\n *\n * If the value is undefined, then the extension isn't running in an editor.\n */\n editor?: Editor;\n\n /**\n * A Boolean to show whether your extension is currently rendered to the screen.\n *\n * Shopify might render your extension before it's visible in the UI,\n * typically to pre-render extensions that appear on a later step of the\n * checkout.\n *\n * Your extension might also continue to run after the customer has navigated away\n * from where it was rendered. The extension continues running so that\n * your extension is immediately available to render if the customer navigates back.\n */\n rendered: SubscribableSignalLike;\n\n /**\n * The URL to the script that started the extension target.\n */\n scriptUrl: string;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n */\n target: Target;\n\n /**\n * The published version of the running extension target.\n *\n * For unpublished extensions, the value is `undefined`.\n *\n * Don't use this property as a stable identifier in development environments.\n * It becomes available only after the extension is published.\n *\n * @example 3.0.10\n */\n version?: string;\n}" }, "ApiVersion": { "filePath": "src/shared.ts", @@ -201680,7 +201680,7 @@ "Editor": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Editor", - "description": "", + "description": "Information about the editor environment when an extension is rendered inside the checkout editor. The value is `undefined` when the extension is not rendering in an editor.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -201695,7 +201695,7 @@ "I18n": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18n", - "description": "", + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use the I18n API alongside the Localization API to build fully localized extensions.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -201731,7 +201731,7 @@ "I18nTranslate": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18nTranslate", - "description": "This returns a translated string matching a key in a locale file.", + "description": "Translates a key from your extension's locale files into a localized string. Supports interpolation with placeholder replacements and pluralization via the special `count` option.", "members": [], "value": "export interface I18nTranslate {\n (\n key: string,\n options?: Record,\n ): ReplacementType extends string | number\n ? string\n : (string | ReplacementType)[];\n}" }, @@ -202295,14 +202295,14 @@ "Localization": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Localization", - "description": "", + "description": "The buyer's language, country, currency, and timezone context. Use this to adapt your extension to the buyer's region and display localized content.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "country", "value": "SubscribableSignalLike", - "description": "The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown." + "description": "The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n\nDerived from the buyer's shipping address. Returns `undefined` until the buyer enters a shipping address." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -202330,18 +202330,18 @@ "syntaxKind": "PropertySignature", "name": "market", "value": "SubscribableSignalLike", - "description": "The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n\n> Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.", - "deprecationMessage": "Deprecated as of version `2025-04`" + "description": "The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. The market context updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.", + "deprecationMessage": "Merchants now manage which extensions load for each\nmarket, so extensions no longer need to check this value." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "timezone", "value": "SubscribableSignalLike", - "description": "The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time." + "description": "The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time." } ], - "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n *\n * > Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" + "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n *\n * Derived from the buyer's shipping address. Returns `undefined` until the\n * buyer enters a shipping address.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout,\n * carried over from the cart context. Markets group countries and\n * regions with shared pricing, languages, and domains. The market\n * context updates when the buyer changes the country of their\n * shipping address. The value is `undefined` if the market is unknown.\n *\n * @deprecated Merchants now manage which extensions load for each\n * market, so extensions no longer need to check this value.\n */\n market: SubscribableSignalLike;\n}" }, "Country": { "filePath": "src/shared.ts", @@ -202542,7 +202542,7 @@ "SessionToken": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SessionToken", - "description": "", + "description": "Authenticates requests between your extension and your app backend. Use session tokens to verify the identity of the buyer and the shop context when making server-side API calls. The token is a signed JWT that contains claims such as the customer ID, shop domain, and expiration.\n\nThe `sub` claim in the decoded token is present only when the buyer is logged in and the app has permission to read customer accounts. Absent for anonymous buyers.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -202801,7 +202801,7 @@ "Shop": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Shop", - "description": "", + "description": "Metadata about the merchant's store, including its name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -202841,30 +202841,30 @@ "syntaxKind": "PropertySignature", "name": "storefrontUrl", "value": "string", - "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n\n> Caution: > As of version `2024-04` this value no longer has a trailing slash.", + "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.", "isOptional": true } ], - "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n *\n * > Caution:\n * > As of version `2024-04` this value no longer has a trailing slash.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom domain.\n */\n myshopifyDomain: string;\n}" + "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom domain.\n */\n myshopifyDomain: string;\n}" }, "Storage": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Storage", - "description": "A key-value storage object for the extension.\n\nStored data is available only to this specific extension and any of its instances.\n\nThe storage backend is implemented with `localStorage` and should persist across the buyer's checkout session. However, data persistence isn't guaranteed.", + "description": "Key-value storage for a specific extension. Use storage to save preferences or cached data that should survive page reloads without requiring a backend call. Stored data is only available to this specific extension. The storage backend is implemented with `localStorage` and data persistence isn't guaranteed.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "delete", "value": "(key: string) => Promise", - "description": "Delete stored data by key." + "description": "Deletes a previously stored value by key." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "read", "value": "(key: string) => Promise", - "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original primitive.\n\nReturns `null` if no stored data exists." + "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original type.\n\nReturns the stored value for the given key, or `null` when no value exists. Doesn't throw on a missing key." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -202874,7 +202874,7 @@ "description": "Write stored data for this key.\n\nThe data must be serializable to JSON." } ], - "value": "export interface Storage {\n /**\n * Read and return a stored value by key.\n *\n * The stored data is deserialized from JSON and returned as\n * its original primitive.\n *\n * Returns `null` if no stored data exists.\n */\n read(key: string): Promise;\n\n /**\n * Write stored data for this key.\n *\n * The data must be serializable to JSON.\n */\n write(key: string, data: any): Promise;\n\n /**\n * Delete stored data by key.\n */\n delete(key: string): Promise;\n}" + "value": "export interface Storage {\n /**\n * Read and return a stored value by key.\n *\n * The stored data is deserialized from JSON and returned as\n * its original type.\n *\n * Returns the stored value for the given key, or `null` when no value\n * exists. Doesn't throw on a missing key.\n */\n read(key: string): Promise;\n\n /**\n * Write stored data for this key.\n *\n * The data must be serializable to JSON.\n */\n write(key: string, data: any): Promise;\n\n /**\n * Deletes a previously stored value by key.\n */\n delete(key: string): Promise;\n}" }, "Version": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -203010,7 +203010,7 @@ "syntaxKind": "PropertySignature", "name": "number", "value": "string", - "description": "A randomly generated alpha-numeric identifier for the order, distinct from `order.id`. The value is `undefined` for orders that were created before this field was introduced. All recent orders have a number.", + "description": "A randomly generated alpha-numeric identifier for the order, distinct from `order.id`. The value is `undefined` for orders that were created before this field was introduced. All recent orders have a number.\n\nOptional. Might not be present for orders created before 2024.", "isOptional": true }, { @@ -203021,7 +203021,7 @@ "description": "" } ], - "value": "export interface OrderConfirmation {\n order: {\n /**\n * A globally unique identifier for the order. This becomes the\n * [`Order`](/docs/api/admin-graphql/latest/objects/Order) object ID in the\n * GraphQL Admin API after the order is created.\n *\n * @example 'gid://shopify/Order/123'\n */\n id: string;\n };\n /**\n * A randomly generated alpha-numeric identifier for the order, distinct\n * from `order.id`. The value is `undefined` for orders that were created\n * before this field was introduced. All recent orders have a number.\n */\n number?: string;\n\n /**\n * Whether this is the customer's first completed order with this shop. `true` means the buyer hasn't placed an order here before. Use this to show first-purchase messaging or trigger welcome offers.\n */\n isFirstOrder: boolean;\n}" + "value": "export interface OrderConfirmation {\n order: {\n /**\n * A globally unique identifier for the order. This becomes the\n * [`Order`](/docs/api/admin-graphql/latest/objects/Order) object ID in the\n * GraphQL Admin API after the order is created.\n *\n * @example 'gid://shopify/Order/123'\n */\n id: string;\n };\n /**\n * A randomly generated alpha-numeric identifier for the order, distinct\n * from `order.id`. The value is `undefined` for orders that were created\n * before this field was introduced. All recent orders have a number.\n *\n * Optional. Might not be present for orders created before 2024.\n */\n number?: string;\n\n /**\n * Whether this is the customer's first completed order with this shop. `true` means the buyer hasn't placed an order here before. Use this to show first-purchase messaging or trigger welcome offers.\n */\n isFirstOrder: boolean;\n}" } } }, @@ -203040,7 +203040,7 @@ "syntaxKind": "PropertySignature", "name": "analytics", "value": "Analytics", - "description": "The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event." + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -203054,7 +203054,7 @@ "syntaxKind": "PropertySignature", "name": "applyTrackingConsentChange", "value": "ApplyTrackingConsentChangeType", - "description": "Enables setting and updating customer privacy consent settings and tracking consent metafields.\n\n> Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent) to be set to `true`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." + "description": "Enables setting and updating customer privacy consent settings and tracking consent metafields.\n\n> Note: Requires the [`collect_buyer_consent` capability](/docs/apps/build/customer-accounts/capabilities#collect-buyer-consent) to be set to `true`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -203075,7 +203075,7 @@ "syntaxKind": "PropertySignature", "name": "availablePaymentOptions", "value": "SubscribableSignalLike", - "description": "All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region." + "description": "All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n\nThe set of payment options can change when the buyer updates their address or cart, so subscribe to changes rather than reading once during initialization. Each option exposes `handle` and `type` only. Provider names, logos, fees, and installment terms aren't available." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -203112,7 +203112,7 @@ "syntaxKind": "PropertySignature", "name": "checkoutToken", "value": "SubscribableSignalLike", - "description": "A stable ID that represents the current checkout.\n\nThe value is `undefined` when the checkout hasn't been created on the server yet.\n\nUse this to correlate checkout sessions across your extension, web pixels, and backend systems.\n\nThis matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data) and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object)." + "description": "A stable ID that represents the current checkout.\n\nThe value is `undefined` when the checkout hasn't been created on the server yet.\n\nUse this to correlate checkout sessions across your extension, web pixels, and backend systems.\n\nThis matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data) and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n\nCan be `undefined`. Handle the `undefined` state before using the value." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -203133,7 +203133,7 @@ "syntaxKind": "PropertySignature", "name": "deliveryGroups", "value": "SubscribableSignalLike", - "description": "The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items." + "description": "The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n\nEmpty until the buyer enters enough address information for Shopify to calculate shipping rates." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -203154,7 +203154,7 @@ "syntaxKind": "PropertySignature", "name": "extension", "value": "Extension", - "description": "The meta information about the extension." + "description": "Metadata about the running extension, including the current target, API version, capabilities, and editor context. Use this to conditionally render content based on where the extension is running." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -203162,7 +203162,7 @@ "name": "extensionPoint", "value": "Target", "description": "The identifier that specifies where in Shopify's UI your code is being injected. This is one of the targets you've included in your extension's configuration file.", - "deprecationMessage": "Deprecated as of version `2023-07`, use `extension.target` instead.", + "deprecationMessage": "Use `extension.target` instead.", "examples": [ { "title": "Example", @@ -203181,14 +203181,14 @@ "syntaxKind": "PropertySignature", "name": "i18n", "value": "I18n", - "description": "Utilities for translating content and formatting values according to the current [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) of the checkout.\n\nRefer to [`localization` examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples) for more information." + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use alongside [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) to build fully localized extensions." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "instructions", "value": "SubscribableSignalLike", - "description": "The cart instructions used to create the checkout and possibly limit extension capabilities.\n\nThese instructions should be checked before performing any actions that might be affected by them.\n\nFor example, if you intend to add a discount code via the `applyDiscountCodeChange` method, check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n\n> Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs aren't available. See the [update guide](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples) for more information." + "description": "The cart instructions used to create the checkout and possibly limit extension capabilities.\n\nThese instructions should be checked before performing any actions that might be affected by them.\n\nFor example, if you intend to add a discount code via the `applyDiscountCodeChange` method, check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n\n> Caution: Check cart instructions before calling select APIs, as > some may not be available. See the > [Cart Instructions API](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples) > for more information." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -203202,7 +203202,7 @@ "syntaxKind": "PropertySignature", "name": "localization", "value": "Localization", - "description": "The details about the location, language, and currency of the customer. For utilities to easily format and translate content based on these details, you can use the [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n) object instead." + "description": "The buyer's language, country, currency, and timezone context. For formatting and translation helpers, use the [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#properties-propertydetail-i18n) object instead." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -203232,21 +203232,21 @@ "syntaxKind": "PropertySignature", "name": "query", "value": ">(query: string, options?: { variables?: Variables; version?: StorefrontApiVersion; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>", - "description": "The method used to query the Storefront GraphQL API with a prefetched token.\n\nRefer to [Storefront API access examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/storefront-api) for more information." + "description": "The method used to query the Storefront GraphQL API with a prefetched token." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "selectedPaymentOptions", "value": "SubscribableSignalLike", - "description": "The payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card)." + "description": "The payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\n\nEach option exposes `handle` and `type` only. Provider names, logos, fees, and installment terms aren't available." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "sessionToken", "value": "SessionToken", - "description": "The session token providing a set of claims as a signed JSON Web Token (JWT).\n\nThe token has a TTL of five minutes.\n\nIf the previous token expires, this value reflects a new session token with a new signature and expiry.\n\nRefer to [session token examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/session-token) for more information." + "description": "The session token providing a set of claims as a signed JSON Web Token (JWT).\n\nThe token has a TTL of five minutes.\n\nIf the previous token expires, this value reflects a new session token with a new signature and expiry.\n\nLearn more about [session tokens](/docs/apps/build/authentication-authorization/session-tokens)." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -203268,14 +203268,14 @@ "syntaxKind": "PropertySignature", "name": "shop", "value": "Shop", - "description": "The shop where the checkout is taking place." + "description": "The store where the checkout is taking place, including the shop name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "storage", "value": "Storage", - "description": "The key-value storage for the extension.\n\nIt uses `localStorage` and should persist across the customer's current checkout session.\n\n> Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n\nData is shared across all activated extension targets of this extension. In versions 2023-07 and earlier, each activated extension target had its own storage." + "description": "Key-value storage that persists across page loads within the current checkout session. Data is shared across all activated targets associated with this extension.\n\n> Caution: Data persistence isn't guaranteed and storage is cleared when the buyer starts a new checkout." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -203297,29 +203297,29 @@ ] } ], - "value": "export interface StandardApi {\n /**\n * The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event.\n */\n analytics: Analytics;\n\n /**\n * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\n */\n appliedGiftCards: SubscribableSignalLike;\n\n /**\n * The cart instructions used to create the checkout and possibly limit extension capabilities.\n *\n * These instructions should be checked before performing any actions that might be affected by them.\n *\n * For example, if you intend to add a discount code via the `applyDiscountCodeChange` method,\n * check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n *\n * > Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs aren't available.\n * See the [update guide](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples) for more information.\n *\n */\n instructions: SubscribableSignalLike;\n\n /**\n * The metafields requested in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration)\n * file. These metafields are updated when there's a change in the merchandise items\n * being purchased by the customer.\n *\n * App owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` isn't supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n appMetafields: SubscribableSignalLike;\n\n /**\n * The custom key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n buyerIdentity?: BuyerIdentity;\n\n /**\n * Provides details on the buyer's progression through the checkout and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/buyer-journey#examples)\n * examples for more information.\n */\n buyerJourney: BuyerJourney;\n\n /**\n * Settings applied to the buyer's checkout.\n */\n checkoutSettings: SubscribableSignalLike;\n\n /**\n * A stable ID that represents the current checkout.\n *\n * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\n *\n * This matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data)\n * and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n */\n checkoutToken: SubscribableSignalLike;\n\n /**\n * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * The meta information about the extension.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n *\n * @deprecated Deprecated as of version `2023-07`, use `extension.target` instead.\n */\n extensionPoint: Target;\n\n /**\n * Utilities for translating content and formatting values according to the current\n * [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization)\n * of the checkout.\n *\n * Refer to [`localization` examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples)\n * for more information.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The details about the location, language, and currency of the customer. For utilities to easily\n * format and translate content based on these details, you can use the\n * [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n)\n * object instead.\n */\n localization: Localization;\n\n /**\n * The metafields that apply to the current checkout.\n *\n * Metafields are stored locally on the client and are applied to the order object after the checkout completes.\n *\n * These metafields are shared by all extensions running on checkout, and\n * persist for as long as the customer is working on this checkout.\n *\n * Once the order is created, you can query these metafields using the\n * [GraphQL Admin API](/docs/admin-api/graphql/reference/orders/order#metafield-2021-01)\n *\n * > Caution:\n * `metafields` is deprecated. Use `appMetafields` with cart metafields instead.\n *\n * @deprecated Use `appMetafields` with cart metafields instead.\n */\n metafields: SubscribableSignalLike;\n\n /**\n * A note left by the customer to the merchant, either in their cart or during checkout.\n *\n * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\n */\n note: SubscribableSignalLike;\n\n /**\n * The method used to query the Storefront GraphQL API with a prefetched token.\n *\n * Refer to [Storefront API access examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/storefront-api) for more information.\n */\n query: >(\n query: string,\n options?: {variables?: Variables; version?: StorefrontApiVersion},\n ) => Promise<{data?: Data; errors?: GraphQLError[]}>;\n\n /**\n * The payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\n */\n selectedPaymentOptions: SubscribableSignalLike;\n\n /**\n * The session token providing a set of claims as a signed JSON Web Token (JWT).\n *\n * The token has a TTL of five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/session-token) for more information.\n */\n sessionToken: SessionToken;\n\n /**\n * The settings matching the settings definition written in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates in real time as a merchant fills in the settings.\n */\n settings: SubscribableSignalLike;\n\n /**\n * The proposed customer shipping address. During the information step, the address\n * updates when the field is committed (on change) rather than every keystroke.\n * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n shippingAddress?: SubscribableSignalLike;\n\n /**\n * The proposed customer billing address. The address updates when the field is\n * committed (on change) rather than every keystroke. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided yet.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n billingAddress?: SubscribableSignalLike;\n\n /** The shop where the checkout is taking place. */\n shop: Shop;\n\n /**\n * The key-value storage for the extension.\n *\n * It uses `localStorage` and should persist across the customer's current checkout session.\n *\n * > Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n *\n * Data is shared across all activated extension targets of this extension. In versions 2023-07 and earlier,\n * each activated extension target had its own storage.\n */\n storage: Storage;\n\n /**\n * The renderer version being used for the extension.\n *\n * @example '2025-10'\n */\n version: Version;\n\n /**\n * Customer privacy consent settings and a flag denoting if consent has previously been collected.\n */\n customerPrivacy: SubscribableSignalLike;\n\n /**\n * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent) to be set to `true`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyTrackingConsentChange: ApplyTrackingConsentChangeType;\n\n /**\n * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" + "value": "export interface StandardApi {\n /**\n * Tracks custom events and sends visitor information to\n * [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events\n * and `visitor()` to submit buyer contact details.\n */\n analytics: Analytics;\n\n /**\n * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\n */\n appliedGiftCards: SubscribableSignalLike;\n\n /**\n * The cart instructions used to create the checkout and possibly limit extension capabilities.\n *\n * These instructions should be checked before performing any actions that might be affected by them.\n *\n * For example, if you intend to add a discount code via the `applyDiscountCodeChange` method,\n * check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n *\n * > Caution: Check cart instructions before calling select APIs, as\n * > some may not be available. See the\n * > [Cart Instructions API](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples)\n * > for more information.\n *\n */\n instructions: SubscribableSignalLike;\n\n /**\n * The metafields requested in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration)\n * file. These metafields are updated when there's a change in the merchandise items\n * being purchased by the customer.\n *\n * App owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` isn't supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n appMetafields: SubscribableSignalLike;\n\n /**\n * The custom key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as\n * credit cards, wallets, and local payment methods. The list depends on\n * the shop's payment configuration and the buyer's region.\n *\n * The set of payment options can change when the buyer updates their\n * address or cart, so subscribe to changes rather than reading once\n * during initialization. Each option exposes `handle` and `type` only.\n * Provider names, logos, fees, and installment terms aren't available.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n buyerIdentity?: BuyerIdentity;\n\n /**\n * Provides details on the buyer's progression through the checkout and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/buyer-journey#examples)\n * examples for more information.\n */\n buyerJourney: BuyerJourney;\n\n /**\n * Settings applied to the buyer's checkout.\n */\n checkoutSettings: SubscribableSignalLike;\n\n /**\n * A stable ID that represents the current checkout.\n *\n * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\n *\n * This matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data)\n * and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n *\n * Can be `undefined`. Handle the `undefined` state before using the value.\n */\n checkoutToken: SubscribableSignalLike;\n\n /**\n * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n *\n * Empty until the buyer enters enough address information for Shopify to\n * calculate shipping rates.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * Metadata about the running extension, including the current target, API version,\n * capabilities, and editor context. Use this to conditionally render content\n * based on where the extension is running.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n *\n * @deprecated Use `extension.target` instead.\n */\n extensionPoint: Target;\n\n /**\n * Utilities for translating strings, formatting currencies, numbers, and dates\n * according to the buyer's locale. Use alongside\n * [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization)\n * to build fully localized extensions.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The buyer's language, country, currency, and timezone context. For\n * formatting and translation helpers, use the\n * [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#properties-propertydetail-i18n)\n * object instead.\n */\n localization: Localization;\n\n /**\n * The metafields that apply to the current checkout.\n *\n * Metafields are stored locally on the client and are applied to the order object after the checkout completes.\n *\n * These metafields are shared by all extensions running on checkout, and\n * persist for as long as the customer is working on this checkout.\n *\n * Once the order is created, you can query these metafields using the\n * [GraphQL Admin API](/docs/admin-api/graphql/reference/orders/order#metafield-2021-01)\n *\n * > Caution:\n * `metafields` is deprecated. Use `appMetafields` with cart metafields instead.\n *\n * @deprecated Use `appMetafields` with cart metafields instead.\n */\n metafields: SubscribableSignalLike;\n\n /**\n * A note left by the customer to the merchant, either in their cart or during checkout.\n *\n * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\n */\n note: SubscribableSignalLike;\n\n /**\n * The method used to query the Storefront GraphQL API with a prefetched token.\n *\n */\n query: >(\n query: string,\n options?: {variables?: Variables; version?: StorefrontApiVersion},\n ) => Promise<{data?: Data; errors?: GraphQLError[]}>;\n\n /**\n * The payment options the buyer has currently selected. This updates as\n * the buyer changes their payment method. The array can contain multiple\n * entries when the buyer splits payment across methods (for example, a\n * gift card and a credit card).\n *\n * Each option exposes `handle` and `type` only. Provider names, logos,\n * fees, and installment terms aren't available.\n */\n selectedPaymentOptions: SubscribableSignalLike;\n\n /**\n * The session token providing a set of claims as a signed JSON Web Token (JWT).\n *\n * The token has a TTL of five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Learn more about [session tokens](/docs/apps/build/authentication-authorization/session-tokens).\n */\n sessionToken: SessionToken;\n\n /**\n * The settings matching the settings definition written in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates in real time as a merchant fills in the settings.\n */\n settings: SubscribableSignalLike;\n\n /**\n * The proposed customer shipping address. During the information step, the address\n * updates when the field is committed (on change) rather than every keystroke.\n * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n shippingAddress?: SubscribableSignalLike;\n\n /**\n * The proposed customer billing address. The address updates when the field is\n * committed (on change) rather than every keystroke. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided yet.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n billingAddress?: SubscribableSignalLike;\n\n /**\n * The store where the checkout is taking place, including the shop name,\n * storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.\n */\n shop: Shop;\n\n /**\n * Key-value storage that persists across page loads within the current checkout\n * session. Data is shared across all activated targets associated with\n * this extension.\n *\n * > Caution: Data persistence isn't guaranteed and storage is cleared when the\n * buyer starts a new checkout.\n */\n storage: Storage;\n\n /**\n * The renderer version being used for the extension.\n *\n * @example '2025-10'\n */\n version: Version;\n\n /**\n * Customer privacy consent settings and a flag denoting if consent has previously been collected.\n */\n customerPrivacy: SubscribableSignalLike;\n\n /**\n * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`collect_buyer_consent` capability](/docs/apps/build/customer-accounts/capabilities#collect-buyer-consent) to be set to `true`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyTrackingConsentChange: ApplyTrackingConsentChangeType;\n\n /**\n * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" }, "Analytics": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Analytics", - "description": "", + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "publish", "value": "(name: string, data: Record) => Promise", - "description": "Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing)." + "description": "Publishes a custom event to [Web Pixels](/docs/apps/marketing). Returns `true` when the event is successfully dispatched.\n\nThe Promise resolves to `true` when the event was dispatched. The boolean indicates dispatch confirmation only. It doesn't indicate whether any specific web pixel processed the event." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "visitor", "value": "(data: { email?: string; phone?: string; }) => Promise", - "description": "A method for capturing details about a visitor on the online store." + "description": "Submits buyer contact details for attribution and analytics purposes." } ], - "value": "export interface Analytics {\n /**\n * Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing).\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * A method for capturing details about a visitor on the online store.\n */\n visitor(data: {email?: string; phone?: string}): Promise;\n}" + "value": "export interface Analytics {\n /**\n * Publishes a custom event to [Web Pixels](/docs/apps/marketing).\n * Returns `true` when the event is successfully dispatched.\n *\n * The Promise resolves to `true` when the event was dispatched. The boolean\n * indicates dispatch confirmation only. It doesn't indicate whether any\n * specific web pixel processed the event.\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * Submits buyer contact details for attribution and analytics purposes.\n */\n visitor(data: {email?: string; phone?: string}): Promise;\n}" }, "VisitorResult": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -203360,10 +203360,10 @@ "syntaxKind": "PropertySignature", "name": "type", "value": "'error'", - "description": "Indicates that the visitor information is invalid and wasn't submitted. Examples are using the wrong data type or missing a required property." + "description": "Indicates that the visitor information is invalid and wasn't submitted. Common causes include using the wrong data type or omitting a required property." } ], - "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Examples are using the wrong data type or missing a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Common causes include using the wrong data type or omitting a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" }, "SubscribableSignalLike": { "filePath": "src/surfaces/checkout/shared.ts", @@ -203577,10 +203577,10 @@ "syntaxKind": "PropertySignature", "name": "value", "value": "string | null", - "description": "The new value to store in the metafield. Set to `null` to delete the metafield." + "description": "The new value to store in the metafield. Set to `null` to delete the metafield.\n\nConsent metafield values are strings, not booleans. Pass `null` to delete a tracking consent metafield." } ], - "value": "export interface TrackingConsentMetafieldChange {\n /**\n * The identifier for the tracking consent metafield to update.\n */\n key: string;\n /**\n * The new value to store in the metafield. Set to `null` to delete the metafield.\n */\n value: string | null;\n}" + "value": "export interface TrackingConsentMetafieldChange {\n /**\n * The identifier for the tracking consent metafield to update.\n */\n key: string;\n /**\n * The new value to store in the metafield. Set to `null` to delete the metafield.\n *\n * Consent metafield values are strings, not booleans. Pass `null` to delete\n * a tracking consent metafield.\n */\n value: string | null;\n}" }, "VisitorConsent": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -203794,7 +203794,7 @@ "syntaxKind": "PropertySignature", "name": "value", "value": "string", - "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.", + "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.\n\nAttribute values are always strings. To store structured data, serialize it to JSON and parse it when reading.", "examples": [ { "title": "Example", @@ -203809,7 +203809,7 @@ ] } ], - "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" + "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * Attribute values are always strings. To store structured data, serialize\n * it to JSON and parse it when reading.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" }, "PaymentOption": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -204160,7 +204160,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A globally-unique identifier for the customer in the format `gid://shopify/Customer/`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", + "description": "An identifier for the customer in the format `gid://shopify/Customer/`. This value is unique per shop.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", "examples": [ { "title": "Example", @@ -204213,7 +204213,7 @@ "isPrivate": true } ], - "value": "export interface Customer {\n /**\n * A globally-unique identifier for the customer in the format `gid://shopify/Customer/`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'gid://shopify/Customer/123'\n */\n id: string;\n /**\n * The email address associated with the customer's account. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email?: string;\n /**\n * The phone number associated with the customer's account. The value is `undefined` if no phone number is on file or the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone?: string;\n /**\n * The customer's full name, typically a combination of first and last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n fullName?: string;\n /**\n * The customer's first name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n firstName?: string;\n /**\n * The customer's last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n lastName?: string;\n /**\n * The customer's profile image, such as a Gravatar avatar. Use this to personalize the extension UI for the logged-in buyer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n image: ImageDetails;\n /**\n * Whether the customer has opted in to receiving marketing communications from the merchant, such as email campaigns and promotional offers.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * > Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n *\n * @deprecated Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n */\n acceptsMarketing: boolean;\n /**\n * Whether the customer has opted in to email marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsEmailMarketing: boolean;\n /**\n * Whether the customer has opted in to SMS marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsSmsMarketing: boolean;\n /**\n * The store credit accounts owned by this customer that can be used as payment during checkout. Each account has a balance representing available store credit.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @private\n */\n storeCreditAccounts: StoreCreditAccount[];\n /**\n * The number of orders the customer has previously placed with this shop.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n ordersCount: number;\n}" + "value": "export interface Customer {\n /**\n * An identifier for the customer in the format `gid://shopify/Customer/`. This value is unique per shop.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'gid://shopify/Customer/123'\n */\n id: string;\n /**\n * The email address associated with the customer's account. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email?: string;\n /**\n * The phone number associated with the customer's account. The value is `undefined` if no phone number is on file or the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone?: string;\n /**\n * The customer's full name, typically a combination of first and last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n fullName?: string;\n /**\n * The customer's first name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n firstName?: string;\n /**\n * The customer's last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n lastName?: string;\n /**\n * The customer's profile image, such as a Gravatar avatar. Use this to personalize the extension UI for the logged-in buyer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n image: ImageDetails;\n /**\n * Whether the customer has opted in to receiving marketing communications from the merchant, such as email campaigns and promotional offers.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * > Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n *\n * @deprecated Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n */\n acceptsMarketing: boolean;\n /**\n * Whether the customer has opted in to email marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsEmailMarketing: boolean;\n /**\n * Whether the customer has opted in to SMS marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsSmsMarketing: boolean;\n /**\n * The store credit accounts owned by this customer that can be used as payment during checkout. Each account has a balance representing available store credit.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @private\n */\n storeCreditAccounts: StoreCreditAccount[];\n /**\n * The number of orders the customer has previously placed with this shop.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n ordersCount: number;\n}" }, "ImageDetails": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -204495,11 +204495,11 @@ "syntaxKind": "MethodSignature", "name": "perform", "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", + "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.\n\nRuns after all intercept results are collected. Use it for local state updates such as setting an error flag. By the time it runs, the navigation decision is final, so blocking logic belongs in the intercept handler itself, not here.", "isOptional": true } ], - "value": "interface InterceptorRequestAllow {\n /**\n * Indicates that the interceptor allows the buyer's journey to continue.\n */\n behavior: 'allow';\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" + "value": "interface InterceptorRequestAllow {\n /**\n * Indicates that the interceptor allows the buyer's journey to continue.\n */\n behavior: 'allow';\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n *\n * Runs after all intercept results are collected. Use it for local state\n * updates such as setting an error flag. By the time it runs, the navigation\n * decision is final, so blocking logic belongs in the intercept handler\n * itself, not here.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" }, "InterceptorResult": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -204563,7 +204563,7 @@ "syntaxKind": "MethodSignature", "name": "perform", "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", + "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.\n\nRuns after all intercept results are collected. Use it for local state updates such as setting an error flag. By the time it runs, the navigation decision is final, so blocking logic belongs in the intercept handler itself, not here.", "isOptional": true }, { @@ -204574,7 +204574,7 @@ "description": "The reason for blocking the interceptor request. This value isn't presented to the buyer, so it doesn't need to be localized. The value is used only for Shopify's own internal debugging and metrics." } ], - "value": "interface InterceptorRequestBlock {\n /**\n * Indicates that the interceptor blocks the buyer's journey from continuing.\n */\n behavior: 'block';\n\n /**\n * The reason for blocking the interceptor request. This value isn't presented to\n * the buyer, so it doesn't need to be localized. The value is used only for Shopify's\n * own internal debugging and metrics.\n */\n reason: string;\n\n /**\n * Used to pass errors to the checkout UI, outside your extension's UI boundaries.\n */\n errors?: ValidationError[];\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" + "value": "interface InterceptorRequestBlock {\n /**\n * Indicates that the interceptor blocks the buyer's journey from continuing.\n */\n behavior: 'block';\n\n /**\n * The reason for blocking the interceptor request. This value isn't presented to\n * the buyer, so it doesn't need to be localized. The value is used only for Shopify's\n * own internal debugging and metrics.\n */\n reason: string;\n\n /**\n * Used to pass errors to the checkout UI, outside your extension's UI boundaries.\n */\n errors?: ValidationError[];\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n *\n * Runs after all intercept results are collected. Use it for local state\n * updates such as setting an error flag. By the time it runs, the navigation\n * decision is final, so blocking logic belongs in the intercept handler\n * itself, not here.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" }, "ValidationError": { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -204795,17 +204795,17 @@ "syntaxKind": "PropertySignature", "name": "totalShippingAmount", "value": "SubscribableSignalLike", - "description": "The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step." + "description": "The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step.\n\n`undefined` until the buyer selects a shipping method (typically after the information step)." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "totalTaxAmount", "value": "SubscribableSignalLike", - "description": "The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet." + "description": "The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet.\n\n`undefined` when taxes haven't been calculated or aren't available for the buyer's region." } ], - "value": "export interface CartCost {\n /**\n * The sum of all line item prices at the current step of checkout, before shipping and taxes are applied. Use this value to display the base cost of the items the buyer purchased.\n */\n subtotalAmount: SubscribableSignalLike;\n\n /**\n * The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step.\n */\n totalShippingAmount: SubscribableSignalLike;\n\n /**\n * The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet.\n */\n totalTaxAmount: SubscribableSignalLike;\n\n /**\n * The minimum total at the current step of checkout. Costs not yet calculated, such as shipping on the information step, aren't included. Gift cards and store credits are excluded from this total.\n */\n totalAmount: SubscribableSignalLike;\n}" + "value": "export interface CartCost {\n /**\n * The sum of all line item prices at the current step of checkout, before shipping and taxes are applied. Use this value to display the base cost of the items the buyer purchased.\n */\n subtotalAmount: SubscribableSignalLike;\n\n /**\n * The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step.\n *\n * `undefined` until the buyer selects a shipping method (typically after the\n * information step).\n */\n totalShippingAmount: SubscribableSignalLike;\n\n /**\n * The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet.\n *\n * `undefined` when taxes haven't been calculated or aren't available for the\n * buyer's region.\n */\n totalTaxAmount: SubscribableSignalLike;\n\n /**\n * The minimum total at the current step of checkout. Costs not yet calculated, such as shipping on the information step, aren't included. Gift cards and store credits are excluded from this total.\n */\n totalAmount: SubscribableSignalLike;\n}" }, "CustomerPrivacy": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -204892,31 +204892,31 @@ "syntaxKind": "PropertySignature", "name": "analytics", "value": "boolean", - "description": "Whether analytics data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Analytics data includes how the shop was used and what interactions occurred." + "description": "Whether analytics data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Analytics data includes how the shop was used and what interactions occurred.\n\nWhether analytics data can be collected right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.analytics`, before calling `shopify.analytics.publish()`." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "marketing", "value": "boolean", - "description": "Whether marketing data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Marketing data includes attribution and targeted advertising preferences." + "description": "Whether marketing data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Marketing data includes attribution and targeted advertising preferences.\n\nWhether marketing data can be collected right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.marketing`, before performing marketing-related data collection." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "preferences", "value": "boolean", - "description": "Whether preference data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Preference data includes language, currency, and sizing choices." + "description": "Whether preference data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Preference data includes language, currency, and sizing choices.\n\nWhether preference data can be collected right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.preferences`, before storing or reading buyer preference data." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "saleOfData", "value": "boolean", - "description": "Whether data can be shared with third parties based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. This typically applies to behavioral advertising data." + "description": "Whether data can be shared with third parties based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. This typically applies to behavioral advertising data.\n\nWhether buyer data can be shared with or sold to third parties right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.saleOfData`, before sharing or selling buyer data with third parties." } ], - "value": "export interface AllowedProcessing {\n /**\n * Whether analytics data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Analytics\n * data includes how the shop was used and what interactions occurred.\n */\n analytics: boolean;\n /**\n * Whether marketing data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Marketing\n * data includes attribution and targeted advertising preferences.\n */\n marketing: boolean;\n /**\n * Whether preference data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Preference\n * data includes language, currency, and sizing choices.\n */\n preferences: boolean;\n /**\n * Whether data can be shared with third parties based on the visitor's\n * consent, the merchant's privacy configuration, and the visitor's region.\n * This typically applies to behavioral advertising data.\n */\n saleOfData: boolean;\n}" + "value": "export interface AllowedProcessing {\n /**\n * Whether analytics data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Analytics\n * data includes how the shop was used and what interactions occurred.\n *\n * Whether analytics data can be collected right now. Combines the buyer's\n * consent, the merchant's privacy configuration, and the buyer's region into\n * a single boolean. Check this flag, not `visitorConsent.analytics`, before\n * calling `shopify.analytics.publish()`.\n */\n analytics: boolean;\n /**\n * Whether marketing data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Marketing\n * data includes attribution and targeted advertising preferences.\n *\n * Whether marketing data can be collected right now. Combines the buyer's\n * consent, the merchant's privacy configuration, and the buyer's region into\n * a single boolean. Check this flag, not `visitorConsent.marketing`, before\n * performing marketing-related data collection.\n */\n marketing: boolean;\n /**\n * Whether preference data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Preference\n * data includes language, currency, and sizing choices.\n *\n * Whether preference data can be collected right now. Combines the buyer's\n * consent, the merchant's privacy configuration, and the buyer's region into\n * a single boolean. Check this flag, not `visitorConsent.preferences`,\n * before storing or reading buyer preference data.\n */\n preferences: boolean;\n /**\n * Whether data can be shared with third parties based on the visitor's\n * consent, the merchant's privacy configuration, and the visitor's region.\n * This typically applies to behavioral advertising data.\n *\n * Whether buyer data can be shared with or sold to third parties right now.\n * Combines the buyer's consent, the merchant's privacy configuration, and\n * the buyer's region into a single boolean. Check this flag, not\n * `visitorConsent.saleOfData`, before sharing or selling buyer data with\n * third parties.\n */\n saleOfData: boolean;\n}" }, "TrackingConsentMetafield": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -205608,7 +205608,7 @@ "Extension": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Extension", - "description": "The meta information about an extension target.", + "description": "Metadata about the running extension, including its API version, target, capabilities, and editor context. Use this to read configuration details or conditionally render content based on where the extension is running.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -205634,7 +205634,7 @@ "syntaxKind": "PropertySignature", "name": "capabilities", "value": "SubscribableSignalLike", - "description": "The allowed capabilities of the extension, defined in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n\n* [`api_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#api-access): the extension can access the Storefront API.\n\n* [`network_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access): the extension can make external network calls.\n\n* [`block_progress`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n\n* [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n\n* [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can register customer consent decisions that are honored on Shopify-managed services.\n\n* [`iframe.sources`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#iframe): the extension can embed an external URL in an iframe." + "description": "The allowed capabilities of the extension, defined in your [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -205682,7 +205682,7 @@ "syntaxKind": "PropertySignature", "name": "version", "value": "string", - "description": "The published version of the running extension target.\n\nFor unpublished extensions, the value is `undefined`.", + "description": "The published version of the running extension target.\n\nFor unpublished extensions, the value is `undefined`.\n\nDon't use this property as a stable identifier in development environments. It becomes available only after the extension is published.", "isOptional": true, "examples": [ { @@ -205698,7 +205698,7 @@ ] } ], - "value": "export interface Extension {\n /**\n * The API version that was set in the extension config file.\n *\n * @example '2024-10', '2025-01', '2025-04', '2025-07', '2025-10'\n */\n apiVersion: ApiVersion;\n\n /**\n * The allowed capabilities of the extension, defined\n * in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n *\n * * [`api_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#api-access): the extension can access the Storefront API.\n *\n * * [`network_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access): the extension can make external network calls.\n *\n * * [`block_progress`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n *\n * * [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n *\n * * [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can register customer consent decisions that are honored on Shopify-managed services.\n *\n * * [`iframe.sources`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#iframe): the extension can embed an external URL in an iframe.\n */\n capabilities: SubscribableSignalLike;\n\n /**\n * Information about the editor where the extension is being rendered.\n *\n * If the value is undefined, then the extension isn't running in an editor.\n */\n editor?: Editor;\n\n /**\n * A Boolean to show whether your extension is currently rendered to the screen.\n *\n * Shopify might render your extension before it's visible in the UI,\n * typically to pre-render extensions that appear on a later step of the\n * checkout.\n *\n * Your extension might also continue to run after the customer has navigated away\n * from where it was rendered. The extension continues running so that\n * your extension is immediately available to render if the customer navigates back.\n */\n rendered: SubscribableSignalLike;\n\n /**\n * The URL to the script that started the extension target.\n */\n scriptUrl: string;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n */\n target: Target;\n\n /**\n * The published version of the running extension target.\n *\n * For unpublished extensions, the value is `undefined`.\n *\n * @example 3.0.10\n */\n version?: string;\n}" + "value": "export interface Extension {\n /**\n * The API version that was set in the extension config file.\n *\n * @example '2024-10', '2025-01', '2025-04', '2025-07', '2025-10'\n */\n apiVersion: ApiVersion;\n\n /**\n * The allowed capabilities of the extension, defined in your\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n */\n capabilities: SubscribableSignalLike;\n\n /**\n * Information about the editor where the extension is being rendered.\n *\n * If the value is undefined, then the extension isn't running in an editor.\n */\n editor?: Editor;\n\n /**\n * A Boolean to show whether your extension is currently rendered to the screen.\n *\n * Shopify might render your extension before it's visible in the UI,\n * typically to pre-render extensions that appear on a later step of the\n * checkout.\n *\n * Your extension might also continue to run after the customer has navigated away\n * from where it was rendered. The extension continues running so that\n * your extension is immediately available to render if the customer navigates back.\n */\n rendered: SubscribableSignalLike;\n\n /**\n * The URL to the script that started the extension target.\n */\n scriptUrl: string;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n */\n target: Target;\n\n /**\n * The published version of the running extension target.\n *\n * For unpublished extensions, the value is `undefined`.\n *\n * Don't use this property as a stable identifier in development environments.\n * It becomes available only after the extension is published.\n *\n * @example 3.0.10\n */\n version?: string;\n}" }, "ApiVersion": { "filePath": "src/shared.ts", @@ -205717,7 +205717,7 @@ "Editor": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Editor", - "description": "", + "description": "Information about the editor environment when an extension is rendered inside the checkout editor. The value is `undefined` when the extension is not rendering in an editor.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -205732,7 +205732,7 @@ "I18n": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18n", - "description": "", + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use the I18n API alongside the Localization API to build fully localized extensions.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -205768,7 +205768,7 @@ "I18nTranslate": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18nTranslate", - "description": "This returns a translated string matching a key in a locale file.", + "description": "Translates a key from your extension's locale files into a localized string. Supports interpolation with placeholder replacements and pluralization via the special `count` option.", "members": [], "value": "export interface I18nTranslate {\n (\n key: string,\n options?: Record,\n ): ReplacementType extends string | number\n ? string\n : (string | ReplacementType)[];\n}" }, @@ -206332,14 +206332,14 @@ "Localization": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Localization", - "description": "", + "description": "The buyer's language, country, currency, and timezone context. Use this to adapt your extension to the buyer's region and display localized content.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "country", "value": "SubscribableSignalLike", - "description": "The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown." + "description": "The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n\nDerived from the buyer's shipping address. Returns `undefined` until the buyer enters a shipping address." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -206367,18 +206367,18 @@ "syntaxKind": "PropertySignature", "name": "market", "value": "SubscribableSignalLike", - "description": "The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n\n> Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.", - "deprecationMessage": "Deprecated as of version `2025-04`" + "description": "The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. The market context updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.", + "deprecationMessage": "Merchants now manage which extensions load for each\nmarket, so extensions no longer need to check this value." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "timezone", "value": "SubscribableSignalLike", - "description": "The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time." + "description": "The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time." } ], - "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n *\n * > Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" + "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n *\n * Derived from the buyer's shipping address. Returns `undefined` until the\n * buyer enters a shipping address.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout,\n * carried over from the cart context. Markets group countries and\n * regions with shared pricing, languages, and domains. The market\n * context updates when the buyer changes the country of their\n * shipping address. The value is `undefined` if the market is unknown.\n *\n * @deprecated Merchants now manage which extensions load for each\n * market, so extensions no longer need to check this value.\n */\n market: SubscribableSignalLike;\n}" }, "Country": { "filePath": "src/shared.ts", @@ -206579,7 +206579,7 @@ "SessionToken": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SessionToken", - "description": "", + "description": "Authenticates requests between your extension and your app backend. Use session tokens to verify the identity of the buyer and the shop context when making server-side API calls. The token is a signed JWT that contains claims such as the customer ID, shop domain, and expiration.\n\nThe `sub` claim in the decoded token is present only when the buyer is logged in and the app has permission to read customer accounts. Absent for anonymous buyers.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -206838,7 +206838,7 @@ "Shop": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Shop", - "description": "", + "description": "Metadata about the merchant's store, including its name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -206878,30 +206878,30 @@ "syntaxKind": "PropertySignature", "name": "storefrontUrl", "value": "string", - "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n\n> Caution: > As of version `2024-04` this value no longer has a trailing slash.", + "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.", "isOptional": true } ], - "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n *\n * > Caution:\n * > As of version `2024-04` this value no longer has a trailing slash.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom domain.\n */\n myshopifyDomain: string;\n}" + "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom domain.\n */\n myshopifyDomain: string;\n}" }, "Storage": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Storage", - "description": "A key-value storage object for the extension.\n\nStored data is available only to this specific extension and any of its instances.\n\nThe storage backend is implemented with `localStorage` and should persist across the buyer's checkout session. However, data persistence isn't guaranteed.", + "description": "Key-value storage for a specific extension. Use storage to save preferences or cached data that should survive page reloads without requiring a backend call. Stored data is only available to this specific extension. The storage backend is implemented with `localStorage` and data persistence isn't guaranteed.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "delete", "value": "(key: string) => Promise", - "description": "Delete stored data by key." + "description": "Deletes a previously stored value by key." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "read", "value": "(key: string) => Promise", - "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original primitive.\n\nReturns `null` if no stored data exists." + "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original type.\n\nReturns the stored value for the given key, or `null` when no value exists. Doesn't throw on a missing key." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -206911,7 +206911,7 @@ "description": "Write stored data for this key.\n\nThe data must be serializable to JSON." } ], - "value": "export interface Storage {\n /**\n * Read and return a stored value by key.\n *\n * The stored data is deserialized from JSON and returned as\n * its original primitive.\n *\n * Returns `null` if no stored data exists.\n */\n read(key: string): Promise;\n\n /**\n * Write stored data for this key.\n *\n * The data must be serializable to JSON.\n */\n write(key: string, data: any): Promise;\n\n /**\n * Delete stored data by key.\n */\n delete(key: string): Promise;\n}" + "value": "export interface Storage {\n /**\n * Read and return a stored value by key.\n *\n * The stored data is deserialized from JSON and returned as\n * its original type.\n *\n * Returns the stored value for the given key, or `null` when no value\n * exists. Doesn't throw on a missing key.\n */\n read(key: string): Promise;\n\n /**\n * Write stored data for this key.\n *\n * The data must be serializable to JSON.\n */\n write(key: string, data: any): Promise;\n\n /**\n * Deletes a previously stored value by key.\n */\n delete(key: string): Promise;\n}" }, "Version": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -206947,7 +206947,7 @@ "AbbreviationElementProps": { "filePath": "src/surfaces/checkout/components/Abbreviation.ts", "name": "AbbreviationElementProps", - "description": "Displays abbreviated text or acronyms, revealing their full meaning or additional context through a tooltip on hover or focus. Use to clarify shortened terms, initialisms, or technical language without interrupting the reading flow.", + "description": "", "isPublicDocs": true, "members": [ { @@ -206955,7 +206955,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -206963,7 +206963,7 @@ "syntaxKind": "PropertySignature", "name": "title", "value": "string", - "description": "Defines the full expansion of the abbreviation or acronym.\n\nHelps user agents and users understand the meaning of the abbreviated text.", + "description": "Defines the full expansion of the abbreviation or acronym, helping user agents and users understand the meaning of the abbreviated text. Learn more about the [abbreviation element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/abbr).", "isOptional": true, "defaultValue": "''" } @@ -207006,7 +207006,7 @@ "AnnouncementElementEvents": { "filePath": "src/surfaces/checkout/components/Announcement.ts", "name": "AnnouncementElementEvents", - "description": "Learn more about [registering events](/docs/api/checkout-ui-extensions/latest/using-polaris-components#event-handling).", + "description": "", "isPublicDocs": true, "members": [ { @@ -207014,7 +207014,7 @@ "syntaxKind": "PropertySignature", "name": "aftertoggle", "value": "CallbackEventListener", - "description": "Callback fired when the element state changes **after** any animations have finished.\n\n- If the element transitioned from hidden to showing, the `oldState` property will be set to `closed` and the `newState` property will be set to `open`.\n- If the element transitioned from showing to hidden, the `oldState` property will be set to `open` and the `newState` will be `closed`.", + "description": "A callback that fires when the element state changes, after any toggle animations have finished.\n\n- If the element transitioned from hidden to showing, the `oldState` property will be set to `closed` and the `newState` property will be set to `open`.\n- If the element transitioned from showing to hidden, the `oldState` property will be set to `open` and the `newState` will be `closed`.\n\nLearn more about [`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).", "isOptional": true }, { @@ -207022,7 +207022,7 @@ "syntaxKind": "PropertySignature", "name": "dismiss", "value": "CallbackEventListener", - "description": "Callback fired when the announcement is dismissed by the user (either via the built-in dismiss button or programmatically).", + "description": "A callback that fires when the announcement is dismissed by the user clicking the close button or by calling the `dismiss()` method programmatically.", "isOptional": true }, { @@ -207030,11 +207030,11 @@ "syntaxKind": "PropertySignature", "name": "toggle", "value": "CallbackEventListener", - "description": "Callback straight after the element state changes.\n\n- If the element is transitioning from hidden to showing, the `oldState` property will be set to `closed` and the `newState` property will be set to `open`.\n- If the element is transitioning from showing to hidden, then `oldState` property will be set to `open` and the `newState` will be `closed`.", + "description": "A callback that fires immediately when the element state changes, before any animations.\n\n- If the element is transitioning from hidden to showing, the `oldState` property will be set to `closed` and the `newState` property will be set to `open`.\n- If the element is transitioning from showing to hidden, then the `oldState` property will be set to `open` and the `newState` will be `closed`.\n\nLearn more about the [`toggle` event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/toggle_event), [`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).", "isOptional": true } ], - "value": "export interface AnnouncementElementEvents {\n /**\n * Callback fired when the element state changes **after** any animations have finished.\n *\n * - If the element transitioned from hidden to showing, the `oldState` property will be set to `closed` and the\n * `newState` property will be set to `open`.\n * - If the element transitioned from showing to hidden, the `oldState` property will be set to `open` and the\n * `newState` will be `closed`.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/newState\n * @see https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/oldState\n */\n aftertoggle?: CallbackEventListener;\n /**\n * Callback fired when the announcement is dismissed by the user\n * (either via the built-in dismiss button or programmatically).\n */\n dismiss?: CallbackEventListener;\n /**\n * Callback straight after the element state changes.\n *\n * - If the element is transitioning from hidden to showing, the `oldState` property will be set to `closed` and the\n * `newState` property will be set to `open`.\n * - If the element is transitioning from showing to hidden, then `oldState` property will be set to `open` and the\n * `newState` will be `closed`.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/toggle_event\n * @see https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/newState\n * @see https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/oldState\n */\n toggle?: CallbackEventListener;\n}" + "value": "export interface AnnouncementElementEvents {\n /**\n * A callback that fires when the element state changes, after any toggle animations have finished.\n *\n * - If the element transitioned from hidden to showing, the `oldState` property will be set to `closed` and the\n * `newState` property will be set to `open`.\n * - If the element transitioned from showing to hidden, the `oldState` property will be set to `open` and the\n * `newState` will be `closed`.\n *\n * Learn more about [`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).\n */\n aftertoggle?: CallbackEventListener;\n /**\n * A callback that fires when the announcement is dismissed by the user clicking the close button or by calling the `dismiss()` method programmatically.\n */\n dismiss?: CallbackEventListener;\n /**\n * A callback that fires immediately when the element state changes, before any animations.\n *\n * - If the element is transitioning from hidden to showing, the `oldState` property will be set to `closed` and the\n * `newState` property will be set to `open`.\n * - If the element is transitioning from showing to hidden, then the `oldState` property will be set to `open` and the\n * `newState` will be `closed`.\n *\n * Learn more about the [`toggle` event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/toggle_event), [`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).\n */\n toggle?: CallbackEventListener;\n}" }, "CallbackEventListener": { "filePath": "src/surfaces/checkout/components/Announcement.ts", @@ -207055,15 +207055,14 @@ "ToggleArgumentsEvent": { "filePath": "src/surfaces/checkout/components/Announcement.ts", "name": "ToggleArgumentsEvent", - "description": "", - "isPublicDocs": true, + "description": "The event data provided to toggle-related callbacks. Contains the previous and next visibility states of the element.", "members": [ { "filePath": "src/surfaces/checkout/components/Announcement.ts", "syntaxKind": "PropertySignature", "name": "newState", "value": "ToggleState", - "description": "", + "description": "The visibility state of the element after the toggle occurred.", "isOptional": true }, { @@ -207071,19 +207070,18 @@ "syntaxKind": "PropertySignature", "name": "oldState", "value": "ToggleState", - "description": "", + "description": "The visibility state of the element before the toggle occurred.", "isOptional": true } ], - "value": "export interface ToggleArgumentsEvent {\n oldState?: ToggleState;\n newState?: ToggleState;\n}" + "value": "export interface ToggleArgumentsEvent {\n /**\n * The visibility state of the element before the toggle occurred.\n */\n oldState?: ToggleState;\n /**\n * The visibility state of the element after the toggle occurred.\n */\n newState?: ToggleState;\n}" }, "ToggleState": { "filePath": "src/surfaces/checkout/components/Announcement.ts", "syntaxKind": "TypeAliasDeclaration", "name": "ToggleState", "value": "'open' | 'closed'", - "description": "", - "isPublicDocs": true + "description": "The visibility state of a toggleable element.\n\n- `open`: The element is visible and showing its content.\n- `closed`: The element is hidden and its content is not visible." } } }, @@ -207095,7 +207093,7 @@ "AnnouncementElementMethods": { "filePath": "src/surfaces/checkout/components/Announcement.ts", "name": "AnnouncementElementMethods", - "description": "Learn more about [component methods](/docs/api/checkout-ui-extensions/latest/using-polaris-components#methods).", + "description": "", "isPublicDocs": true, "members": [ { @@ -207103,10 +207101,10 @@ "syntaxKind": "PropertySignature", "name": "dismiss", "value": "() => void", - "description": "" + "description": "Programmatically dismisses the announcement. This triggers the `dismiss` event callback." } ], - "value": "export interface AnnouncementElementMethods {\n dismiss: AnnouncementMethods['dismiss'];\n}" + "value": "export interface AnnouncementElementMethods {\n /**\n * Programmatically dismisses the announcement. This triggers the `dismiss` event callback.\n */\n dismiss: AnnouncementMethods['dismiss'];\n}" } } } @@ -207151,7 +207149,7 @@ "BadgeElementProps": { "filePath": "src/surfaces/checkout/components/Badge.ts", "name": "BadgeElementProps", - "description": "Properties for the Badge component element.", + "description": "", "isPublicDocs": true, "members": [ { @@ -207159,7 +207157,7 @@ "syntaxKind": "PropertySignature", "name": "color", "value": "'base' | 'subdued'", - "description": "Modify the color to be more or less intense.", + "description": "Controls the visual weight and emphasis of the badge.\n\n- `base`: Standard weight with moderate emphasis, suitable for most use cases.\n- `subdued`: Reduced visual weight for less prominent or secondary badges.", "isOptional": true, "defaultValue": "'base'" }, @@ -207168,7 +207166,7 @@ "syntaxKind": "PropertySignature", "name": "icon", "value": "'' | ReducedIconTypes", - "description": "The type of icon to be displayed in the badge.", + "description": "An icon displayed inside the badge to provide additional visual context or reinforce the badge's meaning. Set to an empty string to display no icon.", "isOptional": true, "defaultValue": "''" }, @@ -207177,7 +207175,7 @@ "syntaxKind": "PropertySignature", "name": "iconPosition", "value": "'start' | 'end'", - "description": "The position of the icon in relation to the text.", + "description": "The position of the icon relative to the badge text.\n\n- `start`: Places the icon before the text.\n- `end`: Places the icon after the text.", "isOptional": true }, { @@ -207185,7 +207183,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -207193,7 +207191,7 @@ "syntaxKind": "PropertySignature", "name": "size", "value": "'small' | 'base' | 'small-100'", - "description": "Adjusts the size.", + "description": "The size of the badge.\n\n- `base`: The default size, suitable for most use cases.\n- `small`: A smaller badge for compact layouts.\n- `small-100`: The smallest badge for tight spaces or dense lists.", "isOptional": true, "defaultValue": "'base'" }, @@ -207202,19 +207200,19 @@ "syntaxKind": "PropertySignature", "name": "tone", "value": "'auto' | 'neutral' | 'critical'", - "description": "Sets the tone of the Badge, based on the intention of the information being conveyed.", + "description": "The semantic meaning and color treatment of the badge.\n\n- `auto`: Automatically determined based on context.\n- `neutral`: General information without specific intent.\n- `critical`: Urgent problems or destructive actions.", "isOptional": true, "defaultValue": "'auto'" } ], - "value": "export interface BadgeElementProps extends Pick {\n size?: Extract;\n tone?: Extract;\n color?: Extract;\n icon?: '' | ReducedIconTypes;\n}" + "value": "export interface BadgeElementProps extends Pick {\n /**\n * The size of the badge.\n *\n * - `base`: The default size, suitable for most use cases.\n * - `small`: A smaller badge for compact layouts.\n * - `small-100`: The smallest badge for tight spaces or dense lists.\n *\n * @default 'base'\n */\n size?: Extract;\n /**\n * The semantic meaning and color treatment of the badge.\n *\n * - `auto`: Automatically determined based on context.\n * - `neutral`: General information without specific intent.\n * - `critical`: Urgent problems or destructive actions.\n *\n * @default 'auto'\n */\n tone?: Extract;\n /**\n * Controls the visual weight and emphasis of the badge.\n *\n * - `base`: Standard weight with moderate emphasis, suitable for most use cases.\n * - `subdued`: Reduced visual weight for less prominent or secondary badges.\n *\n * @default 'base'\n */\n color?: Extract;\n /**\n * An icon displayed inside the badge to provide additional visual context or reinforce the badge's meaning. Set to an empty string to display no icon.\n *\n * @default ''\n */\n icon?: '' | ReducedIconTypes;\n /**\n * The position of the icon relative to the badge text.\n *\n * - `start`: Places the icon before the text.\n * - `end`: Places the icon after the text.\n */\n iconPosition?: BadgeProps$1['iconPosition'];\n}" }, "ReducedIconTypes": { "filePath": "src/surfaces/checkout/components/Badge.ts", "syntaxKind": "TypeAliasDeclaration", "name": "ReducedIconTypes", "value": "'cart' | 'note' | 'settings' | 'reset' | 'map' | 'menu' | 'search' | 'circle' | 'filter' | 'image' | 'alert-circle' | 'alert-triangle-filled' | 'alert-triangle' | 'arrow-down' | 'arrow-left' | 'arrow-right' | 'arrow-up-right' | 'arrow-up' | 'bag' | 'bullet' | 'calendar' | 'camera' | 'caret-down' | 'cash-dollar' | 'categories' | 'check-circle' | 'check-circle-filled' | 'check' | 'chevron-down' | 'chevron-left' | 'chevron-right' | 'chevron-up' | 'clipboard' | 'clock' | 'credit-card' | 'delete' | 'delivered' | 'delivery' | 'disabled' | 'discount' | 'edit' | 'email' | 'empty' | 'external' | 'geolocation' | 'gift-card' | 'globe' | 'grid' | 'info-filled' | 'info' | 'list-bulleted' | 'location' | 'lock' | 'menu-horizontal' | 'menu-vertical' | 'minus' | 'mobile' | 'order' | 'organization' | 'plus' | 'profile' | 'question-circle-filled' | 'question-circle' | 'reorder' | 'return' | 'savings' | 'star-filled' | 'star-half' | 'star' | 'store' | 'truck' | 'upload' | 'x-circle-filled' | 'x-circle' | 'x'", - "description": "", + "description": "The subset of icon types available in checkout and customer account surfaces. This is a narrowed set from the full Shopify icon library, containing only the icons supported in these contexts.", "isPublicDocs": true } } @@ -207253,7 +207251,7 @@ "BannerElementProps": { "filePath": "src/surfaces/checkout/components/Banner.ts", "name": "BannerElementProps", - "description": "The banner component highlights important information or required actions prominently within the interface. Use banner to communicate statuses, provide feedback, draw attention to critical updates, or guide users toward necessary actions.\n\nBanners support multiple tones to convey urgency levels, optional actions for next steps, and can be positioned contextually within sections or page-wide at the top. For inline status indicators on individual items, use [badge](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/feedback-and-status-indicators/badge).", + "description": "", "isPublicDocs": true, "members": [ { @@ -207261,7 +207259,7 @@ "syntaxKind": "PropertySignature", "name": "collapsible", "value": "boolean", - "description": "Makes the content collapsible. A collapsible banner will conceal child elements initially, but allow the user to expand the banner to see them.", + "description": "Whether the banner content can be collapsed and expanded by the user. A collapsible banner conceals child elements initially, allowing the user to expand the banner to reveal them.", "isOptional": true, "defaultValue": "false" }, @@ -207270,7 +207268,7 @@ "syntaxKind": "PropertySignature", "name": "dismissible", "value": "boolean", - "description": "Determines whether the close button of the banner is present.\n\nWhen the close button is pressed, the `dismiss` event will fire, then `hidden` will be true, any animation will complete, and the `afterhide` event will fire.", + "description": "Whether the banner displays a close button that allows users to dismiss it.\n\nWhen the close button is pressed, the `dismiss` event will fire, then `hidden` will be set to `true`, any animation will complete, and the `afterhide` event will fire.", "isOptional": true, "defaultValue": "false" }, @@ -207279,7 +207277,7 @@ "syntaxKind": "PropertySignature", "name": "heading", "value": "string", - "description": "The title of the banner.", + "description": "The heading text displayed at the top of the banner to summarize the message or alert.", "isOptional": true, "defaultValue": "''" }, @@ -207288,7 +207286,7 @@ "syntaxKind": "PropertySignature", "name": "hidden", "value": "boolean", - "description": "Determines whether the banner is hidden.\n\nIf this property is being set on each framework render (as in 'controlled' usage), and the banner is `dismissible`, ensure you update app state for this property when the `dismiss` event fires.\n\nIf the banner is not `dismissible`, it can still be hidden by setting this property.", + "description": "Controls whether the banner is visible or hidden.\n\nWhen using a controlled component pattern and the banner is `dismissible`, update this property to `true` when the `dismiss` event fires.\n\nYou can hide the banner programmatically by setting this to `true` even if it's not `dismissible`.", "isOptional": true, "defaultValue": "false" }, @@ -207297,7 +207295,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -207305,12 +207303,12 @@ "syntaxKind": "PropertySignature", "name": "tone", "value": "'success' | 'info' | 'auto' | 'warning' | 'critical'", - "description": "Sets the tone of the Banner, based on the intention of the information being conveyed.\n\nThe banner is a live region and the type of status will be dictated by the Tone selected.\n\n- `critical` creates an [assertive live region](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/alert_role) that is announced by screen readers immediately.\n- `neutral`, `info`, `success`, `warning` and `caution` creates an [informative live region](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/status_role) that is announced by screen readers after the current message.", + "description": "The semantic meaning and color treatment of the component. The banner is a live region and the type of status is dictated by the tone selected.\n\n- `info`: Informational content or helpful tips.\n- `auto`: Automatically determined based on context.\n- `success`: Positive outcomes or successful states.\n- `warning`: Important warnings about potential issues.\n- `critical`: Urgent problems or destructive actions.\n\nThe `critical` tone creates an [assertive live region](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/alert_role) that is announced by screen readers immediately. The `info`, `success`, and `warning` tones create an [informative live region](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/status_role) that is announced by screen readers after the current message.", "isOptional": true, "defaultValue": "'auto'" } ], - "value": "export interface BannerElementProps extends Pick {\n tone?: Extract;\n}" + "value": "export interface BannerElementProps extends Pick {\n /**\n * Whether the banner content can be collapsed and expanded by the user. A collapsible banner conceals child elements initially, allowing the user to expand the banner to reveal them.\n *\n * @default false\n */\n collapsible?: BannerProps$1['collapsible'];\n /**\n * Whether the banner displays a close button that allows users to dismiss it.\n *\n * When the close button is pressed, the `dismiss` event will fire,\n * then `hidden` will be set to `true`,\n * any animation will complete,\n * and the `afterhide` event will fire.\n *\n * @default false\n */\n dismissible?: BannerProps$1['dismissible'];\n /**\n * The heading text displayed at the top of the banner to summarize the message or alert.\n *\n * @default ''\n */\n heading?: BannerProps$1['heading'];\n /**\n * Controls whether the banner is visible or hidden.\n *\n * When using a controlled component pattern and the banner is `dismissible`,\n * update this property to `true` when the `dismiss` event fires.\n *\n * You can hide the banner programmatically by setting this to `true` even if it's not `dismissible`.\n *\n * @default false\n */\n hidden?: BannerProps$1['hidden'];\n /**\n * The semantic meaning and color treatment of the component. The banner is a live region and the type of status is dictated by the tone selected.\n *\n * - `info`: Informational content or helpful tips.\n * - `auto`: Automatically determined based on context.\n * - `success`: Positive outcomes or successful states.\n * - `warning`: Important warnings about potential issues.\n * - `critical`: Urgent problems or destructive actions.\n *\n * The `critical` tone creates an [assertive live region](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/alert_role) that is announced by screen readers immediately. The `info`, `success`, and `warning` tones create an [informative live region](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/status_role) that is announced by screen readers after the current message.\n *\n * @default 'auto'\n */\n tone?: Extract;\n}" } } }, @@ -207322,7 +207320,7 @@ "BannerElementEvents": { "filePath": "src/surfaces/checkout/components/Banner.ts", "name": "BannerElementEvents", - "description": "Learn more about [registering events](/docs/api/checkout-ui-extensions/latest/using-polaris-components#event-handling).", + "description": "", "isPublicDocs": true, "members": [ { @@ -207330,7 +207328,7 @@ "syntaxKind": "PropertySignature", "name": "afterhide", "value": "CallbackEventListener", - "description": "Event handler when the banner has fully hidden.\n\nThe `hidden` property will be `true` when this event fires.", + "description": "A callback that fires when the banner has fully hidden, including after any hide animations have completed.\n\nThe `hidden` property is `true` when this event fires.", "isOptional": true }, { @@ -207338,11 +207336,11 @@ "syntaxKind": "PropertySignature", "name": "dismiss", "value": "CallbackEventListener", - "description": "Event handler when the banner is dismissed by the user.\n\nThis does not fire when setting `hidden` manually.\n\nThe `hidden` property will be `false` when this event fires.", + "description": "A callback that fires when the banner is dismissed by the user clicking the close button.\n\nThis doesn't fire when setting `hidden` manually.\n\nThe `hidden` property is `false` when this event fires.", "isOptional": true } ], - "value": "export interface BannerElementEvents {\n /**\n * Event handler when the banner has fully hidden.\n *\n * The `hidden` property will be `true` when this event fires.\n *\n * @implementation If implementations animate the hiding of the banner,\n * this event must fire after the banner has fully hidden.\n * We can add an `onHide` event in future if we want to provide a hook for the start of the animation.\n */\n afterhide?: CallbackEventListener;\n /**\n * Event handler when the banner is dismissed by the user.\n *\n * This does not fire when setting `hidden` manually.\n *\n * The `hidden` property will be `false` when this event fires.\n */\n dismiss?: CallbackEventListener;\n}" + "value": "export interface BannerElementEvents {\n /**\n * A callback that fires when the banner has fully hidden, including after any hide animations have completed.\n *\n * The `hidden` property is `true` when this event fires.\n */\n afterhide?: CallbackEventListener;\n /**\n * A callback that fires when the banner is dismissed by the user clicking the close button.\n *\n * This doesn't fire when setting `hidden` manually.\n *\n * The `hidden` property is `false` when this event fires.\n */\n dismiss?: CallbackEventListener;\n}" }, "CallbackEventListener": { "filePath": "src/surfaces/checkout/components/Banner.ts", @@ -207403,7 +207401,7 @@ "BoxElementProps": { "filePath": "src/surfaces/checkout/components/Box.ts", "name": "BoxElementProps", - "description": "The box component provides a generic, flexible container for custom designs and layouts. Use box to apply styling like backgrounds, padding, borders, or border radius when existing components don't meet your needs, or to nest and group other components.\n\nBox contents maintain their natural size, making it especially useful within layout components that would otherwise stretch their children. For structured layouts, use [stack](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/layout-and-structure/stack) or [grid](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/layout-and-structure/grid).", + "description": "", "isPublicDocs": true, "members": [ { @@ -207428,7 +207426,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityVisibility", "value": "'visible' | 'hidden' | 'exclusive'", - "description": "Changes the visibility of the element.\n\n- `visible`: the element is visible to all users.\n- `hidden`: the element is removed from the accessibility tree but remains visible.\n- `exclusive`: the element is visually hidden but remains in the accessibility tree.", + "description": "Controls how the element is exposed to sighted users and to assistive technologies such as screen readers.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", "isOptional": true, "defaultValue": "'visible'" }, @@ -207437,7 +207435,7 @@ "syntaxKind": "PropertySignature", "name": "background", "value": "'base' | 'subdued' | 'transparent'", - "description": "Adjust the background of the element.", + "description": "The background color of the box.\n\n- `base`: The standard background color for general content areas.\n- `subdued`: A muted background for secondary or supporting content.\n- `transparent`: No background color (the default).", "isOptional": true, "defaultValue": "'transparent'" }, @@ -207455,9 +207453,9 @@ "syntaxKind": "PropertySignature", "name": "border", "value": "BorderShorthand", - "description": "Applies a border using shorthand syntax to specify width, color, and style in a single property.\n\nAccepts a size value, optionally followed by a color, optionally followed by a style. Omitted values use defaults: color defaults to `base`, style defaults to `auto`.\n\nIndividual properties (`borderWidth`, `borderStyle`, `borderColor`) can override values set here.", + "description": "A shorthand for setting the border width, color, and style in a single property. Individual border properties (`borderWidth`, `borderStyle`) can override values set here.", "isOptional": true, - "defaultValue": "'none' - equivalent to `none base auto`.", + "defaultValue": "'none'", "examples": [ { "title": "Example", @@ -207476,7 +207474,7 @@ "syntaxKind": "PropertySignature", "name": "borderRadius", "value": "MaybeAllValuesShorthandProperty>", - "description": "Controls the roundedness of the element's corners using the design system's radius scale.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) using flow-relative values:\n- One value: applies to all corners\n- Two values: applies to start corners (top-left & bottom-right) and end corners (top-right & bottom-left) respectively\n- Three values: applies to start-start (top-left), end corners (top-right & bottom-left), and end-end (bottom-right) respectively\n- Four values: applies to start-start (top-left), start-end (top-right), end-end (bottom-right), and end-start (bottom-left) respectively\n\nExamples:\n- `small-100`: All corners have `small-100` radius\n- `small-100 none`: Top-left and bottom-right are `small-100`, top-right and bottom-left are `none`\n- `small-100 none large-100`: Top-left is `small-100`, top-right and bottom-left are `none`, bottom-right is `large-100`\n- `small-100 none large-100 base`: Each corner has its specified radius value", + "description": "The roundedness of the box's corners.\n\n- `none`: Sharp corners with no rounding.\n- `small-100` / `small`: Subtle rounding for compact elements.\n- `base`: Standard rounding for most use cases.\n- `large` / `large-100`: More pronounced rounding for prominent containers.\n- `max`: Maximum rounding, creating a pill or circular shape.\n\nSupports 1-to-4-value shorthand syntax for specifying different radii per corner.", "isOptional": true, "defaultValue": "'none'" }, @@ -207494,7 +207492,7 @@ "syntaxKind": "PropertySignature", "name": "borderWidth", "value": "MaybeAllValuesShorthandProperty | ''", - "description": "Controls the thickness of the border on all sides. When set, this overrides the width value specified in the `border` property.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) for specifying different widths per side:\n- One value: applies to all sides\n- Two values: applies to block sides (top/bottom) and inline sides (left/right) respectively\n- Three values: applies to block-start (top), inline sides (left/right), and block-end (bottom) respectively\n- Four values: applies to block-start (top), inline-end (right), block-end (bottom), and inline-start (left) respectively", + "description": "The thickness of the border on all sides. Supports 1-to-4-value shorthand syntax for specifying different widths per side. Overrides the width value set by `border`.", "isOptional": true, "defaultValue": "'' - meaning no override" }, @@ -207503,7 +207501,7 @@ "syntaxKind": "PropertySignature", "name": "display", "value": "MaybeResponsive<\"auto\" | \"none\">", - "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.", + "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.\n\nLearn more about the [display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display).", "isOptional": true, "defaultValue": "'auto'" }, @@ -207512,7 +207510,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -207633,14 +207631,14 @@ "defaultValue": "'' - meaning no override" } ], - "value": "export interface BoxElementProps extends Pick {\n background?: Extract;\n border?: BorderShorthand;\n borderWidth?: MaybeAllValuesShorthandProperty | '';\n borderRadius?: MaybeAllValuesShorthandProperty>;\n}" + "value": "export interface BoxElementProps extends Pick {\n /**\n * The background color of the box.\n *\n * - `base`: The standard background color for general content areas.\n * - `subdued`: A muted background for secondary or supporting content.\n * - `transparent`: No background color (the default).\n *\n * @default 'transparent'\n */\n background?: Extract;\n /**\n * A shorthand for setting the border width, color, and style in a single property. Individual border properties (`borderWidth`, `borderStyle`) can override values set here.\n *\n * @default 'none'\n */\n border?: BorderShorthand;\n /**\n * The thickness of the border on all sides. Supports 1-to-4-value shorthand syntax for specifying different widths per side. Overrides the width value set by `border`.\n *\n * @default '' - meaning no override\n */\n borderWidth?: MaybeAllValuesShorthandProperty | '';\n /**\n * The roundedness of the box's corners.\n *\n * - `none`: Sharp corners with no rounding.\n * - `small-100` / `small`: Subtle rounding for compact elements.\n * - `base`: Standard rounding for most use cases.\n * - `large` / `large-100`: More pronounced rounding for prominent containers.\n * - `max`: Maximum rounding, creating a pill or circular shape.\n *\n * Supports 1-to-4-value shorthand syntax for specifying different radii per corner.\n *\n * @default 'none'\n */\n borderRadius?: MaybeAllValuesShorthandProperty>;\n}" }, "AccessibilityRole": { "filePath": "src/surfaces/checkout/components/components.ts", "syntaxKind": "TypeAliasDeclaration", "name": "AccessibilityRole", "value": "\"main\" | \"header\" | \"footer\" | \"section\" | \"aside\" | \"navigation\" | \"ordered-list\" | \"list-item\" | \"list-item-separator\" | \"unordered-list\" | \"separator\" | \"status\" | \"alert\" | \"generic\" | \"presentation\" | \"none\"", - "description": "", + "description": "The semantic role of a component, used by assistive technologies to convey the element’s purpose to users. Each role maps to a specific HTML element or ARIA role.\n\n- `main`: The primary content of the page.\n- `header`: A page or section header.\n- `footer`: Information such as copyright, navigation links, and privacy statements.\n- `section`: A generic section that should have a heading or `accessibilityLabel`.\n- `aside`: Supporting content related to the main content.\n- `navigation`: A major group of navigation links.\n- `ordered-list`: A list of ordered items.\n- `list-item`: An item inside a list.\n- `list-item-separator`: A divider between list items.\n- `unordered-list`: A list of unordered items.\n- `separator`: A divider that separates sections of content.\n- `status`: A live region with advisory information that is not urgent.\n- `alert`: Important, usually time-sensitive information.\n- `generic`: A nameless container with no semantic meaning (renders a `
`).\n- `presentation`: Strips semantic meaning while keeping visual styling. Synonym for `none`.\n- `none`: Strips semantic meaning while keeping visual styling. Synonym for `presentation`.", "isPublicDocs": true }, "MaybeResponsive": { @@ -207672,7 +207670,7 @@ "syntaxKind": "TypeAliasDeclaration", "name": "BorderShorthand", "value": "ReducedBorderSizeKeyword | `${ReducedBorderSizeKeyword} ${ReducedColorKeyword}` | `${ReducedBorderSizeKeyword} ${ReducedColorKeyword} ${BorderStyleKeyword}`", - "description": "", + "description": "A shorthand string for specifying border properties. Accepts a size alone (`'base'`), size with color (`'base base'`), or size with color and style (`'base base dashed'`). Omitted values use their defaults.", "isPublicDocs": true }, "ReducedBorderSizeKeyword": { @@ -207735,7 +207733,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityVisibility", "value": "'visible' | 'hidden' | 'exclusive'", - "description": "Changes the visibility of the element.\n\n- `visible`: the element is visible to all users.\n- `hidden`: the element is removed from the accessibility tree but remains visible.\n- `exclusive`: the element is visually hidden but remains in the accessibility tree.", + "description": "Controls how the element is exposed to sighted users and to assistive technologies such as screen readers.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", "isOptional": true, "defaultValue": "'visible'" }, @@ -207744,7 +207742,7 @@ "syntaxKind": "PropertySignature", "name": "background", "value": "'base' | 'subdued' | 'transparent'", - "description": "Adjust the background of the element.", + "description": "The background color of the box.\n\n- `base`: The standard background color for general content areas.\n- `subdued`: A muted background for secondary or supporting content.\n- `transparent`: No background color (the default).", "isOptional": true, "defaultValue": "'transparent'" }, @@ -207762,15 +207760,16 @@ "syntaxKind": "PropertySignature", "name": "border", "value": "BorderShorthand", - "description": "Applies a border using shorthand syntax to specify width, color, and style in a single property.\n\nAccepts a size value, optionally followed by a color, optionally followed by a style. Omitted values use defaults: color defaults to `base`, style defaults to `auto`.\n\nIndividual properties (`borderWidth`, `borderStyle`, `borderColor`) can override values set here.", - "isOptional": true + "description": "A shorthand for setting the border width, color, and style in a single property. Individual border properties (`borderWidth`, `borderStyle`) can override values set here.", + "isOptional": true, + "defaultValue": "'none'" }, { "filePath": "src/surfaces/checkout/components/Box.ts", "syntaxKind": "PropertySignature", "name": "borderRadius", "value": "MaybeAllValuesShorthandProperty>", - "description": "Controls the roundedness of the element's corners using the design system's radius scale.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) using flow-relative values:\n- One value: applies to all corners\n- Two values: applies to start corners (top-left & bottom-right) and end corners (top-right & bottom-left) respectively\n- Three values: applies to start-start (top-left), end corners (top-right & bottom-left), and end-end (bottom-right) respectively\n- Four values: applies to start-start (top-left), start-end (top-right), end-end (bottom-right), and end-start (bottom-left) respectively\n\nExamples:\n- `small-100`: All corners have `small-100` radius\n- `small-100 none`: Top-left and bottom-right are `small-100`, top-right and bottom-left are `none`\n- `small-100 none large-100`: Top-left is `small-100`, top-right and bottom-left are `none`, bottom-right is `large-100`\n- `small-100 none large-100 base`: Each corner has its specified radius value", + "description": "The roundedness of the box's corners.\n\n- `none`: Sharp corners with no rounding.\n- `small-100` / `small`: Subtle rounding for compact elements.\n- `base`: Standard rounding for most use cases.\n- `large` / `large-100`: More pronounced rounding for prominent containers.\n- `max`: Maximum rounding, creating a pill or circular shape.\n\nSupports 1-to-4-value shorthand syntax for specifying different radii per corner.", "isOptional": true, "defaultValue": "'none'" }, @@ -207788,15 +207787,16 @@ "syntaxKind": "PropertySignature", "name": "borderWidth", "value": "MaybeAllValuesShorthandProperty | ''", - "description": "Controls the thickness of the border on all sides. When set, this overrides the width value specified in the `border` property.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) for specifying different widths per side:\n- One value: applies to all sides\n- Two values: applies to block sides (top/bottom) and inline sides (left/right) respectively\n- Three values: applies to block-start (top), inline sides (left/right), and block-end (bottom) respectively\n- Four values: applies to block-start (top), inline-end (right), block-end (bottom), and inline-start (left) respectively", - "isOptional": true + "description": "The thickness of the border on all sides. Supports 1-to-4-value shorthand syntax for specifying different widths per side. Overrides the width value set by `border`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" }, { "filePath": "src/surfaces/checkout/components/Box.ts", "syntaxKind": "PropertySignature", "name": "display", "value": "MaybeResponsive<\"auto\" | \"none\">", - "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.", + "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.\n\nLearn more about the [display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display).", "isOptional": true, "defaultValue": "'auto'" }, @@ -207805,7 +207805,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -208003,7 +208003,7 @@ "ButtonElementProps": { "filePath": "src/surfaces/checkout/components/Button.ts", "name": "ButtonElementProps", - "description": "Properties for the Button component element.", + "description": "", "isPublicDocs": true, "members": [ { @@ -208011,7 +208011,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityLabel", "value": "string", - "description": "A label that describes the purpose or contents of the Button. It will be read to users using assistive technologies such as screen readers.\n\nUse this when using only an icon or the Button text is not enough context for users using assistive technologies.", + "description": "A label that describes the purpose or content of the button for users of assistive technologies such as screen readers. Use this when the visible content alone doesn't provide enough context.", "isOptional": true }, { @@ -208019,7 +208019,7 @@ "syntaxKind": "PropertySignature", "name": "command", "value": "'--auto' | '--show' | '--hide' | '--toggle' | '--copy'", - "description": "Sets the action the `commandFor` should take when this clickable is activated.\n\nSee the documentation of particular components for the actions they support.\n\n- `--auto`: a default action for the target component.\n- `--show`: shows the target component.\n- `--hide`: hides the target component.\n- `--toggle`: toggles the target component.\n- `--copy`: copies the target ClipboardItem.", + "description": "Sets the action the `commandFor` target should take when this component is activated.\n\n- `--auto`: Performs the default action for the target component.\n- `--show`: Displays the target component.\n- `--hide`: Conceals the target component.\n- `--toggle`: Alternates the target component.\n- `--copy`: Copies the target ClipboardItem.\n\nLearn more about the [`command` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).", "isOptional": true, "defaultValue": "'--auto'" }, @@ -208028,7 +208028,7 @@ "syntaxKind": "PropertySignature", "name": "commandFor", "value": "string", - "description": "ID of a component that should respond to activations (e.g. clicks) on this component.\n\nSee `command` for how to control the behavior of the target.", + "description": "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).\n\nWhen both `commandFor` and `href` are set, `commandFor` takes precedence. The command runs and the link doesn't navigate.", "isOptional": true }, { @@ -208036,7 +208036,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the Button meaning it cannot be clicked or receive focus.", + "description": "Whether the button is disabled, preventing it from being clicked or receiving focus.", "isOptional": true, "defaultValue": "false" }, @@ -208045,7 +208045,7 @@ "syntaxKind": "PropertySignature", "name": "href", "value": "string", - "description": "The URL to link to.\n\n- If set, it will navigate to the location specified by `href` after executing the `click` event.\n- If a `commandFor` is set, the `command` will be executed instead of the navigation.", + "description": "The URL to navigate to when clicked. The `click` event fires first, then navigation occurs.\n\n- If set, it will navigate to the location specified by `href` after executing the `click` event.\n- If a `commandFor` is set, the `command` will be executed instead of the navigation.", "isOptional": true }, { @@ -208053,7 +208053,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -208061,7 +208061,7 @@ "syntaxKind": "PropertySignature", "name": "inlineSize", "value": "'auto' | 'fill' | 'fit-content'", - "description": "The displayed inline width of the Button.\n\n- `auto`: the size of the button depends on the surface and context.\n- `fill`: the button will takes up 100% of the available inline size.\n- `fit-content`: the button will take up the minimum inline-size required to fit its content.", + "description": "The inline width of the button component.\n\n- `auto`: The size depends on the surface and context.\n- `fill`: The button takes up 100% of the available inline size.\n- `fit-content`: The button takes up the minimum inline-size required to fit its content.", "isOptional": true, "defaultValue": "'auto'" }, @@ -208070,7 +208070,7 @@ "syntaxKind": "PropertySignature", "name": "interestFor", "value": "string", - "description": "ID of a component that should respond to interest (e.g. hover and focus) on this component.", + "description": "The ID of the component to show when users hover over or focus on this component. Pair with a target component that supports interest-based interactions. Learn more about the [interestFor attribute](https://open-ui.org/components/interest-invokers.explainer/#the-pitch-in-code).", "isOptional": true }, { @@ -208078,7 +208078,7 @@ "syntaxKind": "PropertySignature", "name": "loading", "value": "boolean", - "description": "Replaces content with a loading indicator while a background action is being performed.\n\nThis also disables the Button.", + "description": "Whether the button is in a loading state, which replaces the button content with a loading indicator while a background action is being performed.\n\nThis also disables the button.", "isOptional": true, "defaultValue": "false" }, @@ -208096,7 +208096,7 @@ "syntaxKind": "PropertySignature", "name": "tone", "value": "'auto' | 'neutral' | 'critical'", - "description": "Sets the tone of the Button based on the intention of the information being conveyed.", + "description": "The semantic meaning and color treatment of the button.\n\n- `'auto'`: Automatically determined based on context.\n- `'neutral'`: General information without specific intent.\n- `'critical'`: Urgent problems or destructive actions.", "isOptional": true, "defaultValue": "'auto'" }, @@ -208105,7 +208105,7 @@ "syntaxKind": "PropertySignature", "name": "type", "value": "'submit' | 'button'", - "description": "The behavior of the Button.\n\n- `submit`: Used to indicate the component acts as a submit button, meaning it submits the closest form.\n- `button`: Used to indicate the component acts as a button, meaning it has no default action.\n- `reset`: Used to indicate the component acts as a reset button, meaning it resets the closest form (returning fields to their default values).\n\nThis property is ignored if the component supports `href` or `commandFor`/`command` and one of them is set.", + "description": "The behavioral type of the button component, which determines what action it performs when activated.\n\n- `submit`: Submits the nearest containing form.\n- `button`: Performs no default action, relying on the `click` event handler for behavior.\n\nThis property is ignored if `href` or `commandFor`/`command` is set.", "isOptional": true, "defaultValue": "'button'" }, @@ -208114,12 +208114,12 @@ "syntaxKind": "PropertySignature", "name": "variant", "value": "'auto' | 'primary' | 'secondary'", - "description": "Changes the visual appearance of the Button.", + "description": "The visual style variant of the button component, which controls its prominence and emphasis.\n\n- `'auto'`: Automatically determined by the button's context.\n- `'primary'`: High-emphasis style for the main action.\n- `'secondary'`: Medium-emphasis style for supporting actions.\n- `'tertiary'`: Low-emphasis style for less prominent actions.", "isOptional": true, - "defaultValue": "'auto' - the variant is automatically determined by the Button's context" + "defaultValue": "'auto'" } ], - "value": "export interface ButtonElementProps extends Pick {\n target?: Extract;\n tone?: Extract;\n type?: Extract;\n variant?: Extract;\n}" + "value": "export interface ButtonElementProps extends Pick {\n target?: Extract;\n tone?: Extract;\n /**\n * The behavioral type of the button component, which determines what action it performs when activated.\n *\n * - `submit`: Submits the nearest containing form.\n * - `button`: Performs no default action, relying on the `click` event handler for behavior.\n *\n * This property is ignored if `href` or `commandFor`/`command` is set.\n *\n * @default 'button'\n */\n type?: Extract;\n variant?: Extract;\n}" } } }, @@ -208131,7 +208131,7 @@ "ButtonElementEvents": { "filePath": "src/surfaces/checkout/components/Button.ts", "name": "ButtonElementEvents", - "description": "Events for the Button component element.", + "description": "", "isPublicDocs": true, "members": [ { @@ -208139,11 +208139,11 @@ "syntaxKind": "PropertySignature", "name": "click", "value": "CallbackEventListener", - "description": "Callback when the button is activated. This will be called before the action indicated by `type`.", + "description": "A callback fired when the button is clicked. This will be called before the action indicated by `type`.\n\nLearn more about the [click event](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event).", "isOptional": true } ], - "value": "export interface ButtonElementEvents {\n /**\n * Callback when the button is activated.\n * This will be called before the action indicated by `type`.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event\n */\n click?: CallbackEventListener;\n}" + "value": "export interface ButtonElementEvents {\n /**\n * A callback fired when the button is clicked. This will be called before the action indicated by `type`.\n *\n * Learn more about the [click event](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event).\n */\n click?: CallbackEventListener;\n}" }, "CallbackEventListener": { "filePath": "src/surfaces/checkout/components/Button.ts", @@ -208204,7 +208204,7 @@ "CheckboxElementProps": { "filePath": "src/surfaces/checkout/components/Checkbox.ts", "name": "CheckboxElementProps", - "description": "Properties for the Checkbox component element.", + "description": "", "isPublicDocs": true, "members": [ { @@ -208220,7 +208220,7 @@ "syntaxKind": "PropertySignature", "name": "checked", "value": "boolean", - "description": "Whether the control is active.", + "description": "Whether the control is currently checked.", "isOptional": true, "defaultValue": "false" }, @@ -208229,7 +208229,7 @@ "syntaxKind": "PropertySignature", "name": "command", "value": "'--auto' | '--show' | '--hide' | '--toggle'", - "description": "Sets the action the `commandFor` should take when this clickable is activated.\n\nSee the documentation of particular components for the actions they support.\n\n- `--auto`: a default action for the target component.\n- `--show`: shows the target component.\n- `--hide`: hides the target component.\n- `--toggle`: toggles the target component.\n- `--copy`: copies the target ClipboardItem.", + "description": "Sets the action the `commandFor` target should take when this component is activated.\n\n- `--auto`: Performs the default action for the target component.\n- `--show`: Displays the target component.\n- `--hide`: Conceals the target component.\n- `--toggle`: Alternates the target component.\n- `--copy`: Copies the target ClipboardItem.\n\nLearn more about the [`command` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).", "isOptional": true, "defaultValue": "'--auto'" }, @@ -208238,7 +208238,7 @@ "syntaxKind": "PropertySignature", "name": "commandFor", "value": "string", - "description": "ID of a component that should respond to activations (e.g. clicks) on this component.\n\nSee `command` for how to control the behavior of the target.", + "description": "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).\n\nWhen both `commandFor` and `href` are set, `commandFor` takes precedence. The command runs and the link doesn't navigate.", "isOptional": true }, { @@ -208246,7 +208246,7 @@ "syntaxKind": "PropertySignature", "name": "defaultChecked", "value": "boolean", - "description": "Whether the control is active by default.", + "description": "Whether the control is checked by default.", "isOptional": true, "defaultValue": "false" }, @@ -208255,7 +208255,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the control, disallowing any interaction.", + "description": "Whether the control is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -208264,7 +208264,7 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -208272,7 +208272,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -208280,7 +208280,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Visual content to use as the control label.", + "description": "The visual content to use as the control label. Use a string to provide a simple text label displayed to the user.\n\nIf a `label` slot is also provided, the slot content takes precedence. [Learn more about slots](/docs/api/{API_NAME}/{API_VERSION}/web-components/forms/checkbox#slots-propertydetail-label).", "isOptional": true }, { @@ -208288,7 +208288,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the control that is unique within the nearest containing `Form` component.", + "description": "The name attribute for the control, used to identify its value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -208296,7 +208296,7 @@ "syntaxKind": "PropertySignature", "name": "required", "value": "boolean", - "description": "Whether the field needs a value. This requirement adds semantic value to the field, but it will not cause an error to appear automatically. If you want to present an error when this field is empty, you can do so with the `error` property.", + "description": "Whether the field needs a value. This requirement adds semantic value to the field, but it will not cause an error to appear automatically. If you want to present an error when this field is empty, you can do so with the `error` property.\n\nAdds semantic meaning for accessibility. Doesn't trigger automatic validation or display an error. Implement validation logic yourself and use the `error` prop to show results.", "isOptional": true, "defaultValue": "false" }, @@ -208309,7 +208309,7 @@ "isOptional": true } ], - "value": "export interface CheckboxElementProps extends Pick {\n command?: Extract;\n}" + "value": "export interface CheckboxElementProps extends Pick {\n command?: Extract;\n /**\n * The visual content to use as the control label. Use a string to provide a simple text label displayed to the user.\n *\n * If a `label` slot is also provided, the slot content takes precedence. [Learn more about slots](/docs/api/{API_NAME}/{API_VERSION}/web-components/forms/checkbox#slots-propertydetail-label).\n */\n label?: string;\n}" } } }, @@ -208321,7 +208321,7 @@ "CheckboxElementEvents": { "filePath": "src/surfaces/checkout/components/Checkbox.ts", "name": "CheckboxElementEvents", - "description": "Events for the Checkbox component element.", + "description": "", "isPublicDocs": true, "members": [ { @@ -208329,11 +208329,11 @@ "syntaxKind": "PropertySignature", "name": "change", "value": "CallbackEventListener", - "description": "A callback that is run whenever the control is changed.", + "description": "A callback fired when the checkbox value changes.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", "isOptional": true } ], - "value": "export interface CheckboxElementEvents {\n /**\n * A callback that is run whenever the control is changed.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event\n */\n change?: CallbackEventListener;\n}" + "value": "export interface CheckboxElementEvents {\n /**\n * A callback fired when the checkbox value changes.\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change?: CallbackEventListener;\n}" }, "CallbackEventListener": { "filePath": "src/surfaces/checkout/components/Checkbox.ts", @@ -208352,6 +208352,30 @@ "isPublicDocs": true } } + }, + { + "title": "Slots", + "description": "Learn more about [component slots](/docs/api/checkout-ui-extensions/latest/using-polaris-components#slots).", + "type": "CheckboxElementSlots", + "typeDefinitions": { + "CheckboxElementSlots": { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "name": "CheckboxElementSlots", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "label", + "value": "HTMLElement", + "description": "The visual content to use as the control label.\n\nUse an `HTMLElement` as a rich control label composed of elements. Only an `s-text` element is supported with plain text and `s-link` as its only allowed children. Any other elements are stripped while preserving their text content.", + "isOptional": true + } + ], + "value": "export interface CheckboxElementSlots {\n /**\n * The visual content to use as the control label.\n *\n * Use an `HTMLElement` as a rich control label composed of elements. Only an `s-text` element is supported with plain text and `s-link` as its only allowed children. Any other elements are stripped while preserving their text content.\n */\n label?: HTMLElement;\n}" + } + } } ], "defaultExample": { @@ -208387,7 +208411,7 @@ "ChipElementProps": { "filePath": "src/surfaces/checkout/components/Chip.ts", "name": "ChipElementProps", - "description": "Properties for the Chip component element.", + "description": "", "isPublicDocs": true, "members": [ { @@ -208395,7 +208419,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityLabel", "value": "string", - "description": "A label that describes the purpose or contents of the Chip. It will be read to users using assistive technologies such as screen readers.", + "description": "A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.", "isOptional": true }, { @@ -208403,7 +208427,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true } ], @@ -208419,7 +208443,7 @@ "ChipElementSlots": { "filePath": "src/surfaces/checkout/components/Chip.ts", "name": "ChipElementSlots", - "description": "Slots for the Chip component element.", + "description": "", "isPublicDocs": true, "members": [ { @@ -208427,11 +208451,11 @@ "syntaxKind": "PropertySignature", "name": "graphic", "value": "HTMLElement", - "description": "The graphic to display inside of the chip.\n\nOnly `s-icon` element and its `type` attribute are supported.", + "description": "An optional graphic displayed at the start of the chip, such as an icon to visually reinforce the chip's label. Only the `s-icon` element and its `type` attribute are supported.", "isOptional": true } ], - "value": "export interface ChipElementSlots {\n /**\n * The graphic to display inside of the chip.\n *\n * Only `s-icon` element and its `type` attribute are supported.\n */\n graphic?: HTMLElement;\n}" + "value": "export interface ChipElementSlots {\n /**\n * An optional graphic displayed at the start of the chip, such as an icon to visually reinforce the chip's label. Only the `s-icon` element and its `type` attribute are supported.\n */\n graphic?: HTMLElement;\n}" } } } @@ -208469,7 +208493,7 @@ "ChoiceListElementProps": { "filePath": "src/surfaces/checkout/components/ChoiceList.ts", "name": "ChoiceListElementProps", - "description": "The choice list component presents multiple options for single or multiple selections. Use it when merchants need to choose from a defined set of options, such as filtering results or collecting preferences.\n\nThe component supports both single selection (radio button behavior) and multiple selection (checkbox behavior) modes. It includes configurable labels, help text, and validation. For compact dropdown selection with four or more options, use [select](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/forms/select).", + "description": "", "isPublicDocs": true, "members": [ { @@ -208477,7 +208501,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.\n\n`disabled` on any child choices is ignored when this is true.", + "description": "Whether the field is disabled, preventing any user interaction.\n\n`disabled` on any child choices is ignored when this is true.", "isOptional": true, "defaultValue": "false" }, @@ -208486,7 +208510,7 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -208494,7 +208518,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -208502,7 +208526,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Content to use as the field label.", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", "isOptional": true }, { @@ -208510,7 +208534,7 @@ "syntaxKind": "PropertySignature", "name": "labelAccessibilityVisibility", "value": "'visible' | 'exclusive'", - "description": "Changes the visibility of the component's label.\n\n- `visible`: the label is visible to all users.\n- `exclusive`: the label is visually hidden but remains in the accessibility tree.", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone.\n- `exclusive`: The label is visually hidden but still announced by screen readers.", "isOptional": true, "defaultValue": "'visible'" }, @@ -208528,7 +208552,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -208536,7 +208560,7 @@ "syntaxKind": "PropertySignature", "name": "values", "value": "string[]", - "description": "An array of the `value`s of the selected options.\n\nThis is a convenience prop for setting the `selected` prop on child options.", + "description": "An array of `value` attributes for the currently selected options.\n\nThis is a convenience prop for setting the `selected` prop on child options.\n\nForm data captures the selected value strings only. Complex nested content inside choices is for display purposes and isn't included in form submissions.", "isOptional": true }, { @@ -208544,7 +208568,7 @@ "syntaxKind": "PropertySignature", "name": "variant", "value": "'auto' | 'list' | 'inline' | 'block' | 'grid'", - "description": "The variant of the choice grid.\n\n- `auto`: The variant is determined by the context.\n- `list`: The choices are displayed in a list.\n- `inline`: The choices are displayed on the inline axis.\n- `block`: The choices are displayed on the block axis.\n- `grid`: The choices are displayed in a grid.", + "description": "The variant of the choice grid.\n\n- `auto`: The variant is determined by the context.\n- `list`: The choices are displayed in a list.\n- `inline`: The choices are displayed on the inline axis.\n- `block`: The choices are displayed on the block axis.\n- `grid`: The choices are displayed in a grid.\n\nThe selected content slot is supported only in the default (stacked) variant. `inline` and `grid` ignore it.", "isOptional": true, "defaultValue": "'auto'" } @@ -208561,7 +208585,7 @@ "ChoiceListElementEvents": { "filePath": "src/surfaces/checkout/components/ChoiceList.ts", "name": "ChoiceListElementEvents", - "description": "Learn more about [registering events](/docs/api/checkout-ui-extensions/latest/using-polaris-components#event-handling).", + "description": "", "isPublicDocs": true, "members": [ { @@ -208569,11 +208593,11 @@ "syntaxKind": "PropertySignature", "name": "change", "value": "CallbackEventListener", - "description": "A callback that is run whenever the control is changed.", + "description": "A callback fired when the choice list value changes.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", "isOptional": true } ], - "value": "export interface ChoiceListElementEvents {\n /**\n * A callback that is run whenever the control is changed.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event\n */\n change?: CallbackEventListener;\n}" + "value": "export interface ChoiceListElementEvents {\n /**\n * A callback fired when the choice list value changes.\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change?: CallbackEventListener;\n}" }, "CallbackEventListener": { "filePath": "src/surfaces/checkout/components/ChoiceList.ts", @@ -208601,7 +208625,7 @@ "ChoiceElementProps": { "filePath": "src/surfaces/checkout/components/Choice.ts", "name": "ChoiceElementProps", - "description": "The choice component creates individual selectable options within a choice list. Use choice to define each option that merchants can select, supporting both single selection (radio buttons) and multiple selection (checkboxes) modes.\n\nChoice components support labels, help text, and custom content through slots, providing flexible option presentation within choice lists.", + "description": "", "isPublicDocs": true, "members": [ { @@ -208617,7 +208641,7 @@ "syntaxKind": "PropertySignature", "name": "defaultSelected", "value": "boolean", - "description": "Whether the control is active by default.", + "description": "Whether the control is selected by default.", "isOptional": true, "defaultValue": "false" }, @@ -208626,7 +208650,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the control, disallowing any interaction.", + "description": "Whether the control is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -208635,7 +208659,7 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "boolean", - "description": "Set to `true` to associate a choice with the error passed to `ChoiceList`", + "description": "Whether this choice is associated with the error state of the parent choice list. When `true`, the choice is visually marked as having an error.", "isOptional": true, "defaultValue": "false" }, @@ -208644,7 +208668,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -208652,7 +208676,7 @@ "syntaxKind": "PropertySignature", "name": "selected", "value": "boolean", - "description": "Whether the control is active.", + "description": "Whether the control is currently selected.", "isOptional": true, "defaultValue": "false" }, @@ -208677,7 +208701,7 @@ "ChoiceElementSlots": { "filePath": "src/surfaces/checkout/components/Choice.ts", "name": "ChoiceElementSlots", - "description": "Learn more about [component slots](/docs/api/checkout-ui-extensions/latest/using-polaris-components#slots).", + "description": "", "isPublicDocs": true, "members": [ { @@ -208816,7 +208840,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityVisibility", "value": "'visible' | 'hidden' | 'exclusive'", - "description": "Changes the visibility of the element.\n\n- `visible`: the element is visible to all users.\n- `hidden`: the element is removed from the accessibility tree but remains visible.\n- `exclusive`: the element is visually hidden but remains in the accessibility tree.", + "description": "Controls how the element is exposed to sighted users and to assistive technologies such as screen readers.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", "isOptional": true, "defaultValue": "'visible'" }, @@ -208825,7 +208849,7 @@ "syntaxKind": "PropertySignature", "name": "background", "value": "'base' | 'subdued' | 'transparent'", - "description": "Adjust the background of the element.", + "description": "Adjust the background of the element.\n\n- `'transparent'`: No visible background.\n- `'subdued'`: A subtle, low-emphasis background.\n- `'base'`: The standard background color.\n- `'strong'`: A high-emphasis background for prominence.", "isOptional": true, "defaultValue": "'transparent'" }, @@ -208891,7 +208915,7 @@ "syntaxKind": "PropertySignature", "name": "command", "value": "'--auto' | '--show' | '--hide' | '--toggle' | '--copy'", - "description": "Sets the action the `commandFor` should take when this clickable is activated.\n\nSee the documentation of particular components for the actions they support.\n\n- `--auto`: a default action for the target component.\n- `--show`: shows the target component.\n- `--hide`: hides the target component.\n- `--toggle`: toggles the target component.\n- `--copy`: copies the target ClipboardItem.", + "description": "Sets the action the `commandFor` target should take when this component is activated.\n\n- `--auto`: Performs the default action for the target component.\n- `--show`: Displays the target component.\n- `--hide`: Conceals the target component.\n- `--toggle`: Alternates the target component.\n- `--copy`: Copies the target ClipboardItem.\n\nLearn more about the [`command` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).", "isOptional": true, "defaultValue": "'--auto'" }, @@ -208900,7 +208924,7 @@ "syntaxKind": "PropertySignature", "name": "commandFor", "value": "string", - "description": "ID of a component that should respond to activations (e.g. clicks) on this component.\n\nSee `command` for how to control the behavior of the target.", + "description": "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).\n\nWhen both `commandFor` and `href` are set, `commandFor` takes precedence. The command runs and the link doesn't navigate.", "isOptional": true }, { @@ -208908,7 +208932,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the clickable, meaning it cannot be clicked or receive focus.\n\nIn this state, onClick will not fire. If the click event originates from a child element, the event will immediately stop propagating from this element.\n\nHowever, items within the clickable can still receive focus and be interacted with.\n\nThis has no impact on the visual state by default, but developers are encouraged to style the clickable accordingly.", + "description": "Disables the clickable, meaning it cannot be clicked or receive focus.\n\nIn this state, the `click` event will not fire. If the click event originates from a child element, the event will immediately stop propagating from this element.\n\nHowever, items within the clickable can still receive focus and be interacted with.\n\nThis has no impact on the visual state by default, but developers are encouraged to style the clickable accordingly.", "isOptional": true, "defaultValue": "false" }, @@ -208917,7 +208941,7 @@ "syntaxKind": "PropertySignature", "name": "display", "value": "MaybeResponsive<\"auto\" | \"none\">", - "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.", + "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.\n\nLearn more about the [display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display).", "isOptional": true, "defaultValue": "'auto'" }, @@ -208926,7 +208950,7 @@ "syntaxKind": "PropertySignature", "name": "href", "value": "string", - "description": "The URL to link to.\n\n- If set, it will navigate to the location specified by `href` after executing the `click` event.\n- If a `commandFor` is set, the `command` will be executed instead of the navigation.", + "description": "The URL to navigate to when clicked. The `click` event fires first, then navigation occurs.\n\n- If set, it will navigate to the location specified by `href` after executing the `click` event.\n- If a `commandFor` is set, the `command` will be executed instead of the navigation.", "isOptional": true }, { @@ -208934,7 +208958,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -208951,7 +208975,7 @@ "syntaxKind": "PropertySignature", "name": "interestFor", "value": "string", - "description": "ID of a component that should respond to interest (e.g. hover and focus) on this component.", + "description": "The ID of the component to show when users hover over or focus on this component. Pair with a target component that supports interest-based interactions. Learn more about the [interestFor attribute](https://open-ui.org/components/interest-invokers.explainer/#the-pitch-in-code).", "isOptional": true }, { @@ -208959,7 +208983,7 @@ "syntaxKind": "PropertySignature", "name": "lang", "value": "string", - "description": "Indicate the text language. Useful when the text is in a different language than the rest of the page. It will allow assistive technologies such as screen readers to invoke the correct pronunciation. [Reference of values](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry) (\"subtag\" label)", + "description": "The language of the button's text content. Use this when the button text is in a different language than the rest of the page, so assistive technologies can invoke the correct pronunciation. [Reference of values](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry) (`Subtag` label)", "isOptional": true, "defaultValue": "''" }, @@ -209094,12 +209118,12 @@ "syntaxKind": "PropertySignature", "name": "type", "value": "'submit' | 'button'", - "description": "The behavior of the Button.\n\n- `submit`: Used to indicate the component acts as a submit button, meaning it submits the closest form.\n- `button`: Used to indicate the component acts as a button, meaning it has no default action.\n- `reset`: Used to indicate the component acts as a reset button, meaning it resets the closest form (returning fields to their default values).\n\nThis property is ignored if the component supports `href` or `commandFor`/`command` and one of them is set.", + "description": "The behavioral type of the clickable component, which determines what action it performs when activated.\n\n- `submit`: Submits the nearest containing form.\n- `button`: Performs no default action, relying on the `click` event handler for behavior.\n\nThis property is ignored if `href` or `commandFor`/`command` is set.", "isOptional": true, "defaultValue": "'button'" } ], - "value": "export interface ClickableElementProps extends Pick {\n background?: Extract;\n border?: BorderShorthand;\n borderWidth?: MaybeAllValuesShorthandProperty | '';\n borderRadius?: MaybeAllValuesShorthandProperty>;\n target?: Extract;\n type?: Extract;\n}" + "value": "export interface ClickableElementProps extends Pick {\n background?: Extract;\n border?: BorderShorthand;\n borderWidth?: MaybeAllValuesShorthandProperty | '';\n borderRadius?: MaybeAllValuesShorthandProperty>;\n target?: Extract;\n /**\n * The behavioral type of the clickable component, which determines what action it performs when activated.\n *\n * - `submit`: Submits the nearest containing form.\n * - `button`: Performs no default action, relying on the `click` event handler for behavior.\n *\n * This property is ignored if `href` or `commandFor`/`command` is set.\n *\n * @default 'button'\n */\n type?: Extract;\n}" }, "MaybeResponsive": { "filePath": "src/surfaces/checkout/components/components.ts", @@ -209130,7 +209154,7 @@ "syntaxKind": "TypeAliasDeclaration", "name": "BorderShorthand", "value": "ReducedBorderSizeKeyword | `${ReducedBorderSizeKeyword} ${ReducedColorKeyword}` | `${ReducedBorderSizeKeyword} ${ReducedColorKeyword} ${BorderStyleKeyword}`", - "description": "", + "description": "A shorthand type for specifying border properties. Accepts a border size, or a combination of size and color, or size, color, and style.", "isPublicDocs": true }, "ReducedBorderSizeKeyword": { @@ -209184,7 +209208,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityVisibility", "value": "'visible' | 'hidden' | 'exclusive'", - "description": "Changes the visibility of the element.\n\n- `visible`: the element is visible to all users.\n- `hidden`: the element is removed from the accessibility tree but remains visible.\n- `exclusive`: the element is visually hidden but remains in the accessibility tree.", + "description": "Controls how the element is exposed to sighted users and to assistive technologies such as screen readers.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", "isOptional": true, "defaultValue": "'visible'" }, @@ -209193,7 +209217,7 @@ "syntaxKind": "PropertySignature", "name": "background", "value": "'base' | 'subdued' | 'transparent'", - "description": "Adjust the background of the element.", + "description": "Adjust the background of the element.\n\n- `'transparent'`: No visible background.\n- `'subdued'`: A subtle, low-emphasis background.\n- `'base'`: The standard background color.\n- `'strong'`: A high-emphasis background for prominence.", "isOptional": true, "defaultValue": "'transparent'" }, @@ -209245,7 +209269,7 @@ "syntaxKind": "PropertySignature", "name": "command", "value": "'--auto' | '--show' | '--hide' | '--toggle' | '--copy'", - "description": "Sets the action the `commandFor` should take when this clickable is activated.\n\nSee the documentation of particular components for the actions they support.\n\n- `--auto`: a default action for the target component.\n- `--show`: shows the target component.\n- `--hide`: hides the target component.\n- `--toggle`: toggles the target component.\n- `--copy`: copies the target ClipboardItem.", + "description": "Sets the action the `commandFor` target should take when this component is activated.\n\n- `--auto`: Performs the default action for the target component.\n- `--show`: Displays the target component.\n- `--hide`: Conceals the target component.\n- `--toggle`: Alternates the target component.\n- `--copy`: Copies the target ClipboardItem.\n\nLearn more about the [`command` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).", "isOptional": true, "defaultValue": "'--auto'" }, @@ -209254,7 +209278,7 @@ "syntaxKind": "PropertySignature", "name": "commandFor", "value": "string", - "description": "ID of a component that should respond to activations (e.g. clicks) on this component.\n\nSee `command` for how to control the behavior of the target.", + "description": "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).\n\nWhen both `commandFor` and `href` are set, `commandFor` takes precedence. The command runs and the link doesn't navigate.", "isOptional": true }, { @@ -209262,7 +209286,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the clickable, meaning it cannot be clicked or receive focus.\n\nIn this state, onClick will not fire. If the click event originates from a child element, the event will immediately stop propagating from this element.\n\nHowever, items within the clickable can still receive focus and be interacted with.\n\nThis has no impact on the visual state by default, but developers are encouraged to style the clickable accordingly.", + "description": "Disables the clickable, meaning it cannot be clicked or receive focus.\n\nIn this state, the `click` event will not fire. If the click event originates from a child element, the event will immediately stop propagating from this element.\n\nHowever, items within the clickable can still receive focus and be interacted with.\n\nThis has no impact on the visual state by default, but developers are encouraged to style the clickable accordingly.", "isOptional": true, "defaultValue": "false" }, @@ -209271,7 +209295,7 @@ "syntaxKind": "PropertySignature", "name": "display", "value": "MaybeResponsive<\"auto\" | \"none\">", - "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.", + "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.\n\nLearn more about the [display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display).", "isOptional": true, "defaultValue": "'auto'" }, @@ -209280,7 +209304,7 @@ "syntaxKind": "PropertySignature", "name": "href", "value": "string", - "description": "The URL to link to.\n\n- If set, it will navigate to the location specified by `href` after executing the `click` event.\n- If a `commandFor` is set, the `command` will be executed instead of the navigation.", + "description": "The URL to navigate to when clicked. The `click` event fires first, then navigation occurs.\n\n- If set, it will navigate to the location specified by `href` after executing the `click` event.\n- If a `commandFor` is set, the `command` will be executed instead of the navigation.", "isOptional": true }, { @@ -209288,7 +209312,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -209305,7 +209329,7 @@ "syntaxKind": "PropertySignature", "name": "interestFor", "value": "string", - "description": "ID of a component that should respond to interest (e.g. hover and focus) on this component.", + "description": "The ID of the component to show when users hover over or focus on this component. Pair with a target component that supports interest-based interactions. Learn more about the [interestFor attribute](https://open-ui.org/components/interest-invokers.explainer/#the-pitch-in-code).", "isOptional": true }, { @@ -209313,7 +209337,7 @@ "syntaxKind": "PropertySignature", "name": "lang", "value": "string", - "description": "Indicate the text language. Useful when the text is in a different language than the rest of the page. It will allow assistive technologies such as screen readers to invoke the correct pronunciation. [Reference of values](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry) (\"subtag\" label)", + "description": "The language of the button's text content. Use this when the button text is in a different language than the rest of the page, so assistive technologies can invoke the correct pronunciation. [Reference of values](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry) (`Subtag` label)", "isOptional": true, "defaultValue": "''" }, @@ -209367,7 +209391,7 @@ "syntaxKind": "PropertySignature", "name": "onBlur", "value": "(event: FocusEvent) => void", - "description": "Callback when the element loses focus.", + "description": "A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", "isOptional": true }, { @@ -209375,7 +209399,7 @@ "syntaxKind": "PropertySignature", "name": "onClick", "value": "(event: Event) => void", - "description": "Callback when the Button is activated. This will be called before the action indicated by `type`.", + "description": "A callback fired when the button is activated, before performing the action indicated by `type`. Learn more about the [click event](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event).", "isOptional": true }, { @@ -209383,7 +209407,7 @@ "syntaxKind": "PropertySignature", "name": "onFocus", "value": "(event: FocusEvent) => void", - "description": "Callback when the element receives focus.", + "description": "A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", "isOptional": true }, { @@ -209472,7 +209496,7 @@ "syntaxKind": "PropertySignature", "name": "type", "value": "'submit' | 'button'", - "description": "The behavior of the Button.\n\n- `submit`: Used to indicate the component acts as a submit button, meaning it submits the closest form.\n- `button`: Used to indicate the component acts as a button, meaning it has no default action.\n- `reset`: Used to indicate the component acts as a reset button, meaning it resets the closest form (returning fields to their default values).\n\nThis property is ignored if the component supports `href` or `commandFor`/`command` and one of them is set.", + "description": "The behavioral type of the clickable component, which determines what action it performs when activated.\n\n- `submit`: Submits the nearest containing form.\n- `button`: Performs no default action, relying on the `click` event handler for behavior.\n\nThis property is ignored if `href` or `commandFor`/`command` is set.", "isOptional": true, "defaultValue": "'button'" } @@ -209529,7 +209553,7 @@ "syntaxKind": "PropertySignature", "name": "blur", "value": "CallbackEventListener", - "description": "Callback when the element loses focus.", + "description": "A callback fired when the component loses focus.\n\nLearn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", "isOptional": true }, { @@ -209537,7 +209561,7 @@ "syntaxKind": "PropertySignature", "name": "click", "value": "CallbackEventListener", - "description": "Callback when the button is activated. This will be called before the action indicated by `type`.", + "description": "A callback fired when the component is clicked. This will be called before the action indicated by `type`.\n\nLearn more about the [click event](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event).", "isOptional": true }, { @@ -209545,11 +209569,11 @@ "syntaxKind": "PropertySignature", "name": "focus", "value": "CallbackEventListener", - "description": "Callback when the element receives focus.", + "description": "A callback fired when the component receives focus.\n\nLearn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", "isOptional": true } ], - "value": "export interface ClickableElementEvents {\n /**\n * Callback when the element loses focus.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event\n */\n blur?: CallbackEventListener;\n /**\n * Callback when the button is activated.\n * This will be called before the action indicated by `type`.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event\n */\n click?: CallbackEventListener;\n /**\n * Callback when the element receives focus.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event\n */\n focus?: CallbackEventListener;\n}" + "value": "export interface ClickableElementEvents {\n /**\n * A callback fired when the component loses focus.\n *\n * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur?: CallbackEventListener;\n /**\n * A callback fired when the component is clicked. This will be called before the action indicated by `type`.\n *\n * Learn more about the [click event](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event).\n */\n click?: CallbackEventListener;\n /**\n * A callback fired when the component receives focus.\n *\n * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus?: CallbackEventListener;\n}" }, "CallbackEventListener": { "filePath": "src/surfaces/checkout/components/Clickable.ts", @@ -209603,7 +209627,7 @@ "ClickableChipElementProps": { "filePath": "src/surfaces/checkout/components/ClickableChip.ts", "name": "ClickableChipElementProps", - "description": "The clickable chip component displays interactive labels or categories that users can click or remove. Use clickable chip to show filter tags, selected options, or merchant-created labels that users need to interact with or dismiss.\n\nClickable chips support multiple visual variants, optional icons, and can function as both clickable buttons and removable tags for flexible interaction patterns. For non-interactive labels, use [chip](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/typography-and-content/chip).", + "description": "", "isPublicDocs": true, "members": [ { @@ -209611,7 +209635,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityLabel", "value": "string", - "description": "A label that describes the purpose or contents of the Chip. It will be read to users using assistive technologies such as screen readers.", + "description": "A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.", "isOptional": true }, { @@ -209619,7 +209643,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the chip, disallowing any interaction.", + "description": "Disables the chip, preventing all user interaction including clicks and removal. Disabled chips are visually dimmed to indicate they are not interactive.", "isOptional": true, "defaultValue": "false" }, @@ -209628,7 +209652,7 @@ "syntaxKind": "PropertySignature", "name": "hidden", "value": "boolean", - "description": "Determines whether the chip is hidden.\n\nIf this property is being set on each framework render (as in 'controlled' usage), and the chip is `removable`, ensure you update app state for this property when the `remove` event fires.\n\nIf the chip is not `removable`, it can still be hidden by setting this property.", + "description": "Determines whether the chip is hidden.\n\nIf this property is being set on each framework render (as in 'controlled' usage), and the chip is `removable`, ensure you update app state for this property when the `remove` event fires.\n\nIf the chip is not `removable`, it can still be hidden by setting this property.\n\nWhen using the `removable` variant, keep `hidden` synced with your app state. If `hidden` isn't updated after the chip is removed, the chip can become permanently hidden.", "isOptional": true, "defaultValue": "false" }, @@ -209637,7 +209661,7 @@ "syntaxKind": "PropertySignature", "name": "href", "value": "string", - "description": "The URL to link to.\n\n- If set, it will navigate to the location specified by `href` after executing the `click` event.", + "description": "The URL to link to. When set, the chip navigates to the specified location after the `click` event fires.", "isOptional": true }, { @@ -209645,7 +209669,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -209653,7 +209677,7 @@ "syntaxKind": "PropertySignature", "name": "removable", "value": "boolean", - "description": "Whether the chip is removable.", + "description": "Whether the chip displays a remove button, allowing users to dismiss it. When `true`, clicking the remove button fires the `remove` event.", "isOptional": true, "defaultValue": "false" } @@ -209670,7 +209694,7 @@ "ClickableChipElementEvents": { "filePath": "src/surfaces/checkout/components/ClickableChip.ts", "name": "ClickableChipElementEvents", - "description": "Learn more about [registering events](/docs/api/checkout-ui-extensions/latest/using-polaris-components#event-handling).", + "description": "", "isPublicDocs": true, "members": [ { @@ -209678,7 +209702,7 @@ "syntaxKind": "PropertySignature", "name": "afterhide", "value": "CallbackEventListener", - "description": "Event handler when the chip has fully hidden.\n\nThe `hidden` property will be `true` when this event fires.", + "description": "A callback fired after the chip is hidden. The `hidden` property will be `true` when this event fires.", "isOptional": true }, { @@ -209686,7 +209710,7 @@ "syntaxKind": "PropertySignature", "name": "click", "value": "CallbackEventListener", - "description": "Event handler when the chip is clicked.", + "description": "A callback fired when the chip is clicked.\n\nLearn more about the [click event](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event).", "isOptional": true }, { @@ -209694,11 +209718,11 @@ "syntaxKind": "PropertySignature", "name": "remove", "value": "CallbackEventListener", - "description": "Event handler when the chip is removed.", + "description": "A callback fired when the chip is removed.", "isOptional": true } ], - "value": "export interface ClickableChipElementEvents {\n /**\n * Event handler when the chip has fully hidden.\n *\n * The `hidden` property will be `true` when this event fires.\n */\n afterhide?: CallbackEventListener;\n /**\n * Event handler when the chip is clicked.\n */\n click?: CallbackEventListener;\n /**\n * Event handler when the chip is removed.\n */\n remove?: CallbackEventListener;\n}" + "value": "export interface ClickableChipElementEvents {\n /**\n * A callback fired after the chip is hidden. The `hidden` property will be `true` when this event fires.\n */\n afterhide?: CallbackEventListener;\n /**\n * A callback fired when the chip is clicked.\n *\n * Learn more about the [click event](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event).\n */\n click?: CallbackEventListener;\n /**\n * A callback fired when the chip is removed.\n */\n remove?: CallbackEventListener;\n}" }, "CallbackEventListener": { "filePath": "src/surfaces/checkout/components/ClickableChip.ts", @@ -209726,7 +209750,7 @@ "ClickableChipElementSlots": { "filePath": "src/surfaces/checkout/components/ClickableChip.ts", "name": "ClickableChipElementSlots", - "description": "Learn more about [component slots](/docs/api/checkout-ui-extensions/latest/using-polaris-components#slots).", + "description": "", "isPublicDocs": true, "members": [ { @@ -209734,11 +209758,11 @@ "syntaxKind": "PropertySignature", "name": "graphic", "value": "HTMLElement", - "description": "The graphic to display inside of the chip.\n\nOnly `s-icon` element and its `type` attribute are supported.", + "description": "An optional graphic displayed at the start of the chip, such as an icon to visually reinforce the chip's label. Only the `s-icon` element and its `type` attribute are supported.", "isOptional": true } ], - "value": "export interface ClickableChipElementSlots {\n /**\n * The graphic to display inside of the chip.\n *\n * Only `s-icon` element and its `type` attribute are supported.\n */\n graphic?: HTMLElement;\n}" + "value": "export interface ClickableChipElementSlots {\n /**\n * An optional graphic displayed at the start of the chip, such as an icon to visually reinforce the chip's label. Only the `s-icon` element and its `type` attribute are supported.\n */\n graphic?: HTMLElement;\n}" } } } @@ -209776,7 +209800,7 @@ "ClipboardItemElementProps": { "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", "name": "ClipboardItemElementProps", - "description": "Enables copying text to the user’s clipboard. Use alongside Button or Link components to let users easily copy content. `` doesn’t render visually.", + "description": "", "isPublicDocs": true, "members": [ { @@ -209784,7 +209808,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -209792,7 +209816,7 @@ "syntaxKind": "PropertySignature", "name": "text", "value": "string", - "description": "Plain text to be written to the clipboard.", + "description": "Plain text to be written to the clipboard.\n\nRich text, HTML, and binary content aren't supported.", "isOptional": true, "defaultValue": "''" } @@ -209809,7 +209833,7 @@ "ClipboardItemElementEvents": { "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", "name": "ClipboardItemElementEvents", - "description": "Learn more about [registering events](/docs/api/checkout-ui-extensions/latest/using-polaris-components#event-handling).", + "description": "", "isPublicDocs": true, "members": [ { @@ -209817,7 +209841,7 @@ "syntaxKind": "PropertySignature", "name": "copy", "value": "CallbackEventListener", - "description": "Callback run when the copy to clipboard succeeds.", + "description": "A callback fired when the text is successfully copied to the clipboard. Use this to show a confirmation message or update the UI.", "isOptional": true }, { @@ -209825,11 +209849,11 @@ "syntaxKind": "PropertySignature", "name": "copyerror", "value": "CallbackEventListener", - "description": "Callback run when the copy to clipboard fails.", + "description": "A callback fired when the copy to clipboard fails. Use this to display an error message or provide a fallback action.", "isOptional": true } ], - "value": "export interface ClipboardItemElementEvents {\n /**\n * Callback run when the copy to clipboard succeeds.\n */\n copy?: CallbackEventListener;\n /**\n * Callback run when the copy to clipboard fails.\n */\n copyerror?: CallbackEventListener;\n}" + "value": "export interface ClipboardItemElementEvents {\n /**\n * A callback fired when the text is successfully copied to the clipboard. Use this to show a confirmation message or update the UI.\n */\n copy?: CallbackEventListener;\n /**\n * A callback fired when the copy to clipboard fails. Use this to display an error message or provide a fallback action.\n */\n copyerror?: CallbackEventListener;\n}" }, "CallbackEventListener": { "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", @@ -209883,7 +209907,7 @@ "ConsentCheckboxElementProps": { "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", "name": "ConsentCheckboxElementProps", - "description": "Use buyer consent checkboxes for collecting the buyer’s approval for a given policy.", + "description": "", "isPublicDocs": true, "members": [ { @@ -209899,7 +209923,7 @@ "syntaxKind": "PropertySignature", "name": "checked", "value": "boolean", - "description": "Whether the control is active.", + "description": "Whether the control is currently checked.", "isOptional": true, "defaultValue": "false" }, @@ -209908,7 +209932,7 @@ "syntaxKind": "PropertySignature", "name": "command", "value": "'--auto' | '--show' | '--hide' | '--toggle'", - "description": "Sets the action the `commandFor` should take when this clickable is activated.\n\nSee the documentation of particular components for the actions they support.\n\n- `--auto`: a default action for the target component.\n- `--show`: shows the target component.\n- `--hide`: hides the target component.\n- `--toggle`: toggles the target component.\n- `--copy`: copies the target ClipboardItem.", + "description": "Sets the action the `commandFor` target should take when this component is activated.\n\n- `--auto`: Performs the default action for the target component.\n- `--show`: Displays the target component.\n- `--hide`: Conceals the target component.\n- `--toggle`: Alternates the target component.\n- `--copy`: Copies the target ClipboardItem.\n\nLearn more about the [`command` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).", "isOptional": true, "defaultValue": "'--auto'" }, @@ -209917,7 +209941,7 @@ "syntaxKind": "PropertySignature", "name": "commandFor", "value": "string", - "description": "ID of a component that should respond to activations (e.g. clicks) on this component.\n\nSee `command` for how to control the behavior of the target.", + "description": "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).\n\nWhen both `commandFor` and `href` are set, `commandFor` takes precedence. The command runs and the link doesn't navigate.", "isOptional": true }, { @@ -209925,7 +209949,7 @@ "syntaxKind": "PropertySignature", "name": "defaultChecked", "value": "boolean", - "description": "Whether the control is active by default.", + "description": "Whether the control is checked by default.", "isOptional": true, "defaultValue": "false" }, @@ -209934,7 +209958,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the control, disallowing any interaction.", + "description": "Whether the control is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -209943,7 +209967,7 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -209951,7 +209975,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -209959,7 +209983,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Visual content to use as the control label.", + "description": "The text displayed as the control label, which identifies the purpose of the control to users. This label is associated with the control for accessibility.", "isOptional": true }, { @@ -209967,15 +209991,15 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the control that is unique within the nearest containing `Form` component.", + "description": "The name attribute for the control, used to identify its value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", "syntaxKind": "PropertySignature", "name": "policy", - "value": "ConsentPolicy", - "description": "The policy for which user consent is being collected for.\n\n`sms-marketing`: Represents the policy for SMS marketing consent.", + "value": "'sms-marketing'", + "description": "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.\n\n- `sms-marketing`: Represents the policy for SMS marketing consent.", "isOptional": true }, { @@ -209987,15 +210011,7 @@ "isOptional": true } ], - "value": "export interface ConsentCheckboxElementProps extends Pick {\n command?: Extract;\n}" - }, - "ConsentPolicy": { - "filePath": "src/surfaces/checkout/components/components.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "ConsentPolicy", - "value": "\"sms-marketing\"", - "description": "", - "isPublicDocs": true + "value": "export interface ConsentCheckboxElementProps extends Pick {\n command?: Extract;\n /**\n * 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.\n *\n * - `sms-marketing`: Represents the policy for SMS marketing consent.\n */\n policy?: ConsentCheckboxProps$1['policy'];\n}" } } }, @@ -210007,7 +210023,7 @@ "ConsentCheckboxElementEvents": { "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", "name": "ConsentCheckboxElementEvents", - "description": "Learn more about [registering events](/docs/api/checkout-ui-extensions/latest/using-polaris-components#event-handling).", + "description": "", "isPublicDocs": true, "members": [ { @@ -210015,11 +210031,11 @@ "syntaxKind": "PropertySignature", "name": "change", "value": "CallbackEventListener", - "description": "A callback that is run whenever the control is changed.", + "description": "A callback fired when the consent checkbox value changes.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", "isOptional": true } ], - "value": "export interface ConsentCheckboxElementEvents {\n /**\n * A callback that is run whenever the control is changed.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event\n */\n change?: CallbackEventListener;\n}" + "value": "export interface ConsentCheckboxElementEvents {\n /**\n * A callback fired when the consent checkbox value changes.\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change?: CallbackEventListener;\n}" }, "CallbackEventListener": { "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", @@ -210073,7 +210089,7 @@ "ConsentPhoneFieldElementProps": { "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", "name": "ConsentPhoneFieldElementProps", - "description": "Display a phone field for customers to sign up for text message marketing, noting that the phone field value will be automatically saved during checkout.", + "description": "", "isPublicDocs": true, "members": [ { @@ -210081,7 +210097,7 @@ "syntaxKind": "PropertySignature", "name": "autocomplete", "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", "isOptional": true, "defaultValue": "'on' for everything else" }, @@ -210090,7 +210106,7 @@ "syntaxKind": "PropertySignature", "name": "defaultValue", "value": "string", - "description": "The default value for the field.", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces this value.", "isOptional": true }, { @@ -210098,7 +210114,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -210107,7 +210123,7 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -210115,7 +210131,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -210123,7 +210139,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Content to use as the field label.", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", "isOptional": true }, { @@ -210131,7 +210147,7 @@ "syntaxKind": "PropertySignature", "name": "labelAccessibilityVisibility", "value": "'visible' | 'exclusive'", - "description": "Changes the visibility of the component's label.\n\n- `visible`: the label is visible to all users.\n- `exclusive`: the label is visually hidden but remains in the accessibility tree.", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone.\n- `exclusive`: The label is visually hidden but still announced by screen readers.", "isOptional": true, "defaultValue": "'visible'" }, @@ -210140,7 +210156,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -210157,8 +210173,8 @@ "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", "syntaxKind": "PropertySignature", "name": "policy", - "value": "ConsentPolicy", - "description": "The policy for which user consent is being collected for.\n\n`sms-marketing`: Represents the policy for SMS marketing consent.", + "value": "'sms-marketing'", + "description": "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.\n\n- `sms-marketing`: Represents the policy for SMS marketing consent.", "isOptional": true }, { @@ -210166,7 +210182,7 @@ "syntaxKind": "PropertySignature", "name": "readOnly", "value": "boolean", - "description": "The field cannot be edited by the user. It is focusable will be announced by screen readers.", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", "isOptional": true, "defaultValue": "false" }, @@ -210184,9 +210200,9 @@ "syntaxKind": "PropertySignature", "name": "type", "value": "'mobile' | ''", - "description": "The type of number to collect.\n\nSpecific style may be applied to each type to provide extra guidance to users. Note that no extra validation is performed based on the type.", + "description": "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.\n\nStyling hint for the input keyboard. Doesn't validate the phone number format. Implement validation in your extension and use the `error` prop to show results.", "isOptional": true, - "defaultValue": "'' meaning no specific kind of phone number" + "defaultValue": "''" }, { "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", @@ -210197,7 +210213,7 @@ "isOptional": true } ], - "value": "export interface ConsentPhoneFieldElementProps extends Pick {\n /**\n * @deprecated Use `label` instead.\n * @private\n */\n placeholder?: string;\n}" + "value": "export interface ConsentPhoneFieldElementProps extends Pick {\n /**\n * @deprecated Use `label` instead.\n * @private\n */\n placeholder?: string;\n /**\n * 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.\n *\n * - `sms-marketing`: Represents the policy for SMS marketing consent.\n */\n policy?: ConsentPhoneFieldProps$1['policy'];\n}" }, "AutocompleteSection": { "filePath": "src/surfaces/checkout/components/components.ts", @@ -210214,14 +210230,6 @@ "value": "\"shipping\" | \"billing\"", "description": "The contact information group the autocomplete data should be sourced from.", "isPublicDocs": true - }, - "ConsentPolicy": { - "filePath": "src/surfaces/checkout/components/components.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "ConsentPolicy", - "value": "\"sms-marketing\"", - "description": "", - "isPublicDocs": true } } }, @@ -210233,7 +210241,7 @@ "ConsentPhoneFieldElementEvents": { "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", "name": "ConsentPhoneFieldElementEvents", - "description": "Learn more about [registering events](/docs/api/checkout-ui-extensions/latest/using-polaris-components#event-handling).", + "description": "", "isPublicDocs": true, "members": [ { @@ -210241,7 +210249,7 @@ "syntaxKind": "PropertySignature", "name": "blur", "value": "CallbackEventListener", - "description": "Callback when the element loses focus.", + "description": "A callback fired when the consent phone field loses focus.\n\nLearn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", "isOptional": true }, { @@ -210249,7 +210257,7 @@ "syntaxKind": "PropertySignature", "name": "change", "value": "CallbackEventListener", - "description": "Callback when the user has **finished editing** a field, e.g. once they have blurred the field.", + "description": "A callback fired when the consent phone field value changes.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", "isOptional": true }, { @@ -210257,7 +210265,7 @@ "syntaxKind": "PropertySignature", "name": "focus", "value": "CallbackEventListener", - "description": "Callback when the element receives focus.", + "description": "A callback fired when the consent phone field receives focus.\n\nLearn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", "isOptional": true }, { @@ -210265,11 +210273,11 @@ "syntaxKind": "PropertySignature", "name": "input", "value": "CallbackEventListener", - "description": "Callback when the user makes any changes in the field.", + "description": "A callback fired when the user inputs data into the consent phone field.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).", "isOptional": true } ], - "value": "export interface ConsentPhoneFieldElementEvents {\n /**\n * Callback when the element loses focus.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event\n */\n blur?: CallbackEventListener;\n /**\n * Callback when the user has **finished editing** a field, e.g. once they have blurred the field.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event\n */\n change?: CallbackEventListener;\n /**\n * Callback when the element receives focus.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event\n */\n focus?: CallbackEventListener;\n /**\n * Callback when the user makes any changes in the field.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event\n */\n input?: CallbackEventListener;\n}" + "value": "export interface ConsentPhoneFieldElementEvents {\n /**\n * A callback fired when the consent phone field loses focus.\n *\n * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur?: CallbackEventListener;\n /**\n * A callback fired when the consent phone field value changes.\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change?: CallbackEventListener;\n /**\n * A callback fired when the consent phone field receives focus.\n *\n * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus?: CallbackEventListener;\n /**\n * A callback fired when the user inputs data into the consent phone field.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input?: CallbackEventListener;\n}" }, "CallbackEventListener": { "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", @@ -210297,7 +210305,7 @@ "ConsentPhoneFieldElementSlots": { "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", "name": "ConsentPhoneFieldElementSlots", - "description": "Learn more about [component slots](/docs/api/checkout-ui-extensions/latest/using-polaris-components#slots).", + "description": "", "isPublicDocs": true, "members": [ { @@ -210305,11 +210313,11 @@ "syntaxKind": "PropertySignature", "name": "accessory", "value": "HTMLElement", - "description": "Additional content to be displayed in the field. Commonly used to display an icon that activates a tooltip providing more information.", + "description": "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.", "isOptional": true } ], - "value": "export interface ConsentPhoneFieldElementSlots {\n /**\n * Additional content to be displayed in the field.\n * Commonly used to display an icon that activates a tooltip providing more information.\n */\n accessory?: HTMLElement;\n}" + "value": "export interface ConsentPhoneFieldElementSlots {\n /**\n * 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.\n */\n accessory?: HTMLElement;\n}" } } } @@ -210347,7 +210355,7 @@ "DateFieldElementProps": { "filePath": "src/surfaces/checkout/components/DateField.ts", "name": "DateFieldElementProps", - "description": "The date field component captures date input with a consistent interface for date selection and proper validation. Use it to collect date information in forms, scheduling interfaces, or data entry workflows.\n\nThe component supports manual text entry. For visual calendar-based selection, consider using [date picker](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/forms/date-picker).", + "description": "", "isPublicDocs": true, "members": [ { @@ -210355,7 +210363,7 @@ "syntaxKind": "PropertySignature", "name": "allow", "value": "string", - "description": "Dates that can be selected.\n\nA comma-separated list of dates, date ranges. Whitespace is allowed after commas.\n\nThe default `''` allows all dates.\n\n- Dates in `YYYY-MM-DD` format allow a single date.\n- Dates in `YYYY-MM` format allow a whole month.\n- Dates in `YYYY` format allow a whole year.\n- Ranges are expressed as `start--end`. - Ranges are inclusive.\n - If either `start` or `end` is omitted, the range is unbounded in that direction.\n - If parts of the date are omitted for `start`, they are assumed to be the minimum possible value.\n So `2024--` is equivalent to `2024-01-01--`.\n - If parts of the date are omitted for `end`, they are assumed to be the maximum possible value.\n So `--2024` is equivalent to `--2024-12-31`.\n - Whitespace is allowed either side of `--`.", + "description": "Restricts which dates the user can select. Accepts a comma-separated list of dates and date ranges. Whitespace is allowed after commas.\n\nThe default `''` allows all dates.\n\n- Dates in `YYYY-MM-DD` format allow a single date.\n- Dates in `YYYY-MM` format allow a whole month.\n- Dates in `YYYY` format allow a whole year.\n- Ranges are expressed as `start--end`. - Ranges are inclusive.\n - If either `start` or `end` is omitted, the range is unbounded in that direction.\n - If parts of the date are omitted for `start`, they are assumed to be the minimum possible value.\n So `2024--` is equivalent to `2024-01-01--`.\n - If parts of the date are omitted for `end`, they are assumed to be the maximum possible value.\n So `--2024` is equivalent to `--2024-12-31`.\n - Whitespace is allowed either side of `--`.\n\nComma-separated list of allowed dates in `YYYY-MM-DD` format.", "isOptional": true, "defaultValue": "\"\"", "examples": [ @@ -210376,7 +210384,7 @@ "syntaxKind": "PropertySignature", "name": "allowDays", "value": "string", - "description": "Days of the week that can be selected. These intersect with the result of `allow` and `disallow`.\n\nA comma-separated list of days. Whitespace is allowed after commas.\n\nThe default `''` has no effect on the result of `allow` and `disallow`.\n\nDays are `sunday`, `monday`, `tuesday`, `wednesday`, `thursday`, `friday`, `saturday`.", + "description": "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.\n\nA comma-separated list of days. Whitespace is allowed after commas.\n\nThe default `''` has no effect on the result of `allow` and `disallow`.\n\nDays are `sunday`, `monday`, `tuesday`, `wednesday`, `thursday`, `friday`, `saturday`.", "isOptional": true, "defaultValue": "\"\"", "examples": [ @@ -210397,7 +210405,7 @@ "syntaxKind": "PropertySignature", "name": "autocomplete", "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", "isOptional": true, "defaultValue": "'on' for everything else" }, @@ -210406,7 +210414,7 @@ "syntaxKind": "PropertySignature", "name": "defaultValue", "value": "string", - "description": "The default value for the field.", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces this value.", "isOptional": true }, { @@ -210422,7 +210430,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -210431,7 +210439,7 @@ "syntaxKind": "PropertySignature", "name": "disallow", "value": "string", - "description": "Dates that cannot be selected. These subtract from `allow`.\n\nA comma-separated list of dates, date ranges. Whitespace is allowed after commas.\n\nThe default `''` has no effect on `allow`.\n\n- Dates in `YYYY-MM-DD` format disallow a single date.\n- Dates in `YYYY-MM` format disallow a whole month.\n- Dates in `YYYY` format disallow a whole year.\n- Ranges are expressed as `start--end`. - Ranges are inclusive.\n - If either `start` or `end` is omitted, the range is unbounded in that direction.\n - If parts of the date are omitted for `start`, they are assumed to be the minimum possible value.\n So `2024--` is equivalent to `2024-01-01--`.\n - If parts of the date are omitted for `end`, they are assumed to be the maximum possible value.\n So `--2024` is equivalent to `--2024-12-31`.\n - Whitespace is allowed either side of `--`.", + "description": "Dates that cannot be selected. These subtract from `allow`.\n\nA comma-separated list of dates, date ranges. Whitespace is allowed after commas.\n\nThe default `''` has no effect on `allow`.\n\n- Dates in `YYYY-MM-DD` format disallow a single date.\n- Dates in `YYYY-MM` format disallow a whole month.\n- Dates in `YYYY` format disallow a whole year.\n- Ranges are expressed as `start--end`. - Ranges are inclusive.\n - If either `start` or `end` is omitted, the range is unbounded in that direction.\n - If parts of the date are omitted for `start`, they are assumed to be the minimum possible value.\n So `2024--` is equivalent to `2024-01-01--`.\n - If parts of the date are omitted for `end`, they are assumed to be the maximum possible value.\n So `--2024` is equivalent to `--2024-12-31`.\n - Whitespace is allowed either side of `--`.\n\nComma-separated list of disallowed dates in `YYYY-MM-DD` format.", "isOptional": true, "defaultValue": "\"\"", "examples": [ @@ -210473,7 +210481,7 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -210481,7 +210489,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -210489,7 +210497,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Content to use as the field label.", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", "isOptional": true }, { @@ -210497,7 +210505,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -210515,7 +210523,7 @@ "syntaxKind": "PropertySignature", "name": "readOnly", "value": "boolean", - "description": "The field cannot be edited by the user. It is focusable will be announced by screen readers.", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", "isOptional": true, "defaultValue": "false" }, @@ -210573,7 +210581,7 @@ "DateFieldElementEvents": { "filePath": "src/surfaces/checkout/components/DateField.ts", "name": "DateFieldElementEvents", - "description": "Learn more about [registering events](/docs/api/checkout-ui-extensions/latest/using-polaris-components#event-handling).", + "description": "", "isPublicDocs": true, "members": [ { @@ -210581,7 +210589,7 @@ "syntaxKind": "PropertySignature", "name": "blur", "value": "CallbackEventListener", - "description": "Callback when the element loses focus.", + "description": "A callback fired when the date field loses focus.\n\nLearn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", "isOptional": true }, { @@ -210589,7 +210597,7 @@ "syntaxKind": "PropertySignature", "name": "change", "value": "CallbackEventListener", - "description": "Callback when the user has **finished editing** a field, e.g. once they have blurred the field.", + "description": "A callback fired when the date field value changes.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", "isOptional": true }, { @@ -210597,7 +210605,7 @@ "syntaxKind": "PropertySignature", "name": "focus", "value": "CallbackEventListener", - "description": "Callback when the element receives focus.", + "description": "A callback fired when the date field receives focus.\n\nLearn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", "isOptional": true }, { @@ -210605,7 +210613,7 @@ "syntaxKind": "PropertySignature", "name": "input", "value": "CallbackEventListener", - "description": "Callback when the user makes any changes in the field.", + "description": "A callback fired when the user inputs data into the date field.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).", "isOptional": true }, { @@ -210613,7 +210621,7 @@ "syntaxKind": "PropertySignature", "name": "invalid", "value": "CallbackEventListener", - "description": "Callback when the user enters an invalid date.", + "description": "A callback fired when the date field value is invalid.\n\nLearn more about the [invalid event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement/invalid_event).", "isOptional": true }, { @@ -210621,11 +210629,11 @@ "syntaxKind": "PropertySignature", "name": "viewChange", "value": "CallbackEventListener", - "description": "Callback when the view changes.", + "description": "A callback fired when the calendar view changes, such as when navigating between months.", "isOptional": true } ], - "value": "export interface DateFieldElementEvents {\n /**\n * Callback when the element loses focus.\n */\n blur?: CallbackEventListener;\n /**\n * Callback when the user has **finished editing** a field, e.g. once they have blurred the field.\n */\n change?: CallbackEventListener;\n /**\n * Callback when the element receives focus.\n */\n focus?: CallbackEventListener;\n /**\n * Callback when the user makes any changes in the field.\n */\n input?: CallbackEventListener;\n /**\n * Callback when the user enters an invalid date.\n */\n invalid?: CallbackEventListener;\n /**\n * Callback when the view changes.\n */\n viewChange?: CallbackEventListener;\n}" + "value": "export interface DateFieldElementEvents {\n /**\n * A callback fired when the date field loses focus.\n *\n * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur?: CallbackEventListener;\n /**\n * A callback fired when the date field value changes.\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change?: CallbackEventListener;\n /**\n * A callback fired when the date field receives focus.\n *\n * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus?: CallbackEventListener;\n /**\n * A callback fired when the user inputs data into the date field.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input?: CallbackEventListener;\n /**\n * A callback fired when the date field value is invalid.\n *\n * Learn more about the [invalid event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement/invalid_event).\n */\n invalid?: CallbackEventListener;\n /**\n * A callback fired when the calendar view changes, such as when navigating between months.\n */\n viewChange?: CallbackEventListener;\n}" }, "CallbackEventListener": { "filePath": "src/surfaces/checkout/components/DateField.ts", @@ -210679,7 +210687,7 @@ "DatePickerElementProps": { "filePath": "src/surfaces/checkout/components/DatePicker.ts", "name": "DatePickerElementProps", - "description": "The date picker component allows merchants to select dates using a calendar interface. Use it when merchants benefit from seeing dates in context of the full month, such as selecting dates relative to today or needing weekday context.\n\nThe component supports single dates, multiple dates, and date ranges. For text date entry, use [date field](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/forms/date-field).", + "description": "", "isPublicDocs": true, "members": [ { @@ -210687,7 +210695,7 @@ "syntaxKind": "PropertySignature", "name": "allow", "value": "string", - "description": "Dates that can be selected.\n\nA comma-separated list of dates, date ranges. Whitespace is allowed after commas.\n\nThe default `''` allows all dates.\n\n- Dates in `YYYY-MM-DD` format allow a single date.\n- Dates in `YYYY-MM` format allow a whole month.\n- Dates in `YYYY` format allow a whole year.\n- Ranges are expressed as `start--end`. - Ranges are inclusive.\n - If either `start` or `end` is omitted, the range is unbounded in that direction.\n - If parts of the date are omitted for `start`, they are assumed to be the minimum possible value.\n So `2024--` is equivalent to `2024-01-01--`.\n - If parts of the date are omitted for `end`, they are assumed to be the maximum possible value.\n So `--2024` is equivalent to `--2024-12-31`.\n - Whitespace is allowed either side of `--`.", + "description": "Restricts which dates the user can select. Accepts a comma-separated list of dates and date ranges. Whitespace is allowed after commas.\n\nThe default `''` allows all dates.\n\n- Dates in `YYYY-MM-DD` format allow a single date.\n- Dates in `YYYY-MM` format allow a whole month.\n- Dates in `YYYY` format allow a whole year.\n- Ranges are expressed as `start--end`. - Ranges are inclusive.\n - If either `start` or `end` is omitted, the range is unbounded in that direction.\n - If parts of the date are omitted for `start`, they are assumed to be the minimum possible value.\n So `2024--` is equivalent to `2024-01-01--`.\n - If parts of the date are omitted for `end`, they are assumed to be the maximum possible value.\n So `--2024` is equivalent to `--2024-12-31`.\n - Whitespace is allowed either side of `--`.\n\nComma-separated list of allowed dates in `YYYY-MM-DD` format.", "isOptional": true, "defaultValue": "\"\"", "examples": [ @@ -210708,7 +210716,7 @@ "syntaxKind": "PropertySignature", "name": "allowDays", "value": "string", - "description": "Days of the week that can be selected. These intersect with the result of `allow` and `disallow`.\n\nA comma-separated list of days. Whitespace is allowed after commas.\n\nThe default `''` has no effect on the result of `allow` and `disallow`.\n\nDays are `sunday`, `monday`, `tuesday`, `wednesday`, `thursday`, `friday`, `saturday`.", + "description": "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.\n\nA comma-separated list of days. Whitespace is allowed after commas.\n\nThe default `''` has no effect on the result of `allow` and `disallow`.\n\nDays are `sunday`, `monday`, `tuesday`, `wednesday`, `thursday`, `friday`, `saturday`.", "isOptional": true, "defaultValue": "\"\"", "examples": [ @@ -210746,7 +210754,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -210755,7 +210763,7 @@ "syntaxKind": "PropertySignature", "name": "disallow", "value": "string", - "description": "Dates that cannot be selected. These subtract from `allow`.\n\nA comma-separated list of dates, date ranges. Whitespace is allowed after commas.\n\nThe default `''` has no effect on `allow`.\n\n- Dates in `YYYY-MM-DD` format disallow a single date.\n- Dates in `YYYY-MM` format disallow a whole month.\n- Dates in `YYYY` format disallow a whole year.\n- Ranges are expressed as `start--end`. - Ranges are inclusive.\n - If either `start` or `end` is omitted, the range is unbounded in that direction.\n - If parts of the date are omitted for `start`, they are assumed to be the minimum possible value.\n So `2024--` is equivalent to `2024-01-01--`.\n - If parts of the date are omitted for `end`, they are assumed to be the maximum possible value.\n So `--2024` is equivalent to `--2024-12-31`.\n - Whitespace is allowed either side of `--`.", + "description": "Dates that cannot be selected. These subtract from `allow`.\n\nA comma-separated list of dates, date ranges. Whitespace is allowed after commas.\n\nThe default `''` has no effect on `allow`.\n\n- Dates in `YYYY-MM-DD` format disallow a single date.\n- Dates in `YYYY-MM` format disallow a whole month.\n- Dates in `YYYY` format disallow a whole year.\n- Ranges are expressed as `start--end`. - Ranges are inclusive.\n - If either `start` or `end` is omitted, the range is unbounded in that direction.\n - If parts of the date are omitted for `start`, they are assumed to be the minimum possible value.\n So `2024--` is equivalent to `2024-01-01--`.\n - If parts of the date are omitted for `end`, they are assumed to be the maximum possible value.\n So `--2024` is equivalent to `--2024-12-31`.\n - Whitespace is allowed either side of `--`.\n\nComma-separated list of disallowed dates in `YYYY-MM-DD` format.", "isOptional": true, "defaultValue": "\"\"", "examples": [ @@ -210797,7 +210805,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -210805,7 +210813,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -210822,7 +210830,7 @@ "syntaxKind": "PropertySignature", "name": "value", "value": "string", - "description": "Current selected value.\n\nThe default means no date is selected.\n\nIf the provided value is invalid, no date is selected.\n\nOtherwise:\n\n- If `type=\"single\"`, this is a date in `YYYY-MM-DD` format.\n- If `type=\"multiple\"`, this is a comma-separated list of dates in `YYYY-MM-DD` format.\n- If `type=\"range\"`, this is a range in `YYYY-MM-DD--YYYY-MM-DD` format. The range is inclusive.", + "description": "Current selected value.\n\nThe default means no date is selected.\n\nIf the provided value is invalid, no date is selected.\n\nOtherwise:\n\n- If `type=\"single\"`, this is a date in `YYYY-MM-DD` format.\n- If `type=\"multiple\"`, this is a comma-separated list of dates in `YYYY-MM-DD` format.\n- If `type=\"range\"`, this is a range in `YYYY-MM-DD--YYYY-MM-DD` format. The range is inclusive.\n\nSingle dates use ISO 8601 format (`YYYY-MM-DD`); ranges use `YYYY-MM-DD--YYYY-MM-DD`. Locale-specific formats aren't supported.", "isOptional": true, "defaultValue": "\"\"" }, @@ -210847,7 +210855,7 @@ "DatePickerElementEvents": { "filePath": "src/surfaces/checkout/components/DatePicker.ts", "name": "DatePickerElementEvents", - "description": "Learn more about [registering events](/docs/api/checkout-ui-extensions/latest/using-polaris-components#event-handling).", + "description": "", "isPublicDocs": true, "members": [ { @@ -210855,7 +210863,7 @@ "syntaxKind": "PropertySignature", "name": "blur", "value": "CallbackEventListener", - "description": "Callback when the element loses focus.", + "description": "A callback fired when the date picker loses focus.\n\nLearn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", "isOptional": true }, { @@ -210863,7 +210871,7 @@ "syntaxKind": "PropertySignature", "name": "change", "value": "CallbackEventListener", - "description": "Callback when the user has **finished editing** a field, e.g. once they have blurred the field.", + "description": "A callback fired when the date picker value changes.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", "isOptional": true }, { @@ -210871,7 +210879,7 @@ "syntaxKind": "PropertySignature", "name": "focus", "value": "CallbackEventListener", - "description": "Callback when the element receives focus.", + "description": "A callback fired when the date picker receives focus.\n\nLearn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", "isOptional": true }, { @@ -210879,7 +210887,7 @@ "syntaxKind": "PropertySignature", "name": "input", "value": "CallbackEventListener", - "description": "Callback when the user makes any changes in the field.", + "description": "A callback fired when the user inputs data into the date picker.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).", "isOptional": true }, { @@ -210887,11 +210895,11 @@ "syntaxKind": "PropertySignature", "name": "viewChange", "value": "CallbackEventListener", - "description": "Callback when the view changes.", + "description": "A callback fired when the calendar view changes, such as when navigating between months.", "isOptional": true } ], - "value": "export interface DatePickerElementEvents {\n /**\n * Callback when the element loses focus.\n */\n blur?: CallbackEventListener;\n /**\n * Callback when the user has **finished editing** a field, e.g. once they have blurred the field.\n */\n change?: CallbackEventListener;\n /**\n * Callback when the element receives focus.\n */\n focus?: CallbackEventListener;\n /**\n * Callback when the user makes any changes in the field.\n */\n input?: CallbackEventListener;\n /**\n * Callback when the view changes.\n */\n viewChange?: CallbackEventListener;\n}" + "value": "export interface DatePickerElementEvents {\n /**\n * A callback fired when the date picker loses focus.\n *\n * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur?: CallbackEventListener;\n /**\n * A callback fired when the date picker value changes.\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change?: CallbackEventListener;\n /**\n * A callback fired when the date picker receives focus.\n *\n * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus?: CallbackEventListener;\n /**\n * A callback fired when the user inputs data into the date picker.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input?: CallbackEventListener;\n /**\n * A callback fired when the calendar view changes, such as when navigating between months.\n */\n viewChange?: CallbackEventListener;\n}" }, "CallbackEventListener": { "filePath": "src/surfaces/checkout/components/DatePicker.ts", @@ -210945,7 +210953,7 @@ "DetailsElementProps": { "filePath": "src/surfaces/checkout/components/Details.ts", "name": "DetailsElementProps", - "description": "Creates a collapsible content area that can be expanded or collapsed by users. Use with Summary to provide expandable sections for additional information or settings.", + "description": "", "isPublicDocs": true, "members": [ { @@ -210953,7 +210961,7 @@ "syntaxKind": "PropertySignature", "name": "defaultOpen", "value": "boolean", - "description": "Indicates whether the element should be open by default.\n\nThis reflects to the `open` attribute.", + "description": "Whether the element should be open when it first renders. This reflects to the `open` attribute and only takes effect on the initial render.", "isOptional": true, "defaultValue": "false" }, @@ -210962,7 +210970,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -210970,7 +210978,7 @@ "syntaxKind": "PropertySignature", "name": "open", "value": "boolean", - "description": "Whether the element is open.\n\nThis does not reflect to any attribute.", + "description": "Whether the element is currently open. Use this for controlled component patterns where your application manages the open state directly. This does not reflect to any attribute.", "isOptional": true, "defaultValue": "false" }, @@ -210979,7 +210987,7 @@ "syntaxKind": "PropertySignature", "name": "toggleTransition", "value": "'none' | 'auto'", - "description": "Sets the transition between the two states.", + "description": "The transition style used when toggling between open and closed states.\n\n- `none`: Switches states immediately without animation.\n- `auto`: Uses the default animated transition.", "isOptional": true, "defaultValue": "'auto'" } @@ -210996,7 +211004,7 @@ "DetailsElementEvents": { "filePath": "src/surfaces/checkout/components/Details.ts", "name": "DetailsElementEvents", - "description": "Learn more about [registering events](/docs/api/checkout-ui-extensions/latest/using-polaris-components#event-handling).", + "description": "", "isPublicDocs": true, "members": [ { @@ -211004,7 +211012,7 @@ "syntaxKind": "PropertySignature", "name": "aftertoggle", "value": "CallbackEventListener", - "description": "Callback fired when the element state changes **after** any animations have finished.\n\n- If the element transitioned from hidden to showing, the `oldState` property will be set to `closed` and the `newState` property will be set to `open`.\n- If the element transitioned from showing to hidden, the `oldState` property will be set to `open` and the `newState` will be `closed`.", + "description": "A callback fired when the element state changes, after any toggle animations have finished.\n\n- If the element transitioned from hidden to showing, the `oldState` property will be set to `closed` and the `newState` property will be set to `open`.\n- If the element transitioned from showing to hidden, the `oldState` property will be set to `open` and the `newState` will be `closed`.\n\nLearn more about 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.", "isOptional": true }, { @@ -211012,11 +211020,11 @@ "syntaxKind": "PropertySignature", "name": "toggle", "value": "CallbackEventListener", - "description": "Callback straight after the element state changes.\n\n- If the element is transitioning from hidden to showing, the `oldState` property will be set to `closed` and the `newState` property will be set to `open`.\n- If the element is transitioning from showing to hidden, then `oldState` property will be set to `open` and the `newState` will be `closed`.", + "description": "A callback fired immediately when the element state changes, before any animations.\n\n- If the element is transitioning from hidden to showing, the `oldState` property will be set to `closed` and the `newState` property will be set to `open`.\n- If the element is transitioning from showing to hidden, then the `oldState` property will be set to `open` and the `newState` will be `closed`.\n\nLearn 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.", "isOptional": true } ], - "value": "export interface DetailsElementEvents {\n /**\n * Callback straight after the element state changes.\n *\n * - If the element is transitioning from hidden to showing, the `oldState` property will be set to `closed` and the\n * `newState` property will be set to `open`.\n * - If the element is transitioning from showing to hidden, then `oldState` property will be set to `open` and the\n * `newState` will be `closed`.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/toggle_event\n * @see https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/newState\n * @see https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/oldState\n */\n toggle?: CallbackEventListener;\n /**\n * Callback fired when the element state changes **after** any animations have finished.\n *\n * - If the element transitioned from hidden to showing, the `oldState` property will be set to `closed` and the\n * `newState` property will be set to `open`.\n * - If the element transitioned from showing to hidden, the `oldState` property will be set to `open` and the\n * `newState` will be `closed`.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/newState\n * @see https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/oldState\n */\n aftertoggle?: CallbackEventListener;\n}" + "value": "export interface DetailsElementEvents {\n /**\n * A callback fired immediately when the element state changes, before any animations.\n *\n * - If the element is transitioning from hidden to showing, the `oldState` property will be set to `closed` and the\n * `newState` property will be set to `open`.\n * - If the element is transitioning from showing to hidden, then the `oldState` property will be set to `open` and the\n * `newState` will be `closed`.\n *\n * 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.\n */\n toggle?: CallbackEventListener;\n /**\n * A callback fired when the element state changes, after any toggle animations have finished.\n *\n * - If the element transitioned from hidden to showing, the `oldState` property will be set to `closed` and the\n * `newState` property will be set to `open`.\n * - If the element transitioned from showing to hidden, the `oldState` property will be set to `open` and the\n * `newState` will be `closed`.\n *\n * Learn more about 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.\n */\n aftertoggle?: CallbackEventListener;\n}" }, "CallbackEventListener": { "filePath": "src/surfaces/checkout/components/Details.ts", @@ -211077,7 +211085,7 @@ "SummaryElementProps": { "filePath": "src/surfaces/checkout/components/Summary.ts", "name": "SummaryElementProps", - "description": "Provides a clickable label for collapsible Details content. Use to create clear, accessible disclosure controls that show or hide additional information.", + "description": "", "isPublicDocs": true, "members": [ { @@ -211085,7 +211093,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true } ], @@ -211127,7 +211135,7 @@ "DividerElementProps": { "filePath": "src/surfaces/checkout/components/Divider.ts", "name": "DividerElementProps", - "description": "The divider component creates clear visual separation between elements in the interface. Use divider to separate distinct content groups in forms, settings panels, lists, or page sections, helping users scan and understand content organization.\n\nDividers support both horizontal and vertical orientations, along with different visual strengths for varying levels of emphasis. For more structured content grouping with headings, use [section](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/layout-and-structure/section).", + "description": "", "isPublicDocs": true, "members": [ { @@ -211135,7 +211143,7 @@ "syntaxKind": "PropertySignature", "name": "direction", "value": "'inline' | 'block'", - "description": "Specify the direction of the divider. This uses [logical properties](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_logical_properties_and_values).", + "description": "Specify the direction of the divider. This uses [logical properties](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_logical_properties_and_values).\n\nVertical dividers (`'block'` direction) require a parent with a defined height to render visibly.", "isOptional": true, "defaultValue": "'inline'" }, @@ -211144,7 +211152,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true } ], @@ -211186,7 +211194,7 @@ "DropZoneElementProps": { "filePath": "src/surfaces/checkout/components/DropZone.ts", "name": "DropZoneElementProps", - "description": "The drop zone component lets users upload files through drag-and-drop or by clicking to browse. Use for file uploads such as images, documents, or CSV imports.\n\nThe component provides visual feedback during drag operations and supports file type validation through the `accept` property. Rejected files trigger the `droprejected` event for custom error handling.", + "description": "", "isPublicDocs": true, "members": [ { @@ -211194,7 +211202,7 @@ "syntaxKind": "PropertySignature", "name": "accept", "value": "string", - "description": "A string representing the types of files that are accepted by the drop zone. This string is a comma-separated list of unique file type specifiers which can be one of the following:\n- A file extension starting with a period (\".\") character (e.g. .jpg, .pdf, .doc)\n- A valid MIME type string with no extensions\n\nIf omitted, all file types are accepted.", + "description": "A string representing the types of files that are accepted by the drop zone. This string is a comma-separated list of unique file type specifiers which can be one of the following:\n- A file extension starting with a period (\".\") character (such as .jpg, .pdf, .doc)\n- A valid MIME type string with no extensions\n\nIf omitted, all file types are accepted.", "isOptional": true, "defaultValue": "''" }, @@ -211211,7 +211219,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -211220,7 +211228,7 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -211228,7 +211236,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -211236,7 +211244,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Content to use as the field label.", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", "isOptional": true }, { @@ -211253,7 +211261,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -211287,7 +211295,7 @@ "DropZoneElementEvents": { "filePath": "src/surfaces/checkout/components/DropZone.ts", "name": "DropZoneElementEvents", - "description": "Learn more about [registering events](/docs/api/checkout-ui-extensions/latest/using-polaris-components#event-handling).", + "description": "", "isPublicDocs": true, "members": [ { @@ -211295,7 +211303,7 @@ "syntaxKind": "PropertySignature", "name": "change", "value": "CallbackEventListener", - "description": "Callback when the user has finished selecting a file or files.", + "description": "A callback fired when the drop zone value changes.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", "isOptional": true }, { @@ -211303,7 +211311,7 @@ "syntaxKind": "PropertySignature", "name": "droprejected", "value": "CallbackEventListener", - "description": "Callback when rejected files are dropped. Files are rejected based on the `accept` prop.", + "description": "A callback fired when files are rejected based on the `accept` prop.", "isOptional": true }, { @@ -211311,11 +211319,11 @@ "syntaxKind": "PropertySignature", "name": "input", "value": "CallbackEventListener", - "description": "Callback when the user makes any changes in the field.", + "description": "A callback fired when the user inputs data into the drop zone.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).", "isOptional": true } ], - "value": "export interface DropZoneElementEvents {\n /**\n * Callback when rejected files are dropped. Files are rejected based on the `accept` prop.\n */\n droprejected?: CallbackEventListener;\n /**\n * Callback when the user makes any changes in the field.\n */\n input?: CallbackEventListener;\n /**\n * Callback when the user has finished selecting a file or files.\n */\n change?: CallbackEventListener;\n}" + "value": "export interface DropZoneElementEvents {\n /**\n * A callback fired when files are rejected based on the `accept` prop.\n */\n droprejected?: CallbackEventListener;\n /**\n * A callback fired when the user inputs data into the drop zone.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input?: CallbackEventListener;\n /**\n * A callback fired when the drop zone value changes.\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change?: CallbackEventListener;\n}" }, "CallbackEventListener": { "filePath": "src/surfaces/checkout/components/DropZone.ts", @@ -211376,7 +211384,7 @@ "EmailFieldElementProps": { "filePath": "src/surfaces/checkout/components/EmailField.ts", "name": "EmailFieldElementProps", - "description": "The email field component captures email address input. Use it to collect email information in forms, customer profiles, or contact workflows.\n\nEmail field doesn't perform automatic email validation. Implement your own validation logic, and use the `error` property to display validation results. For general text input, use [text field](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/forms/text-field).", + "description": "", "isPublicDocs": true, "members": [ { @@ -211384,7 +211392,7 @@ "syntaxKind": "PropertySignature", "name": "autocomplete", "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", "isOptional": true, "defaultValue": "'on' for everything else" }, @@ -211393,7 +211401,7 @@ "syntaxKind": "PropertySignature", "name": "defaultValue", "value": "string", - "description": "The default value for the field.", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces this value.", "isOptional": true }, { @@ -211401,7 +211409,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -211410,7 +211418,7 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -211418,7 +211426,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -211426,7 +211434,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Content to use as the field label.", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", "isOptional": true }, { @@ -211434,7 +211442,7 @@ "syntaxKind": "PropertySignature", "name": "labelAccessibilityVisibility", "value": "'visible' | 'exclusive'", - "description": "Changes the visibility of the component's label.\n\n- `visible`: the label is visible to all users.\n- `exclusive`: the label is visually hidden but remains in the accessibility tree.", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone.\n- `exclusive`: The label is visually hidden but still announced by screen readers.", "isOptional": true, "defaultValue": "'visible'" }, @@ -211452,7 +211460,7 @@ "syntaxKind": "PropertySignature", "name": "minLength", "value": "number", - "description": "Specifies the min number of characters allowed.", + "description": "Specifies the minimum number of characters allowed.", "isOptional": true, "defaultValue": "0" }, @@ -211461,7 +211469,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -211479,7 +211487,7 @@ "syntaxKind": "PropertySignature", "name": "readOnly", "value": "boolean", - "description": "The field cannot be edited by the user. It is focusable will be announced by screen readers.", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", "isOptional": true, "defaultValue": "false" }, @@ -211529,7 +211537,7 @@ "EmailFieldElementEvents": { "filePath": "src/surfaces/checkout/components/EmailField.ts", "name": "EmailFieldElementEvents", - "description": "Learn more about [registering events](/docs/api/checkout-ui-extensions/latest/using-polaris-components#event-handling).", + "description": "", "isPublicDocs": true, "members": [ { @@ -211537,7 +211545,7 @@ "syntaxKind": "PropertySignature", "name": "blur", "value": "CallbackEventListener", - "description": "Callback when the element loses focus.", + "description": "<<<<<<< HEAD A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n======= A callback fired when the email field loses focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) \n Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", "isOptional": true }, { @@ -211545,7 +211553,7 @@ "syntaxKind": "PropertySignature", "name": "change", "value": "CallbackEventListener", - "description": "Callback when the user has **finished editing** a field, e.g. once they have blurred the field.", + "description": "<<<<<<< HEAD Callback when the user has **finished editing** a field, for example, once they have blurred the field.\n======= A callback fired when the email field value changes.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) \n Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", "isOptional": true }, { @@ -211553,7 +211561,7 @@ "syntaxKind": "PropertySignature", "name": "focus", "value": "CallbackEventListener", - "description": "Callback when the element receives focus.", + "description": "<<<<<<< HEAD A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n======= A callback fired when the email field receives focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) \n Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", "isOptional": true }, { @@ -211561,11 +211569,11 @@ "syntaxKind": "PropertySignature", "name": "input", "value": "CallbackEventListener", - "description": "Callback when the user makes any changes in the field.", + "description": "A callback fired when the user inputs data into the email field.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).", "isOptional": true } ], - "value": "export interface EmailFieldElementEvents {\n /**\n * Callback when the element loses focus.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event\n */\n blur?: CallbackEventListener;\n /**\n * Callback when the user has **finished editing** a field, e.g. once they have blurred the field.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event\n */\n change?: CallbackEventListener;\n /**\n * Callback when the element receives focus.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event\n */\n focus?: CallbackEventListener;\n /**\n * Callback when the user makes any changes in the field.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event\n */\n input?: CallbackEventListener;\n}" + "value": "export interface EmailFieldElementEvents {\n /**\n<<<<<<< HEAD\n * A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n=======\n * A callback fired when the email field loses focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality)\n *\n * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur?: CallbackEventListener;\n /**\n<<<<<<< HEAD\n * Callback when the user has **finished editing** a field, for example, once they have blurred the field.\n=======\n * A callback fired when the email field value changes.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality)\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change?: CallbackEventListener;\n /**\n<<<<<<< HEAD\n * A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n=======\n * A callback fired when the email field receives focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality)\n *\n * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus?: CallbackEventListener;\n /**\n * A callback fired when the user inputs data into the email field.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input?: CallbackEventListener;\n}" }, "CallbackEventListener": { "filePath": "src/surfaces/checkout/components/EmailField.ts", @@ -211593,7 +211601,7 @@ "EmailFieldElementSlots": { "filePath": "src/surfaces/checkout/components/EmailField.ts", "name": "EmailFieldElementSlots", - "description": "Learn more about [component slots](/docs/api/checkout-ui-extensions/latest/using-polaris-components#slots).", + "description": "", "isPublicDocs": true, "members": [ { @@ -211601,11 +211609,11 @@ "syntaxKind": "PropertySignature", "name": "accessory", "value": "HTMLElement", - "description": "Additional content to be displayed in the field. Commonly used to display an icon that activates a tooltip providing more information.", + "description": "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.", "isOptional": true } ], - "value": "export interface EmailFieldElementSlots {\n /**\n * Additional content to be displayed in the field.\n * Commonly used to display an icon that activates a tooltip providing more information.\n */\n accessory?: HTMLElement;\n}" + "value": "export interface EmailFieldElementSlots {\n /**\n * 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.\n */\n accessory?: HTMLElement;\n}" } } } @@ -211643,7 +211651,7 @@ "FormElementProps": { "filePath": "src/surfaces/checkout/components/Form.ts", "name": "FormElementProps", - "description": "The form component wraps form controls and enables implicit submission, allowing users to submit from any input by pressing **Enter**. Use form to group related input fields and handle form submission through JavaScript event handlers.\n\nUnlike HTML forms, form doesn't automatically submit data using HTTP—you must register a `submit` event to process form data programmatically. For Shopify Functions configuration forms, use [function settings](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/forms/function-settings).", + "description": "", "isPublicDocs": true, "members": [ { @@ -211662,7 +211670,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true } ], @@ -211678,7 +211686,7 @@ "FormElementEvents": { "filePath": "src/surfaces/checkout/components/Form.ts", "name": "FormElementEvents", - "description": "Learn more about [registering events](/docs/api/checkout-ui-extensions/latest/using-polaris-components#event-handling).", + "description": "", "isPublicDocs": true, "members": [ { @@ -211686,11 +211694,11 @@ "syntaxKind": "PropertySignature", "name": "submit", "value": "CallbackEventListener", - "description": "A callback that is run when the form is submitted.", + "description": "A callback fired when the form is submitted.", "isOptional": true } ], - "value": "export interface FormElementEvents {\n /**\n * A callback that is run when the form is submitted.\n */\n submit?: CallbackEventListener;\n}" + "value": "export interface FormElementEvents {\n /**\n * A callback fired when the form is submitted.\n */\n submit?: CallbackEventListener;\n}" }, "CallbackEventListener": { "filePath": "src/surfaces/checkout/components/Form.ts", @@ -211751,7 +211759,7 @@ "GridElementProps": { "filePath": "src/surfaces/checkout/components/Grid.ts", "name": "GridElementProps", - "description": "The grid component organizes content in a matrix of rows and columns to create responsive page layouts. Use grid to build complex, multi-column layouts that adapt to different screen sizes and maintain consistent alignment.\n\nGrid follows the CSS grid layout pattern and supports flexible column configurations, gap spacing, and alignment properties for precise layout control. For simpler linear layouts (horizontal or vertical), use [stack](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/layout-and-structure/stack).", + "description": "", "isPublicDocs": true, "members": [ { @@ -211776,7 +211784,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityVisibility", "value": "'visible' | 'hidden' | 'exclusive'", - "description": "Changes the visibility of the element.\n\n- `visible`: the element is visible to all users.\n- `hidden`: the element is removed from the accessibility tree but remains visible.\n- `exclusive`: the element is visually hidden but remains in the accessibility tree.", + "description": "Controls how the element is exposed to sighted users and to assistive technologies such as screen readers.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", "isOptional": true, "defaultValue": "'visible'" }, @@ -211785,7 +211793,7 @@ "syntaxKind": "PropertySignature", "name": "alignContent", "value": "MaybeResponsive", - "description": "Aligns the grid along the block (column) axis.\n\nThis overrides the block value of `placeContent`.", + "description": "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.", "isOptional": true, "defaultValue": "'' - meaning no override" }, @@ -211794,7 +211802,7 @@ "syntaxKind": "PropertySignature", "name": "alignItems", "value": "MaybeResponsive", - "description": "Aligns the grid items along the block (column) axis.\n\nThis overrides the block value of `placeItems`.", + "description": "Aligns grid items along the block (column) axis. Set to an empty string to use the default.", "isOptional": true, "defaultValue": "'' - meaning no override" }, @@ -211803,7 +211811,7 @@ "syntaxKind": "PropertySignature", "name": "background", "value": "'base' | 'subdued' | 'transparent'", - "description": "Adjust the background of the element.", + "description": "The background color of the grid.\n\n- `base`: The standard background color for general content areas.\n- `subdued`: A muted background for secondary or supporting content.\n- `transparent`: No background color (the default).", "isOptional": true, "defaultValue": "'transparent'" }, @@ -211821,9 +211829,9 @@ "syntaxKind": "PropertySignature", "name": "border", "value": "BorderShorthand", - "description": "Applies a border using shorthand syntax to specify width, color, and style in a single property.\n\nAccepts a size value, optionally followed by a color, optionally followed by a style. Omitted values use defaults: color defaults to `base`, style defaults to `auto`.\n\nIndividual properties (`borderWidth`, `borderStyle`, `borderColor`) can override values set here.", + "description": "A shorthand for setting the border width, color, and style in a single property. Individual border properties (`borderWidth`, `borderStyle`, `borderColor`) can override values set here.", "isOptional": true, - "defaultValue": "'none' - equivalent to `none base auto`.", + "defaultValue": "'none'", "examples": [ { "title": "Example", @@ -211842,7 +211850,7 @@ "syntaxKind": "PropertySignature", "name": "borderColor", "value": "'' | 'base'", - "description": "Controls the color of the border using the design system's color scale.\n\nWhen set, this overrides the color value specified in the `border` property. Choose from `subdued`, `base`, or `strong` to match the visual emphasis needed.", + "description": "The color of the border using the design system's color scale. Overrides the color value set by `border`.", "isOptional": true, "defaultValue": "'' - meaning no override" }, @@ -211851,7 +211859,7 @@ "syntaxKind": "PropertySignature", "name": "borderRadius", "value": "MaybeAllValuesShorthandProperty>", - "description": "Controls the roundedness of the element's corners using the design system's radius scale.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) using flow-relative values:\n- One value: applies to all corners\n- Two values: applies to start corners (top-left & bottom-right) and end corners (top-right & bottom-left) respectively\n- Three values: applies to start-start (top-left), end corners (top-right & bottom-left), and end-end (bottom-right) respectively\n- Four values: applies to start-start (top-left), start-end (top-right), end-end (bottom-right), and end-start (bottom-left) respectively\n\nExamples:\n- `small-100`: All corners have `small-100` radius\n- `small-100 none`: Top-left and bottom-right are `small-100`, top-right and bottom-left are `none`\n- `small-100 none large-100`: Top-left is `small-100`, top-right and bottom-left are `none`, bottom-right is `large-100`\n- `small-100 none large-100 base`: Each corner has its specified radius value", + "description": "The roundedness of the grid's corners.\n\n- `none`: Sharp corners with no rounding.\n- `small-100` / `small`: Subtle rounding for compact elements.\n- `base`: Standard rounding for most use cases.\n- `large` / `large-100`: More pronounced rounding for prominent containers.\n- `max`: Maximum rounding, creating a pill or circular shape.\n\nSupports 1-to-4-value shorthand syntax for specifying different radii per corner.", "isOptional": true, "defaultValue": "'none'" }, @@ -211869,7 +211877,7 @@ "syntaxKind": "PropertySignature", "name": "borderWidth", "value": "MaybeAllValuesShorthandProperty | ''", - "description": "Controls the thickness of the border on all sides. When set, this overrides the width value specified in the `border` property.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) for specifying different widths per side:\n- One value: applies to all sides\n- Two values: applies to block sides (top/bottom) and inline sides (left/right) respectively\n- Three values: applies to block-start (top), inline sides (left/right), and block-end (bottom) respectively\n- Four values: applies to block-start (top), inline-end (right), block-end (bottom), and inline-start (left) respectively", + "description": "The thickness of the border on all sides. Supports 1-to-4-value shorthand syntax for specifying different widths per side. Overrides the width value set by `border`.", "isOptional": true, "defaultValue": "'' - meaning no override" }, @@ -211887,7 +211895,7 @@ "syntaxKind": "PropertySignature", "name": "display", "value": "MaybeResponsive<\"auto\" | \"none\">", - "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.", + "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.\n\nLearn more about the [display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display).", "isOptional": true, "defaultValue": "'auto'" }, @@ -211923,7 +211931,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -211940,7 +211948,7 @@ "syntaxKind": "PropertySignature", "name": "justifyContent", "value": "MaybeResponsive", - "description": "Aligns the grid along the inline (row) axis.\n\nThis overrides the inline value of `placeContent`.", + "description": "Controls how the grid's columns are distributed along the inline (row) axis when there is extra space. Set to an empty string to use the default.", "isOptional": true, "defaultValue": "'' - meaning no override" }, @@ -211949,7 +211957,7 @@ "syntaxKind": "PropertySignature", "name": "justifyItems", "value": "MaybeResponsive", - "description": "Aligns the grid items along the inline (row) axis.\n\nThis overrides the inline value of `placeItems`.", + "description": "Aligns grid items along the inline (row) axis. Set to an empty string to use the default.", "isOptional": true, "defaultValue": "'' - meaning no override" }, @@ -212066,7 +212074,7 @@ "syntaxKind": "PropertySignature", "name": "placeContent", "value": "MaybeResponsive<`${ReducedAlignContentKeyword} ${ReducedJustifyContentKeyword}` | ReducedAlignContentKeyword>", - "description": "A shorthand property for `justify-content` and `align-content`.", + "description": "A shorthand for `justifyContent` and `alignContent` that sets both distribution axes at once.", "isOptional": true, "defaultValue": "'normal normal'" }, @@ -212075,7 +212083,7 @@ "syntaxKind": "PropertySignature", "name": "placeItems", "value": "MaybeResponsive<`${ReducedAlignItemsKeyword} ${ReducedJustifyItemsKeyword}` | ReducedAlignItemsKeyword>", - "description": "A shorthand property for `justify-items` and `align-items`.", + "description": "A shorthand for `justifyItems` and `alignItems` that sets both alignment axes at once.", "isOptional": true, "defaultValue": "'normal normal'" }, @@ -212089,14 +212097,14 @@ "defaultValue": "'' - meaning no override" } ], - "value": "export interface GridElementProps extends Pick {\n alignContent?: MaybeResponsive;\n alignItems?: MaybeResponsive;\n background?: Extract;\n border?: BorderShorthand;\n borderColor?: ReducedColorKeyword | '';\n borderWidth?: MaybeAllValuesShorthandProperty | '';\n borderRadius?: MaybeAllValuesShorthandProperty>;\n justifyContent?: MaybeResponsive;\n justifyItems?: MaybeResponsive;\n placeContent?: MaybeResponsive<`${ReducedAlignContentKeyword} ${ReducedJustifyContentKeyword}` | ReducedAlignContentKeyword>;\n placeItems?: MaybeResponsive<`${ReducedAlignItemsKeyword} ${ReducedJustifyItemsKeyword}` | ReducedAlignItemsKeyword>;\n}" + "value": "export interface GridElementProps extends Pick {\n /**\n * 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.\n *\n * @default '' - meaning no override\n */\n alignContent?: MaybeResponsive;\n /**\n * Aligns grid items along the block (column) axis. Set to an empty string to use the default.\n *\n * @default '' - meaning no override\n */\n alignItems?: MaybeResponsive;\n /**\n * The background color of the grid.\n *\n * - `base`: The standard background color for general content areas.\n * - `subdued`: A muted background for secondary or supporting content.\n * - `transparent`: No background color (the default).\n *\n * @default 'transparent'\n */\n background?: Extract;\n /**\n * A shorthand for setting the border width, color, and style in a single property. Individual border properties (`borderWidth`, `borderStyle`, `borderColor`) can override values set here.\n *\n * @default 'none'\n */\n border?: BorderShorthand;\n /**\n * The color of the border using the design system's color scale. Overrides the color value set by `border`.\n *\n * @default '' - meaning no override\n */\n borderColor?: ReducedColorKeyword | '';\n /**\n * The thickness of the border on all sides. Supports 1-to-4-value shorthand syntax for specifying different widths per side. Overrides the width value set by `border`.\n *\n * @default '' - meaning no override\n */\n borderWidth?: MaybeAllValuesShorthandProperty | '';\n /**\n * The roundedness of the grid's corners.\n *\n * - `none`: Sharp corners with no rounding.\n * - `small-100` / `small`: Subtle rounding for compact elements.\n * - `base`: Standard rounding for most use cases.\n * - `large` / `large-100`: More pronounced rounding for prominent containers.\n * - `max`: Maximum rounding, creating a pill or circular shape.\n *\n * Supports 1-to-4-value shorthand syntax for specifying different radii per corner.\n *\n * @default 'none'\n */\n borderRadius?: MaybeAllValuesShorthandProperty>;\n /**\n * Controls how the grid's columns are distributed along the inline (row) axis when there is extra space. Set to an empty string to use the default.\n *\n * @default '' - meaning no override\n */\n justifyContent?: MaybeResponsive;\n /**\n * Aligns grid items along the inline (row) axis. Set to an empty string to use the default.\n *\n * @default '' - meaning no override\n */\n justifyItems?: MaybeResponsive;\n /**\n * A shorthand for `justifyContent` and `alignContent` that sets both distribution axes at once.\n *\n * @default 'normal normal'\n */\n placeContent?: MaybeResponsive<`${ReducedAlignContentKeyword} ${ReducedJustifyContentKeyword}` | ReducedAlignContentKeyword>;\n /**\n * A shorthand for `justifyItems` and `alignItems` that sets both alignment axes at once.\n *\n * @default 'normal normal'\n */\n placeItems?: MaybeResponsive<`${ReducedAlignItemsKeyword} ${ReducedJustifyItemsKeyword}` | ReducedAlignItemsKeyword>;\n}" }, "AccessibilityRole": { "filePath": "src/surfaces/checkout/components/components.ts", "syntaxKind": "TypeAliasDeclaration", "name": "AccessibilityRole", "value": "\"main\" | \"header\" | \"footer\" | \"section\" | \"aside\" | \"navigation\" | \"ordered-list\" | \"list-item\" | \"list-item-separator\" | \"unordered-list\" | \"separator\" | \"status\" | \"alert\" | \"generic\" | \"presentation\" | \"none\"", - "description": "", + "description": "The semantic role of a component, used by assistive technologies to convey the element’s purpose to users. Each role maps to a specific HTML element or ARIA role.\n\n- `main`: The primary content of the page.\n- `header`: A page or section header.\n- `footer`: Information such as copyright, navigation links, and privacy statements.\n- `section`: A generic section that should have a heading or `accessibilityLabel`.\n- `aside`: Supporting content related to the main content.\n- `navigation`: A major group of navigation links.\n- `ordered-list`: A list of ordered items.\n- `list-item`: An item inside a list.\n- `list-item-separator`: A divider between list items.\n- `unordered-list`: A list of unordered items.\n- `separator`: A divider that separates sections of content.\n- `status`: A live region with advisory information that is not urgent.\n- `alert`: Important, usually time-sensitive information.\n- `generic`: A nameless container with no semantic meaning (renders a `
`).\n- `presentation`: Strips semantic meaning while keeping visual styling. Synonym for `none`.\n- `none`: Strips semantic meaning while keeping visual styling. Synonym for `presentation`.", "isPublicDocs": true }, "MaybeResponsive": { @@ -212112,7 +212120,7 @@ "syntaxKind": "TypeAliasDeclaration", "name": "ReducedAlignContentKeyword", "value": "'center' | 'start' | 'end' | 'normal' | 'space-between' | 'space-around' | 'space-evenly' | 'stretch'", - "description": "", + "description": "The subset of `align-content` values available for the grid component.\n\n- `center`: Packs rows toward the center of the grid.\n- `start`: Packs rows toward the start of the block axis.\n- `end`: Packs rows toward the end of the block axis.\n- `normal`: Default browser behavior.\n- `space-between`: Distributes rows evenly with no space at the edges.\n- `space-around`: Distributes rows evenly with equal space around each.\n- `space-evenly`: Distributes rows with equal space between and at the edges.\n- `stretch`: Stretches rows to fill the available space.", "isPublicDocs": true }, "ReducedAlignItemsKeyword": { @@ -212120,7 +212128,7 @@ "syntaxKind": "TypeAliasDeclaration", "name": "ReducedAlignItemsKeyword", "value": "'center' | 'start' | 'end' | 'normal' | 'baseline' | 'stretch'", - "description": "", + "description": "The subset of `align-items` values available for the grid component.\n\n- `center`: Centers items along the block axis.\n- `start`: Aligns items to the start of the block axis.\n- `end`: Aligns items to the end of the block axis.\n- `normal`: Default browser behavior.\n- `baseline`: Aligns items along their text baseline.\n- `stretch`: Stretches items to fill the cell along the block axis.", "isPublicDocs": true }, "SizeUnitsOrAuto": { @@ -212144,7 +212152,7 @@ "syntaxKind": "TypeAliasDeclaration", "name": "BorderShorthand", "value": "ReducedBorderSizeKeyword | `${ReducedBorderSizeKeyword} ${ReducedColorKeyword}` | `${ReducedBorderSizeKeyword} ${ReducedColorKeyword} ${BorderStyleKeyword}`", - "description": "", + "description": "A shorthand string for specifying border properties. Accepts a size alone (`'base'`), size with color (`'base base'`), or size with color and style (`'base base dashed'`). Omitted values use their defaults.", "isPublicDocs": true }, "ReducedBorderSizeKeyword": { @@ -212207,7 +212215,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityVisibility", "value": "'visible' | 'hidden' | 'exclusive'", - "description": "Changes the visibility of the element.\n\n- `visible`: the element is visible to all users.\n- `hidden`: the element is removed from the accessibility tree but remains visible.\n- `exclusive`: the element is visually hidden but remains in the accessibility tree.", + "description": "Controls how the element is exposed to sighted users and to assistive technologies such as screen readers.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", "isOptional": true, "defaultValue": "'visible'" }, @@ -212216,23 +212224,25 @@ "syntaxKind": "PropertySignature", "name": "alignContent", "value": "MaybeResponsive", - "description": "Aligns the grid along the block (column) axis.\n\nThis overrides the block value of `placeContent`.", - "isOptional": true + "description": "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.", + "isOptional": true, + "defaultValue": "'' - meaning no override" }, { "filePath": "src/surfaces/checkout/components/Grid.ts", "syntaxKind": "PropertySignature", "name": "alignItems", "value": "MaybeResponsive", - "description": "Aligns the grid items along the block (column) axis.\n\nThis overrides the block value of `placeItems`.", - "isOptional": true + "description": "Aligns grid items along the block (column) axis. Set to an empty string to use the default.", + "isOptional": true, + "defaultValue": "'' - meaning no override" }, { "filePath": "src/surfaces/checkout/components/Grid.ts", "syntaxKind": "PropertySignature", "name": "background", "value": "'base' | 'subdued' | 'transparent'", - "description": "Adjust the background of the element.", + "description": "The background color of the grid.\n\n- `base`: The standard background color for general content areas.\n- `subdued`: A muted background for secondary or supporting content.\n- `transparent`: No background color (the default).", "isOptional": true, "defaultValue": "'transparent'" }, @@ -212250,23 +212260,25 @@ "syntaxKind": "PropertySignature", "name": "border", "value": "BorderShorthand", - "description": "Applies a border using shorthand syntax to specify width, color, and style in a single property.\n\nAccepts a size value, optionally followed by a color, optionally followed by a style. Omitted values use defaults: color defaults to `base`, style defaults to `auto`.\n\nIndividual properties (`borderWidth`, `borderStyle`, `borderColor`) can override values set here.", - "isOptional": true + "description": "A shorthand for setting the border width, color, and style in a single property. Individual border properties (`borderWidth`, `borderStyle`, `borderColor`) can override values set here.", + "isOptional": true, + "defaultValue": "'none'" }, { "filePath": "src/surfaces/checkout/components/Grid.ts", "syntaxKind": "PropertySignature", "name": "borderColor", "value": "'' | 'base'", - "description": "Controls the color of the border using the design system's color scale.\n\nWhen set, this overrides the color value specified in the `border` property. Choose from `subdued`, `base`, or `strong` to match the visual emphasis needed.", - "isOptional": true + "description": "The color of the border using the design system's color scale. Overrides the color value set by `border`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" }, { "filePath": "src/surfaces/checkout/components/Grid.ts", "syntaxKind": "PropertySignature", "name": "borderRadius", "value": "MaybeAllValuesShorthandProperty>", - "description": "Controls the roundedness of the element's corners using the design system's radius scale.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) using flow-relative values:\n- One value: applies to all corners\n- Two values: applies to start corners (top-left & bottom-right) and end corners (top-right & bottom-left) respectively\n- Three values: applies to start-start (top-left), end corners (top-right & bottom-left), and end-end (bottom-right) respectively\n- Four values: applies to start-start (top-left), start-end (top-right), end-end (bottom-right), and end-start (bottom-left) respectively\n\nExamples:\n- `small-100`: All corners have `small-100` radius\n- `small-100 none`: Top-left and bottom-right are `small-100`, top-right and bottom-left are `none`\n- `small-100 none large-100`: Top-left is `small-100`, top-right and bottom-left are `none`, bottom-right is `large-100`\n- `small-100 none large-100 base`: Each corner has its specified radius value", + "description": "The roundedness of the grid's corners.\n\n- `none`: Sharp corners with no rounding.\n- `small-100` / `small`: Subtle rounding for compact elements.\n- `base`: Standard rounding for most use cases.\n- `large` / `large-100`: More pronounced rounding for prominent containers.\n- `max`: Maximum rounding, creating a pill or circular shape.\n\nSupports 1-to-4-value shorthand syntax for specifying different radii per corner.", "isOptional": true, "defaultValue": "'none'" }, @@ -212284,8 +212296,9 @@ "syntaxKind": "PropertySignature", "name": "borderWidth", "value": "MaybeAllValuesShorthandProperty | ''", - "description": "Controls the thickness of the border on all sides. When set, this overrides the width value specified in the `border` property.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) for specifying different widths per side:\n- One value: applies to all sides\n- Two values: applies to block sides (top/bottom) and inline sides (left/right) respectively\n- Three values: applies to block-start (top), inline sides (left/right), and block-end (bottom) respectively\n- Four values: applies to block-start (top), inline-end (right), block-end (bottom), and inline-start (left) respectively", - "isOptional": true + "description": "The thickness of the border on all sides. Supports 1-to-4-value shorthand syntax for specifying different widths per side. Overrides the width value set by `border`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" }, { "filePath": "src/surfaces/checkout/components/Grid.ts", @@ -212301,7 +212314,7 @@ "syntaxKind": "PropertySignature", "name": "display", "value": "MaybeResponsive<\"auto\" | \"none\">", - "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.", + "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.\n\nLearn more about the [display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display).", "isOptional": true, "defaultValue": "'auto'" }, @@ -212337,7 +212350,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -212354,16 +212367,18 @@ "syntaxKind": "PropertySignature", "name": "justifyContent", "value": "MaybeResponsive", - "description": "Aligns the grid along the inline (row) axis.\n\nThis overrides the inline value of `placeContent`.", - "isOptional": true + "description": "Controls how the grid's columns are distributed along the inline (row) axis when there is extra space. Set to an empty string to use the default.", + "isOptional": true, + "defaultValue": "'' - meaning no override" }, { "filePath": "src/surfaces/checkout/components/Grid.ts", "syntaxKind": "PropertySignature", "name": "justifyItems", "value": "MaybeResponsive", - "description": "Aligns the grid items along the inline (row) axis.\n\nThis overrides the inline value of `placeItems`.", - "isOptional": true + "description": "Aligns grid items along the inline (row) axis. Set to an empty string to use the default.", + "isOptional": true, + "defaultValue": "'' - meaning no override" }, { "filePath": "src/surfaces/checkout/components/Grid.ts", @@ -212478,16 +212493,18 @@ "syntaxKind": "PropertySignature", "name": "placeContent", "value": "MaybeResponsive<`${ReducedAlignContentKeyword} ${ReducedJustifyContentKeyword}` | ReducedAlignContentKeyword>", - "description": "A shorthand property for `justify-content` and `align-content`.", - "isOptional": true + "description": "A shorthand for `justifyContent` and `alignContent` that sets both distribution axes at once.", + "isOptional": true, + "defaultValue": "'normal normal'" }, { "filePath": "src/surfaces/checkout/components/Grid.ts", "syntaxKind": "PropertySignature", "name": "placeItems", "value": "MaybeResponsive<`${ReducedAlignItemsKeyword} ${ReducedJustifyItemsKeyword}` | ReducedAlignItemsKeyword>", - "description": "A shorthand property for `justify-items` and `align-items`.", - "isOptional": true + "description": "A shorthand for `justifyItems` and `alignItems` that sets both alignment axes at once.", + "isOptional": true, + "defaultValue": "'normal normal'" }, { "filePath": "src/surfaces/checkout/components/Grid.ts", @@ -212530,7 +212547,7 @@ "syntaxKind": "TypeAliasDeclaration", "name": "ReducedJustifyContentKeyword", "value": "'center' | 'start' | 'end' | 'normal' | 'space-between' | 'space-around' | 'space-evenly' | 'stretch'", - "description": "", + "description": "The subset of `justify-content` values available for the grid component.\n\n- `center`: Packs columns toward the center of the grid.\n- `start`: Packs columns toward the start of the inline axis.\n- `end`: Packs columns toward the end of the inline axis.\n- `normal`: Default browser behavior.\n- `space-between`: Distributes columns evenly with no space at the edges.\n- `space-around`: Distributes columns evenly with equal space around each.\n- `space-evenly`: Distributes columns with equal space between and at the edges.\n- `stretch`: Stretches columns to fill the available space.", "isPublicDocs": true }, "ReducedJustifyItemsKeyword": { @@ -212538,7 +212555,7 @@ "syntaxKind": "TypeAliasDeclaration", "name": "ReducedJustifyItemsKeyword", "value": "'center' | 'start' | 'end' | 'normal' | 'baseline' | 'stretch'", - "description": "", + "description": "The subset of `justify-items` values available for the grid component.\n\n- `center`: Centers items along the inline axis.\n- `start`: Aligns items to the start of the inline axis.\n- `end`: Aligns items to the end of the inline axis.\n- `normal`: Default browser behavior.\n- `baseline`: Aligns items along their text baseline.\n- `stretch`: Stretches items to fill the cell along the inline axis.", "isPublicDocs": true }, "SizeUnitsOrNone": { @@ -212567,7 +212584,7 @@ "GridItemElementProps": { "filePath": "src/surfaces/checkout/components/GridItem.ts", "name": "GridItemElementProps", - "description": "The grid item component represents a single cell within a grid layout, allowing you to control how content is positioned and sized within the grid. Use grid item as a child of grid to specify column span, row span, and positioning for individual content areas.\n\nGrid item supports precise placement control through column and row properties, enabling you to create complex layouts where different items occupy varying amounts of space or appear in specific grid positions.", + "description": "", "isPublicDocs": true, "members": [ { @@ -212592,7 +212609,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityVisibility", "value": "'visible' | 'hidden' | 'exclusive'", - "description": "Changes the visibility of the element.\n\n- `visible`: the element is visible to all users.\n- `hidden`: the element is removed from the accessibility tree but remains visible.\n- `exclusive`: the element is visually hidden but remains in the accessibility tree.", + "description": "Controls how the element is exposed to sighted users and to assistive technologies such as screen readers.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", "isOptional": true, "defaultValue": "'visible'" }, @@ -212601,7 +212618,7 @@ "syntaxKind": "PropertySignature", "name": "background", "value": "'base' | 'subdued' | 'transparent'", - "description": "Adjust the background of the element.", + "description": "The background color of the grid item.\n\n- `base`: The standard background color for general content areas.\n- `subdued`: A muted background for secondary or supporting content.\n- `transparent`: No background color (the default).", "isOptional": true, "defaultValue": "'transparent'" }, @@ -212619,9 +212636,9 @@ "syntaxKind": "PropertySignature", "name": "border", "value": "BorderShorthand", - "description": "Applies a border using shorthand syntax to specify width, color, and style in a single property.\n\nAccepts a size value, optionally followed by a color, optionally followed by a style. Omitted values use defaults: color defaults to `base`, style defaults to `auto`.\n\nIndividual properties (`borderWidth`, `borderStyle`, `borderColor`) can override values set here.", + "description": "A shorthand for setting the border width, color, and style in a single property. Individual border properties (`borderWidth`, `borderStyle`, `borderColor`) can override values set here.", "isOptional": true, - "defaultValue": "'none' - equivalent to `none base auto`.", + "defaultValue": "'none'", "examples": [ { "title": "Example", @@ -212640,7 +212657,7 @@ "syntaxKind": "PropertySignature", "name": "borderColor", "value": "'' | 'base'", - "description": "Controls the color of the border using the design system's color scale.\n\nWhen set, this overrides the color value specified in the `border` property. Choose from `subdued`, `base`, or `strong` to match the visual emphasis needed.", + "description": "The color of the border using the design system's color scale. Overrides the color value set by `border`.", "isOptional": true, "defaultValue": "'' - meaning no override" }, @@ -212649,7 +212666,7 @@ "syntaxKind": "PropertySignature", "name": "borderRadius", "value": "MaybeAllValuesShorthandProperty>", - "description": "Controls the roundedness of the element's corners using the design system's radius scale.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) using flow-relative values:\n- One value: applies to all corners\n- Two values: applies to start corners (top-left & bottom-right) and end corners (top-right & bottom-left) respectively\n- Three values: applies to start-start (top-left), end corners (top-right & bottom-left), and end-end (bottom-right) respectively\n- Four values: applies to start-start (top-left), start-end (top-right), end-end (bottom-right), and end-start (bottom-left) respectively\n\nExamples:\n- `small-100`: All corners have `small-100` radius\n- `small-100 none`: Top-left and bottom-right are `small-100`, top-right and bottom-left are `none`\n- `small-100 none large-100`: Top-left is `small-100`, top-right and bottom-left are `none`, bottom-right is `large-100`\n- `small-100 none large-100 base`: Each corner has its specified radius value", + "description": "The roundedness of the grid item's corners.\n\n- `none`: Sharp corners with no rounding.\n- `small-100` / `small`: Subtle rounding for compact elements.\n- `base`: Standard rounding for most use cases.\n- `large` / `large-100`: More pronounced rounding for prominent containers.\n- `max`: Maximum rounding, creating a pill or circular shape.\n\nSupports 1-to-4-value shorthand syntax for specifying different radii per corner.", "isOptional": true, "defaultValue": "'none'" }, @@ -212667,7 +212684,7 @@ "syntaxKind": "PropertySignature", "name": "borderWidth", "value": "MaybeAllValuesShorthandProperty | ''", - "description": "Controls the thickness of the border on all sides. When set, this overrides the width value specified in the `border` property.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) for specifying different widths per side:\n- One value: applies to all sides\n- Two values: applies to block sides (top/bottom) and inline sides (left/right) respectively\n- Three values: applies to block-start (top), inline sides (left/right), and block-end (bottom) respectively\n- Four values: applies to block-start (top), inline-end (right), block-end (bottom), and inline-start (left) respectively", + "description": "The thickness of the border on all sides. Supports 1-to-4-value shorthand syntax for specifying different widths per side. Overrides the width value set by `border`.", "isOptional": true, "defaultValue": "'' - meaning no override" }, @@ -212676,7 +212693,7 @@ "syntaxKind": "PropertySignature", "name": "display", "value": "MaybeResponsive<\"auto\" | \"none\">", - "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.", + "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.\n\nLearn more about the [display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display).", "isOptional": true, "defaultValue": "'auto'" }, @@ -212703,7 +212720,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -212824,14 +212841,14 @@ "defaultValue": "'' - meaning no override" } ], - "value": "export interface GridItemElementProps extends Pick {\n background?: Extract;\n border?: BorderShorthand;\n borderColor?: ReducedColorKeyword | '';\n borderWidth?: MaybeAllValuesShorthandProperty | '';\n borderRadius?: MaybeAllValuesShorthandProperty>;\n}" + "value": "export interface GridItemElementProps extends Pick {\n /**\n * The background color of the grid item.\n *\n * - `base`: The standard background color for general content areas.\n * - `subdued`: A muted background for secondary or supporting content.\n * - `transparent`: No background color (the default).\n *\n * @default 'transparent'\n */\n background?: Extract;\n /**\n * A shorthand for setting the border width, color, and style in a single property. Individual border properties (`borderWidth`, `borderStyle`, `borderColor`) can override values set here.\n *\n * @default 'none'\n */\n border?: BorderShorthand;\n /**\n * The color of the border using the design system's color scale. Overrides the color value set by `border`.\n *\n * @default '' - meaning no override\n */\n borderColor?: ReducedColorKeyword | '';\n /**\n * The thickness of the border on all sides. Supports 1-to-4-value shorthand syntax for specifying different widths per side. Overrides the width value set by `border`.\n *\n * @default '' - meaning no override\n */\n borderWidth?: MaybeAllValuesShorthandProperty | '';\n /**\n * The roundedness of the grid item's corners.\n *\n * - `none`: Sharp corners with no rounding.\n * - `small-100` / `small`: Subtle rounding for compact elements.\n * - `base`: Standard rounding for most use cases.\n * - `large` / `large-100`: More pronounced rounding for prominent containers.\n * - `max`: Maximum rounding, creating a pill or circular shape.\n *\n * Supports 1-to-4-value shorthand syntax for specifying different radii per corner.\n *\n * @default 'none'\n */\n borderRadius?: MaybeAllValuesShorthandProperty>;\n}" }, "AccessibilityRole": { "filePath": "src/surfaces/checkout/components/components.ts", "syntaxKind": "TypeAliasDeclaration", "name": "AccessibilityRole", "value": "\"main\" | \"header\" | \"footer\" | \"section\" | \"aside\" | \"navigation\" | \"ordered-list\" | \"list-item\" | \"list-item-separator\" | \"unordered-list\" | \"separator\" | \"status\" | \"alert\" | \"generic\" | \"presentation\" | \"none\"", - "description": "", + "description": "The semantic role of a component, used by assistive technologies to convey the element’s purpose to users. Each role maps to a specific HTML element or ARIA role.\n\n- `main`: The primary content of the page.\n- `header`: A page or section header.\n- `footer`: Information such as copyright, navigation links, and privacy statements.\n- `section`: A generic section that should have a heading or `accessibilityLabel`.\n- `aside`: Supporting content related to the main content.\n- `navigation`: A major group of navigation links.\n- `ordered-list`: A list of ordered items.\n- `list-item`: An item inside a list.\n- `list-item-separator`: A divider between list items.\n- `unordered-list`: A list of unordered items.\n- `separator`: A divider that separates sections of content.\n- `status`: A live region with advisory information that is not urgent.\n- `alert`: Important, usually time-sensitive information.\n- `generic`: A nameless container with no semantic meaning (renders a `
`).\n- `presentation`: Strips semantic meaning while keeping visual styling. Synonym for `none`.\n- `none`: Strips semantic meaning while keeping visual styling. Synonym for `presentation`.", "isPublicDocs": true }, "MaybeResponsive": { @@ -212863,7 +212880,7 @@ "syntaxKind": "TypeAliasDeclaration", "name": "BorderShorthand", "value": "ReducedBorderSizeKeyword | `${ReducedBorderSizeKeyword} ${ReducedColorKeyword}` | `${ReducedBorderSizeKeyword} ${ReducedColorKeyword} ${BorderStyleKeyword}`", - "description": "", + "description": "A shorthand string for specifying border properties. Accepts a size alone (`'base'`), size with color (`'base base'`), or size with color and style (`'base base dashed'`). Omitted values use their defaults.", "isPublicDocs": true }, "ReducedBorderSizeKeyword": { @@ -212926,7 +212943,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityVisibility", "value": "'visible' | 'hidden' | 'exclusive'", - "description": "Changes the visibility of the element.\n\n- `visible`: the element is visible to all users.\n- `hidden`: the element is removed from the accessibility tree but remains visible.\n- `exclusive`: the element is visually hidden but remains in the accessibility tree.", + "description": "Controls how the element is exposed to sighted users and to assistive technologies such as screen readers.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", "isOptional": true, "defaultValue": "'visible'" }, @@ -212935,7 +212952,7 @@ "syntaxKind": "PropertySignature", "name": "background", "value": "'base' | 'subdued' | 'transparent'", - "description": "Adjust the background of the element.", + "description": "The background color of the grid item.\n\n- `base`: The standard background color for general content areas.\n- `subdued`: A muted background for secondary or supporting content.\n- `transparent`: No background color (the default).", "isOptional": true, "defaultValue": "'transparent'" }, @@ -212953,23 +212970,25 @@ "syntaxKind": "PropertySignature", "name": "border", "value": "BorderShorthand", - "description": "Applies a border using shorthand syntax to specify width, color, and style in a single property.\n\nAccepts a size value, optionally followed by a color, optionally followed by a style. Omitted values use defaults: color defaults to `base`, style defaults to `auto`.\n\nIndividual properties (`borderWidth`, `borderStyle`, `borderColor`) can override values set here.", - "isOptional": true + "description": "A shorthand for setting the border width, color, and style in a single property. Individual border properties (`borderWidth`, `borderStyle`, `borderColor`) can override values set here.", + "isOptional": true, + "defaultValue": "'none'" }, { "filePath": "src/surfaces/checkout/components/GridItem.ts", "syntaxKind": "PropertySignature", "name": "borderColor", "value": "'' | 'base'", - "description": "Controls the color of the border using the design system's color scale.\n\nWhen set, this overrides the color value specified in the `border` property. Choose from `subdued`, `base`, or `strong` to match the visual emphasis needed.", - "isOptional": true + "description": "The color of the border using the design system's color scale. Overrides the color value set by `border`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" }, { "filePath": "src/surfaces/checkout/components/GridItem.ts", "syntaxKind": "PropertySignature", "name": "borderRadius", "value": "MaybeAllValuesShorthandProperty>", - "description": "Controls the roundedness of the element's corners using the design system's radius scale.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) using flow-relative values:\n- One value: applies to all corners\n- Two values: applies to start corners (top-left & bottom-right) and end corners (top-right & bottom-left) respectively\n- Three values: applies to start-start (top-left), end corners (top-right & bottom-left), and end-end (bottom-right) respectively\n- Four values: applies to start-start (top-left), start-end (top-right), end-end (bottom-right), and end-start (bottom-left) respectively\n\nExamples:\n- `small-100`: All corners have `small-100` radius\n- `small-100 none`: Top-left and bottom-right are `small-100`, top-right and bottom-left are `none`\n- `small-100 none large-100`: Top-left is `small-100`, top-right and bottom-left are `none`, bottom-right is `large-100`\n- `small-100 none large-100 base`: Each corner has its specified radius value", + "description": "The roundedness of the grid item's corners.\n\n- `none`: Sharp corners with no rounding.\n- `small-100` / `small`: Subtle rounding for compact elements.\n- `base`: Standard rounding for most use cases.\n- `large` / `large-100`: More pronounced rounding for prominent containers.\n- `max`: Maximum rounding, creating a pill or circular shape.\n\nSupports 1-to-4-value shorthand syntax for specifying different radii per corner.", "isOptional": true, "defaultValue": "'none'" }, @@ -212987,15 +213006,16 @@ "syntaxKind": "PropertySignature", "name": "borderWidth", "value": "MaybeAllValuesShorthandProperty | ''", - "description": "Controls the thickness of the border on all sides. When set, this overrides the width value specified in the `border` property.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) for specifying different widths per side:\n- One value: applies to all sides\n- Two values: applies to block sides (top/bottom) and inline sides (left/right) respectively\n- Three values: applies to block-start (top), inline sides (left/right), and block-end (bottom) respectively\n- Four values: applies to block-start (top), inline-end (right), block-end (bottom), and inline-start (left) respectively", - "isOptional": true + "description": "The thickness of the border on all sides. Supports 1-to-4-value shorthand syntax for specifying different widths per side. Overrides the width value set by `border`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" }, { "filePath": "src/surfaces/checkout/components/GridItem.ts", "syntaxKind": "PropertySignature", "name": "display", "value": "MaybeResponsive<\"auto\" | \"none\">", - "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.", + "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.\n\nLearn more about the [display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display).", "isOptional": true, "defaultValue": "'auto'" }, @@ -213022,7 +213042,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -213213,7 +213233,7 @@ "HeadingElementProps": { "filePath": "src/surfaces/checkout/components/Heading.ts", "name": "HeadingElementProps", - "description": "The heading component renders hierarchical titles to communicate the structure and organization of page content. Use heading to create section titles and content headers that help users understand information hierarchy and navigate content.\n\nHeading levels adjust automatically based on nesting within parent [section](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/layout-and-structure/section) components, ensuring meaningful and accessible page outlines without manual level management.", + "description": "", "isPublicDocs": true, "members": [ { @@ -213230,7 +213250,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true } ], @@ -213299,7 +213319,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -213375,7 +213395,7 @@ "ImageElementProps": { "filePath": "src/surfaces/checkout/components/Image.ts", "name": "ImageElementProps", - "description": "The image component embeds images within the interface with control over presentation and loading behavior. Use image to visually illustrate concepts, showcase products, display user content, or support tasks and interactions with visual context.\n\nImages support responsive sizing, alt text for accessibility, aspect ratio control, and loading states for progressive enhancement. For small preview images in lists or tables, use [thumbnail](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/media-and-visuals/thumbnail). For profile images, use [avatar](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/media-and-visuals/avatar).", + "description": "", "isPublicDocs": true, "members": [ { @@ -213458,7 +213478,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -213558,7 +213578,7 @@ "ImageProps": { "filePath": "src/surfaces/checkout/components/Image.ts", "name": "ImageProps", - "description": "The properties for the image component when it's used in JSX.", + "description": "", "isPublicDocs": true, "members": [ { @@ -213627,7 +213647,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -213727,7 +213747,7 @@ "LinkElementProps": { "filePath": "src/surfaces/checkout/components/Link.ts", "name": "LinkElementProps", - "description": "The link component makes text interactive, allowing users to navigate to other pages or perform specific actions. Use link for navigation, external references, or triggering actions while maintaining standard link semantics and accessibility.\n\nLinks support standard URLs, custom protocols, navigation within Shopify admin pages, and can open in new windows for external destinations. For prominent actions or form submissions, use [button](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/actions/button) instead.", + "description": "", "isPublicDocs": true, "members": [ { @@ -213735,7 +213755,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityLabel", "value": "string", - "description": "A label that describes the purpose or contents of the Link. It will be read to users using assistive technologies such as screen readers.\n\nUse this when using only an icon or the content of the link is not enough context for users using assistive technologies.", + "description": "A label that describes the purpose or contents of the link. It will be read to users using assistive technologies such as screen readers.\n\nUse this when using only an icon or the content of the link is not enough context for users using assistive technologies.", "isOptional": true }, { @@ -213743,7 +213763,7 @@ "syntaxKind": "PropertySignature", "name": "command", "value": "'--auto' | '--show' | '--hide' | '--toggle' | '--copy'", - "description": "Sets the action the `commandFor` should take when this clickable is activated.\n\nSee the documentation of particular components for the actions they support.\n\n- `--auto`: a default action for the target component.\n- `--show`: shows the target component.\n- `--hide`: hides the target component.\n- `--toggle`: toggles the target component.\n- `--copy`: copies the target ClipboardItem.", + "description": "Sets the action the `commandFor` target should take when this component is activated.\n\n- `--auto`: Performs the default action for the target component.\n- `--show`: Displays the target component.\n- `--hide`: Conceals the target component.\n- `--toggle`: Alternates the target component.\n- `--copy`: Copies the target ClipboardItem.\n\nLearn more about the [`command` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).", "isOptional": true, "defaultValue": "'--auto'" }, @@ -213752,7 +213772,7 @@ "syntaxKind": "PropertySignature", "name": "commandFor", "value": "string", - "description": "ID of a component that should respond to activations (e.g. clicks) on this component.\n\nSee `command` for how to control the behavior of the target.", + "description": "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).\n\nWhen both `commandFor` and `href` are set, `commandFor` takes precedence. The command runs and the link doesn't navigate.", "isOptional": true }, { @@ -213760,7 +213780,7 @@ "syntaxKind": "PropertySignature", "name": "href", "value": "string", - "description": "The URL to link to.\n\n- If set, it will navigate to the location specified by `href` after executing the `click` event.\n- If a `commandFor` is set, the `command` will be executed instead of the navigation.", + "description": "The URL to navigate to when clicked. The `click` event fires first, then navigation occurs.\n\n- If set, it will navigate to the location specified by `href` after executing the `click` event.\n- If a `commandFor` is set, the `command` will be executed instead of the navigation.", "isOptional": true }, { @@ -213768,7 +213788,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -213776,7 +213796,7 @@ "syntaxKind": "PropertySignature", "name": "interestFor", "value": "string", - "description": "ID of a component that should respond to interest (e.g. hover and focus) on this component.", + "description": "The ID of the component to show when users hover over or focus on this component. Pair with a target component that supports interest-based interactions. Learn more about the [interestFor attribute](https://open-ui.org/components/interest-invokers.explainer/#the-pitch-in-code).", "isOptional": true }, { @@ -213784,7 +213804,7 @@ "syntaxKind": "PropertySignature", "name": "lang", "value": "string", - "description": "Indicate the text language. Useful when the text is in a different language than the rest of the page. It will allow assistive technologies such as screen readers to invoke the correct pronunciation. [Reference of values](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry) (\"subtag\" label)", + "description": "The language of the button's text content. Use this when the button text is in a different language than the rest of the page, so assistive technologies can invoke the correct pronunciation. [Reference of values](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry) (`Subtag` label)", "isOptional": true }, { @@ -213801,7 +213821,7 @@ "syntaxKind": "PropertySignature", "name": "tone", "value": "'auto' | 'neutral'", - "description": "Sets the tone of the Link, based on the intention of the information being conveyed.", + "description": "Sets the tone of the link, based on the intention of the information being conveyed.\n\n- `'auto'`: Automatically determined based on context.\n- `'neutral'`: Removes the default link color, inheriting the surrounding text style.", "isOptional": true, "defaultValue": "'auto'" } @@ -213818,7 +213838,7 @@ "LinkElementEvents": { "filePath": "src/surfaces/checkout/components/Link.ts", "name": "LinkElementEvents", - "description": "Learn more about [registering events](/docs/api/checkout-ui-extensions/latest/using-polaris-components#event-handling).", + "description": "", "isPublicDocs": true, "members": [ { @@ -213826,11 +213846,11 @@ "syntaxKind": "PropertySignature", "name": "click", "value": "CallbackEventListener", - "description": "Callback when the link is activated. This will be called before navigating to the location specified by `href`.", + "description": "A callback fired when the link is clicked, before navigating to the location specified by `href`.\n\nLearn more about the [click event](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event).", "isOptional": true } ], - "value": "export interface LinkElementEvents {\n /**\n * Callback when the link is activated.\n * This will be called before navigating to the location specified by `href`.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event\n */\n click?: CallbackEventListener;\n}" + "value": "export interface LinkElementEvents {\n /**\n * A callback fired when the link is clicked, before navigating to the location specified by `href`.\n *\n * Learn more about the [click event](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event).\n */\n click?: CallbackEventListener;\n}" }, "CallbackEventListener": { "filePath": "src/surfaces/checkout/components/Link.ts", @@ -213891,7 +213911,7 @@ "MapElementProps": { "filePath": "src/surfaces/checkout/components/Map.ts", "name": "MapElementProps", - "description": "Use Map to display a map on a page. This component is useful for displaying a map of a location, such as a store or a customer’s address.", + "description": "", "isPublicDocs": true, "members": [ { @@ -213924,7 +213944,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -214062,7 +214082,7 @@ "MapElementEvents": { "filePath": "src/surfaces/checkout/components/Map.ts", "name": "MapElementEvents", - "description": "Learn more about [registering events](/docs/api/checkout-ui-extensions/latest/using-polaris-components#event-handling).", + "description": "", "isPublicDocs": true, "members": [ { @@ -214244,7 +214264,7 @@ "syntaxKind": "PropertySignature", "name": "command", "value": "'--auto' | '--show' | '--hide' | '--toggle'", - "description": "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).\n\n- `--auto`: a default action for the target component.\n- `--show`: shows the target component.\n- `--hide`: hides the target component.\n- `--toggle`: toggles the target component.", + "description": "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).\n\n- `--auto`: a default action for the target component.\n- `--show`: shows the target component.\n- `--hide`: hides the target component.\n- `--toggle`: toggles the target component.", "isOptional": true, "defaultValue": "'--auto'" }, @@ -214253,7 +214273,7 @@ "syntaxKind": "PropertySignature", "name": "commandFor", "value": "string", - "description": "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).", + "description": "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).", "isOptional": true }, { @@ -214284,7 +214304,7 @@ "defaultValue": "0" } ], - "value": "export interface MapMarkerElementProps extends Pick {\n /**\n * 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).\n *\n * - `--auto`: a default action for the target component.\n * - `--show`: shows the target component.\n * - `--hide`: hides the target component.\n * - `--toggle`: toggles the target component.\n *\n * @default '--auto'\n */\n command?: Extract;\n /**\n * 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).\n */\n commandFor?: MapMarkerProps$1['commandFor'];\n}" + "value": "export interface MapMarkerElementProps extends Pick {\n /**\n * 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).\n *\n * - `--auto`: a default action for the target component.\n * - `--show`: shows the target component.\n * - `--hide`: hides the target component.\n * - `--toggle`: toggles the target component.\n *\n * @default '--auto'\n */\n command?: Extract;\n /**\n * 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).\n */\n commandFor?: MapMarkerProps$1['commandFor'];\n}" }, "MaybeResponsive": { "filePath": "src/surfaces/checkout/components/components.ts", @@ -214360,7 +214380,7 @@ "MapMarkerElementSlots": { "filePath": "src/surfaces/checkout/components/MapMarker.ts", "name": "MapMarkerElementSlots", - "description": "The named slots for the map marker component. Slots allow you to insert custom content into specific areas of the marker.", + "description": "", "isPublicDocs": true, "members": [ { @@ -214439,7 +214459,7 @@ "ModalElementProps": { "filePath": "src/surfaces/checkout/components/Modal.ts", "name": "ModalElementProps", - "description": "The modal component displays content in an overlay. Use to create a distraction-free experience such as a confirmation dialog or a settings panel.\n\nA button triggers the modal using the `commandFor` attribute. Content within the modal scrolls if it exceeds available height.", + "description": "", "isPublicDocs": true, "members": [ { @@ -214463,7 +214483,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -214497,7 +214517,7 @@ "ModalElementEvents": { "filePath": "src/surfaces/checkout/components/Modal.ts", "name": "ModalElementEvents", - "description": "Learn more about [registering events](/docs/api/checkout-ui-extensions/latest/using-polaris-components#event-handling).", + "description": "", "isPublicDocs": true, "members": [ { @@ -214561,7 +214581,7 @@ "ModalElementSlots": { "filePath": "src/surfaces/checkout/components/Modal.ts", "name": "ModalElementSlots", - "description": "Learn more about [component slots](/docs/api/checkout-ui-extensions/latest/using-polaris-components#slots).", + "description": "", "isPublicDocs": true, "members": [ { @@ -214593,7 +214613,7 @@ "ModalElementMethods": { "filePath": "src/surfaces/checkout/components/Modal.ts", "name": "ModalElementMethods", - "description": "Learn more about [component methods](/docs/api/checkout-ui-extensions/latest/using-polaris-components#methods).", + "description": "", "isPublicDocs": true, "members": [ { @@ -214642,7 +214662,7 @@ "MoneyFieldElementProps": { "filePath": "src/surfaces/checkout/components/MoneyField.ts", "name": "MoneyFieldElementProps", - "description": "The money field component collects monetary values from users with built-in currency formatting and validation. Use money field for prices, costs, or financial amounts to provide proper currency symbols, decimal handling, and numeric validation.\n\nMoney fields support currency codes, automatic formatting, and min/max constraints to ensure users enter valid monetary values. For non-currency numeric input, use [number field](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/forms/number-field).", + "description": "", "isPublicDocs": true, "members": [ { @@ -214650,7 +214670,7 @@ "syntaxKind": "PropertySignature", "name": "autocomplete", "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", "isOptional": true, "defaultValue": "'on' for everything else" }, @@ -214659,7 +214679,7 @@ "syntaxKind": "PropertySignature", "name": "defaultValue", "value": "string", - "description": "The default value for the field.", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces this value.", "isOptional": true }, { @@ -214667,7 +214687,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -214676,7 +214696,7 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -214684,7 +214704,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -214692,7 +214712,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Content to use as the field label.", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", "isOptional": true }, { @@ -214700,7 +214720,7 @@ "syntaxKind": "PropertySignature", "name": "labelAccessibilityVisibility", "value": "'visible' | 'exclusive'", - "description": "Changes the visibility of the component's label.\n\n- `visible`: the label is visible to all users.\n- `exclusive`: the label is visually hidden but remains in the accessibility tree.", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone.\n- `exclusive`: The label is visually hidden but still announced by screen readers.", "isOptional": true, "defaultValue": "'visible'" }, @@ -214727,7 +214747,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -214735,7 +214755,7 @@ "syntaxKind": "PropertySignature", "name": "readOnly", "value": "boolean", - "description": "The field cannot be edited by the user. It is focusable will be announced by screen readers.", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", "isOptional": true, "defaultValue": "false" }, @@ -214794,7 +214814,7 @@ "MoneyFieldElementEvents": { "filePath": "src/surfaces/checkout/components/MoneyField.ts", "name": "MoneyFieldElementEvents", - "description": "Learn more about [registering events](/docs/api/checkout-ui-extensions/latest/using-polaris-components#event-handling).", + "description": "", "isPublicDocs": true, "members": [ { @@ -214802,7 +214822,7 @@ "syntaxKind": "PropertySignature", "name": "blur", "value": "CallbackEventListener", - "description": "Callback when the element loses focus.", + "description": "<<<<<<< HEAD A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n======= A callback fired when the money field loses focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) \n Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", "isOptional": true }, { @@ -214810,7 +214830,7 @@ "syntaxKind": "PropertySignature", "name": "change", "value": "CallbackEventListener", - "description": "Callback when the user has **finished editing** a field, e.g. once they have blurred the field.", + "description": "<<<<<<< HEAD Callback when the user has **finished editing** a field, for example, once they have blurred the field.\n======= A callback fired when the money field value changes.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) \n Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", "isOptional": true }, { @@ -214818,7 +214838,7 @@ "syntaxKind": "PropertySignature", "name": "focus", "value": "CallbackEventListener", - "description": "Callback when the element receives focus.", + "description": "<<<<<<< HEAD A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n======= A callback fired when the money field receives focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) \n Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", "isOptional": true }, { @@ -214826,11 +214846,11 @@ "syntaxKind": "PropertySignature", "name": "input", "value": "CallbackEventListener", - "description": "Callback when the user makes any changes in the field.", + "description": "A callback fired when the user inputs data into the money field.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).", "isOptional": true } ], - "value": "export interface MoneyFieldElementEvents {\n /**\n * Callback when the element loses focus.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event\n */\n blur?: CallbackEventListener;\n /**\n * Callback when the user has **finished editing** a field, e.g. once they have blurred the field.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event\n */\n change?: CallbackEventListener;\n /**\n * Callback when the element receives focus.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event\n */\n focus?: CallbackEventListener;\n /**\n * Callback when the user makes any changes in the field.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event\n */\n input?: CallbackEventListener;\n}" + "value": "export interface MoneyFieldElementEvents {\n /**\n<<<<<<< HEAD\n * A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n=======\n * A callback fired when the money field loses focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality)\n *\n * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur?: CallbackEventListener;\n /**\n<<<<<<< HEAD\n * Callback when the user has **finished editing** a field, for example, once they have blurred the field.\n=======\n * A callback fired when the money field value changes.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality)\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change?: CallbackEventListener;\n /**\n<<<<<<< HEAD\n * A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n=======\n * A callback fired when the money field receives focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality)\n *\n * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus?: CallbackEventListener;\n /**\n * A callback fired when the user inputs data into the money field.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input?: CallbackEventListener;\n}" }, "CallbackEventListener": { "filePath": "src/surfaces/checkout/components/MoneyField.ts", @@ -214884,7 +214904,7 @@ "NumberFieldElementProps": { "filePath": "src/surfaces/checkout/components/NumberField.ts", "name": "NumberFieldElementProps", - "description": "The number field component captures numeric input with built-in number validation. Use it to collect quantities, prices, or other numeric information.\n\nThe component supports min/max constraints and step increments for guided numeric entry. For monetary values with currency formatting, use [money field](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/forms/money-field).", + "description": "", "isPublicDocs": true, "members": [ { @@ -214892,7 +214912,7 @@ "syntaxKind": "PropertySignature", "name": "autocomplete", "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", "isOptional": true, "defaultValue": "'on' for everything else" }, @@ -214910,7 +214930,7 @@ "syntaxKind": "PropertySignature", "name": "defaultValue", "value": "string", - "description": "The default value for the field.", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces this value.", "isOptional": true }, { @@ -214918,7 +214938,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -214927,7 +214947,7 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -214944,7 +214964,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -214961,7 +214981,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Content to use as the field label.", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", "isOptional": true }, { @@ -214969,7 +214989,7 @@ "syntaxKind": "PropertySignature", "name": "labelAccessibilityVisibility", "value": "'visible' | 'exclusive'", - "description": "Changes the visibility of the component's label.\n\n- `visible`: the label is visible to all users.\n- `exclusive`: the label is visually hidden but remains in the accessibility tree.", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone.\n- `exclusive`: The label is visually hidden but still announced by screen readers.", "isOptional": true, "defaultValue": "'visible'" }, @@ -214996,7 +215016,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -215014,7 +215034,7 @@ "syntaxKind": "PropertySignature", "name": "prefix", "value": "string", - "description": "A value to be displayed immediately before the editable portion of the field.\n\nThis is useful for displaying an implied part of the value, such as \"https://\" or \"+353\".\n\nThis cannot be edited by the user, and it isn't included in the value of the field.\n\nIt may not be displayed until the user has interacted with the input. For example, an inline label may take the place of the prefix until the user focuses the input.", + "description": "A value to be displayed immediately before the editable portion of the field.\n\nThis is useful for displaying an implied part of the value, such as \"https://\" or \"+353\".\n\nThis can't be edited by the user, and it isn't included in the value of the field.\n\nIt may not be displayed until the user has interacted with the input. For example, an inline label may take the place of the prefix until the user focuses the input.", "isOptional": true, "defaultValue": "''" }, @@ -215023,7 +215043,7 @@ "syntaxKind": "PropertySignature", "name": "readOnly", "value": "boolean", - "description": "The field cannot be edited by the user. It is focusable will be announced by screen readers.", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", "isOptional": true, "defaultValue": "false" }, @@ -215050,7 +215070,7 @@ "syntaxKind": "PropertySignature", "name": "suffix", "value": "string", - "description": "A value to be displayed immediately after the editable portion of the field.\n\nThis is useful for displaying an implied part of the value, such as \"@shopify.com\", or \"%\".\n\nThis cannot be edited by the user, and it isn't included in the value of the field.\n\nIt may not be displayed until the user has interacted with the input. For example, an inline label may take the place of the suffix until the user focuses the input.", + "description": "A value to be displayed immediately after the editable portion of the field.\n\nThis is useful for displaying an implied part of the value, such as \"@shopify.com\", or \"%\".\n\nThis can't be edited by the user, and it isn't included in the value of the field.\n\nIt may not be displayed until the user has interacted with the input. For example, an inline label may take the place of the suffix until the user focuses the input.", "isOptional": true, "defaultValue": "''" }, @@ -215091,7 +215111,7 @@ "NumberFieldElementEvents": { "filePath": "src/surfaces/checkout/components/NumberField.ts", "name": "NumberFieldElementEvents", - "description": "Learn more about [registering events](/docs/api/checkout-ui-extensions/latest/using-polaris-components#event-handling).", + "description": "", "isPublicDocs": true, "members": [ { @@ -215099,7 +215119,7 @@ "syntaxKind": "PropertySignature", "name": "blur", "value": "CallbackEventListener", - "description": "Callback when the element loses focus.", + "description": "<<<<<<< HEAD A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n======= A callback fired when the number field loses focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) \n Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", "isOptional": true }, { @@ -215107,7 +215127,7 @@ "syntaxKind": "PropertySignature", "name": "change", "value": "CallbackEventListener", - "description": "Callback when the user has **finished editing** a field, e.g. once they have blurred the field.", + "description": "<<<<<<< HEAD Callback when the user has **finished editing** a field, for example, once they have blurred the field.\n======= A callback fired when the number field value changes.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) \n Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", "isOptional": true }, { @@ -215115,7 +215135,7 @@ "syntaxKind": "PropertySignature", "name": "focus", "value": "CallbackEventListener", - "description": "Callback when the element receives focus.", + "description": "<<<<<<< HEAD A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n======= A callback fired when the number field receives focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) \n Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", "isOptional": true }, { @@ -215123,11 +215143,11 @@ "syntaxKind": "PropertySignature", "name": "input", "value": "CallbackEventListener", - "description": "Callback when the user makes any changes in the field.", + "description": "A callback fired when the user inputs data into the number field.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).", "isOptional": true } ], - "value": "export interface NumberFieldElementEvents {\n /**\n * Callback when the element loses focus.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event\n */\n blur?: CallbackEventListener;\n /**\n * Callback when the user has **finished editing** a field, e.g. once they have blurred the field.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event\n */\n change?: CallbackEventListener;\n /**\n * Callback when the element receives focus.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event\n */\n focus?: CallbackEventListener;\n /**\n * Callback when the user makes any changes in the field.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event\n */\n input?: CallbackEventListener;\n}" + "value": "export interface NumberFieldElementEvents {\n /**\n<<<<<<< HEAD\n * A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n=======\n * A callback fired when the number field loses focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality)\n *\n * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur?: CallbackEventListener;\n /**\n<<<<<<< HEAD\n * Callback when the user has **finished editing** a field, for example, once they have blurred the field.\n=======\n * A callback fired when the number field value changes.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality)\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change?: CallbackEventListener;\n /**\n<<<<<<< HEAD\n * A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n=======\n * A callback fired when the number field receives focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality)\n *\n * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus?: CallbackEventListener;\n /**\n * A callback fired when the user inputs data into the number field.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input?: CallbackEventListener;\n}" }, "CallbackEventListener": { "filePath": "src/surfaces/checkout/components/NumberField.ts", @@ -215155,7 +215175,7 @@ "NumberFieldElementSlots": { "filePath": "src/surfaces/checkout/components/NumberField.ts", "name": "NumberFieldElementSlots", - "description": "Learn more about [component slots](/docs/api/checkout-ui-extensions/latest/using-polaris-components#slots).", + "description": "", "isPublicDocs": true, "members": [ { @@ -215163,11 +215183,11 @@ "syntaxKind": "PropertySignature", "name": "accessory", "value": "HTMLElement", - "description": "Additional content to be displayed in the field. Commonly used to display an icon that activates a tooltip providing more information.", + "description": "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.", "isOptional": true } ], - "value": "export interface NumberFieldElementSlots {\n /**\n * Additional content to be displayed in the field.\n * Commonly used to display an icon that activates a tooltip providing more information.\n */\n accessory?: HTMLElement;\n}" + "value": "export interface NumberFieldElementSlots {\n /**\n * 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.\n */\n accessory?: HTMLElement;\n}" } } } @@ -215205,7 +215225,7 @@ "OrderedListElementProps": { "filePath": "src/surfaces/checkout/components/OrderedList.ts", "name": "OrderedListElementProps", - "description": "Properties for the OrderedList component element.", + "description": "", "isPublicDocs": true, "members": [ { @@ -215213,7 +215233,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true } ], @@ -215229,7 +215249,7 @@ "ListItemElementProps": { "filePath": "src/surfaces/checkout/components/ListItem.ts", "name": "ListItemElementProps", - "description": "The list item component represents a single entry within an ordered list or unordered list. Use list item to structure individual points, steps, or items within a list, with each item automatically receiving appropriate list markers (bullets or numbers) from its parent list.\n\nList item must be used as a direct child of ordered list or unordered list components. Each list item can contain text, inline formatting, or other components to create rich list content.", + "description": "", "isPublicDocs": true, "members": [ { @@ -215237,7 +215257,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true } ], @@ -215286,7 +215306,7 @@ "ParagraphElementProps": { "filePath": "src/surfaces/checkout/components/Paragraph.ts", "name": "ParagraphElementProps", - "description": "The paragraph component displays blocks of text content and can contain inline elements like buttons, links, or emphasized text. Use paragraph to present standalone blocks of readable content, descriptions, or explanatory text.\n\nParagraphs support alignment options and can wrap inline components to create rich, formatted content blocks. For inline text styling, use [text](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/typography-and-content/text).", + "description": "", "isPublicDocs": true, "members": [ { @@ -215294,7 +215314,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityVisibility", "value": "'visible' | 'hidden' | 'exclusive'", - "description": "Changes the visibility of the element.\n\n- `visible`: the element is visible to all users.\n- `hidden`: the element is removed from the accessibility tree but remains visible.\n- `exclusive`: the element is visually hidden but remains in the accessibility tree.", + "description": "Controls how the element is exposed to sighted users and to assistive technologies such as screen readers.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", "isOptional": true, "defaultValue": "'visible'" }, @@ -215303,7 +215323,7 @@ "syntaxKind": "PropertySignature", "name": "color", "value": "'base' | 'subdued'", - "description": "Modify the color to be more or less intense.", + "description": "The color emphasis level that controls visual intensity.\n\n- `subdued`: Deemphasized color for secondary text, supporting labels, and less critical interface elements.\n- `base`: Primary color for body text, standard UI elements, and general content with good readability.\n- `strong`: Emphasized color for headings, key labels, and interactive elements that need prominence.", "isOptional": true, "defaultValue": "'base'" }, @@ -215312,7 +215332,7 @@ "syntaxKind": "PropertySignature", "name": "dir", "value": "'ltr' | 'rtl' | 'auto' | ''", - "description": "Indicates the directionality of the element’s text.\n\n- `ltr`: languages written from left to right (e.g. English)\n- `rtl`: languages written from right to left (e.g. Arabic)\n- `auto`: the user agent determines the direction based on the content\n- `''`: direction is inherited from parent elements (equivalent to not setting the attribute)", + "description": "Indicates the directionality of the element’s text.\n\n- `ltr`: The languages written from left to right (such as English).\n- `rtl`: The languages written from right to left (such as Arabic).\n- `auto`: The user agent determines the direction based on the content.\n- `\"\"`: The direction is inherited from parent elements (equivalent to not setting the attribute).\n\nLearn more about the [dir attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/dir).", "isOptional": true, "defaultValue": "''" }, @@ -215321,7 +215341,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -215333,12 +215353,21 @@ "isOptional": true, "defaultValue": "''" }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "textAlign", + "value": "'start' | 'end' | 'center' | 'auto'", + "description": "Sets the alignment of the text.", + "isOptional": true, + "defaultValue": "'auto'" + }, { "filePath": "src/surfaces/checkout/components/Paragraph.ts", "syntaxKind": "PropertySignature", "name": "tone", "value": "'custom' | 'success' | 'info' | 'auto' | 'neutral' | 'warning' | 'critical'", - "description": "Sets the tone of the component, based on the intention of the information being conveyed.", + "description": "The semantic meaning and color treatment of the component.\n\n- `auto`: Automatically determined based on context.\n- `neutral`: General information without specific intent.\n- `info`: Informational content or helpful tips.\n- `success`: Positive outcomes or successful states.\n- `warning`: Important warnings about potential issues.\n- `critical`: Urgent problems or destructive actions.\n- `custom`: Custom styling controlled by your theme.", "isOptional": true, "defaultValue": "'auto'" }, @@ -215347,12 +215376,12 @@ "syntaxKind": "PropertySignature", "name": "type", "value": "ParagraphType", - "description": "Provide semantic meaning and default styling to the paragraph.\n\nOther presentation properties on `s-paragraph` override the default styling.", + "description": "The semantic type and styling treatment for the paragraph content.\n\nOther presentation properties on `s-paragraph` override the default styling.", "isOptional": true, "defaultValue": "'paragraph'" } ], - "value": "export interface ParagraphElementProps extends Pick {\n color?: Extract;\n tone?: Extract;\n}" + "value": "export interface ParagraphElementProps extends Pick {\n color?: Extract;\n tone?: Extract;\n /**\n * Sets the alignment of the text.\n * @see https://developer.mozilla.org/en-US/docs/Web/CSS/text-align\n *\n * @default 'auto'\n */\n textAlign?: 'start' | 'end' | 'center' | 'auto';\n}" }, "ParagraphType": { "filePath": "src/surfaces/checkout/components/components.ts", @@ -215405,7 +215434,7 @@ "PasswordFieldElementProps": { "filePath": "src/surfaces/checkout/components/PasswordField.ts", "name": "PasswordFieldElementProps", - "description": "The password field component securely collects sensitive information from users. Use password field for password entry, where input characters are automatically masked for privacy.\n\nPassword fields support validation, help text, and accessibility features to create secure and user-friendly authentication experiences. For general text input, use [text field](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/forms/text-field).", + "description": "", "isPublicDocs": true, "members": [ { @@ -215413,7 +215442,7 @@ "syntaxKind": "PropertySignature", "name": "autocomplete", "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", "isOptional": true, "defaultValue": "'on' for everything else" }, @@ -215422,7 +215451,7 @@ "syntaxKind": "PropertySignature", "name": "defaultValue", "value": "string", - "description": "The default value for the field.", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces this value.", "isOptional": true }, { @@ -215430,7 +215459,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -215439,7 +215468,7 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -215447,7 +215476,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -215455,7 +215484,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Content to use as the field label.", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", "isOptional": true }, { @@ -215463,7 +215492,7 @@ "syntaxKind": "PropertySignature", "name": "labelAccessibilityVisibility", "value": "'visible' | 'exclusive'", - "description": "Changes the visibility of the component's label.\n\n- `visible`: the label is visible to all users.\n- `exclusive`: the label is visually hidden but remains in the accessibility tree.", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone.\n- `exclusive`: The label is visually hidden but still announced by screen readers.", "isOptional": true, "defaultValue": "'visible'" }, @@ -215481,7 +215510,7 @@ "syntaxKind": "PropertySignature", "name": "minLength", "value": "number", - "description": "Specifies the min number of characters allowed.", + "description": "Specifies the minimum number of characters allowed.", "isOptional": true, "defaultValue": "0" }, @@ -215490,7 +215519,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -215498,7 +215527,7 @@ "syntaxKind": "PropertySignature", "name": "readOnly", "value": "boolean", - "description": "The field cannot be edited by the user. It is focusable will be announced by screen readers.", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", "isOptional": true, "defaultValue": "false" }, @@ -215548,7 +215577,7 @@ "PasswordFieldElementEvents": { "filePath": "src/surfaces/checkout/components/PasswordField.ts", "name": "PasswordFieldElementEvents", - "description": "Learn more about [registering events](/docs/api/checkout-ui-extensions/latest/using-polaris-components#event-handling).", + "description": "", "isPublicDocs": true, "members": [ { @@ -215556,7 +215585,7 @@ "syntaxKind": "PropertySignature", "name": "blur", "value": "CallbackEventListener", - "description": "Callback when the element loses focus.", + "description": "<<<<<<< HEAD A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n======= A callback fired when the password field loses focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) \n Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", "isOptional": true }, { @@ -215564,7 +215593,7 @@ "syntaxKind": "PropertySignature", "name": "change", "value": "CallbackEventListener", - "description": "Callback when the user has **finished editing** a field, e.g. once they have blurred the field.", + "description": "<<<<<<< HEAD Callback when the user has **finished editing** a field, for example, once they have blurred the field.\n======= A callback fired when the password field value changes.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) \n Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", "isOptional": true }, { @@ -215572,7 +215601,7 @@ "syntaxKind": "PropertySignature", "name": "focus", "value": "CallbackEventListener", - "description": "Callback when the element receives focus.", + "description": "<<<<<<< HEAD A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n======= A callback fired when the password field receives focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) \n Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", "isOptional": true }, { @@ -215580,11 +215609,11 @@ "syntaxKind": "PropertySignature", "name": "input", "value": "CallbackEventListener", - "description": "Callback when the user makes any changes in the field.", + "description": "A callback fired when the user inputs data into the password field.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).", "isOptional": true } ], - "value": "export interface PasswordFieldElementEvents {\n /**\n * Callback when the element loses focus.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event\n */\n blur?: CallbackEventListener;\n /**\n * Callback when the user has **finished editing** a field, e.g. once they have blurred the field.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event\n */\n change?: CallbackEventListener;\n /**\n * Callback when the element receives focus.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event\n */\n focus?: CallbackEventListener;\n /**\n * Callback when the user makes any changes in the field.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event\n */\n input?: CallbackEventListener;\n}" + "value": "export interface PasswordFieldElementEvents {\n /**\n<<<<<<< HEAD\n * A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n=======\n * A callback fired when the password field loses focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality)\n *\n * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur?: CallbackEventListener;\n /**\n<<<<<<< HEAD\n * Callback when the user has **finished editing** a field, for example, once they have blurred the field.\n=======\n * A callback fired when the password field value changes.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality)\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change?: CallbackEventListener;\n /**\n<<<<<<< HEAD\n * A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n=======\n * A callback fired when the password field receives focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality)\n *\n * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus?: CallbackEventListener;\n /**\n * A callback fired when the user inputs data into the password field.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input?: CallbackEventListener;\n}" }, "CallbackEventListener": { "filePath": "src/surfaces/checkout/components/PasswordField.ts", @@ -215612,7 +215641,7 @@ "PasswordFieldElementSlots": { "filePath": "src/surfaces/checkout/components/PasswordField.ts", "name": "PasswordFieldElementSlots", - "description": "Learn more about [component slots](/docs/api/checkout-ui-extensions/latest/using-polaris-components#slots).", + "description": "", "isPublicDocs": true, "members": [ { @@ -215620,11 +215649,11 @@ "syntaxKind": "PropertySignature", "name": "accessory", "value": "HTMLElement", - "description": "Additional content to be displayed in the field. Commonly used to display an icon that activates a tooltip providing more information.", + "description": "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.", "isOptional": true } ], - "value": "export interface PasswordFieldElementSlots {\n /**\n * Additional content to be displayed in the field.\n * Commonly used to display an icon that activates a tooltip providing more information.\n */\n accessory?: HTMLElement;\n}" + "value": "export interface PasswordFieldElementSlots {\n /**\n * 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.\n */\n accessory?: HTMLElement;\n}" } } } @@ -215662,7 +215691,7 @@ "PaymentIconElementProps": { "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", "name": "PaymentIconElementProps", - "description": "Displays icons representing payment methods. Use to visually communicate available or saved payment options clearly", + "description": "", "isPublicDocs": true, "members": [ { @@ -215678,7 +215707,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -215753,7 +215782,7 @@ "syntaxKind": "PropertySignature", "name": "autocomplete", "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", "isOptional": true, "defaultValue": "'on' for everything else" }, @@ -215762,7 +215791,7 @@ "syntaxKind": "PropertySignature", "name": "defaultValue", "value": "string", - "description": "The default value for the field.", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces this value.", "isOptional": true }, { @@ -215770,7 +215799,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -215779,7 +215808,7 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -215787,7 +215816,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -215795,7 +215824,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Content to use as the field label.", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", "isOptional": true }, { @@ -215803,7 +215832,7 @@ "syntaxKind": "PropertySignature", "name": "labelAccessibilityVisibility", "value": "'visible' | 'exclusive'", - "description": "Changes the visibility of the component's label.\n\n- `visible`: the label is visible to all users.\n- `exclusive`: the label is visually hidden but remains in the accessibility tree.", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone.\n- `exclusive`: The label is visually hidden but still announced by screen readers.", "isOptional": true, "defaultValue": "'visible'" }, @@ -215812,7 +215841,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -215830,7 +215859,7 @@ "syntaxKind": "PropertySignature", "name": "readOnly", "value": "boolean", - "description": "The field cannot be edited by the user. It is focusable will be announced by screen readers.", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", "isOptional": true, "defaultValue": "false" }, @@ -215848,9 +215877,9 @@ "syntaxKind": "PropertySignature", "name": "type", "value": "'mobile' | ''", - "description": "The type of number to collect.\n\nSpecific style may be applied to each type to provide extra guidance to users. Note that no extra validation is performed based on the type.", + "description": "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.\n\nStyling hint for the input keyboard. Doesn't validate the phone number format. Implement validation in your extension and use the `error` prop to show results.", "isOptional": true, - "defaultValue": "'' meaning no specific kind of phone number" + "defaultValue": "''" }, { "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", @@ -215889,7 +215918,7 @@ "PhoneFieldElementEvents": { "filePath": "src/surfaces/checkout/components/PhoneField.ts", "name": "PhoneFieldElementEvents", - "description": "Learn more about [registering events](/docs/api/checkout-ui-extensions/latest/using-polaris-components#event-handling).", + "description": "", "isPublicDocs": true, "members": [ { @@ -215897,7 +215926,7 @@ "syntaxKind": "PropertySignature", "name": "blur", "value": "CallbackEventListener", - "description": "Callback when the element loses focus.", + "description": "<<<<<<< HEAD A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n======= A callback fired when the phone field loses focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) \n Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", "isOptional": true }, { @@ -215905,7 +215934,7 @@ "syntaxKind": "PropertySignature", "name": "change", "value": "CallbackEventListener", - "description": "Callback when the user has **finished editing** a field, e.g. once they have blurred the field.", + "description": "<<<<<<< HEAD Callback when the user has **finished editing** a field, for example, once they have blurred the field.\n======= A callback fired when the phone field value changes.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) \n Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", "isOptional": true }, { @@ -215913,7 +215942,7 @@ "syntaxKind": "PropertySignature", "name": "focus", "value": "CallbackEventListener", - "description": "Callback when the element receives focus.", + "description": "<<<<<<< HEAD A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n======= A callback fired when the phone field receives focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) \n Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", "isOptional": true }, { @@ -215921,11 +215950,11 @@ "syntaxKind": "PropertySignature", "name": "input", "value": "CallbackEventListener", - "description": "Callback when the user makes any changes in the field.", + "description": "A callback fired when the user inputs data into the phone field.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).", "isOptional": true } ], - "value": "export interface PhoneFieldElementEvents {\n /**\n * Callback when the element loses focus.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event\n */\n blur?: CallbackEventListener;\n /**\n * Callback when the user has **finished editing** a field, e.g. once they have blurred the field.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event\n */\n change?: CallbackEventListener;\n /**\n * Callback when the element receives focus.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event\n */\n focus?: CallbackEventListener;\n /**\n * Callback when the user makes any changes in the field.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event\n */\n input?: CallbackEventListener;\n}" + "value": "export interface PhoneFieldElementEvents {\n /**\n<<<<<<< HEAD\n * A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n=======\n * A callback fired when the phone field loses focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality)\n *\n * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur?: CallbackEventListener;\n /**\n<<<<<<< HEAD\n * Callback when the user has **finished editing** a field, for example, once they have blurred the field.\n=======\n * A callback fired when the phone field value changes.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality)\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change?: CallbackEventListener;\n /**\n<<<<<<< HEAD\n * A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n=======\n * A callback fired when the phone field receives focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality)\n *\n * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus?: CallbackEventListener;\n /**\n * A callback fired when the user inputs data into the phone field.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input?: CallbackEventListener;\n}" }, "CallbackEventListener": { "filePath": "src/surfaces/checkout/components/PhoneField.ts", @@ -215953,7 +215982,7 @@ "PhoneFieldElementSlots": { "filePath": "src/surfaces/checkout/components/PhoneField.ts", "name": "PhoneFieldElementSlots", - "description": "Learn more about [component slots](/docs/api/checkout-ui-extensions/latest/using-polaris-components#slots).", + "description": "", "isPublicDocs": true, "members": [ { @@ -215961,11 +215990,11 @@ "syntaxKind": "PropertySignature", "name": "accessory", "value": "HTMLElement", - "description": "Additional content to be displayed in the field. Commonly used to display an icon that activates a tooltip providing more information.", + "description": "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.", "isOptional": true } ], - "value": "export interface PhoneFieldElementSlots {\n /**\n * Additional content to be displayed in the field.\n * Commonly used to display an icon that activates a tooltip providing more information.\n */\n accessory?: HTMLElement;\n}" + "value": "export interface PhoneFieldElementSlots {\n /**\n * 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.\n */\n accessory?: HTMLElement;\n}" } } } @@ -216003,7 +216032,7 @@ "PopoverElementProps": { "filePath": "src/surfaces/checkout/components/Popover.ts", "name": "PopoverElementProps", - "description": "The popover component displays contextual content in an overlay triggered by a button using the [`commandFor`](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/button#commandfor) attribute. Use for secondary actions, settings, or information that doesn't require a full modal.\n\nFor interactions that need more space or user focus, such as confirmations or complex forms, use [modal](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/overlays/modal) instead.", + "description": "", "isPublicDocs": true, "members": [ { @@ -216020,7 +216049,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -216105,7 +216134,7 @@ "PopoverElementEvents": { "filePath": "src/surfaces/checkout/components/Popover.ts", "name": "PopoverElementEvents", - "description": "Learn more about [registering events](/docs/api/checkout-ui-extensions/latest/using-polaris-components#event-handling).", + "description": "", "isPublicDocs": true, "members": [ { @@ -216179,7 +216208,7 @@ "PressButtonElementProps": { "filePath": "src/surfaces/checkout/components/PressButton.ts", "name": "PressButtonElementProps", - "description": "Allows users to toggle between active/inactive states. Use to represent a persistent on/off or selected/unselected status.", + "description": "", "isPublicDocs": true, "members": [ { @@ -216187,7 +216216,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityLabel", "value": "string", - "description": "A label that describes the purpose or contents of the Button. It will be read to users using assistive technologies such as screen readers.\n\nUse this when using only an icon or the Button text is not enough context for users using assistive technologies.", + "description": "A label that describes the purpose or content of the button for users of assistive technologies such as screen readers. Use this when the visible content alone doesn't provide enough context.", "isOptional": true }, { @@ -216204,7 +216233,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the Button meaning it cannot be clicked or receive focus.", + "description": "Whether the button is disabled, preventing it from being clicked or receiving focus.", "isOptional": true, "defaultValue": "false" }, @@ -216213,7 +216242,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -216221,7 +216250,7 @@ "syntaxKind": "PropertySignature", "name": "inlineSize", "value": "'auto' | 'fill' | 'fit-content'", - "description": "The displayed inline width of the Button.\n\n- `auto`: the size of the button depends on the surface and context.\n- `fill`: the button will takes up 100% of the available inline size.\n- `fit-content`: the button will take up the minimum inline-size required to fit its content.", + "description": "The inline width of the button component.\n\n- `auto`: The size depends on the surface and context.\n- `fill`: The button takes up 100% of the available inline size.\n- `fit-content`: The button takes up the minimum inline-size required to fit its content.", "isOptional": true, "defaultValue": "'auto'" }, @@ -216230,7 +216259,7 @@ "syntaxKind": "PropertySignature", "name": "lang", "value": "string", - "description": "Indicate the text language. Useful when the text is in a different language than the rest of the page. It will allow assistive technologies such as screen readers to invoke the correct pronunciation. [Reference of values](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry) (\"subtag\" label)", + "description": "The language of the button's text content. Use this when the button text is in a different language than the rest of the page, so assistive technologies can invoke the correct pronunciation. [Reference of values](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry) (`Subtag` label)", "isOptional": true }, { @@ -216238,7 +216267,7 @@ "syntaxKind": "PropertySignature", "name": "loading", "value": "boolean", - "description": "Replaces content with a loading indicator while a background action is being performed.\n\nThis also disables the Button.", + "description": "Whether the button is in a loading state, which replaces the button content with a loading indicator while a background action is being performed.\n\nThis also disables the button.", "isOptional": true, "defaultValue": "false" }, @@ -216264,7 +216293,7 @@ "PressButtonElementEvents": { "filePath": "src/surfaces/checkout/components/PressButton.ts", "name": "PressButtonElementEvents", - "description": "Learn more about [registering events](/docs/api/checkout-ui-extensions/latest/using-polaris-components#event-handling).", + "description": "", "isPublicDocs": true, "members": [ { @@ -216272,7 +216301,7 @@ "syntaxKind": "PropertySignature", "name": "blur", "value": "CallbackEventListener", - "description": "Callback when the button has lost focus.", + "description": "A callback fired when the button loses focus.\n\nLearn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", "isOptional": true }, { @@ -216280,7 +216309,7 @@ "syntaxKind": "PropertySignature", "name": "click", "value": "CallbackEventListener", - "description": "Callback when the button is activated.", + "description": "A callback fired when the button is clicked.\n\nLearn more about the [click event](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event).", "isOptional": true }, { @@ -216288,11 +216317,11 @@ "syntaxKind": "PropertySignature", "name": "focus", "value": "CallbackEventListener", - "description": "Callback when the button has received focus.", + "description": "A callback fired when the button receives focus.\n\nLearn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", "isOptional": true } ], - "value": "export interface PressButtonElementEvents {\n /**\n * Callback when the button is activated.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event\n */\n click?: CallbackEventListener;\n /**\n * Callback when the button has lost focus.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event\n */\n blur?: CallbackEventListener;\n /**\n * Callback when the button has received focus.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event\n */\n focus?: CallbackEventListener;\n}" + "value": "export interface PressButtonElementEvents {\n /**\n * A callback fired when the button is clicked.\n *\n * Learn more about the [click event](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event).\n */\n click?: CallbackEventListener;\n /**\n * A callback fired when the button loses focus.\n *\n * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur?: CallbackEventListener;\n /**\n * A callback fired when the button receives focus.\n *\n * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus?: CallbackEventListener;\n}" }, "CallbackEventListener": { "filePath": "src/surfaces/checkout/components/PressButton.ts", @@ -216346,7 +216375,7 @@ "ProductThumbnailElementProps": { "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", "name": "ProductThumbnailElementProps", - "description": "Use ProductThumbnail to display a product thumbnail", + "description": "", "isPublicDocs": true, "members": [ { @@ -216438,7 +216467,7 @@ "ProgressElementProps": { "filePath": "src/surfaces/checkout/components/Progress.ts", "name": "ProgressElementProps", - "description": "Displays an indicator showing the completion status of a task. Use to visually communicate progress in either determinate (known percentage) or indeterminate (unknown duration) states.", + "description": "", "isPublicDocs": true, "members": [ { @@ -216446,7 +216475,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityLabel", "value": "string", - "description": "A label that describes the purpose of the progress. When set, it will be announced to users using assistive technologies and will provide them with more context.\n\nUse it to provide context of what is progressing.", + "description": "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\".", "isOptional": true }, { @@ -216454,7 +216483,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -216462,7 +216491,7 @@ "syntaxKind": "PropertySignature", "name": "max", "value": "number", - "description": "This attribute describes how much work the task indicated by the progress element requires.\n\nThe `max` attribute, if present, must have a value greater than 0 and be a valid floating point number.", + "description": "The total amount of work the task requires. Must be a value greater than `0` and a valid floating point number.\n\nLearn more about the [max attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/progress#max).", "isOptional": true, "defaultValue": "1" }, @@ -216471,7 +216500,7 @@ "syntaxKind": "PropertySignature", "name": "tone", "value": "'auto' | 'critical'", - "description": "Sets the tone of the progress, based on the intention of the information being conveyed.", + "description": "The semantic meaning and color treatment of the progress indicator.\n\n- `auto`: Automatically determined based on context.\n- `critical`: Indicates an urgent or error state requiring immediate attention.", "isOptional": true, "defaultValue": "'auto'" }, @@ -216480,11 +216509,11 @@ "syntaxKind": "PropertySignature", "name": "value", "value": "number", - "description": "Specifies how much of the task has been completed.\n\nIt must be a valid floating point number between 0 and `max`, or between 0 and 1 if `max` is omitted. If there is no value attribute, the progress bar is indeterminate; this indicates that an activity is ongoing with no indication of how long it is expected to take.", + "description": "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.\n\nLearn more about the [value attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/progress#value).", "isOptional": true } ], - "value": "export interface ProgressElementProps extends Pick {\n tone?: Extract;\n}" + "value": "export interface ProgressElementProps extends Pick {\n /**\n * 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\".\n */\n accessibilityLabel?: ProgressProps$1['accessibilityLabel'];\n /**\n * The total amount of work the task requires. Must be a value greater than `0` and a valid floating point number.\n *\n * Learn more about the [max attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/progress#max).\n *\n * @default 1\n */\n max?: ProgressProps$1['max'];\n /**\n * The semantic meaning and color treatment of the progress indicator.\n *\n * - `auto`: Automatically determined based on context.\n * - `critical`: Indicates an urgent or error state requiring immediate attention.\n *\n * @default 'auto'\n */\n tone?: Extract;\n /**\n * 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.\n *\n * Learn more about the [value attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/progress#value).\n */\n value?: ProgressProps$1['value'];\n}" } } } @@ -216529,7 +216558,7 @@ "QRCodeElementProps": { "filePath": "src/surfaces/checkout/components/QRCode.ts", "name": "QRCodeElementProps", - "description": "Displays a scannable QR code representing data such as URLs or text. Use to let users quickly access information by scanning with a smartphone or other device.", + "description": "", "isPublicDocs": true, "members": [ { @@ -216563,7 +216592,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -216604,7 +216633,7 @@ "QRCodeElementEvents": { "filePath": "src/surfaces/checkout/components/QRCode.ts", "name": "QRCodeElementEvents", - "description": "Learn more about [registering events](/docs/api/checkout-ui-extensions/latest/using-polaris-components#event-handling).", + "description": "", "isPublicDocs": true, "members": [ { @@ -216684,7 +216713,7 @@ "QueryContainerElementProps": { "filePath": "src/surfaces/checkout/components/QueryContainer.ts", "name": "QueryContainerElementProps", - "description": "The query container component establishes a container query context for responsive design. Use query container to define an element as a containment context, enabling child components or styles to adapt based on the container's size rather than viewport width.\n\nQuery containers support modern responsive patterns where components respond to their container dimensions, creating more flexible and reusable layouts.", + "description": "", "isPublicDocs": true, "members": [ { @@ -216701,7 +216730,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true } ], @@ -216743,7 +216772,7 @@ "ScrollBoxElementProps": { "filePath": "src/surfaces/checkout/components/ScrollBox.ts", "name": "ScrollBoxElementProps", - "description": "Provides a scrollable container for long content that exceeds the available space. Use to display lists, order summaries, or other lengthy content while maintaining a constrained layout.", + "description": "", "isPublicDocs": true, "members": [ { @@ -216768,7 +216797,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityVisibility", "value": "'visible' | 'hidden' | 'exclusive'", - "description": "Changes the visibility of the element.\n\n- `visible`: the element is visible to all users.\n- `hidden`: the element is removed from the accessibility tree but remains visible.\n- `exclusive`: the element is visually hidden but remains in the accessibility tree.", + "description": "Controls how the element is exposed to sighted users and to assistive technologies such as screen readers.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", "isOptional": true, "defaultValue": "'visible'" }, @@ -216777,7 +216806,7 @@ "syntaxKind": "PropertySignature", "name": "background", "value": "'base' | 'subdued' | 'transparent'", - "description": "Adjust the background of the element.", + "description": "The background color of the scroll box.\n\n- `base`: The standard background color for general content areas.\n- `subdued`: A muted background for secondary or supporting content.\n- `transparent`: No background color (the default).", "isOptional": true, "defaultValue": "'transparent'" }, @@ -216795,9 +216824,9 @@ "syntaxKind": "PropertySignature", "name": "border", "value": "BorderShorthand", - "description": "Applies a border using shorthand syntax to specify width, color, and style in a single property.\n\nAccepts a size value, optionally followed by a color, optionally followed by a style. Omitted values use defaults: color defaults to `base`, style defaults to `auto`.\n\nIndividual properties (`borderWidth`, `borderStyle`, `borderColor`) can override values set here.", + "description": "A shorthand for setting the border width, color, and style in a single property. Individual border properties (`borderWidth`, `borderStyle`, `borderColor`) can override values set here.", "isOptional": true, - "defaultValue": "'none' - equivalent to `none base auto`.", + "defaultValue": "'none'", "examples": [ { "title": "Example", @@ -216816,7 +216845,7 @@ "syntaxKind": "PropertySignature", "name": "borderColor", "value": "'' | 'base'", - "description": "Controls the color of the border using the design system's color scale.\n\nWhen set, this overrides the color value specified in the `border` property. Choose from `subdued`, `base`, or `strong` to match the visual emphasis needed.", + "description": "The color of the border using the design system's color scale. Overrides the color value set by `border`.", "isOptional": true, "defaultValue": "'' - meaning no override" }, @@ -216825,7 +216854,7 @@ "syntaxKind": "PropertySignature", "name": "borderRadius", "value": "MaybeAllValuesShorthandProperty>", - "description": "Controls the roundedness of the element's corners using the design system's radius scale.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) using flow-relative values:\n- One value: applies to all corners\n- Two values: applies to start corners (top-left & bottom-right) and end corners (top-right & bottom-left) respectively\n- Three values: applies to start-start (top-left), end corners (top-right & bottom-left), and end-end (bottom-right) respectively\n- Four values: applies to start-start (top-left), start-end (top-right), end-end (bottom-right), and end-start (bottom-left) respectively\n\nExamples:\n- `small-100`: All corners have `small-100` radius\n- `small-100 none`: Top-left and bottom-right are `small-100`, top-right and bottom-left are `none`\n- `small-100 none large-100`: Top-left is `small-100`, top-right and bottom-left are `none`, bottom-right is `large-100`\n- `small-100 none large-100 base`: Each corner has its specified radius value", + "description": "The roundedness of the scroll box's corners.\n\n- `none`: Sharp corners with no rounding.\n- `small-100` / `small`: Subtle rounding for compact elements.\n- `base`: Standard rounding for most use cases.\n- `large` / `large-100`: More pronounced rounding for prominent containers.\n- `max`: Maximum rounding, creating a pill or circular shape.\n\nSupports 1-to-4-value shorthand syntax for specifying different radii per corner.", "isOptional": true, "defaultValue": "'none'" }, @@ -216843,7 +216872,7 @@ "syntaxKind": "PropertySignature", "name": "borderWidth", "value": "MaybeAllValuesShorthandProperty | ''", - "description": "Controls the thickness of the border on all sides. When set, this overrides the width value specified in the `border` property.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) for specifying different widths per side:\n- One value: applies to all sides\n- Two values: applies to block sides (top/bottom) and inline sides (left/right) respectively\n- Three values: applies to block-start (top), inline sides (left/right), and block-end (bottom) respectively\n- Four values: applies to block-start (top), inline-end (right), block-end (bottom), and inline-start (left) respectively", + "description": "The thickness of the border on all sides. Supports 1-to-4-value shorthand syntax for specifying different widths per side. Overrides the width value set by `border`.", "isOptional": true, "defaultValue": "'' - meaning no override" }, @@ -216852,7 +216881,7 @@ "syntaxKind": "PropertySignature", "name": "display", "value": "MaybeResponsive<\"auto\" | \"none\">", - "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.", + "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.\n\nLearn more about the [display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display).", "isOptional": true, "defaultValue": "'auto'" }, @@ -216861,7 +216890,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -216982,14 +217011,14 @@ "defaultValue": "'' - meaning no override" } ], - "value": "export interface ScrollBoxElementProps extends Pick {\n background?: Extract;\n border?: BorderShorthand;\n borderColor?: ReducedColorKeyword | '';\n borderRadius?: MaybeAllValuesShorthandProperty>;\n borderWidth?: MaybeAllValuesShorthandProperty | '';\n}" + "value": "export interface ScrollBoxElementProps extends Pick {\n /**\n * The background color of the scroll box.\n *\n * - `base`: The standard background color for general content areas.\n * - `subdued`: A muted background for secondary or supporting content.\n * - `transparent`: No background color (the default).\n *\n * @default 'transparent'\n */\n background?: Extract;\n /**\n * A shorthand for setting the border width, color, and style in a single property. Individual border properties (`borderWidth`, `borderStyle`, `borderColor`) can override values set here.\n *\n * @default 'none'\n */\n border?: BorderShorthand;\n /**\n * The color of the border using the design system's color scale. Overrides the color value set by `border`.\n *\n * @default '' - meaning no override\n */\n borderColor?: ReducedColorKeyword | '';\n /**\n * The roundedness of the scroll box's corners.\n *\n * - `none`: Sharp corners with no rounding.\n * - `small-100` / `small`: Subtle rounding for compact elements.\n * - `base`: Standard rounding for most use cases.\n * - `large` / `large-100`: More pronounced rounding for prominent containers.\n * - `max`: Maximum rounding, creating a pill or circular shape.\n *\n * Supports 1-to-4-value shorthand syntax for specifying different radii per corner.\n *\n * @default 'none'\n */\n borderRadius?: MaybeAllValuesShorthandProperty>;\n /**\n * The thickness of the border on all sides. Supports 1-to-4-value shorthand syntax for specifying different widths per side. Overrides the width value set by `border`.\n *\n * @default '' - meaning no override\n */\n borderWidth?: MaybeAllValuesShorthandProperty | '';\n}" }, "AccessibilityRole": { "filePath": "src/surfaces/checkout/components/components.ts", "syntaxKind": "TypeAliasDeclaration", "name": "AccessibilityRole", "value": "\"main\" | \"header\" | \"footer\" | \"section\" | \"aside\" | \"navigation\" | \"ordered-list\" | \"list-item\" | \"list-item-separator\" | \"unordered-list\" | \"separator\" | \"status\" | \"alert\" | \"generic\" | \"presentation\" | \"none\"", - "description": "", + "description": "The semantic role of a component, used by assistive technologies to convey the element’s purpose to users. Each role maps to a specific HTML element or ARIA role.\n\n- `main`: The primary content of the page.\n- `header`: A page or section header.\n- `footer`: Information such as copyright, navigation links, and privacy statements.\n- `section`: A generic section that should have a heading or `accessibilityLabel`.\n- `aside`: Supporting content related to the main content.\n- `navigation`: A major group of navigation links.\n- `ordered-list`: A list of ordered items.\n- `list-item`: An item inside a list.\n- `list-item-separator`: A divider between list items.\n- `unordered-list`: A list of unordered items.\n- `separator`: A divider that separates sections of content.\n- `status`: A live region with advisory information that is not urgent.\n- `alert`: Important, usually time-sensitive information.\n- `generic`: A nameless container with no semantic meaning (renders a `
`).\n- `presentation`: Strips semantic meaning while keeping visual styling. Synonym for `none`.\n- `none`: Strips semantic meaning while keeping visual styling. Synonym for `presentation`.", "isPublicDocs": true }, "MaybeResponsive": { @@ -217021,7 +217050,7 @@ "syntaxKind": "TypeAliasDeclaration", "name": "BorderShorthand", "value": "ReducedBorderSizeKeyword | `${ReducedBorderSizeKeyword} ${ReducedColorKeyword}` | `${ReducedBorderSizeKeyword} ${ReducedColorKeyword} ${BorderStyleKeyword}`", - "description": "", + "description": "A shorthand string for specifying border properties. Accepts a size alone (`'base'`), size with color (`'base base'`), or size with color and style (`'base base dashed'`). Omitted values use their defaults.", "isPublicDocs": true }, "ReducedBorderSizeKeyword": { @@ -217084,7 +217113,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityVisibility", "value": "'visible' | 'hidden' | 'exclusive'", - "description": "Changes the visibility of the element.\n\n- `visible`: the element is visible to all users.\n- `hidden`: the element is removed from the accessibility tree but remains visible.\n- `exclusive`: the element is visually hidden but remains in the accessibility tree.", + "description": "Controls how the element is exposed to sighted users and to assistive technologies such as screen readers.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", "isOptional": true, "defaultValue": "'visible'" }, @@ -217093,7 +217122,7 @@ "syntaxKind": "PropertySignature", "name": "background", "value": "'base' | 'subdued' | 'transparent'", - "description": "Adjust the background of the element.", + "description": "The background color of the scroll box.\n\n- `base`: The standard background color for general content areas.\n- `subdued`: A muted background for secondary or supporting content.\n- `transparent`: No background color (the default).", "isOptional": true, "defaultValue": "'transparent'" }, @@ -217111,23 +217140,25 @@ "syntaxKind": "PropertySignature", "name": "border", "value": "BorderShorthand", - "description": "Applies a border using shorthand syntax to specify width, color, and style in a single property.\n\nAccepts a size value, optionally followed by a color, optionally followed by a style. Omitted values use defaults: color defaults to `base`, style defaults to `auto`.\n\nIndividual properties (`borderWidth`, `borderStyle`, `borderColor`) can override values set here.", - "isOptional": true + "description": "A shorthand for setting the border width, color, and style in a single property. Individual border properties (`borderWidth`, `borderStyle`, `borderColor`) can override values set here.", + "isOptional": true, + "defaultValue": "'none'" }, { "filePath": "src/surfaces/checkout/components/ScrollBox.ts", "syntaxKind": "PropertySignature", "name": "borderColor", "value": "'' | 'base'", - "description": "Controls the color of the border using the design system's color scale.\n\nWhen set, this overrides the color value specified in the `border` property. Choose from `subdued`, `base`, or `strong` to match the visual emphasis needed.", - "isOptional": true + "description": "The color of the border using the design system's color scale. Overrides the color value set by `border`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" }, { "filePath": "src/surfaces/checkout/components/ScrollBox.ts", "syntaxKind": "PropertySignature", "name": "borderRadius", "value": "MaybeAllValuesShorthandProperty>", - "description": "Controls the roundedness of the element's corners using the design system's radius scale.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) using flow-relative values:\n- One value: applies to all corners\n- Two values: applies to start corners (top-left & bottom-right) and end corners (top-right & bottom-left) respectively\n- Three values: applies to start-start (top-left), end corners (top-right & bottom-left), and end-end (bottom-right) respectively\n- Four values: applies to start-start (top-left), start-end (top-right), end-end (bottom-right), and end-start (bottom-left) respectively\n\nExamples:\n- `small-100`: All corners have `small-100` radius\n- `small-100 none`: Top-left and bottom-right are `small-100`, top-right and bottom-left are `none`\n- `small-100 none large-100`: Top-left is `small-100`, top-right and bottom-left are `none`, bottom-right is `large-100`\n- `small-100 none large-100 base`: Each corner has its specified radius value", + "description": "The roundedness of the scroll box's corners.\n\n- `none`: Sharp corners with no rounding.\n- `small-100` / `small`: Subtle rounding for compact elements.\n- `base`: Standard rounding for most use cases.\n- `large` / `large-100`: More pronounced rounding for prominent containers.\n- `max`: Maximum rounding, creating a pill or circular shape.\n\nSupports 1-to-4-value shorthand syntax for specifying different radii per corner.", "isOptional": true, "defaultValue": "'none'" }, @@ -217145,15 +217176,16 @@ "syntaxKind": "PropertySignature", "name": "borderWidth", "value": "MaybeAllValuesShorthandProperty | ''", - "description": "Controls the thickness of the border on all sides. When set, this overrides the width value specified in the `border` property.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) for specifying different widths per side:\n- One value: applies to all sides\n- Two values: applies to block sides (top/bottom) and inline sides (left/right) respectively\n- Three values: applies to block-start (top), inline sides (left/right), and block-end (bottom) respectively\n- Four values: applies to block-start (top), inline-end (right), block-end (bottom), and inline-start (left) respectively", - "isOptional": true + "description": "The thickness of the border on all sides. Supports 1-to-4-value shorthand syntax for specifying different widths per side. Overrides the width value set by `border`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" }, { "filePath": "src/surfaces/checkout/components/ScrollBox.ts", "syntaxKind": "PropertySignature", "name": "display", "value": "MaybeResponsive<\"auto\" | \"none\">", - "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.", + "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.\n\nLearn more about the [display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display).", "isOptional": true, "defaultValue": "'auto'" }, @@ -217162,7 +217194,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -217369,7 +217401,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityLabel", "value": "string", - "description": "A label used to describe the section that will be announced by assistive technologies.\n\nWhen no `heading` property is provided or included as a children of the Section, you **must** provide an `accessibilityLabel` to describe the Section. This is important as it allows assistive technologies to provide the right context to users.", + "description": "A label used to describe the section that will be announced by assistive technologies.\n\nWhen no `heading` property is provided or included as a child of the section, you **must** provide an `accessibilityLabel` to describe the section. This is important as it allows assistive technologies to provide the right context to users.", "isOptional": true }, { @@ -217377,7 +217409,7 @@ "syntaxKind": "PropertySignature", "name": "heading", "value": "string", - "description": "A title that describes the content of the section.", + "description": "A title displayed at the top of the section. When provided, it serves as both a visible heading and the accessible name for the section. If omitted, you must provide an `accessibilityLabel` instead.", "isOptional": true }, { @@ -217385,7 +217417,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true } ], @@ -217440,7 +217472,7 @@ "SelectElementProps": { "filePath": "src/surfaces/checkout/components/Select.ts", "name": "SelectElementProps", - "description": "Properties for the Select component element.", + "description": "", "isPublicDocs": true, "members": [ { @@ -217448,7 +217480,7 @@ "syntaxKind": "PropertySignature", "name": "autocomplete", "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", "isOptional": true, "defaultValue": "'on' for everything else" }, @@ -217457,7 +217489,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -217466,7 +217498,7 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -217474,7 +217506,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -217482,7 +217514,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Content to use as the field label.", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", "isOptional": true }, { @@ -217490,7 +217522,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -217498,7 +217530,7 @@ "syntaxKind": "PropertySignature", "name": "placeholder", "value": "string", - "description": "A short hint that describes the expected value of the field.", + "description": "The placeholder text displayed in the field when it's empty, providing a hint about the expected input format or value.", "isOptional": true }, { @@ -217547,7 +217579,7 @@ "SelectElementEvents": { "filePath": "src/surfaces/checkout/components/Select.ts", "name": "SelectElementEvents", - "description": "Events for the Select component element.", + "description": "", "isPublicDocs": true, "members": [ { @@ -217555,7 +217587,7 @@ "syntaxKind": "PropertySignature", "name": "blur", "value": "CallbackEventListener", - "description": "Callback when the element loses focus.", + "description": "<<<<<<< HEAD A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n======= A callback fired when the select loses focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) \n Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", "isOptional": true }, { @@ -217563,7 +217595,7 @@ "syntaxKind": "PropertySignature", "name": "change", "value": "CallbackEventListener", - "description": "Callback when the user has **finished editing** a field, e.g. once they have blurred the field.", + "description": "<<<<<<< HEAD Callback when the user has **finished editing** a field, for example, once they have blurred the field.\n======= A callback fired when the select value changes.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) \n Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", "isOptional": true }, { @@ -217571,11 +217603,11 @@ "syntaxKind": "PropertySignature", "name": "focus", "value": "CallbackEventListener", - "description": "Callback when the element receives focus.", + "description": "<<<<<<< HEAD A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n======= A callback fired when the select receives focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) \n Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", "isOptional": true } ], - "value": "export interface SelectElementEvents {\n /**\n * Callback when the element loses focus.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event\n */\n blur?: CallbackEventListener;\n /**\n * Callback when the user has **finished editing** a field, e.g. once they have blurred the field.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event\n */\n change?: CallbackEventListener;\n /**\n * Callback when the element receives focus.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event\n */\n focus?: CallbackEventListener;\n}" + "value": "export interface SelectElementEvents {\n /**\n<<<<<<< HEAD\n * A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n=======\n * A callback fired when the select loses focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality)\n *\n * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur?: CallbackEventListener;\n /**\n<<<<<<< HEAD\n * Callback when the user has **finished editing** a field, for example, once they have blurred the field.\n=======\n * A callback fired when the select value changes.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality)\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change?: CallbackEventListener;\n /**\n<<<<<<< HEAD\n * A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n=======\n * A callback fired when the select receives focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality)\n *\n * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus?: CallbackEventListener;\n}" }, "CallbackEventListener": { "filePath": "src/surfaces/checkout/components/Select.ts", @@ -217603,7 +217635,7 @@ "OptionElementProps": { "filePath": "src/surfaces/checkout/components/Option.ts", "name": "OptionElementProps", - "description": "Represents a single option within a select component. Use only as a child of `s-select` components.", + "description": "", "isPublicDocs": true, "members": [ { @@ -217619,7 +217651,7 @@ "syntaxKind": "PropertySignature", "name": "defaultSelected", "value": "boolean", - "description": "Whether the control is active by default.", + "description": "Whether the control is selected by default.", "isOptional": true, "defaultValue": "false" }, @@ -217628,7 +217660,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the control, disallowing any interaction.", + "description": "Whether the control is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -217637,7 +217669,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -217645,7 +217677,7 @@ "syntaxKind": "PropertySignature", "name": "selected", "value": "boolean", - "description": "Whether the control is active.", + "description": "Whether the control is currently selected.", "isOptional": true, "defaultValue": "false" }, @@ -217696,7 +217728,7 @@ "SheetElementProps": { "filePath": "src/surfaces/checkout/components/Sheet.ts", "name": "SheetElementProps", - "description": "The Sheet component displays essential information for customers at the bottom of the screen, appearing above other elements. Use it sparingly to avoid distracting customers during checkout. This component requires access to [Customer Privacy API](/docs/api/checkout-ui-extensions/latest/configuration#collect-buyer-consent) to be rendered.\n\nThe library automatically applies the [WAI-ARIA Dialog pattern](https://www.w3.org/WAI/ARIA/apg/patterns/dialog-modal/) to both the activator and the sheet content.", + "description": "", "isPublicDocs": true, "members": [ { @@ -217729,7 +217761,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true } ], @@ -217745,7 +217777,7 @@ "SheetElementEvents": { "filePath": "src/surfaces/checkout/components/Sheet.ts", "name": "SheetElementEvents", - "description": "Learn more about [registering events](/docs/api/checkout-ui-extensions/latest/using-polaris-components#event-handling).", + "description": "", "isPublicDocs": true, "members": [ { @@ -217809,7 +217841,7 @@ "SheetElementSlots": { "filePath": "src/surfaces/checkout/components/Sheet.ts", "name": "SheetElementSlots", - "description": "Learn more about [component slots](/docs/api/checkout-ui-extensions/latest/using-polaris-components#slots).", + "description": "", "isPublicDocs": true, "members": [ { @@ -217841,7 +217873,7 @@ "SheetElementMethods": { "filePath": "src/surfaces/checkout/components/Sheet.ts", "name": "SheetElementMethods", - "description": "Learn more about [component methods](/docs/api/checkout-ui-extensions/latest/using-polaris-components#methods).", + "description": "", "isPublicDocs": true, "members": [ { @@ -217903,7 +217935,7 @@ "SkeletonParagraphElementProps": { "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", "name": "SkeletonParagraphElementProps", - "description": "Displays a placeholder representation of text content while it loads. Use to improve perceived performance by showing users where text will appear.", + "description": "", "isPublicDocs": true, "members": [ { @@ -217920,7 +217952,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true } ], @@ -217962,7 +217994,7 @@ "SpinnerElementProps": { "filePath": "src/surfaces/checkout/components/Spinner.ts", "name": "SpinnerElementProps", - "description": "Properties for the Spinner component element.", + "description": "", "isPublicDocs": true, "members": [ { @@ -217970,7 +218002,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityLabel", "value": "string", - "description": "A label that describes the purpose of the progress. When set, it will be announced to users using assistive technologies and will provide them with more context. Providing an `accessibilityLabel` is recommended if there is no accompanying text describing that something is loading.", + "description": "A label that describes the purpose of the spinner for assistive technologies like screen readers. Provide an `accessibilityLabel` when there is no visible text that conveys a loading state.", "isOptional": true }, { @@ -217978,7 +218010,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -217986,12 +218018,12 @@ "syntaxKind": "PropertySignature", "name": "size", "value": "'small' | 'large' | 'base' | 'small-100' | 'large-100'", - "description": "Adjusts the size of the spinner icon.", + "description": "The size of the spinner icon.\n\n- `base`: The default size, suitable for most use cases.\n- `small`: A compact size for secondary loading states.\n- `small-100`: The smallest size for tight spaces or inline indicators.\n- `large`: A larger size for more prominent loading states.\n- `large-100`: The largest size for full-page or section-level loading indicators.", "isOptional": true, "defaultValue": "'base'" } ], - "value": "export interface SpinnerElementProps extends SpinnerProps$1 {\n size?: Extract;\n}" + "value": "export interface SpinnerElementProps extends SpinnerProps$1 {\n /**\n * A label that describes the purpose of the spinner for assistive technologies like screen readers. Provide an `accessibilityLabel` when there is no visible text that conveys a loading state.\n */\n accessibilityLabel?: SpinnerProps$1['accessibilityLabel'];\n /**\n * The size of the spinner icon.\n *\n * - `base`: The default size, suitable for most use cases.\n * - `small`: A compact size for secondary loading states.\n * - `small-100`: The smallest size for tight spaces or inline indicators.\n * - `large`: A larger size for more prominent loading states.\n * - `large-100`: The largest size for full-page or section-level loading indicators.\n *\n * @default 'base'\n */\n size?: Extract;\n}" } } } @@ -218029,7 +218061,7 @@ "StackElementProps": { "filePath": "src/surfaces/checkout/components/Stack.ts", "name": "StackElementProps", - "description": "The stack component organizes elements horizontally or vertically along the block or inline axis. Use stack to structure layouts, group related components, control spacing between elements, or create flexible arrangements that adapt to content.\n\nStacks support gap spacing, alignment, wrapping, and distribution properties to create consistent, responsive layouts without custom CSS. For complex multi-column layouts with precise grid positioning, use [grid](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/layout-and-structure/grid).", + "description": "", "isPublicDocs": true, "members": [ { @@ -218045,7 +218077,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityRole", "value": "'aside' | 'footer' | 'header' | 'main' | 'section' | 'status' | 'none' | 'navigation' | 'ordered-list' | 'list-item' | 'list-item-separator' | 'unordered-list' | 'separator' | 'alert' | 'generic'", - "description": "Sets the semantic meaning of the component’s content. When set, the role will be used by assistive technologies to help users navigate the page.", + "description": "The semantic meaning of the stack's content, used by assistive technologies.\n\n- `aside`: Supporting content related to the main content.\n- `footer`: Information such as copyright, navigation links, and privacy statements.\n- `header`: A page or section header.\n- `main`: The primary content of the page.\n- `section`: A generic section that should have a heading or `accessibilityLabel`.\n- `status`: A live region with advisory information that is not urgent.\n- `none`: Strips semantic meaning while keeping visual styling.\n- `navigation`: A major group of navigation links.\n- `ordered-list`: A list of ordered items.\n- `list-item`: An item inside a list.\n- `list-item-separator`: A divider between list items.\n- `unordered-list`: A list of unordered items.\n- `separator`: A divider that separates sections of content.\n- `alert`: Important, usually time-sensitive information.\n- `generic`: A nameless container with no semantic meaning (renders a `
`).", "isOptional": true, "defaultValue": "'generic'" }, @@ -218054,7 +218086,7 @@ "syntaxKind": "PropertySignature", "name": "alignContent", "value": "MaybeResponsive>", - "description": "Aligns the Stack along the cross axis.", + "description": "Controls how lines of content are distributed along the cross axis when there is extra space.\n\n- `normal`: Default browser behavior.\n- `space-between`: Distributes lines evenly with no space at the edges.\n- `space-around`: Distributes lines evenly with equal space around each.\n- `space-evenly`: Distributes lines with equal space between and at the edges.\n- `stretch`: Stretches lines to fill the available space.\n- `center`: Packs lines toward the center.\n- `start`: Packs lines toward the start of the cross axis.\n- `end`: Packs lines toward the end of the cross axis.", "isOptional": true, "defaultValue": "'normal'" }, @@ -218063,7 +218095,7 @@ "syntaxKind": "PropertySignature", "name": "alignItems", "value": "MaybeResponsive>", - "description": "Aligns the Stack's children along the cross axis.", + "description": "Controls how child elements are aligned along the cross axis.\n\n- `normal`: Default browser behavior.\n- `stretch`: Stretches children to fill the cross axis.\n- `center`: Centers children along the cross axis.\n- `start`: Aligns children to the start of the cross axis.\n- `end`: Aligns children to the end of the cross axis.", "isOptional": true, "defaultValue": "'normal'" }, @@ -218072,7 +218104,7 @@ "syntaxKind": "PropertySignature", "name": "background", "value": "'base' | 'subdued' | 'transparent'", - "description": "Adjust the background of the element.", + "description": "The background color of the stack.\n\n- `base`: The standard background color for general content areas.\n- `subdued`: A muted background for secondary or supporting content.\n- `transparent`: No background color (the default).", "isOptional": true, "defaultValue": "'transparent'" }, @@ -218090,9 +218122,9 @@ "syntaxKind": "PropertySignature", "name": "border", "value": "BorderShorthand", - "description": "Applies a border using shorthand syntax to specify width, color, and style in a single property.\n\nAccepts a size value, optionally followed by a color, optionally followed by a style. Omitted values use defaults: color defaults to `base`, style defaults to `auto`.\n\nIndividual properties (`borderWidth`, `borderStyle`, `borderColor`) can override values set here.", + "description": "A shorthand for setting the border width, color, and style in a single property. Individual border properties (`borderWidth`, `borderStyle`) can override values set here.", "isOptional": true, - "defaultValue": "'none' - equivalent to `none base auto`.", + "defaultValue": "'none'", "examples": [ { "title": "Example", @@ -218111,7 +218143,7 @@ "syntaxKind": "PropertySignature", "name": "borderRadius", "value": "MaybeAllValuesShorthandProperty>", - "description": "Controls the roundedness of the element's corners using the design system's radius scale.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) using flow-relative values:\n- One value: applies to all corners\n- Two values: applies to start corners (top-left & bottom-right) and end corners (top-right & bottom-left) respectively\n- Three values: applies to start-start (top-left), end corners (top-right & bottom-left), and end-end (bottom-right) respectively\n- Four values: applies to start-start (top-left), start-end (top-right), end-end (bottom-right), and end-start (bottom-left) respectively\n\nExamples:\n- `small-100`: All corners have `small-100` radius\n- `small-100 none`: Top-left and bottom-right are `small-100`, top-right and bottom-left are `none`\n- `small-100 none large-100`: Top-left is `small-100`, top-right and bottom-left are `none`, bottom-right is `large-100`\n- `small-100 none large-100 base`: Each corner has its specified radius value", + "description": "The roundedness of the stack's corners.\n\n- `none`: Sharp corners with no rounding.\n- `small-100` / `small`: Subtle rounding for compact elements.\n- `base`: Standard rounding for most use cases.\n- `large` / `large-100`: More pronounced rounding for prominent containers.\n- `max`: Maximum rounding, creating a pill or circular shape.\n\nSupports 1-to-4-value shorthand syntax for specifying different radii per corner.", "isOptional": true, "defaultValue": "'none'" }, @@ -218129,7 +218161,7 @@ "syntaxKind": "PropertySignature", "name": "borderWidth", "value": "MaybeAllValuesShorthandProperty | ''", - "description": "Controls the thickness of the border on all sides. When set, this overrides the width value specified in the `border` property.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) for specifying different widths per side:\n- One value: applies to all sides\n- Two values: applies to block sides (top/bottom) and inline sides (left/right) respectively\n- Three values: applies to block-start (top), inline sides (left/right), and block-end (bottom) respectively\n- Four values: applies to block-start (top), inline-end (right), block-end (bottom), and inline-start (left) respectively", + "description": "The thickness of the border on all sides. Supports 1-to-4-value shorthand syntax for specifying different widths per side. Overrides the width value set by `border`.", "isOptional": true, "defaultValue": "'' - meaning no override" }, @@ -218156,7 +218188,7 @@ "syntaxKind": "PropertySignature", "name": "display", "value": "MaybeResponsive<\"auto\" | \"none\">", - "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.", + "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.\n\nLearn more about the [display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display).", "isOptional": true, "defaultValue": "'auto'" }, @@ -218174,7 +218206,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -218191,7 +218223,7 @@ "syntaxKind": "PropertySignature", "name": "justifyContent", "value": "MaybeResponsive>", - "description": "Aligns the Stack along the main axis.", + "description": "Controls how child elements are distributed along the main axis.\n\n- `normal`: Default browser behavior.\n- `space-between`: Distributes children evenly with no space at the edges.\n- `space-around`: Distributes children evenly with equal space around each.\n- `space-evenly`: Distributes children with equal space between and at the edges.\n- `stretch`: Stretches children to fill the available space.\n- `center`: Packs children toward the center.\n- `start`: Packs children toward the start of the main axis.\n- `end`: Packs children toward the end of the main axis.", "isOptional": true, "defaultValue": "'normal'" }, @@ -218313,7 +218345,7 @@ "defaultValue": "'' - meaning no override" } ], - "value": "export interface StackElementProps extends Pick {\n accessibilityRole?: Extract;\n background?: Extract;\n border?: BorderShorthand;\n borderWidth?: MaybeAllValuesShorthandProperty | '';\n borderRadius?: MaybeAllValuesShorthandProperty>;\n alignContent?: MaybeResponsive>;\n alignItems?: MaybeResponsive>;\n justifyContent?: MaybeResponsive>;\n}" + "value": "export interface StackElementProps extends Pick {\n /**\n * The semantic meaning of the stack's content, used by assistive technologies.\n *\n * - `aside`: Supporting content related to the main content.\n * - `footer`: Information such as copyright, navigation links, and privacy statements.\n * - `header`: A page or section header.\n * - `main`: The primary content of the page.\n * - `section`: A generic section that should have a heading or `accessibilityLabel`.\n * - `status`: A live region with advisory information that is not urgent.\n * - `none`: Strips semantic meaning while keeping visual styling.\n * - `navigation`: A major group of navigation links.\n * - `ordered-list`: A list of ordered items.\n * - `list-item`: An item inside a list.\n * - `list-item-separator`: A divider between list items.\n * - `unordered-list`: A list of unordered items.\n * - `separator`: A divider that separates sections of content.\n * - `alert`: Important, usually time-sensitive information.\n * - `generic`: A nameless container with no semantic meaning (renders a `
`).\n *\n * @default 'generic'\n */\n accessibilityRole?: Extract;\n /**\n * The background color of the stack.\n *\n * - `base`: The standard background color for general content areas.\n * - `subdued`: A muted background for secondary or supporting content.\n * - `transparent`: No background color (the default).\n *\n * @default 'transparent'\n */\n background?: Extract;\n /**\n * A shorthand for setting the border width, color, and style in a single property. Individual border properties (`borderWidth`, `borderStyle`) can override values set here.\n *\n * @default 'none'\n */\n border?: BorderShorthand;\n /**\n * The thickness of the border on all sides. Supports 1-to-4-value shorthand syntax for specifying different widths per side. Overrides the width value set by `border`.\n *\n * @default '' - meaning no override\n */\n borderWidth?: MaybeAllValuesShorthandProperty | '';\n /**\n * The roundedness of the stack's corners.\n *\n * - `none`: Sharp corners with no rounding.\n * - `small-100` / `small`: Subtle rounding for compact elements.\n * - `base`: Standard rounding for most use cases.\n * - `large` / `large-100`: More pronounced rounding for prominent containers.\n * - `max`: Maximum rounding, creating a pill or circular shape.\n *\n * Supports 1-to-4-value shorthand syntax for specifying different radii per corner.\n *\n * @default 'none'\n */\n borderRadius?: MaybeAllValuesShorthandProperty>;\n /**\n * Controls how lines of content are distributed along the cross axis when there is extra space.\n *\n * - `normal`: Default browser behavior.\n * - `space-between`: Distributes lines evenly with no space at the edges.\n * - `space-around`: Distributes lines evenly with equal space around each.\n * - `space-evenly`: Distributes lines with equal space between and at the edges.\n * - `stretch`: Stretches lines to fill the available space.\n * - `center`: Packs lines toward the center.\n * - `start`: Packs lines toward the start of the cross axis.\n * - `end`: Packs lines toward the end of the cross axis.\n *\n * @default 'normal'\n */\n alignContent?: MaybeResponsive>;\n /**\n * Controls how child elements are aligned along the cross axis.\n *\n * - `normal`: Default browser behavior.\n * - `stretch`: Stretches children to fill the cross axis.\n * - `center`: Centers children along the cross axis.\n * - `start`: Aligns children to the start of the cross axis.\n * - `end`: Aligns children to the end of the cross axis.\n *\n * @default 'normal'\n */\n alignItems?: MaybeResponsive>;\n /**\n * Controls how child elements are distributed along the main axis.\n *\n * - `normal`: Default browser behavior.\n * - `space-between`: Distributes children evenly with no space at the edges.\n * - `space-around`: Distributes children evenly with equal space around each.\n * - `space-evenly`: Distributes children with equal space between and at the edges.\n * - `stretch`: Stretches children to fill the available space.\n * - `center`: Packs children toward the center.\n * - `start`: Packs children toward the start of the main axis.\n * - `end`: Packs children toward the end of the main axis.\n *\n * @default 'normal'\n */\n justifyContent?: MaybeResponsive>;\n}" }, "MaybeResponsive": { "filePath": "src/surfaces/checkout/components/components.ts", @@ -218342,7 +218374,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityRole", "value": "'aside' | 'footer' | 'header' | 'main' | 'section' | 'status' | 'none' | 'navigation' | 'ordered-list' | 'list-item' | 'list-item-separator' | 'unordered-list' | 'separator' | 'alert' | 'generic'", - "description": "Sets the semantic meaning of the component’s content. When set, the role will be used by assistive technologies to help users navigate the page.", + "description": "The semantic meaning of the stack's content, used by assistive technologies.\n\n- `aside`: Supporting content related to the main content.\n- `footer`: Information such as copyright, navigation links, and privacy statements.\n- `header`: A page or section header.\n- `main`: The primary content of the page.\n- `section`: A generic section that should have a heading or `accessibilityLabel`.\n- `status`: A live region with advisory information that is not urgent.\n- `none`: Strips semantic meaning while keeping visual styling.\n- `navigation`: A major group of navigation links.\n- `ordered-list`: A list of ordered items.\n- `list-item`: An item inside a list.\n- `list-item-separator`: A divider between list items.\n- `unordered-list`: A list of unordered items.\n- `separator`: A divider that separates sections of content.\n- `alert`: Important, usually time-sensitive information.\n- `generic`: A nameless container with no semantic meaning (renders a `
`).", "isOptional": true, "defaultValue": "'generic'" }, @@ -218351,7 +218383,7 @@ "syntaxKind": "PropertySignature", "name": "alignContent", "value": "MaybeResponsive>", - "description": "Aligns the Stack along the cross axis.", + "description": "Controls how lines of content are distributed along the cross axis when there is extra space.\n\n- `normal`: Default browser behavior.\n- `space-between`: Distributes lines evenly with no space at the edges.\n- `space-around`: Distributes lines evenly with equal space around each.\n- `space-evenly`: Distributes lines with equal space between and at the edges.\n- `stretch`: Stretches lines to fill the available space.\n- `center`: Packs lines toward the center.\n- `start`: Packs lines toward the start of the cross axis.\n- `end`: Packs lines toward the end of the cross axis.", "isOptional": true, "defaultValue": "'normal'" }, @@ -218360,7 +218392,7 @@ "syntaxKind": "PropertySignature", "name": "alignItems", "value": "MaybeResponsive>", - "description": "Aligns the Stack's children along the cross axis.", + "description": "Controls how child elements are aligned along the cross axis.\n\n- `normal`: Default browser behavior.\n- `stretch`: Stretches children to fill the cross axis.\n- `center`: Centers children along the cross axis.\n- `start`: Aligns children to the start of the cross axis.\n- `end`: Aligns children to the end of the cross axis.", "isOptional": true, "defaultValue": "'normal'" }, @@ -218369,7 +218401,7 @@ "syntaxKind": "PropertySignature", "name": "background", "value": "'base' | 'subdued' | 'transparent'", - "description": "Adjust the background of the element.", + "description": "The background color of the stack.\n\n- `base`: The standard background color for general content areas.\n- `subdued`: A muted background for secondary or supporting content.\n- `transparent`: No background color (the default).", "isOptional": true, "defaultValue": "'transparent'" }, @@ -218387,15 +218419,16 @@ "syntaxKind": "PropertySignature", "name": "border", "value": "BorderShorthand", - "description": "Applies a border using shorthand syntax to specify width, color, and style in a single property.\n\nAccepts a size value, optionally followed by a color, optionally followed by a style. Omitted values use defaults: color defaults to `base`, style defaults to `auto`.\n\nIndividual properties (`borderWidth`, `borderStyle`, `borderColor`) can override values set here.", - "isOptional": true + "description": "A shorthand for setting the border width, color, and style in a single property. Individual border properties (`borderWidth`, `borderStyle`) can override values set here.", + "isOptional": true, + "defaultValue": "'none'" }, { "filePath": "src/surfaces/checkout/components/Stack.ts", "syntaxKind": "PropertySignature", "name": "borderRadius", "value": "MaybeAllValuesShorthandProperty>", - "description": "Controls the roundedness of the element's corners using the design system's radius scale.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) using flow-relative values:\n- One value: applies to all corners\n- Two values: applies to start corners (top-left & bottom-right) and end corners (top-right & bottom-left) respectively\n- Three values: applies to start-start (top-left), end corners (top-right & bottom-left), and end-end (bottom-right) respectively\n- Four values: applies to start-start (top-left), start-end (top-right), end-end (bottom-right), and end-start (bottom-left) respectively\n\nExamples:\n- `small-100`: All corners have `small-100` radius\n- `small-100 none`: Top-left and bottom-right are `small-100`, top-right and bottom-left are `none`\n- `small-100 none large-100`: Top-left is `small-100`, top-right and bottom-left are `none`, bottom-right is `large-100`\n- `small-100 none large-100 base`: Each corner has its specified radius value", + "description": "The roundedness of the stack's corners.\n\n- `none`: Sharp corners with no rounding.\n- `small-100` / `small`: Subtle rounding for compact elements.\n- `base`: Standard rounding for most use cases.\n- `large` / `large-100`: More pronounced rounding for prominent containers.\n- `max`: Maximum rounding, creating a pill or circular shape.\n\nSupports 1-to-4-value shorthand syntax for specifying different radii per corner.", "isOptional": true, "defaultValue": "'none'" }, @@ -218413,8 +218446,9 @@ "syntaxKind": "PropertySignature", "name": "borderWidth", "value": "MaybeAllValuesShorthandProperty | ''", - "description": "Controls the thickness of the border on all sides. When set, this overrides the width value specified in the `border` property.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) for specifying different widths per side:\n- One value: applies to all sides\n- Two values: applies to block sides (top/bottom) and inline sides (left/right) respectively\n- Three values: applies to block-start (top), inline sides (left/right), and block-end (bottom) respectively\n- Four values: applies to block-start (top), inline-end (right), block-end (bottom), and inline-start (left) respectively", - "isOptional": true + "description": "The thickness of the border on all sides. Supports 1-to-4-value shorthand syntax for specifying different widths per side. Overrides the width value set by `border`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" }, { "filePath": "src/surfaces/checkout/components/Stack.ts", @@ -218439,7 +218473,7 @@ "syntaxKind": "PropertySignature", "name": "display", "value": "MaybeResponsive<\"auto\" | \"none\">", - "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.", + "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.\n\nLearn more about the [display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display).", "isOptional": true, "defaultValue": "'auto'" }, @@ -218457,7 +218491,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -218474,7 +218508,7 @@ "syntaxKind": "PropertySignature", "name": "justifyContent", "value": "MaybeResponsive>", - "description": "Aligns the Stack along the main axis.", + "description": "Controls how child elements are distributed along the main axis.\n\n- `normal`: Default browser behavior.\n- `space-between`: Distributes children evenly with no space at the edges.\n- `space-around`: Distributes children evenly with equal space around each.\n- `space-evenly`: Distributes children with equal space between and at the edges.\n- `stretch`: Stretches children to fill the available space.\n- `center`: Packs children toward the center.\n- `start`: Packs children toward the start of the main axis.\n- `end`: Packs children toward the end of the main axis.", "isOptional": true, "defaultValue": "'normal'" }, @@ -218619,7 +218653,7 @@ "syntaxKind": "TypeAliasDeclaration", "name": "BorderShorthand", "value": "ReducedBorderSizeKeyword | `${ReducedBorderSizeKeyword} ${ReducedColorKeyword}` | `${ReducedBorderSizeKeyword} ${ReducedColorKeyword} ${BorderStyleKeyword}`", - "description": "", + "description": "A shorthand string for specifying border properties. Accepts a size alone (`'base'`), size with color (`'base base'`), or size with color and style (`'base base dashed'`). Omitted values use their defaults.", "isPublicDocs": true }, "ReducedBorderSizeKeyword": { @@ -218749,7 +218783,7 @@ "SwitchElementProps": { "filePath": "src/surfaces/checkout/components/Switch.ts", "name": "SwitchElementProps", - "description": "The switch component provides a clear way for users to toggle options or settings on and off. Use switch for binary controls that take effect immediately, like enabling features, activating settings, or controlling visibility.\n\nSwitches provide instant visual feedback and are ideal for settings that don't require a save action to apply changes. For selections that require explicit submission, use [checkbox](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/forms/checkbox) instead.", + "description": "", "isPublicDocs": true, "members": [ { @@ -218765,7 +218799,7 @@ "syntaxKind": "PropertySignature", "name": "checked", "value": "boolean", - "description": "Whether the control is active.", + "description": "Whether the control is currently checked.", "isOptional": true, "defaultValue": "false" }, @@ -218774,7 +218808,7 @@ "syntaxKind": "PropertySignature", "name": "command", "value": "'--auto' | '--show' | '--hide' | '--toggle'", - "description": "Sets the action the `commandFor` should take when this clickable is activated.\n\nSee the documentation of particular components for the actions they support.\n\n- `--auto`: a default action for the target component.\n- `--show`: shows the target component.\n- `--hide`: hides the target component.\n- `--toggle`: toggles the target component.\n- `--copy`: copies the target ClipboardItem.", + "description": "Sets the action the `commandFor` target should take when this component is activated.\n\n- `--auto`: Performs the default action for the target component.\n- `--show`: Displays the target component.\n- `--hide`: Conceals the target component.\n- `--toggle`: Alternates the target component.\n- `--copy`: Copies the target ClipboardItem.\n\nLearn more about the [`command` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).", "isOptional": true, "defaultValue": "'--auto'" }, @@ -218783,7 +218817,7 @@ "syntaxKind": "PropertySignature", "name": "commandFor", "value": "string", - "description": "ID of a component that should respond to activations (e.g. clicks) on this component.\n\nSee `command` for how to control the behavior of the target.", + "description": "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).\n\nWhen both `commandFor` and `href` are set, `commandFor` takes precedence. The command runs and the link doesn't navigate.", "isOptional": true }, { @@ -218791,7 +218825,7 @@ "syntaxKind": "PropertySignature", "name": "defaultChecked", "value": "boolean", - "description": "Whether the control is active by default.", + "description": "Whether the control is checked by default.", "isOptional": true, "defaultValue": "false" }, @@ -218800,7 +218834,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the control, disallowing any interaction.", + "description": "Whether the control is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -218809,7 +218843,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -218817,7 +218851,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Visual content to use as the control label.", + "description": "The text displayed as the control label, which identifies the purpose of the control to users. This label is associated with the control for accessibility.", "isOptional": true }, { @@ -218825,7 +218859,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the control that is unique within the nearest containing `Form` component.", + "description": "The name attribute for the control, used to identify its value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -218849,7 +218883,7 @@ "SwitchElementEvents": { "filePath": "src/surfaces/checkout/components/Switch.ts", "name": "SwitchElementEvents", - "description": "Learn more about [registering events](/docs/api/checkout-ui-extensions/latest/using-polaris-components#event-handling).", + "description": "", "isPublicDocs": true, "members": [ { @@ -218857,11 +218891,11 @@ "syntaxKind": "PropertySignature", "name": "change", "value": "CallbackEventListener", - "description": "A callback that is run whenever the control is changed.", + "description": "A callback fired when the switch value changes.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", "isOptional": true } ], - "value": "export interface SwitchElementEvents {\n /**\n * A callback that is run whenever the control is changed.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event\n */\n change?: CallbackEventListener;\n}" + "value": "export interface SwitchElementEvents {\n /**\n * A callback fired when the switch value changes.\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change?: CallbackEventListener;\n}" }, "CallbackEventListener": { "filePath": "src/surfaces/checkout/components/Switch.ts", @@ -218915,7 +218949,7 @@ "TextElementProps": { "filePath": "src/surfaces/checkout/components/Text.ts", "name": "TextElementProps", - "description": "The text component displays inline text with specific visual styles or tones. Use text to emphasize or differentiate words or phrases within paragraphs or other block-level components, applying weight, color, or semantic styling.\n\nText supports multiple visual variants, alignment options, and line clamping for flexible inline typography control. For block-level text content, use [paragraph](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/typography-and-content/paragraph).", + "description": "", "isPublicDocs": true, "members": [ { @@ -218923,7 +218957,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityVisibility", "value": "'visible' | 'hidden' | 'exclusive'", - "description": "Changes the visibility of the element.\n\n- `visible`: the element is visible to all users.\n- `hidden`: the element is removed from the accessibility tree but remains visible.\n- `exclusive`: the element is visually hidden but remains in the accessibility tree.", + "description": "Controls how the element is exposed to sighted users and to assistive technologies such as screen readers.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", "isOptional": true, "defaultValue": "'visible'" }, @@ -218932,7 +218966,7 @@ "syntaxKind": "PropertySignature", "name": "color", "value": "'base' | 'subdued'", - "description": "Modify the color to be more or less intense.", + "description": "The color emphasis level that controls visual intensity.\n\n- `subdued`: Deemphasized color for secondary text, supporting labels, and less critical interface elements.\n- `base`: Primary color for body text, standard UI elements, and general content with good readability.\n- `strong`: Emphasized color for headings, key labels, and interactive elements that need prominence.", "isOptional": true, "defaultValue": "'base'" }, @@ -218941,7 +218975,7 @@ "syntaxKind": "PropertySignature", "name": "dir", "value": "'ltr' | 'rtl' | 'auto' | ''", - "description": "Indicates the directionality of the element’s text.\n\n- `ltr`: languages written from left to right (e.g. English)\n- `rtl`: languages written from right to left (e.g. Arabic)\n- `auto`: the user agent determines the direction based on the content\n- `''`: direction is inherited from parent elements (equivalent to not setting the attribute)", + "description": "Indicates the directionality of the element’s text.\n\n- `ltr`: The languages written from left to right (such as English).\n- `rtl`: The languages written from right to left (such as Arabic).\n- `auto`: The user agent determines the direction based on the content.\n- `\"\"`: The direction is inherited from parent elements (equivalent to not setting the attribute).\n\nLearn more about the [dir attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/dir).", "isOptional": true, "defaultValue": "''" }, @@ -218950,7 +218984,7 @@ "syntaxKind": "PropertySignature", "name": "display", "value": "MaybeResponsive<\"auto\" | \"none\">", - "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.", + "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.\n\nLearn more about the [display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display).", "isOptional": true, "defaultValue": "'auto'" }, @@ -218959,7 +218993,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -218976,7 +219010,7 @@ "syntaxKind": "PropertySignature", "name": "tone", "value": "'custom' | 'success' | 'info' | 'auto' | 'neutral' | 'warning' | 'critical'", - "description": "Sets the tone of the component, based on the intention of the information being conveyed.", + "description": "The semantic meaning and color treatment of the component.\n\n- `auto`: Automatically determined based on context.\n- `neutral`: General information without specific intent.\n- `info`: Informational content or helpful tips.\n- `success`: Positive outcomes or successful states.\n- `warning`: Important warnings about potential issues.\n- `critical`: Urgent problems or destructive actions.\n- `custom`: Custom styling controlled by your theme.", "isOptional": true, "defaultValue": "'auto'" }, @@ -218985,12 +219019,12 @@ "syntaxKind": "PropertySignature", "name": "type", "value": "'small' | 'address' | 'mark' | 'strong' | 'generic' | 'redundant' | 'emphasis' | 'offset'", - "description": "Provide semantic meaning and default styling to the text.\n\nOther presentation properties on Text override the default styling.", + "description": "The semantic type and styling treatment for the text content.\n\nOther presentation properties on `s-text` override the default styling.\n\n- `address`: A semantic type that indicates the text is contact information. Typically used for addresses.\n- `redundant`: A semantic type that indicates the text is no longer accurate or no longer relevant.\n- `mark`: A semantic type that indicates the text is marked or highlighted.\n- `emphasis`: A semantic type that indicates emphatic stress.\n- `offset`: A semantic type that indicates an offset from the normal prose.\n- `strong`: A semantic type that indicates strong importance, seriousness, or urgency.\n- `small`: A semantic type that indicates less important text.\n- `generic`: No additional semantics or styling is applied.", "isOptional": true, "defaultValue": "'generic'" } ], - "value": "export interface TextElementProps extends Pick {\n color?: Extract;\n tone?: Extract;\n type?: Extract;\n}" + "value": "export interface TextElementProps extends Pick {\n color?: Extract;\n tone?: Extract;\n /**\n * The semantic type and styling treatment for the text content.\n *\n * Other presentation properties on `s-text` override the default styling.\n *\n * - `address`: A semantic type that indicates the text is contact information. Typically used for addresses.\n * - `redundant`: A semantic type that indicates the text is no longer accurate or no longer relevant.\n * - `mark`: A semantic type that indicates the text is marked or highlighted.\n * - `emphasis`: A semantic type that indicates emphatic stress.\n * - `offset`: A semantic type that indicates an offset from the normal prose.\n * - `strong`: A semantic type that indicates strong importance, seriousness, or urgency.\n * - `small`: A semantic type that indicates less important text.\n * - `generic`: No additional semantics or styling is applied.\n *\n * @default 'generic'\n */\n type?: Extract;\n}" }, "MaybeResponsive": { "filePath": "src/surfaces/checkout/components/components.ts", @@ -219049,7 +219083,7 @@ "TextAreaElementProps": { "filePath": "src/surfaces/checkout/components/TextArea.ts", "name": "TextAreaElementProps", - "description": "The text area component captures multi-line text input. Use it to collect descriptions, notes, comments, or other extended text content.\n\nThe component supports configurable height, character limits, and validation. For single-line text input, use [text field](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/forms/text-field).", + "description": "", "isPublicDocs": true, "members": [ { @@ -219057,7 +219091,7 @@ "syntaxKind": "PropertySignature", "name": "autocomplete", "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", "isOptional": true, "defaultValue": "'on' for everything else" }, @@ -219066,7 +219100,7 @@ "syntaxKind": "PropertySignature", "name": "defaultValue", "value": "string", - "description": "The default value for the field.", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces this value.", "isOptional": true }, { @@ -219074,7 +219108,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -219083,7 +219117,7 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -219091,7 +219125,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -219099,7 +219133,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Content to use as the field label.", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", "isOptional": true }, { @@ -219107,7 +219141,7 @@ "syntaxKind": "PropertySignature", "name": "labelAccessibilityVisibility", "value": "'visible' | 'exclusive'", - "description": "Changes the visibility of the component's label.\n\n- `visible`: the label is visible to all users.\n- `exclusive`: the label is visually hidden but remains in the accessibility tree.", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone.\n- `exclusive`: The label is visually hidden but still announced by screen readers.", "isOptional": true, "defaultValue": "'visible'" }, @@ -219125,7 +219159,7 @@ "syntaxKind": "PropertySignature", "name": "minLength", "value": "number", - "description": "Specifies the min number of characters allowed.", + "description": "Specifies the minimum number of characters allowed.", "isOptional": true, "defaultValue": "0" }, @@ -219134,7 +219168,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -219152,7 +219186,7 @@ "syntaxKind": "PropertySignature", "name": "readOnly", "value": "boolean", - "description": "The field cannot be edited by the user. It is focusable will be announced by screen readers.", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", "isOptional": true, "defaultValue": "false" }, @@ -219211,7 +219245,7 @@ "TextAreaElementEvents": { "filePath": "src/surfaces/checkout/components/TextArea.ts", "name": "TextAreaElementEvents", - "description": "Learn more about [registering events](/docs/api/checkout-ui-extensions/latest/using-polaris-components#event-handling).", + "description": "", "isPublicDocs": true, "members": [ { @@ -219219,7 +219253,7 @@ "syntaxKind": "PropertySignature", "name": "blur", "value": "CallbackEventListener", - "description": "Callback when the element loses focus.", + "description": "<<<<<<< HEAD A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n======= A callback fired when the text area loses focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) \n Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", "isOptional": true }, { @@ -219227,7 +219261,7 @@ "syntaxKind": "PropertySignature", "name": "change", "value": "CallbackEventListener", - "description": "Callback when the user has **finished editing** a field, e.g. once they have blurred the field.", + "description": "<<<<<<< HEAD Callback when the user has **finished editing** a field, for example, once they have blurred the field.\n======= A callback fired when the text area value changes.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) \n Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", "isOptional": true }, { @@ -219235,7 +219269,7 @@ "syntaxKind": "PropertySignature", "name": "focus", "value": "CallbackEventListener", - "description": "Callback when the element receives focus.", + "description": "<<<<<<< HEAD A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n======= A callback fired when the text area receives focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) \n Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", "isOptional": true }, { @@ -219243,11 +219277,11 @@ "syntaxKind": "PropertySignature", "name": "input", "value": "CallbackEventListener", - "description": "Callback when the user makes any changes in the field.", + "description": "A callback fired when the user inputs data into the text area.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).", "isOptional": true } ], - "value": "export interface TextAreaElementEvents {\n /**\n * Callback when the element loses focus.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event\n */\n blur?: CallbackEventListener;\n /**\n * Callback when the user has **finished editing** a field, e.g. once they have blurred the field.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event\n */\n change?: CallbackEventListener;\n /**\n * Callback when the element receives focus.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event\n */\n focus?: CallbackEventListener;\n /**\n * Callback when the user makes any changes in the field.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event\n */\n input?: CallbackEventListener;\n}" + "value": "export interface TextAreaElementEvents {\n /**\n<<<<<<< HEAD\n * A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n=======\n * A callback fired when the text area loses focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality)\n *\n * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur?: CallbackEventListener;\n /**\n<<<<<<< HEAD\n * Callback when the user has **finished editing** a field, for example, once they have blurred the field.\n=======\n * A callback fired when the text area value changes.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality)\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change?: CallbackEventListener;\n /**\n<<<<<<< HEAD\n * A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n=======\n * A callback fired when the text area receives focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality)\n *\n * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus?: CallbackEventListener;\n /**\n * A callback fired when the user inputs data into the text area.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input?: CallbackEventListener;\n}" }, "CallbackEventListener": { "filePath": "src/surfaces/checkout/components/TextArea.ts", @@ -219301,7 +219335,7 @@ "TextFieldElementProps": { "filePath": "src/surfaces/checkout/components/TextField.ts", "name": "TextFieldElementProps", - "description": "Properties for the TextField component element.", + "description": "", "isPublicDocs": true, "members": [ { @@ -219309,7 +219343,7 @@ "syntaxKind": "PropertySignature", "name": "autocomplete", "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", "isOptional": true, "defaultValue": "'on' for everything else" }, @@ -219318,7 +219352,7 @@ "syntaxKind": "PropertySignature", "name": "defaultValue", "value": "string", - "description": "The default value for the field.", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces this value.", "isOptional": true }, { @@ -219326,7 +219360,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -219335,7 +219369,7 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -219352,7 +219386,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -219360,7 +219394,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Content to use as the field label.", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", "isOptional": true }, { @@ -219368,7 +219402,7 @@ "syntaxKind": "PropertySignature", "name": "labelAccessibilityVisibility", "value": "'visible' | 'exclusive'", - "description": "Changes the visibility of the component's label.\n\n- `visible`: the label is visible to all users.\n- `exclusive`: the label is visually hidden but remains in the accessibility tree.", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone.\n- `exclusive`: The label is visually hidden but still announced by screen readers.", "isOptional": true, "defaultValue": "'visible'" }, @@ -219386,7 +219420,7 @@ "syntaxKind": "PropertySignature", "name": "minLength", "value": "number", - "description": "Specifies the min number of characters allowed.", + "description": "Specifies the minimum number of characters allowed.", "isOptional": true, "defaultValue": "0" }, @@ -219395,7 +219429,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -219413,7 +219447,7 @@ "syntaxKind": "PropertySignature", "name": "prefix", "value": "string", - "description": "A value to be displayed immediately before the editable portion of the field.\n\nThis is useful for displaying an implied part of the value, such as \"https://\" or \"+353\".\n\nThis cannot be edited by the user, and it isn't included in the value of the field.\n\nIt may not be displayed until the user has interacted with the input. For example, an inline label may take the place of the prefix until the user focuses the input.", + "description": "A value to be displayed immediately before the editable portion of the field.\n\nThis is useful for displaying an implied part of the value, such as \"https://\" or \"+353\".\n\nThis can't be edited by the user, and it isn't included in the value of the field.\n\nIt may not be displayed until the user has interacted with the input. For example, an inline label may take the place of the prefix until the user focuses the input.", "isOptional": true, "defaultValue": "''" }, @@ -219422,7 +219456,7 @@ "syntaxKind": "PropertySignature", "name": "readOnly", "value": "boolean", - "description": "The field cannot be edited by the user. It is focusable will be announced by screen readers.", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", "isOptional": true, "defaultValue": "false" }, @@ -219440,7 +219474,7 @@ "syntaxKind": "PropertySignature", "name": "suffix", "value": "string", - "description": "A value to be displayed immediately after the editable portion of the field.\n\nThis is useful for displaying an implied part of the value, such as \"@shopify.com\", or \"%\".\n\nThis cannot be edited by the user, and it isn't included in the value of the field.\n\nIt may not be displayed until the user has interacted with the input. For example, an inline label may take the place of the suffix until the user focuses the input.", + "description": "A value to be displayed immediately after the editable portion of the field.\n\nThis is useful for displaying an implied part of the value, such as \"@shopify.com\", or \"%\".\n\nThis can't be edited by the user, and it isn't included in the value of the field.\n\nIt may not be displayed until the user has interacted with the input. For example, an inline label may take the place of the suffix until the user focuses the input.", "isOptional": true, "defaultValue": "''" }, @@ -219481,7 +219515,7 @@ "TextFieldElementEvents": { "filePath": "src/surfaces/checkout/components/TextField.ts", "name": "TextFieldElementEvents", - "description": "Events for the TextField component element.", + "description": "", "isPublicDocs": true, "members": [ { @@ -219489,7 +219523,7 @@ "syntaxKind": "PropertySignature", "name": "blur", "value": "CallbackEventListener", - "description": "Callback when the element loses focus.", + "description": "<<<<<<< HEAD A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n======= A callback fired when the text field loses focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) \n Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", "isOptional": true }, { @@ -219497,7 +219531,7 @@ "syntaxKind": "PropertySignature", "name": "change", "value": "CallbackEventListener", - "description": "Callback when the user has **finished editing** a field, e.g. once they have blurred the field.", + "description": "<<<<<<< HEAD Callback when the user has **finished editing** a field, for example, once they have blurred the field.\n======= A callback fired when the text field value changes.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) \n Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", "isOptional": true }, { @@ -219505,7 +219539,7 @@ "syntaxKind": "PropertySignature", "name": "focus", "value": "CallbackEventListener", - "description": "Callback when the element receives focus.", + "description": "<<<<<<< HEAD A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n======= A callback fired when the text field receives focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) \n Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", "isOptional": true }, { @@ -219513,11 +219547,11 @@ "syntaxKind": "PropertySignature", "name": "input", "value": "CallbackEventListener", - "description": "Callback when the user makes any changes in the field.", + "description": "A callback fired when the user inputs data into the text field.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).", "isOptional": true } ], - "value": "export interface TextFieldElementEvents {\n /**\n * Callback when the element loses focus.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event\n */\n blur?: CallbackEventListener;\n /**\n * Callback when the user has **finished editing** a field, e.g. once they have blurred the field.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event\n */\n change?: CallbackEventListener;\n /**\n * Callback when the element receives focus.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event\n */\n focus?: CallbackEventListener;\n /**\n * Callback when the user makes any changes in the field.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event\n */\n input?: CallbackEventListener;\n}" + "value": "export interface TextFieldElementEvents {\n /**\n<<<<<<< HEAD\n * A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n=======\n * A callback fired when the text field loses focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality)\n *\n * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur?: CallbackEventListener;\n /**\n<<<<<<< HEAD\n * Callback when the user has **finished editing** a field, for example, once they have blurred the field.\n=======\n * A callback fired when the text field value changes.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality)\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change?: CallbackEventListener;\n /**\n<<<<<<< HEAD\n * A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n=======\n * A callback fired when the text field receives focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality)\n *\n * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus?: CallbackEventListener;\n /**\n * A callback fired when the user inputs data into the text field.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input?: CallbackEventListener;\n}" }, "CallbackEventListener": { "filePath": "src/surfaces/checkout/components/TextField.ts", @@ -219545,7 +219579,7 @@ "TextFieldElementSlots": { "filePath": "src/surfaces/checkout/components/TextField.ts", "name": "TextFieldElementSlots", - "description": "Slots for the TextField component element.", + "description": "", "isPublicDocs": true, "members": [ { @@ -219553,11 +219587,11 @@ "syntaxKind": "PropertySignature", "name": "accessory", "value": "HTMLElement", - "description": "Additional content to be displayed in the field. Commonly used to display an icon that activates a tooltip providing more information.", + "description": "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.", "isOptional": true } ], - "value": "export interface TextFieldElementSlots {\n /**\n * Additional content to be displayed in the field.\n * Commonly used to display an icon that activates a tooltip providing more information.\n */\n accessory?: HTMLElement;\n}" + "value": "export interface TextFieldElementSlots {\n /**\n * 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.\n */\n accessory?: HTMLElement;\n}" } } } @@ -219602,7 +219636,7 @@ "TimeElementProps": { "filePath": "src/surfaces/checkout/components/Time.ts", "name": "TimeElementProps", - "description": "Represents a specific point or duration in time. Use to display dates, times, or durations clearly and consistently. May include a machine-readable `datetime` attribute for improved accessibility and functionality.", + "description": "", "isPublicDocs": true, "members": [ { @@ -219610,7 +219644,7 @@ "syntaxKind": "PropertySignature", "name": "dateTime", "value": "string", - "description": "Set the time and/or date of the element.\n\nIt must be a [valid date string](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/time#valid_datetime_values).", + "description": "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.\n\nThe 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`.", "isOptional": true, "defaultValue": "''" }, @@ -219619,7 +219653,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true } ], @@ -219668,7 +219702,7 @@ "TooltipElementProps": { "filePath": "src/surfaces/checkout/components/Tooltip.ts", "name": "TooltipElementProps", - "description": "Properties for the Tooltip component element.", + "description": "", "isPublicDocs": true, "members": [ { @@ -219676,7 +219710,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true } ], @@ -219718,7 +219752,7 @@ "UnorderedListElementProps": { "filePath": "src/surfaces/checkout/components/UnorderedList.ts", "name": "UnorderedListElementProps", - "description": "Properties for the UnorderedList component element.", + "description": "", "isPublicDocs": true, "members": [ { @@ -219726,7 +219760,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true } ], @@ -219742,7 +219776,7 @@ "ListItemElementProps": { "filePath": "src/surfaces/checkout/components/ListItem.ts", "name": "ListItemElementProps", - "description": "The list item component represents a single entry within an ordered list or unordered list. Use list item to structure individual points, steps, or items within a list, with each item automatically receiving appropriate list markers (bullets or numbers) from its parent list.\n\nList item must be used as a direct child of ordered list or unordered list components. Each list item can contain text, inline formatting, or other components to create rich list content.", + "description": "", "isPublicDocs": true, "members": [ { @@ -219750,7 +219784,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true } ], @@ -219799,7 +219833,7 @@ "URLFieldElementProps": { "filePath": "src/surfaces/checkout/components/UrlField.ts", "name": "URLFieldElementProps", - "description": "The URL field component collects URLs from users with built-in formatting and validation. Use URL field for website addresses, link destinations, or any URL input to provide URL-specific keyboard layouts and automatic validation.\n\nURL fields support protocol prefixing, validation, and help text to guide users toward entering properly formatted web addresses. For general text input, use [text field](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/forms/text-field).", + "description": "", "isPublicDocs": true, "members": [ { @@ -219807,7 +219841,7 @@ "syntaxKind": "PropertySignature", "name": "autocomplete", "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", "isOptional": true, "defaultValue": "'on' for everything else" }, @@ -219816,7 +219850,7 @@ "syntaxKind": "PropertySignature", "name": "defaultValue", "value": "string", - "description": "The default value for the field.", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces this value.", "isOptional": true }, { @@ -219824,7 +219858,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -219833,7 +219867,7 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -219841,7 +219875,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -219849,7 +219883,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Content to use as the field label.", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", "isOptional": true }, { @@ -219857,7 +219891,7 @@ "syntaxKind": "PropertySignature", "name": "labelAccessibilityVisibility", "value": "'visible' | 'exclusive'", - "description": "Changes the visibility of the component's label.\n\n- `visible`: the label is visible to all users.\n- `exclusive`: the label is visually hidden but remains in the accessibility tree.", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone.\n- `exclusive`: The label is visually hidden but still announced by screen readers.", "isOptional": true, "defaultValue": "'visible'" }, @@ -219875,7 +219909,7 @@ "syntaxKind": "PropertySignature", "name": "minLength", "value": "number", - "description": "Specifies the min number of characters allowed.", + "description": "Specifies the minimum number of characters allowed.", "isOptional": true, "defaultValue": "0" }, @@ -219884,7 +219918,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -219892,7 +219926,7 @@ "syntaxKind": "PropertySignature", "name": "readOnly", "value": "boolean", - "description": "The field cannot be edited by the user. It is focusable will be announced by screen readers.", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", "isOptional": true, "defaultValue": "false" }, @@ -219942,7 +219976,7 @@ "URLFieldElementEvents": { "filePath": "src/surfaces/checkout/components/UrlField.ts", "name": "URLFieldElementEvents", - "description": "Learn more about [registering events](/docs/api/checkout-ui-extensions/latest/using-polaris-components#event-handling).", + "description": "", "isPublicDocs": true, "members": [ { @@ -219950,7 +219984,7 @@ "syntaxKind": "PropertySignature", "name": "blur", "value": "CallbackEventListener", - "description": "Callback when the element loses focus.", + "description": "A callback fired when the URL field loses focus.\n\nLearn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", "isOptional": true }, { @@ -219958,7 +219992,7 @@ "syntaxKind": "PropertySignature", "name": "change", "value": "CallbackEventListener", - "description": "Callback when the user has **finished editing** a field, e.g. once they have blurred the field.", + "description": "A callback fired when the URL field value changes.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", "isOptional": true }, { @@ -219966,7 +220000,7 @@ "syntaxKind": "PropertySignature", "name": "focus", "value": "CallbackEventListener", - "description": "Callback when the element receives focus.", + "description": "A callback fired when the URL field receives focus.\n\nLearn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", "isOptional": true }, { @@ -219974,11 +220008,11 @@ "syntaxKind": "PropertySignature", "name": "input", "value": "CallbackEventListener", - "description": "Callback when the user makes any changes in the field.", + "description": "A callback fired when the user inputs data into the URL field.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).", "isOptional": true } ], - "value": "export interface URLFieldElementEvents {\n /**\n * Callback when the element loses focus.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event\n */\n blur?: CallbackEventListener;\n /**\n * Callback when the user has **finished editing** a field, e.g. once they have blurred the field.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event\n */\n change?: CallbackEventListener;\n /**\n * Callback when the element receives focus.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event\n */\n focus?: CallbackEventListener;\n /**\n * Callback when the user makes any changes in the field.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event\n */\n input?: CallbackEventListener;\n}" + "value": "export interface URLFieldElementEvents {\n /**\n * A callback fired when the URL field loses focus.\n *\n * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur?: CallbackEventListener;\n /**\n * A callback fired when the URL field value changes.\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change?: CallbackEventListener;\n /**\n * A callback fired when the URL field receives focus.\n *\n * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus?: CallbackEventListener;\n /**\n * A callback fired when the user inputs data into the URL field.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input?: CallbackEventListener;\n}" }, "CallbackEventListener": { "filePath": "src/surfaces/checkout/components/UrlField.ts", @@ -220006,7 +220040,7 @@ "URLFieldElementSlots": { "filePath": "src/surfaces/checkout/components/UrlField.ts", "name": "URLFieldElementSlots", - "description": "Learn more about [component slots](/docs/api/checkout-ui-extensions/latest/using-polaris-components#slots).", + "description": "", "isPublicDocs": true, "members": [ { @@ -220014,11 +220048,11 @@ "syntaxKind": "PropertySignature", "name": "accessory", "value": "HTMLElement", - "description": "Additional content to be displayed in the field. Commonly used to display an icon that activates a tooltip providing more information.", + "description": "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.", "isOptional": true } ], - "value": "export interface URLFieldElementSlots {\n /**\n * Additional content to be displayed in the field.\n * Commonly used to display an icon that activates a tooltip providing more information.\n */\n accessory?: HTMLElement;\n}" + "value": "export interface URLFieldElementSlots {\n /**\n * 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.\n */\n accessory?: HTMLElement;\n}" } } } diff --git a/packages/ui-extensions/docs/surfaces/checkout/generated/generated_docs_data_v2.json b/packages/ui-extensions/docs/surfaces/checkout/generated/generated_docs_data_v2.json index ba15b9e57c..f52bcdeee9 100644 --- a/packages/ui-extensions/docs/surfaces/checkout/generated/generated_docs_data_v2.json +++ b/packages/ui-extensions/docs/surfaces/checkout/generated/generated_docs_data_v2.json @@ -19,7 +19,7 @@ "syntaxKind": "PropertySignature", "name": "analytics", "value": "Analytics", - "description": "The methods for interacting with [Web Pixels](https://shopify.dev/docs/apps/marketing), such as emitting an event." + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -33,14 +33,14 @@ "syntaxKind": "PropertySignature", "name": "applyTrackingConsentChange", "value": "ApplyTrackingConsentChangeType", - "description": "Enables setting and updating customer privacy consent settings and tracking consent metafields.\n\n> Note: Requires the [`customer_privacy` capability](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent) to be set to `true`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data)." + "description": "Enables setting and updating customer privacy consent settings and tracking consent metafields.\n\n> Note: Requires the [`collect_buyer_consent` capability](/docs/apps/build/customer-accounts/capabilities#collect-buyer-consent) to be set to `true`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "appMetafields", "value": "SubscribableSignalLike", - "description": "The metafields requested in the [`shopify.extension.toml`](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file. These metafields are updated when there's a change in the merchandise items being purchased by the customer.\n\nApp owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` isn't supported. See [app owned metafields](https://shopify.dev/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data)." + "description": "The metafields requested in the [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file. These metafields are updated when there's a change in the merchandise items being purchased by the customer.\n\nApp owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` isn't supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -54,14 +54,14 @@ "syntaxKind": "PropertySignature", "name": "availablePaymentOptions", "value": "SubscribableSignalLike", - "description": "All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region." + "description": "All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n\nThe set of payment options can change when the buyer updates their address or cart, so subscribe to changes rather than reading once during initialization. Each option exposes `handle` and `type` only. Provider names, logos, fees, and installment terms aren't available." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "billingAddress", "value": "SubscribableSignalLike", - "description": "The proposed customer billing address. The address updates when the field is committed (on change) rather than every keystroke. The property is available only if the extension has access to protected customer data. The subscribable value is `undefined` if the billing address hasn't been provided yet.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).", + "description": "The proposed customer billing address. The address updates when the field is committed (on change) rather than every keystroke. The property is available only if the extension has access to protected customer data. The subscribable value is `undefined` if the billing address hasn't been provided yet.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", "isOptional": true }, { @@ -69,7 +69,7 @@ "syntaxKind": "PropertySignature", "name": "buyerIdentity", "value": "BuyerIdentity", - "description": "Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).", + "description": "Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", "isOptional": true }, { @@ -77,7 +77,7 @@ "syntaxKind": "PropertySignature", "name": "buyerJourney", "value": "BuyerJourney", - "description": "Provides details on the buyer's progression through the checkout and lets you intercept navigation to validate data before the buyer continues.\n\nRefer to [buyer journey](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/buyer-journey#examples) examples for more information." + "description": "Provides details on the buyer's progression through the checkout and lets you intercept navigation to validate data before the buyer continues.\n\nRefer to [buyer journey](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/buyer-journey#examples) examples for more information." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -91,7 +91,7 @@ "syntaxKind": "PropertySignature", "name": "checkoutToken", "value": "SubscribableSignalLike", - "description": "A stable ID that represents the current checkout.\n\nThe value is `undefined` when the checkout hasn't been created on the server yet.\n\nUse this to correlate checkout sessions across your extension, web pixels, and backend systems.\n\nThis matches the `data.checkout.token` field in a [checkout-related WebPixel event](https://shopify.dev/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data) and the `checkout_token` field in the [REST Admin API `Order` resource](https://shopify.dev/docs/api/admin-rest/unstable/resources/order#resource-object)." + "description": "A stable ID that represents the current checkout.\n\nThe value is `undefined` when the checkout hasn't been created on the server yet.\n\nUse this to correlate checkout sessions across your extension, web pixels, and backend systems.\n\nThis matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data) and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n\nCan be `undefined`. Handle the `undefined` state before using the value." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -112,14 +112,14 @@ "syntaxKind": "PropertySignature", "name": "deliveryGroups", "value": "SubscribableSignalLike", - "description": "The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items." + "description": "The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n\nEmpty until the buyer enters enough address information for Shopify to calculate shipping rates." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "discountAllocations", "value": "SubscribableSignalLike", - "description": "The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](https://shopify.dev/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered." + "description": "The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -133,7 +133,7 @@ "syntaxKind": "PropertySignature", "name": "extension", "value": "Extension", - "description": "The meta information about the extension." + "description": "Metadata about the running extension, including the current target, API version, capabilities, and editor context. Use this to conditionally render content based on where the extension is running." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -141,7 +141,7 @@ "name": "extensionPoint", "value": "Target", "description": "The identifier that specifies where in Shopify's UI your code is being injected. This is one of the targets you've included in your extension's configuration file.", - "deprecationMessage": "Deprecated as of version `2023-07`, use `extension.target` instead.", + "deprecationMessage": "Use `extension.target` instead.", "examples": [ { "title": "Example", @@ -160,14 +160,14 @@ "syntaxKind": "PropertySignature", "name": "i18n", "value": "I18n", - "description": "Utilities for translating content and formatting values according to the current [`localization`](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) of the checkout.\n\nRefer to [`localization` examples](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples) for more information." + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use alongside [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) to build fully localized extensions." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "instructions", "value": "SubscribableSignalLike", - "description": "The cart instructions used to create the checkout and possibly limit extension capabilities.\n\nThese instructions should be checked before performing any actions that might be affected by them.\n\nFor example, if you intend to add a discount code via the `applyDiscountCodeChange` method, check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n\n> Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs aren't available. See the [update guide](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples) for more information." + "description": "The cart instructions used to create the checkout and possibly limit extension capabilities.\n\nThese instructions should be checked before performing any actions that might be affected by them.\n\nFor example, if you intend to add a discount code via the `applyDiscountCodeChange` method, check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n\n> Caution: Check cart instructions before calling select APIs, as > some may not be available. See the > [Cart Instructions API](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples) > for more information." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -181,7 +181,7 @@ "syntaxKind": "PropertySignature", "name": "localization", "value": "Localization", - "description": "The details about the location, language, and currency of the customer. For utilities to easily format and translate content based on these details, you can use the [`i18n`](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n) object instead." + "description": "The buyer's language, country, currency, and timezone context. For formatting and translation helpers, use the [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#properties-propertydetail-i18n) object instead." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -196,7 +196,7 @@ "syntaxKind": "PropertySignature", "name": "metafields", "value": "SubscribableSignalLike", - "description": "The metafields that apply to the current checkout.\n\nMetafields are stored locally on the client and are applied to the order object after the checkout completes.\n\nThese metafields are shared by all extensions running on checkout, and persist for as long as the customer is working on this checkout.\n\nOnce the order is created, you can query these metafields using the [GraphQL Admin API](https://shopify.dev/docs/admin-api/graphql/reference/orders/order#metafield-2021-01)\n\n> Caution: `metafields` is deprecated. Use `appMetafields` with cart metafields instead.", + "description": "The metafields that apply to the current checkout.\n\nMetafields are stored locally on the client and are applied to the order object after the checkout completes.\n\nThese metafields are shared by all extensions running on checkout, and persist for as long as the customer is working on this checkout.\n\nOnce the order is created, you can query these metafields using the [GraphQL Admin API](/docs/admin-api/graphql/reference/orders/order#metafield-2021-01)\n\n> Caution: `metafields` is deprecated. Use `appMetafields` with cart metafields instead.", "deprecationMessage": "Use `appMetafields` with cart metafields instead." }, { @@ -211,35 +211,35 @@ "syntaxKind": "PropertySignature", "name": "query", "value": ">(query: string, options?: { variables?: Variables; version?: StorefrontApiVersion; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>", - "description": "The method used to query the Storefront GraphQL API with a prefetched token.\n\nRefer to [Storefront API access examples](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/storefront-api) for more information." + "description": "The method used to query the Storefront GraphQL API with a prefetched token." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "selectedPaymentOptions", "value": "SubscribableSignalLike", - "description": "The payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card)." + "description": "The payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\n\nEach option exposes `handle` and `type` only. Provider names, logos, fees, and installment terms aren't available." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "sessionToken", "value": "SessionToken", - "description": "The session token providing a set of claims as a signed JSON Web Token (JWT).\n\nThe token has a TTL of five minutes.\n\nIf the previous token expires, this value reflects a new session token with a new signature and expiry.\n\nRefer to [session token examples](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/session-token) for more information." + "description": "The session token providing a set of claims as a signed JSON Web Token (JWT).\n\nThe token has a TTL of five minutes.\n\nIf the previous token expires, this value reflects a new session token with a new signature and expiry.\n\nLearn more about [session tokens](/docs/apps/build/authentication-authorization/session-tokens)." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "settings", "value": "SubscribableSignalLike", - "description": "The settings matching the settings definition written in the [`shopify.extension.toml`](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n\n Refer to [settings examples](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n\n> Note: When an extension is being installed in the editor, the settings are empty until a merchant sets a value. In that case, this object updates in real time as a merchant fills in the settings." + "description": "The settings matching the settings definition written in the [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n\n Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n\n> Note: When an extension is being installed in the editor, the settings are empty until a merchant sets a value. In that case, this object updates in real time as a merchant fills in the settings." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "shippingAddress", "value": "SubscribableSignalLike", - "description": "The proposed customer shipping address. During the information step, the address updates when the field is committed (on change) rather than every keystroke. The property is available only if the extension has access to protected customer data. When available, the subscribable value is `undefined` if delivery isn't required.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).", + "description": "The proposed customer shipping address. During the information step, the address updates when the field is committed (on change) rather than every keystroke. The property is available only if the extension has access to protected customer data. When available, the subscribable value is `undefined` if delivery isn't required.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", "isOptional": true }, { @@ -247,14 +247,14 @@ "syntaxKind": "PropertySignature", "name": "shop", "value": "Shop", - "description": "The shop where the checkout is taking place." + "description": "The store where the checkout is taking place, including the shop name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "storage", "value": "Storage", - "description": "The key-value storage for the extension.\n\nIt uses `localStorage` and should persist across the customer's current checkout session.\n\n> Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n\nData is shared across all activated extension targets of this extension. In versions 2023-07 and earlier, each activated extension target had its own storage." + "description": "Key-value storage that persists across page loads within the current checkout session. Data is shared across all activated targets associated with this extension.\n\n> Caution: Data persistence isn't guaranteed and storage is cleared when the buyer starts a new checkout." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -276,31 +276,31 @@ ] } ], - "value": "export interface StandardApi {\n /**\n * The methods for interacting with [Web Pixels](https://shopify.dev/docs/apps/marketing), such as emitting an event.\n */\n analytics: Analytics;\n\n /**\n * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\n */\n appliedGiftCards: SubscribableSignalLike;\n\n /**\n * The cart instructions used to create the checkout and possibly limit extension capabilities.\n *\n * These instructions should be checked before performing any actions that might be affected by them.\n *\n * For example, if you intend to add a discount code via the `applyDiscountCodeChange` method,\n * check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n *\n * > Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs aren't available.\n * See the [update guide](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples) for more information.\n *\n */\n instructions: SubscribableSignalLike;\n\n /**\n * The metafields requested in the\n * [`shopify.extension.toml`](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/configuration)\n * file. These metafields are updated when there's a change in the merchandise items\n * being purchased by the customer.\n *\n * App owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` isn't supported. See [app owned metafields](https://shopify.dev/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).\n */\n appMetafields: SubscribableSignalLike;\n\n /**\n * The custom key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).\n */\n buyerIdentity?: BuyerIdentity;\n\n /**\n * Provides details on the buyer's progression through the checkout and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/buyer-journey#examples)\n * examples for more information.\n */\n buyerJourney: BuyerJourney;\n\n /**\n * Settings applied to the buyer's checkout.\n */\n checkoutSettings: SubscribableSignalLike;\n\n /**\n * A stable ID that represents the current checkout.\n *\n * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\n *\n * This matches the `data.checkout.token` field in a [checkout-related WebPixel event](https://shopify.dev/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data)\n * and the `checkout_token` field in the [REST Admin API `Order` resource](https://shopify.dev/docs/api/admin-rest/unstable/resources/order#resource-object).\n */\n checkoutToken: SubscribableSignalLike;\n\n /**\n * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](https://shopify.dev/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * The meta information about the extension.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see https://shopify.dev/docs/apps/app-extensions/configuration#targets\n *\n * @deprecated Deprecated as of version `2023-07`, use `extension.target` instead.\n */\n extensionPoint: Target;\n\n /**\n * Utilities for translating content and formatting values according to the current\n * [`localization`](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization)\n * of the checkout.\n *\n * Refer to [`localization` examples](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples)\n * for more information.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The details about the location, language, and currency of the customer. For utilities to easily\n * format and translate content based on these details, you can use the\n * [`i18n`](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n)\n * object instead.\n */\n localization: Localization;\n\n /**\n * The metafields that apply to the current checkout.\n *\n * Metafields are stored locally on the client and are applied to the order object after the checkout completes.\n *\n * These metafields are shared by all extensions running on checkout, and\n * persist for as long as the customer is working on this checkout.\n *\n * Once the order is created, you can query these metafields using the\n * [GraphQL Admin API](https://shopify.dev/docs/admin-api/graphql/reference/orders/order#metafield-2021-01)\n *\n * > Caution:\n * `metafields` is deprecated. Use `appMetafields` with cart metafields instead.\n *\n * @deprecated Use `appMetafields` with cart metafields instead.\n */\n metafields: SubscribableSignalLike;\n\n /**\n * A note left by the customer to the merchant, either in their cart or during checkout.\n *\n * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\n */\n note: SubscribableSignalLike;\n\n /**\n * The method used to query the Storefront GraphQL API with a prefetched token.\n *\n * Refer to [Storefront API access examples](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/storefront-api) for more information.\n */\n query: >(\n query: string,\n options?: {variables?: Variables; version?: StorefrontApiVersion},\n ) => Promise<{data?: Data; errors?: GraphQLError[]}>;\n\n /**\n * The payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\n */\n selectedPaymentOptions: SubscribableSignalLike;\n\n /**\n * The session token providing a set of claims as a signed JSON Web Token (JWT).\n *\n * The token has a TTL of five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/session-token) for more information.\n */\n sessionToken: SessionToken;\n\n /**\n * The settings matching the settings definition written in the\n * [`shopify.extension.toml`](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates in real time as a merchant fills in the settings.\n */\n settings: SubscribableSignalLike;\n\n /**\n * The proposed customer shipping address. During the information step, the address\n * updates when the field is committed (on change) rather than every keystroke.\n * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).\n */\n shippingAddress?: SubscribableSignalLike;\n\n /**\n * The proposed customer billing address. The address updates when the field is\n * committed (on change) rather than every keystroke. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided yet.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).\n */\n billingAddress?: SubscribableSignalLike;\n\n /** The shop where the checkout is taking place. */\n shop: Shop;\n\n /**\n * The key-value storage for the extension.\n *\n * It uses `localStorage` and should persist across the customer's current checkout session.\n *\n * > Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n *\n * Data is shared across all activated extension targets of this extension. In versions 2023-07 and earlier,\n * each activated extension target had its own storage.\n */\n storage: Storage;\n\n /**\n * The renderer version being used for the extension.\n *\n * @example '2025-10'\n */\n version: Version;\n\n /**\n * Customer privacy consent settings and a flag denoting if consent has previously been collected.\n */\n customerPrivacy: SubscribableSignalLike;\n\n /**\n * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`customer_privacy` capability](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent) to be set to `true`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).\n */\n applyTrackingConsentChange: ApplyTrackingConsentChangeType;\n\n /**\n * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" + "value": "export interface StandardApi {\n /**\n * Tracks custom events and sends visitor information to\n * [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events\n * and `visitor()` to submit buyer contact details.\n */\n analytics: Analytics;\n\n /**\n * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\n */\n appliedGiftCards: SubscribableSignalLike;\n\n /**\n * The cart instructions used to create the checkout and possibly limit extension capabilities.\n *\n * These instructions should be checked before performing any actions that might be affected by them.\n *\n * For example, if you intend to add a discount code via the `applyDiscountCodeChange` method,\n * check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n *\n * > Caution: Check cart instructions before calling select APIs, as\n * > some may not be available. See the\n * > [Cart Instructions API](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples)\n * > for more information.\n *\n */\n instructions: SubscribableSignalLike;\n\n /**\n * The metafields requested in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration)\n * file. These metafields are updated when there's a change in the merchandise items\n * being purchased by the customer.\n *\n * App owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` isn't supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n appMetafields: SubscribableSignalLike;\n\n /**\n * The custom key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as\n * credit cards, wallets, and local payment methods. The list depends on\n * the shop's payment configuration and the buyer's region.\n *\n * The set of payment options can change when the buyer updates their\n * address or cart, so subscribe to changes rather than reading once\n * during initialization. Each option exposes `handle` and `type` only.\n * Provider names, logos, fees, and installment terms aren't available.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n buyerIdentity?: BuyerIdentity;\n\n /**\n * Provides details on the buyer's progression through the checkout and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/buyer-journey#examples)\n * examples for more information.\n */\n buyerJourney: BuyerJourney;\n\n /**\n * Settings applied to the buyer's checkout.\n */\n checkoutSettings: SubscribableSignalLike;\n\n /**\n * A stable ID that represents the current checkout.\n *\n * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\n *\n * This matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data)\n * and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n *\n * Can be `undefined`. Handle the `undefined` state before using the value.\n */\n checkoutToken: SubscribableSignalLike;\n\n /**\n * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n *\n * Empty until the buyer enters enough address information for Shopify to\n * calculate shipping rates.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * Metadata about the running extension, including the current target, API version,\n * capabilities, and editor context. Use this to conditionally render content\n * based on where the extension is running.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n *\n * @deprecated Use `extension.target` instead.\n */\n extensionPoint: Target;\n\n /**\n * Utilities for translating strings, formatting currencies, numbers, and dates\n * according to the buyer's locale. Use alongside\n * [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization)\n * to build fully localized extensions.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The buyer's language, country, currency, and timezone context. For\n * formatting and translation helpers, use the\n * [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#properties-propertydetail-i18n)\n * object instead.\n */\n localization: Localization;\n\n /**\n * The metafields that apply to the current checkout.\n *\n * Metafields are stored locally on the client and are applied to the order object after the checkout completes.\n *\n * These metafields are shared by all extensions running on checkout, and\n * persist for as long as the customer is working on this checkout.\n *\n * Once the order is created, you can query these metafields using the\n * [GraphQL Admin API](/docs/admin-api/graphql/reference/orders/order#metafield-2021-01)\n *\n * > Caution:\n * `metafields` is deprecated. Use `appMetafields` with cart metafields instead.\n *\n * @deprecated Use `appMetafields` with cart metafields instead.\n */\n metafields: SubscribableSignalLike;\n\n /**\n * A note left by the customer to the merchant, either in their cart or during checkout.\n *\n * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\n */\n note: SubscribableSignalLike;\n\n /**\n * The method used to query the Storefront GraphQL API with a prefetched token.\n *\n */\n query: >(\n query: string,\n options?: {variables?: Variables; version?: StorefrontApiVersion},\n ) => Promise<{data?: Data; errors?: GraphQLError[]}>;\n\n /**\n * The payment options the buyer has currently selected. This updates as\n * the buyer changes their payment method. The array can contain multiple\n * entries when the buyer splits payment across methods (for example, a\n * gift card and a credit card).\n *\n * Each option exposes `handle` and `type` only. Provider names, logos,\n * fees, and installment terms aren't available.\n */\n selectedPaymentOptions: SubscribableSignalLike;\n\n /**\n * The session token providing a set of claims as a signed JSON Web Token (JWT).\n *\n * The token has a TTL of five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Learn more about [session tokens](/docs/apps/build/authentication-authorization/session-tokens).\n */\n sessionToken: SessionToken;\n\n /**\n * The settings matching the settings definition written in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates in real time as a merchant fills in the settings.\n */\n settings: SubscribableSignalLike;\n\n /**\n * The proposed customer shipping address. During the information step, the address\n * updates when the field is committed (on change) rather than every keystroke.\n * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n shippingAddress?: SubscribableSignalLike;\n\n /**\n * The proposed customer billing address. The address updates when the field is\n * committed (on change) rather than every keystroke. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided yet.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n billingAddress?: SubscribableSignalLike;\n\n /**\n * The store where the checkout is taking place, including the shop name,\n * storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.\n */\n shop: Shop;\n\n /**\n * Key-value storage that persists across page loads within the current checkout\n * session. Data is shared across all activated targets associated with\n * this extension.\n *\n * > Caution: Data persistence isn't guaranteed and storage is cleared when the\n * buyer starts a new checkout.\n */\n storage: Storage;\n\n /**\n * The renderer version being used for the extension.\n *\n * @example '2025-10'\n */\n version: Version;\n\n /**\n * Customer privacy consent settings and a flag denoting if consent has previously been collected.\n */\n customerPrivacy: SubscribableSignalLike;\n\n /**\n * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`collect_buyer_consent` capability](/docs/apps/build/customer-accounts/capabilities#collect-buyer-consent) to be set to `true`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyTrackingConsentChange: ApplyTrackingConsentChangeType;\n\n /**\n * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" } }, "Analytics": { "src/surfaces/checkout/api/standard/standard.ts": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Analytics", - "description": "", + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "publish", "value": "(name: string, data: Record) => Promise", - "description": "Publish method to emit analytics events to [Web Pixels](https://shopify.dev/docs/apps/marketing)." + "description": "Publishes a custom event to [Web Pixels](/docs/apps/marketing). Returns `true` when the event is successfully dispatched.\n\nThe Promise resolves to `true` when the event was dispatched. The boolean indicates dispatch confirmation only. It doesn't indicate whether any specific web pixel processed the event." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "visitor", "value": "(data: { email?: string; phone?: string; }) => Promise", - "description": "A method for capturing details about a visitor on the online store." + "description": "Submits buyer contact details for attribution and analytics purposes." } ], - "value": "export interface Analytics {\n /**\n * Publish method to emit analytics events to [Web Pixels](https://shopify.dev/docs/apps/marketing).\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * A method for capturing details about a visitor on the online store.\n */\n visitor(data: {email?: string; phone?: string}): Promise;\n}" + "value": "export interface Analytics {\n /**\n * Publishes a custom event to [Web Pixels](/docs/apps/marketing).\n * Returns `true` when the event is successfully dispatched.\n *\n * The Promise resolves to `true` when the event was dispatched. The boolean\n * indicates dispatch confirmation only. It doesn't indicate whether any\n * specific web pixel processed the event.\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * Submits buyer contact details for attribution and analytics purposes.\n */\n visitor(data: {email?: string; phone?: string}): Promise;\n}" } }, "VisitorResult": { @@ -347,10 +347,10 @@ "syntaxKind": "PropertySignature", "name": "type", "value": "'error'", - "description": "Indicates that the visitor information is invalid and wasn't submitted. Examples are using the wrong data type or missing a required property." + "description": "Indicates that the visitor information is invalid and wasn't submitted. Common causes include using the wrong data type or omitting a required property." } ], - "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Examples are using the wrong data type or missing a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Common causes include using the wrong data type or omitting a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" } }, "SubscribableSignalLike": { @@ -578,10 +578,10 @@ "syntaxKind": "PropertySignature", "name": "value", "value": "string | null", - "description": "The new value to store in the metafield. Set to `null` to delete the metafield." + "description": "The new value to store in the metafield. Set to `null` to delete the metafield.\n\nConsent metafield values are strings, not booleans. Pass `null` to delete a tracking consent metafield." } ], - "value": "export interface TrackingConsentMetafieldChange {\n /**\n * The identifier for the tracking consent metafield to update.\n */\n key: string;\n /**\n * The new value to store in the metafield. Set to `null` to delete the metafield.\n */\n value: string | null;\n}" + "value": "export interface TrackingConsentMetafieldChange {\n /**\n * The identifier for the tracking consent metafield to update.\n */\n key: string;\n /**\n * The new value to store in the metafield. Set to `null` to delete the metafield.\n *\n * Consent metafield values are strings, not booleans. Pass `null` to delete\n * a tracking consent metafield.\n */\n value: string | null;\n}" } }, "VisitorConsent": { @@ -680,7 +680,7 @@ "src/surfaces/checkout/api/standard/standard.ts": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppMetafieldEntry", - "description": "An entry that pairs a Shopify resource with one of its [metafields](https://shopify.dev/docs/apps/build/custom-data/metafields). Each entry contains a `target` identifying which resource the metafield belongs to and a `metafield` object with the actual data.", + "description": "An entry that pairs a Shopify resource with one of its [metafields](/docs/apps/build/custom-data/metafields). Each entry contains a `target` identifying which resource the metafield belongs to and a `metafield` object with the actual data.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -694,17 +694,17 @@ "syntaxKind": "PropertySignature", "name": "target", "value": "AppMetafieldEntryTarget", - "description": "The Shopify resource that this metafield is attached to, including the resource type (such as `'product'` or `'customer'`) and its globally-unique ID.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`." + "description": "The Shopify resource that this metafield is attached to, including the resource type (such as `'product'` or `'customer'`) and its globally-unique ID.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`." } ], - "value": "export interface AppMetafieldEntry {\n /**\n * The Shopify resource that this metafield is attached to, including the resource type (such as `'product'` or `'customer'`) and its globally-unique ID.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`.\n */\n target: AppMetafieldEntryTarget;\n\n /**\n * The metafield data, including the namespace, key, value, and content type. Use the `namespace` and `key` together to uniquely identify the metafield within its resource.\n */\n metafield: AppMetafield;\n}" + "value": "export interface AppMetafieldEntry {\n /**\n * The Shopify resource that this metafield is attached to, including the resource type (such as `'product'` or `'customer'`) and its globally-unique ID.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`.\n */\n target: AppMetafieldEntryTarget;\n\n /**\n * The metafield data, including the namespace, key, value, and content type. Use the `namespace` and `key` together to uniquely identify the metafield within its resource.\n */\n metafield: AppMetafield;\n}" } }, "AppMetafield": { "src/surfaces/checkout/api/standard/standard.ts": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppMetafield", - "description": "Represents a custom [metafield](https://shopify.dev/docs/apps/build/custom-data/metafields) attached to a resource such as a product, variant, customer, or shop.", + "description": "Represents a custom [metafield](/docs/apps/build/custom-data/metafields) attached to a resource such as a product, variant, customer, or shop.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -718,14 +718,14 @@ "syntaxKind": "PropertySignature", "name": "namespace", "value": "string", - "description": "The namespace that the metafield belongs to. Namespaces group related metafields and prevent naming collisions between different apps.\n\nApp owned metafield namespaces are returned using the `$app` format. See [app owned metafields](https://shopify.dev/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information." + "description": "The namespace that the metafield belongs to. Namespaces group related metafields and prevent naming collisions between different apps.\n\nApp owned metafield namespaces are returned using the `$app` format. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "type", "value": "string", - "description": "The metafield's [type name](https://shopify.dev/docs/apps/build/custom-data/metafields/list-of-data-types), such as `'single_line_text_field'` or `'json'`. This is the full type identifier, whereas `valueType` is a simplified category." + "description": "The metafield's [type name](/docs/apps/build/custom-data/metafields/list-of-data-types), such as `'single_line_text_field'` or `'json'`. This is the full type identifier, whereas `valueType` is a simplified category." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -742,7 +742,7 @@ "description": "The metafield's information type.\n\n- `'boolean'`: A true or false value.\n- `'float'`: A decimal number value.\n- `'integer'`: A whole number value.\n- `'json_string'`: A JSON-encoded string value.\n- `'string'`: A plain text value." } ], - "value": "export interface AppMetafield {\n /**\n * The identifier for the metafield within its namespace, such as `'ingredients'` or `'shipping_weight'`.\n */\n key: string;\n\n /**\n * The namespace that the metafield belongs to. Namespaces group related metafields and prevent naming collisions between different apps.\n *\n * App owned metafield namespaces are returned using the `$app` format. See [app owned metafields](https://shopify.dev/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n */\n namespace: string;\n\n /**\n * The value of a metafield, stored as a string regardless of the underlying type. For JSON metafields, parse the string to access structured data.\n */\n value: string;\n\n /**\n * The metafield's information type.\n *\n * - `'boolean'`: A true or false value.\n * - `'float'`: A decimal number value.\n * - `'integer'`: A whole number value.\n * - `'json_string'`: A JSON-encoded string value.\n * - `'string'`: A plain text value.\n */\n valueType: 'boolean' | 'float' | 'integer' | 'json_string' | 'string';\n\n /**\n * The metafield's [type name](https://shopify.dev/docs/apps/build/custom-data/metafields/list-of-data-types), such as `'single_line_text_field'` or `'json'`. This is the full type identifier, whereas `valueType` is a simplified category.\n */\n type: string;\n}" + "value": "export interface AppMetafield {\n /**\n * The identifier for the metafield within its namespace, such as `'ingredients'` or `'shipping_weight'`.\n */\n key: string;\n\n /**\n * The namespace that the metafield belongs to. Namespaces group related metafields and prevent naming collisions between different apps.\n *\n * App owned metafield namespaces are returned using the `$app` format. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n */\n namespace: string;\n\n /**\n * The value of a metafield, stored as a string regardless of the underlying type. For JSON metafields, parse the string to access structured data.\n */\n value: string;\n\n /**\n * The metafield's information type.\n *\n * - `'boolean'`: A true or false value.\n * - `'float'`: A decimal number value.\n * - `'integer'`: A whole number value.\n * - `'json_string'`: A JSON-encoded string value.\n * - `'string'`: A plain text value.\n */\n valueType: 'boolean' | 'float' | 'integer' | 'json_string' | 'string';\n\n /**\n * The metafield's [type name](/docs/apps/build/custom-data/metafields/list-of-data-types), such as `'single_line_text_field'` or `'json'`. This is the full type identifier, whereas `valueType` is a simplified category.\n */\n type: string;\n}" } }, "AppMetafieldEntryTarget": { @@ -756,7 +756,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "The globally-unique identifier of the Shopify resource, in [GID](https://shopify.dev/docs/api/usage/gids) format. Use this value to match the metafield to a specific resource in your extension or when querying the [Storefront API](https://shopify.dev/docs/api/storefront).", + "description": "The globally-unique identifier of the Shopify resource, in [GID](/docs/api/usage/gids) format. Use this value to match the metafield to a specific resource in your extension or when querying the [Storefront API](/docs/api/storefront).", "examples": [ { "title": "Example", @@ -775,10 +775,10 @@ "syntaxKind": "PropertySignature", "name": "type", "value": "| 'customer'\n | 'product'\n | 'shop'\n | 'shopUser'\n | 'variant'\n | 'company'\n | 'companyLocation'\n | 'cart'", - "description": "The kind of Shopify resource this metafield belongs to:\n\n- `'customer'`: The customer who placed the order.\n- `'product'`: A product in the merchant's catalog.\n- `'shop'`: The merchant's shop.\n- `'shopUser'`: A staff member or collaborator account on the shop.\n- `'variant'`: A specific variant of a product.\n- `'company'`: A [B2B](https://shopify.dev/docs/apps/build/b2b) company associated with the order.\n- `'companyLocation'`: A location belonging to a [B2B](https://shopify.dev/docs/apps/build/b2b) company.\n- `'cart'`: The cart associated with the checkout.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`." + "description": "The kind of Shopify resource this metafield belongs to:\n\n- `'customer'`: The customer who placed the order.\n- `'product'`: A product in the merchant's catalog.\n- `'shop'`: The merchant's shop.\n- `'shopUser'`: A staff member or collaborator account on the shop.\n- `'variant'`: A specific variant of a product.\n- `'company'`: A [B2B](/docs/apps/build/b2b) company associated with the order.\n- `'companyLocation'`: A location belonging to a [B2B](/docs/apps/build/b2b) company.\n- `'cart'`: The cart associated with the checkout.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`." } ], - "value": "export interface AppMetafieldEntryTarget {\n /**\n * The kind of Shopify resource this metafield belongs to:\n *\n * - `'customer'`: The customer who placed the order.\n * - `'product'`: A product in the merchant's catalog.\n * - `'shop'`: The merchant's shop.\n * - `'shopUser'`: A staff member or collaborator account on the shop.\n * - `'variant'`: A specific variant of a product.\n * - `'company'`: A [B2B](https://shopify.dev/docs/apps/build/b2b) company associated with the order.\n * - `'companyLocation'`: A location belonging to a [B2B](https://shopify.dev/docs/apps/build/b2b) company.\n * - `'cart'`: The cart associated with the checkout.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`.\n */\n type:\n | 'customer'\n | 'product'\n | 'shop'\n | 'shopUser'\n | 'variant'\n | 'company'\n | 'companyLocation'\n | 'cart';\n\n /**\n * The globally-unique identifier of the Shopify resource, in [GID](https://shopify.dev/docs/api/usage/gids) format. Use this value to match the metafield to a specific resource in your extension or when querying the [Storefront API](https://shopify.dev/docs/api/storefront).\n *\n * @example 'gid://shopify/Product/123'\n */\n id: string;\n}" + "value": "export interface AppMetafieldEntryTarget {\n /**\n * The kind of Shopify resource this metafield belongs to:\n *\n * - `'customer'`: The customer who placed the order.\n * - `'product'`: A product in the merchant's catalog.\n * - `'shop'`: The merchant's shop.\n * - `'shopUser'`: A staff member or collaborator account on the shop.\n * - `'variant'`: A specific variant of a product.\n * - `'company'`: A [B2B](/docs/apps/build/b2b) company associated with the order.\n * - `'companyLocation'`: A location belonging to a [B2B](/docs/apps/build/b2b) company.\n * - `'cart'`: The cart associated with the checkout.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`.\n */\n type:\n | 'customer'\n | 'product'\n | 'shop'\n | 'shopUser'\n | 'variant'\n | 'company'\n | 'companyLocation'\n | 'cart';\n\n /**\n * The globally-unique identifier of the Shopify resource, in [GID](/docs/api/usage/gids) format. Use this value to match the metafield to a specific resource in your extension or when querying the [Storefront API](/docs/api/storefront).\n *\n * @example 'gid://shopify/Product/123'\n */\n id: string;\n}" } }, "Attribute": { @@ -811,7 +811,7 @@ "syntaxKind": "PropertySignature", "name": "value", "value": "string", - "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.", + "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.\n\nAttribute values are always strings. To store structured data, serialize it to JSON and parse it when reading.", "examples": [ { "title": "Example", @@ -826,7 +826,7 @@ ] } ], - "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" + "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * Attribute values are always strings. To store structured data, serialize\n * it to JSON and parse it when reading.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" } }, "PaymentOption": { @@ -864,7 +864,7 @@ "syntaxKind": "PropertySignature", "name": "address1", "value": "string", - "description": "The first line of the street address, including the street number and name. The value is `undefined` if the buyer hasn't entered an address yet.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).", + "description": "The first line of the street address, including the street number and name. The value is `undefined` if the buyer hasn't entered an address yet.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", "isOptional": true, "examples": [ { @@ -884,7 +884,7 @@ "syntaxKind": "PropertySignature", "name": "address2", "value": "string", - "description": "The second line of the buyer's address, such as apartment number, suite, or unit. The value is `undefined` if the buyer didn't provide a second address line.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).", + "description": "The second line of the buyer's address, such as apartment number, suite, or unit. The value is `undefined` if the buyer didn't provide a second address line.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", "isOptional": true, "examples": [ { @@ -904,7 +904,7 @@ "syntaxKind": "PropertySignature", "name": "city", "value": "string", - "description": "The city, town, or village of the address. The value is `undefined` if the buyer hasn't entered a city yet.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).", + "description": "The city, town, or village of the address. The value is `undefined` if the buyer hasn't entered a city yet.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", "isOptional": true, "examples": [ { @@ -924,7 +924,7 @@ "syntaxKind": "PropertySignature", "name": "company", "value": "string", - "description": "The buyer's company name. The value is `undefined` if the buyer didn't enter a company or the store doesn't collect company names.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).", + "description": "The buyer's company name. The value is `undefined` if the buyer didn't enter a company or the store doesn't collect company names.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", "isOptional": true, "examples": [ { @@ -944,7 +944,7 @@ "syntaxKind": "PropertySignature", "name": "countryCode", "value": "CountryCode", - "description": "The two-letter country code in [ISO 3166 Alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. The value is `undefined` if the buyer hasn't selected a country yet.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).", + "description": "The two-letter country code in [ISO 3166 Alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. The value is `undefined` if the buyer hasn't selected a country yet.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", "isOptional": true, "examples": [ { @@ -964,7 +964,7 @@ "syntaxKind": "PropertySignature", "name": "firstName", "value": "string", - "description": "The buyer's first name. Use this alongside `lastName` when you need to display or process name parts separately. The value is `undefined` if the buyer didn't provide a first name or the store doesn't collect split names.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).", + "description": "The buyer's first name. Use this alongside `lastName` when you need to display or process name parts separately. The value is `undefined` if the buyer didn't provide a first name or the store doesn't collect split names.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", "isOptional": true, "examples": [ { @@ -984,7 +984,7 @@ "syntaxKind": "PropertySignature", "name": "lastName", "value": "string", - "description": "The buyer's last name. Use this alongside `firstName` when you need to display or process name parts separately. The value is `undefined` if the buyer didn't provide a last name or the store doesn't collect split names.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).", + "description": "The buyer's last name. Use this alongside `firstName` when you need to display or process name parts separately. The value is `undefined` if the buyer didn't provide a last name or the store doesn't collect split names.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", "isOptional": true, "examples": [ { @@ -1004,7 +1004,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "The buyer's full name, typically a combination of first and last name. The value is `undefined` if the buyer didn't provide a name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).", + "description": "The buyer's full name, typically a combination of first and last name. The value is `undefined` if the buyer didn't provide a name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", "isOptional": true, "examples": [ { @@ -1024,7 +1024,7 @@ "syntaxKind": "PropertySignature", "name": "phone", "value": "string", - "description": "The phone number associated with the address, typically in international format. The value is `undefined` if the buyer didn't provide a phone number or the store doesn't collect phone numbers.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).", + "description": "The phone number associated with the address, typically in international format. The value is `undefined` if the buyer didn't provide a phone number or the store doesn't collect phone numbers.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", "isOptional": true, "examples": [ { @@ -1044,7 +1044,7 @@ "syntaxKind": "PropertySignature", "name": "provinceCode", "value": "string", - "description": "The province, state, prefecture, or region code of the address. The format varies by country. The value is `undefined` if the buyer hasn't selected one yet or the country doesn't have provinces.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).", + "description": "The province, state, prefecture, or region code of the address. The format varies by country. The value is `undefined` if the buyer hasn't selected one yet or the country doesn't have provinces.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", "isOptional": true, "examples": [ { @@ -1064,7 +1064,7 @@ "syntaxKind": "PropertySignature", "name": "zip", "value": "string", - "description": "The postal code or ZIP code of the address, used for mail sorting and delivery routing. The value is `undefined` if the buyer hasn't entered one yet or the country doesn't use postal codes.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).", + "description": "The postal code or ZIP code of the address, used for mail sorting and delivery routing. The value is `undefined` if the buyer hasn't entered one yet or the country doesn't use postal codes.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", "isOptional": true, "examples": [ { @@ -1080,7 +1080,7 @@ ] } ], - "value": "export interface MailingAddress {\n /**\n * The buyer's full name, typically a combination of first and last name.\n * The value is `undefined` if the buyer didn't provide a name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John Doe'\n */\n name?: string;\n\n /**\n * The buyer's first name. Use this alongside `lastName` when you need to\n * display or process name parts separately. The value is `undefined` if\n * the buyer didn't provide a first name or the store doesn't collect\n * split names.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John'\n */\n firstName?: string;\n\n /**\n * The buyer's last name. Use this alongside `firstName` when you need to\n * display or process name parts separately. The value is `undefined` if\n * the buyer didn't provide a last name or the store doesn't collect\n * split names.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Doe'\n */\n lastName?: string;\n\n /**\n * The buyer's company name. The value is `undefined` if the buyer didn't\n * enter a company or the store doesn't collect company names.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Shopify'\n */\n company?: string;\n\n /**\n * The first line of the street address, including the street number and\n * name. The value is `undefined` if the buyer hasn't entered an address yet.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '151 O'Connor Street'\n */\n address1?: string;\n\n /**\n * The second line of the buyer's address, such as apartment number, suite,\n * or unit. The value is `undefined` if the buyer didn't provide a second\n * address line.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ground floor'\n */\n address2?: string;\n\n /**\n * The city, town, or village of the address. The value is `undefined` if\n * the buyer hasn't entered a city yet.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ottawa'\n */\n city?: string;\n\n /**\n * The postal code or ZIP code of the address, used for mail sorting and\n * delivery routing. The value is `undefined` if the buyer hasn't entered\n * one yet or the country doesn't use postal codes.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'K2P 2L8'\n */\n zip?: string;\n\n /**\n * The two-letter country code in [ISO 3166 Alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)\n * format. The value is `undefined` if the buyer hasn't selected a country\n * yet.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'CA' for Canada.\n */\n countryCode?: CountryCode;\n\n /**\n * The province, state, prefecture, or region code of the address. The\n * format varies by country. The value is `undefined` if the buyer hasn't\n * selected one yet or the country doesn't have provinces.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'ON' for Ontario.\n */\n provinceCode?: string;\n\n /**\n * The phone number associated with the address, typically in international\n * format. The value is `undefined` if the buyer didn't provide a phone\n * number or the store doesn't collect phone numbers.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '+1 613 111 2222'\n */\n phone?: string;\n}" + "value": "export interface MailingAddress {\n /**\n * The buyer's full name, typically a combination of first and last name.\n * The value is `undefined` if the buyer didn't provide a name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John Doe'\n */\n name?: string;\n\n /**\n * The buyer's first name. Use this alongside `lastName` when you need to\n * display or process name parts separately. The value is `undefined` if\n * the buyer didn't provide a first name or the store doesn't collect\n * split names.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John'\n */\n firstName?: string;\n\n /**\n * The buyer's last name. Use this alongside `firstName` when you need to\n * display or process name parts separately. The value is `undefined` if\n * the buyer didn't provide a last name or the store doesn't collect\n * split names.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Doe'\n */\n lastName?: string;\n\n /**\n * The buyer's company name. The value is `undefined` if the buyer didn't\n * enter a company or the store doesn't collect company names.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Shopify'\n */\n company?: string;\n\n /**\n * The first line of the street address, including the street number and\n * name. The value is `undefined` if the buyer hasn't entered an address yet.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '151 O'Connor Street'\n */\n address1?: string;\n\n /**\n * The second line of the buyer's address, such as apartment number, suite,\n * or unit. The value is `undefined` if the buyer didn't provide a second\n * address line.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ground floor'\n */\n address2?: string;\n\n /**\n * The city, town, or village of the address. The value is `undefined` if\n * the buyer hasn't entered a city yet.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ottawa'\n */\n city?: string;\n\n /**\n * The postal code or ZIP code of the address, used for mail sorting and\n * delivery routing. The value is `undefined` if the buyer hasn't entered\n * one yet or the country doesn't use postal codes.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'K2P 2L8'\n */\n zip?: string;\n\n /**\n * The two-letter country code in [ISO 3166 Alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)\n * format. The value is `undefined` if the buyer hasn't selected a country\n * yet.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'CA' for Canada.\n */\n countryCode?: CountryCode;\n\n /**\n * The province, state, prefecture, or region code of the address. The\n * format varies by country. The value is `undefined` if the buyer hasn't\n * selected one yet or the country doesn't have provinces.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'ON' for Ontario.\n */\n provinceCode?: string;\n\n /**\n * The phone number associated with the address, typically in international\n * format. The value is `undefined` if the buyer didn't provide a phone\n * number or the store doesn't collect phone numbers.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '+1 613 111 2222'\n */\n phone?: string;\n}" } }, "CountryCode": { @@ -1096,59 +1096,59 @@ "src/surfaces/checkout/api/standard/standard.ts": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "BuyerIdentity", - "description": "Information about the buyer who is completing the checkout.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data). The `customer` and `purchasingCompany` properties require level 1 access. The `email` and `phone` properties require level 2 access.", + "description": "Information about the buyer who is completing the checkout.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data). The `customer` and `purchasingCompany` properties require level 1 access. The `email` and `phone` properties require level 2 access.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "customer", "value": "SubscribableSignalLike", - "description": "The buyer's customer account, including their ID and whether they've accepted marketing. The value is `undefined` if the buyer isn't a known customer for this shop or if they haven't logged in yet.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data)." + "description": "The buyer's customer account, including their ID and whether they've accepted marketing. The value is `undefined` if the buyer isn't a known customer for this shop or if they haven't logged in yet.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "email", "value": "SubscribableSignalLike", - "description": "The email address the buyer provided during checkout. The value is `undefined` if the app doesn't have access to customer data.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data)." + "description": "The email address the buyer provided during checkout. The value is `undefined` if the app doesn't have access to customer data.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "phone", "value": "SubscribableSignalLike", - "description": "The phone number the buyer provided during checkout. The value is `undefined` if no phone number was provided or the app doesn't have access to customer data.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data)." + "description": "The phone number the buyer provided during checkout. The value is `undefined` if no phone number was provided or the app doesn't have access to customer data.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "purchasingCompany", "value": "SubscribableSignalLike", - "description": "The company and company location that a B2B (business-to-business) customer is purchasing on behalf of. Use this to identify the business context of the order. The value is `undefined` if the buyer isn't a B2B customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data)." + "description": "The company and company location that a B2B (business-to-business) customer is purchasing on behalf of. Use this to identify the business context of the order. The value is `undefined` if the buyer isn't a B2B customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." } ], - "value": "export interface BuyerIdentity {\n /**\n * The buyer's customer account, including their ID and whether they've accepted marketing. The value is `undefined` if the buyer isn't a\n * known customer for this shop or if they haven't logged in yet.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).\n */\n customer: SubscribableSignalLike;\n\n /**\n * The email address the buyer provided during checkout. The value is `undefined` if the app doesn't have access to customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).\n */\n email: SubscribableSignalLike;\n\n /**\n * The phone number the buyer provided during checkout. The value is `undefined` if no phone number was provided or the app doesn't have access to customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).\n */\n phone: SubscribableSignalLike;\n\n /**\n * The company and company location that a B2B (business-to-business) customer is purchasing on behalf of. Use this to identify the business context of the order. The value is `undefined` if the buyer isn't a B2B customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).\n */\n purchasingCompany: SubscribableSignalLike;\n}" + "value": "export interface BuyerIdentity {\n /**\n * The buyer's customer account, including their ID and whether they've accepted marketing. The value is `undefined` if the buyer isn't a\n * known customer for this shop or if they haven't logged in yet.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n customer: SubscribableSignalLike;\n\n /**\n * The email address the buyer provided during checkout. The value is `undefined` if the app doesn't have access to customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email: SubscribableSignalLike;\n\n /**\n * The phone number the buyer provided during checkout. The value is `undefined` if no phone number was provided or the app doesn't have access to customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone: SubscribableSignalLike;\n\n /**\n * The company and company location that a B2B (business-to-business) customer is purchasing on behalf of. Use this to identify the business context of the order. The value is `undefined` if the buyer isn't a B2B customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n purchasingCompany: SubscribableSignalLike;\n}" } }, "Customer": { "src/surfaces/checkout/api/standard/standard.ts": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Customer", - "description": "Information about a customer who has previously purchased from this shop.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).", + "description": "Information about a customer who has previously purchased from this shop.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "acceptsEmailMarketing", "value": "boolean", - "description": "Whether the customer has opted in to email marketing.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data)." + "description": "Whether the customer has opted in to email marketing.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "acceptsMarketing", "value": "boolean", - "description": "Whether the customer has opted in to receiving marketing communications from the merchant, such as email campaigns and promotional offers.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).\n\n> Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.", + "description": "Whether the customer has opted in to receiving marketing communications from the merchant, such as email campaigns and promotional offers.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n\n> Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.", "deprecationMessage": "Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead." }, { @@ -1156,14 +1156,14 @@ "syntaxKind": "PropertySignature", "name": "acceptsSmsMarketing", "value": "boolean", - "description": "Whether the customer has opted in to SMS marketing.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data)." + "description": "Whether the customer has opted in to SMS marketing.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "email", "value": "string", - "description": "The email address associated with the customer's account. The value is `undefined` if the app doesn't have the required access level.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).", + "description": "The email address associated with the customer's account. The value is `undefined` if the app doesn't have the required access level.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", "isOptional": true }, { @@ -1171,7 +1171,7 @@ "syntaxKind": "PropertySignature", "name": "firstName", "value": "string", - "description": "The customer's first name. The value is `undefined` if the app doesn't have the required access level.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).", + "description": "The customer's first name. The value is `undefined` if the app doesn't have the required access level.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", "isOptional": true }, { @@ -1179,7 +1179,7 @@ "syntaxKind": "PropertySignature", "name": "fullName", "value": "string", - "description": "The customer's full name, typically a combination of first and last name. The value is `undefined` if the app doesn't have the required access level.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).", + "description": "The customer's full name, typically a combination of first and last name. The value is `undefined` if the app doesn't have the required access level.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", "isOptional": true }, { @@ -1187,7 +1187,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A globally-unique identifier for the customer in the format `gid://shopify/Customer/`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).", + "description": "An identifier for the customer in the format `gid://shopify/Customer/`. This value is unique per shop.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", "examples": [ { "title": "Example", @@ -1206,14 +1206,14 @@ "syntaxKind": "PropertySignature", "name": "image", "value": "ImageDetails", - "description": "The customer's profile image, such as a Gravatar avatar. Use this to personalize the extension UI for the logged-in buyer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data)." + "description": "The customer's profile image, such as a Gravatar avatar. Use this to personalize the extension UI for the logged-in buyer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "lastName", "value": "string", - "description": "The customer's last name. The value is `undefined` if the app doesn't have the required access level.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).", + "description": "The customer's last name. The value is `undefined` if the app doesn't have the required access level.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", "isOptional": true }, { @@ -1221,14 +1221,14 @@ "syntaxKind": "PropertySignature", "name": "ordersCount", "value": "number", - "description": "The number of orders the customer has previously placed with this shop.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data)." + "description": "The number of orders the customer has previously placed with this shop.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "phone", "value": "string", - "description": "The phone number associated with the customer's account. The value is `undefined` if no phone number is on file or the app doesn't have the required access level.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).", + "description": "The phone number associated with the customer's account. The value is `undefined` if no phone number is on file or the app doesn't have the required access level.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", "isOptional": true }, { @@ -1236,11 +1236,11 @@ "syntaxKind": "PropertySignature", "name": "storeCreditAccounts", "value": "StoreCreditAccount[]", - "description": "The store credit accounts owned by this customer that can be used as payment during checkout. Each account has a balance representing available store credit.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).", + "description": "The store credit accounts owned by this customer that can be used as payment during checkout. Each account has a balance representing available store credit.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", "isPrivate": true } ], - "value": "export interface Customer {\n /**\n * A globally-unique identifier for the customer in the format `gid://shopify/Customer/`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'gid://shopify/Customer/123'\n */\n id: string;\n /**\n * The email address associated with the customer's account. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).\n */\n email?: string;\n /**\n * The phone number associated with the customer's account. The value is `undefined` if no phone number is on file or the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).\n */\n phone?: string;\n /**\n * The customer's full name, typically a combination of first and last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).\n */\n fullName?: string;\n /**\n * The customer's first name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).\n */\n firstName?: string;\n /**\n * The customer's last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).\n */\n lastName?: string;\n /**\n * The customer's profile image, such as a Gravatar avatar. Use this to personalize the extension UI for the logged-in buyer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).\n */\n image: ImageDetails;\n /**\n * Whether the customer has opted in to receiving marketing communications from the merchant, such as email campaigns and promotional offers.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).\n *\n * > Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n *\n * @deprecated Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n */\n acceptsMarketing: boolean;\n /**\n * Whether the customer has opted in to email marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsEmailMarketing: boolean;\n /**\n * Whether the customer has opted in to SMS marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsSmsMarketing: boolean;\n /**\n * The store credit accounts owned by this customer that can be used as payment during checkout. Each account has a balance representing available store credit.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).\n *\n * @private\n */\n storeCreditAccounts: StoreCreditAccount[];\n /**\n * The number of orders the customer has previously placed with this shop.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).\n */\n ordersCount: number;\n}" + "value": "export interface Customer {\n /**\n * An identifier for the customer in the format `gid://shopify/Customer/`. This value is unique per shop.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'gid://shopify/Customer/123'\n */\n id: string;\n /**\n * The email address associated with the customer's account. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email?: string;\n /**\n * The phone number associated with the customer's account. The value is `undefined` if no phone number is on file or the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone?: string;\n /**\n * The customer's full name, typically a combination of first and last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n fullName?: string;\n /**\n * The customer's first name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n firstName?: string;\n /**\n * The customer's last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n lastName?: string;\n /**\n * The customer's profile image, such as a Gravatar avatar. Use this to personalize the extension UI for the logged-in buyer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n image: ImageDetails;\n /**\n * Whether the customer has opted in to receiving marketing communications from the merchant, such as email campaigns and promotional offers.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * > Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n *\n * @deprecated Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n */\n acceptsMarketing: boolean;\n /**\n * Whether the customer has opted in to email marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsEmailMarketing: boolean;\n /**\n * Whether the customer has opted in to SMS marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsSmsMarketing: boolean;\n /**\n * The store credit accounts owned by this customer that can be used as payment during checkout. Each account has a balance representing available store credit.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @private\n */\n storeCreditAccounts: StoreCreditAccount[];\n /**\n * The number of orders the customer has previously placed with this shop.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n ordersCount: number;\n}" } }, "ImageDetails": { @@ -1308,24 +1308,24 @@ "src/surfaces/checkout/api/standard/standard.ts": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PurchasingCompany", - "description": "The company and location that the [B2B](https://shopify.dev/docs/apps/build/b2b) customer is purchasing on behalf of. This is present only when the buyer is logged in as a business customer.", + "description": "The company and location that the [B2B](/docs/apps/build/b2b) customer is purchasing on behalf of. This is present only when the buyer is logged in as a business customer.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "company", "value": "Company", - "description": "The company the B2B customer belongs to.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data)." + "description": "The company the B2B customer belongs to.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "location", "value": "CompanyLocation", - "description": "The specific company location associated with this B2B purchase.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data)." + "description": "The specific company location associated with this B2B purchase.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." } ], - "value": "export interface PurchasingCompany {\n /**\n * The company the B2B customer belongs to.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).\n */\n company: Company;\n /**\n * The specific company location associated with this B2B purchase.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).\n */\n location: CompanyLocation;\n}" + "value": "export interface PurchasingCompany {\n /**\n * The company the B2B customer belongs to.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n company: Company;\n /**\n * The specific company location associated with this B2B purchase.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n location: CompanyLocation;\n}" } }, "Company": { @@ -1339,7 +1339,7 @@ "syntaxKind": "PropertySignature", "name": "externalId", "value": "string", - "description": "A merchant-defined external identifier for the company. The value is `undefined` if the merchant hasn't set one.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).", + "description": "A merchant-defined external identifier for the company. The value is `undefined` if the merchant hasn't set one.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", "isOptional": true }, { @@ -1347,7 +1347,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A globally-unique identifier for the company in the format `gid://shopify/Company/`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).", + "description": "A globally-unique identifier for the company in the format `gid://shopify/Company/`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", "examples": [ { "title": "Example", @@ -1366,10 +1366,10 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "The company's display name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data)." + "description": "The company's display name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." } ], - "value": "export interface Company {\n /**\n * A globally-unique identifier for the company in the format `gid://shopify/Company/`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'gid://shopify/Company/123'\n */\n id: string;\n /**\n * The company's display name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).\n */\n name: string;\n /**\n * A merchant-defined external identifier for the company. The value is `undefined` if the merchant hasn't set one.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).\n */\n externalId?: string;\n}" + "value": "export interface Company {\n /**\n * A globally-unique identifier for the company in the format `gid://shopify/Company/`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'gid://shopify/Company/123'\n */\n id: string;\n /**\n * The company's display name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n name: string;\n /**\n * A merchant-defined external identifier for the company. The value is `undefined` if the merchant hasn't set one.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n externalId?: string;\n}" } }, "CompanyLocation": { @@ -1383,7 +1383,7 @@ "syntaxKind": "PropertySignature", "name": "externalId", "value": "string", - "description": "A merchant-defined external identifier for the company location. The value is `undefined` if the merchant hasn't set one.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).", + "description": "A merchant-defined external identifier for the company location. The value is `undefined` if the merchant hasn't set one.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", "isOptional": true }, { @@ -1391,7 +1391,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A globally-unique identifier for the company location in the format `gid://shopify/CompanyLocation/`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).", + "description": "A globally-unique identifier for the company location in the format `gid://shopify/CompanyLocation/`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", "examples": [ { "title": "Example", @@ -1410,10 +1410,10 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "The display name of the company location.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data)." + "description": "The display name of the company location.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." } ], - "value": "export interface CompanyLocation {\n /**\n * A globally-unique identifier for the company location in the format `gid://shopify/CompanyLocation/`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'gid://shopify/CompanyLocation/123'\n */\n id: string;\n /**\n * The display name of the company location.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).\n */\n name: string;\n /**\n * A merchant-defined external identifier for the company location. The value is `undefined` if the merchant hasn't set one.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).\n */\n externalId?: string;\n}" + "value": "export interface CompanyLocation {\n /**\n * A globally-unique identifier for the company location in the format `gid://shopify/CompanyLocation/`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'gid://shopify/CompanyLocation/123'\n */\n id: string;\n /**\n * The display name of the company location.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n name: string;\n /**\n * A merchant-defined external identifier for the company location. The value is `undefined` if the merchant hasn't set one.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n externalId?: string;\n}" } }, "BuyerJourney": { @@ -1441,7 +1441,7 @@ "syntaxKind": "MethodSignature", "name": "intercept", "value": "(interceptor: Interceptor) => Promise<() => void>", - "description": "Installs a function for intercepting and preventing progress on checkout.\n\nThis returns a promise that resolves to a teardown function. Calling the teardown function removes the interceptor.\n\nTo block checkout progress, you must set the [block_progress](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#block-progress) capability in your extension's configuration.\n\nIf you do, then you're expected to inform the buyer why navigation was blocked, either by passing validation errors to the checkout UI or rendering the errors in your extension.\n\nIf the merchant hasn't allowed your extension to block checkout progress, show a warning in the [checkout editor](https://shopify.dev/docs/apps/build/checkout/test-checkout-ui-extensions#test-the-extension-in-the-checkout-editor)." + "description": "Installs a function for intercepting and preventing progress on checkout.\n\nThis returns a promise that resolves to a teardown function. Calling the teardown function removes the interceptor.\n\nTo block checkout progress, you must set the [block_progress](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#block-progress) capability in your extension's configuration.\n\nIf you do, then you're expected to inform the buyer why navigation was blocked, either by passing validation errors to the checkout UI or rendering the errors in your extension.\n\nIf the merchant hasn't allowed your extension to block checkout progress, show a warning in the [checkout editor](/docs/apps/build/checkout/test-checkout-ui-extensions#test-the-extension-in-the-checkout-editor)." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -1451,7 +1451,7 @@ "description": "All possible steps the buyer can take to complete checkout. These steps vary depending on whether the checkout is one-page or three-page, and on the shop's configuration." } ], - "value": "export interface BuyerJourney {\n /**\n * Installs a function for intercepting and preventing progress on checkout.\n *\n * This returns a promise that resolves to a teardown function. Calling the\n * teardown function removes the interceptor.\n *\n * To block checkout progress, you must set the [block_progress](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#block-progress)\n * capability in your extension's configuration.\n *\n * If you do, then you're expected to inform the buyer why navigation was blocked,\n * either by passing validation errors to the checkout UI or rendering the errors in your extension.\n *\n * If the merchant hasn't allowed your extension to block checkout progress, show a warning in the [checkout editor](https://shopify.dev/docs/apps/build/checkout/test-checkout-ui-extensions#test-the-extension-in-the-checkout-editor).\n */\n intercept(interceptor: Interceptor): Promise<() => void>;\n\n /**\n * Whether the buyer has completed submitting their order. When `true`, the buyer is on the order status page after submitting payment. When `false`, the buyer is still in the checkout flow.\n */\n completed: SubscribableSignalLike;\n /**\n * All possible steps the buyer can take to complete checkout. These steps vary depending on whether the checkout is one-page or three-page, and on the shop's configuration.\n */\n steps: SubscribableSignalLike;\n /**\n * The step of checkout the buyer is currently on. The value is `undefined` if the current step can't be determined.\n */\n activeStep: SubscribableSignalLike;\n}" + "value": "export interface BuyerJourney {\n /**\n * Installs a function for intercepting and preventing progress on checkout.\n *\n * This returns a promise that resolves to a teardown function. Calling the\n * teardown function removes the interceptor.\n *\n * To block checkout progress, you must set the [block_progress](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#block-progress)\n * capability in your extension's configuration.\n *\n * If you do, then you're expected to inform the buyer why navigation was blocked,\n * either by passing validation errors to the checkout UI or rendering the errors in your extension.\n *\n * If the merchant hasn't allowed your extension to block checkout progress, show a warning in the [checkout editor](/docs/apps/build/checkout/test-checkout-ui-extensions#test-the-extension-in-the-checkout-editor).\n */\n intercept(interceptor: Interceptor): Promise<() => void>;\n\n /**\n * Whether the buyer has completed submitting their order. When `true`, the buyer is on the order status page after submitting payment. When `false`, the buyer is still in the checkout flow.\n */\n completed: SubscribableSignalLike;\n /**\n * All possible steps the buyer can take to complete checkout. These steps vary depending on whether the checkout is one-page or three-page, and on the shop's configuration.\n */\n steps: SubscribableSignalLike;\n /**\n * The step of checkout the buyer is currently on. The value is `undefined` if the current step can't be determined.\n */\n activeStep: SubscribableSignalLike;\n}" } }, "BuyerJourneyStepReference": { @@ -1546,11 +1546,11 @@ "syntaxKind": "MethodSignature", "name": "perform", "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", + "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.\n\nRuns after all intercept results are collected. Use it for local state updates such as setting an error flag. By the time it runs, the navigation decision is final, so blocking logic belongs in the intercept handler itself, not here.", "isOptional": true } ], - "value": "interface InterceptorRequestAllow {\n /**\n * Indicates that the interceptor allows the buyer's journey to continue.\n */\n behavior: 'allow';\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" + "value": "interface InterceptorRequestAllow {\n /**\n * Indicates that the interceptor allows the buyer's journey to continue.\n */\n behavior: 'allow';\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n *\n * Runs after all intercept results are collected. Use it for local state\n * updates such as setting an error flag. By the time it runs, the navigation\n * decision is final, so blocking logic belongs in the intercept handler\n * itself, not here.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" } }, "InterceptorResult": { @@ -1622,7 +1622,7 @@ "syntaxKind": "MethodSignature", "name": "perform", "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", + "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.\n\nRuns after all intercept results are collected. Use it for local state updates such as setting an error flag. By the time it runs, the navigation decision is final, so blocking logic belongs in the intercept handler itself, not here.", "isOptional": true }, { @@ -1633,7 +1633,7 @@ "description": "The reason for blocking the interceptor request. This value isn't presented to the buyer, so it doesn't need to be localized. The value is used only for Shopify's own internal debugging and metrics." } ], - "value": "interface InterceptorRequestBlock {\n /**\n * Indicates that the interceptor blocks the buyer's journey from continuing.\n */\n behavior: 'block';\n\n /**\n * The reason for blocking the interceptor request. This value isn't presented to\n * the buyer, so it doesn't need to be localized. The value is used only for Shopify's\n * own internal debugging and metrics.\n */\n reason: string;\n\n /**\n * Used to pass errors to the checkout UI, outside your extension's UI boundaries.\n */\n errors?: ValidationError[];\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" + "value": "interface InterceptorRequestBlock {\n /**\n * Indicates that the interceptor blocks the buyer's journey from continuing.\n */\n behavior: 'block';\n\n /**\n * The reason for blocking the interceptor request. This value isn't presented to\n * the buyer, so it doesn't need to be localized. The value is used only for Shopify's\n * own internal debugging and metrics.\n */\n reason: string;\n\n /**\n * Used to pass errors to the checkout UI, outside your extension's UI boundaries.\n */\n errors?: ValidationError[];\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n *\n * Runs after all intercept results are collected. Use it for local state\n * updates such as setting an error flag. By the time it runs, the navigation\n * decision is final, so blocking logic belongs in the intercept handler\n * itself, not here.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" } }, "ValidationError": { @@ -1662,7 +1662,7 @@ "description": "", "tabs": [ { - "code": "'$.cart.deliveryGroups[0].deliveryAddress.countryCode'\n\nSee the [supported targets](https://shopify.dev/docs/api/functions/reference/cart-checkout-validation/graphql#supported-targets)\nfor more information.", + "code": "'$.cart.deliveryGroups[0].deliveryAddress.countryCode'\n\nSee the [supported targets](/docs/api/functions/reference/cart-checkout-validation/graphql#supported-targets)\nfor more information.", "title": "Example" } ] @@ -1670,7 +1670,7 @@ ] } ], - "value": "export interface ValidationError {\n /**\n * The error message to display to the buyer. Use this to explain what\n * went wrong and how to fix it.\n */\n message: string;\n /**\n * The checkout UI field that the error is associated with. When provided,\n * checkout highlights the matching field so the buyer knows where to fix\n * the issue. The value is `undefined` if the error isn't tied to a\n * specific field.\n *\n * @example '$.cart.deliveryGroups[0].deliveryAddress.countryCode'\n *\n * See the [supported targets](https://shopify.dev/docs/api/functions/reference/cart-checkout-validation/graphql#supported-targets)\n * for more information.\n */\n target?: string;\n}" + "value": "export interface ValidationError {\n /**\n * The error message to display to the buyer. Use this to explain what\n * went wrong and how to fix it.\n */\n message: string;\n /**\n * The checkout UI field that the error is associated with. When provided,\n * checkout highlights the matching field so the buyer knows where to fix\n * the issue. The value is `undefined` if the error isn't tied to a\n * specific field.\n *\n * @example '$.cart.deliveryGroups[0].deliveryAddress.countryCode'\n *\n * See the [supported targets](/docs/api/functions/reference/cart-checkout-validation/graphql#supported-targets)\n * for more information.\n */\n target?: string;\n}" } }, "BuyerJourneyStep": { @@ -1868,17 +1868,17 @@ "syntaxKind": "PropertySignature", "name": "totalShippingAmount", "value": "SubscribableSignalLike", - "description": "The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step." + "description": "The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step.\n\n`undefined` until the buyer selects a shipping method (typically after the information step)." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "totalTaxAmount", "value": "SubscribableSignalLike", - "description": "The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet." + "description": "The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet.\n\n`undefined` when taxes haven't been calculated or aren't available for the buyer's region." } ], - "value": "export interface CartCost {\n /**\n * The sum of all line item prices at the current step of checkout, before shipping and taxes are applied. Use this value to display the base cost of the items the buyer purchased.\n */\n subtotalAmount: SubscribableSignalLike;\n\n /**\n * The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step.\n */\n totalShippingAmount: SubscribableSignalLike;\n\n /**\n * The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet.\n */\n totalTaxAmount: SubscribableSignalLike;\n\n /**\n * The minimum total at the current step of checkout. Costs not yet calculated, such as shipping on the information step, aren't included. Gift cards and store credits are excluded from this total.\n */\n totalAmount: SubscribableSignalLike;\n}" + "value": "export interface CartCost {\n /**\n * The sum of all line item prices at the current step of checkout, before shipping and taxes are applied. Use this value to display the base cost of the items the buyer purchased.\n */\n subtotalAmount: SubscribableSignalLike;\n\n /**\n * The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step.\n *\n * `undefined` until the buyer selects a shipping method (typically after the\n * information step).\n */\n totalShippingAmount: SubscribableSignalLike;\n\n /**\n * The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet.\n *\n * `undefined` when taxes haven't been calculated or aren't available for the\n * buyer's region.\n */\n totalTaxAmount: SubscribableSignalLike;\n\n /**\n * The minimum total at the current step of checkout. Costs not yet calculated, such as shipping on the information step, aren't included. Gift cards and store credits are excluded from this total.\n */\n totalAmount: SubscribableSignalLike;\n}" } }, "CustomerPrivacy": { @@ -1926,7 +1926,7 @@ "description": "", "tabs": [ { - "code": "`{countryCode: 'CA', provinceCode: 'ON'}` for a visitor in Ontario, Canada; `{countryCode: 'US', provinceCode: undefined}` for a visitor in the United States if geolocation fails to detect the state; or `undefined` if neither country nor province is detected or geolocation fails.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).", + "code": "`{countryCode: 'CA', provinceCode: 'ON'}` for a visitor in Ontario, Canada; `{countryCode: 'US', provinceCode: undefined}` for a visitor in the United States if geolocation fails to detect the state; or `undefined` if neither country nor province is detected or geolocation fails.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", "title": "Example" } ] @@ -1955,7 +1955,7 @@ "description": "The visitor's current privacy consent settings. Each property represents a consent category and is `true` (actively granted), `false` (actively denied), or `undefined` (no decision made yet)." } ], - "value": "export interface CustomerPrivacy {\n /**\n * Flags indicating whether each type of data processing is permitted, based on the visitor's consent, the merchant's privacy configuration, and the visitor's geographic location.\n */\n allowedProcessing: AllowedProcessing;\n /**\n * The tracking consent metafields that have been stored for this visitor. These contain app-specific consent data beyond the standard categories.\n *\n * @example `[{key: 'analyticsType', value: 'granular'}, {key: 'marketingType', value: 'granular'}]`, or `[]`\n */\n metafields: TrackingConsentMetafield[];\n /**\n * The visitor's current privacy consent settings. Each property represents a consent category and is `true` (actively granted), `false` (actively denied), or `undefined` (no decision made yet).\n */\n visitorConsent: VisitorConsent;\n /**\n * Whether a consent banner should be displayed by default when the page loads. Use this as the initial open/expanded state of the consent banner.\n *\n * This is determined by the visitor's current privacy consent, the shop's [region visibility configuration](https://help.shopify.com/en/manual/privacy-and-security/privacy/customer-privacy-settings/privacy-settings#add-a-cookie-banner) settings, and the region in which the visitor is located.\n */\n shouldShowBanner: boolean;\n /**\n * Whether the visitor is located in a region that requires an explicit opt-out option for the sale or sharing of personal data, such as California (CCPA) or other jurisdictions with similar regulations.\n */\n saleOfDataRegion: boolean;\n /**\n * The visitor's geographic location, used to determine whether more granular consent controls should be displayed based on regional privacy regulations.\n *\n * @example `{countryCode: 'CA', provinceCode: 'ON'}` for a visitor in Ontario, Canada; `{countryCode: 'US', provinceCode: undefined}` for a visitor in the United States if geolocation fails to detect the state; or `undefined` if neither country nor province is detected or geolocation fails.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).\n */\n region?: CustomerPrivacyRegion;\n}" + "value": "export interface CustomerPrivacy {\n /**\n * Flags indicating whether each type of data processing is permitted, based on the visitor's consent, the merchant's privacy configuration, and the visitor's geographic location.\n */\n allowedProcessing: AllowedProcessing;\n /**\n * The tracking consent metafields that have been stored for this visitor. These contain app-specific consent data beyond the standard categories.\n *\n * @example `[{key: 'analyticsType', value: 'granular'}, {key: 'marketingType', value: 'granular'}]`, or `[]`\n */\n metafields: TrackingConsentMetafield[];\n /**\n * The visitor's current privacy consent settings. Each property represents a consent category and is `true` (actively granted), `false` (actively denied), or `undefined` (no decision made yet).\n */\n visitorConsent: VisitorConsent;\n /**\n * Whether a consent banner should be displayed by default when the page loads. Use this as the initial open/expanded state of the consent banner.\n *\n * This is determined by the visitor's current privacy consent, the shop's [region visibility configuration](https://help.shopify.com/en/manual/privacy-and-security/privacy/customer-privacy-settings/privacy-settings#add-a-cookie-banner) settings, and the region in which the visitor is located.\n */\n shouldShowBanner: boolean;\n /**\n * Whether the visitor is located in a region that requires an explicit opt-out option for the sale or sharing of personal data, such as California (CCPA) or other jurisdictions with similar regulations.\n */\n saleOfDataRegion: boolean;\n /**\n * The visitor's geographic location, used to determine whether more granular consent controls should be displayed based on regional privacy regulations.\n *\n * @example `{countryCode: 'CA', provinceCode: 'ON'}` for a visitor in Ontario, Canada; `{countryCode: 'US', provinceCode: undefined}` for a visitor in the United States if geolocation fails to detect the state; or `undefined` if neither country nor province is detected or geolocation fails.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n region?: CustomerPrivacyRegion;\n}" } }, "AllowedProcessing": { @@ -1969,31 +1969,31 @@ "syntaxKind": "PropertySignature", "name": "analytics", "value": "boolean", - "description": "Whether analytics data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Analytics data includes how the shop was used and what interactions occurred." + "description": "Whether analytics data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Analytics data includes how the shop was used and what interactions occurred.\n\nWhether analytics data can be collected right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.analytics`, before calling `shopify.analytics.publish()`." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "marketing", "value": "boolean", - "description": "Whether marketing data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Marketing data includes attribution and targeted advertising preferences." + "description": "Whether marketing data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Marketing data includes attribution and targeted advertising preferences.\n\nWhether marketing data can be collected right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.marketing`, before performing marketing-related data collection." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "preferences", "value": "boolean", - "description": "Whether preference data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Preference data includes language, currency, and sizing choices." + "description": "Whether preference data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Preference data includes language, currency, and sizing choices.\n\nWhether preference data can be collected right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.preferences`, before storing or reading buyer preference data." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "saleOfData", "value": "boolean", - "description": "Whether data can be shared with third parties based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. This typically applies to behavioral advertising data." + "description": "Whether data can be shared with third parties based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. This typically applies to behavioral advertising data.\n\nWhether buyer data can be shared with or sold to third parties right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.saleOfData`, before sharing or selling buyer data with third parties." } ], - "value": "export interface AllowedProcessing {\n /**\n * Whether analytics data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Analytics\n * data includes how the shop was used and what interactions occurred.\n */\n analytics: boolean;\n /**\n * Whether marketing data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Marketing\n * data includes attribution and targeted advertising preferences.\n */\n marketing: boolean;\n /**\n * Whether preference data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Preference\n * data includes language, currency, and sizing choices.\n */\n preferences: boolean;\n /**\n * Whether data can be shared with third parties based on the visitor's\n * consent, the merchant's privacy configuration, and the visitor's region.\n * This typically applies to behavioral advertising data.\n */\n saleOfData: boolean;\n}" + "value": "export interface AllowedProcessing {\n /**\n * Whether analytics data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Analytics\n * data includes how the shop was used and what interactions occurred.\n *\n * Whether analytics data can be collected right now. Combines the buyer's\n * consent, the merchant's privacy configuration, and the buyer's region into\n * a single boolean. Check this flag, not `visitorConsent.analytics`, before\n * calling `shopify.analytics.publish()`.\n */\n analytics: boolean;\n /**\n * Whether marketing data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Marketing\n * data includes attribution and targeted advertising preferences.\n *\n * Whether marketing data can be collected right now. Combines the buyer's\n * consent, the merchant's privacy configuration, and the buyer's region into\n * a single boolean. Check this flag, not `visitorConsent.marketing`, before\n * performing marketing-related data collection.\n */\n marketing: boolean;\n /**\n * Whether preference data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Preference\n * data includes language, currency, and sizing choices.\n *\n * Whether preference data can be collected right now. Combines the buyer's\n * consent, the merchant's privacy configuration, and the buyer's region into\n * a single boolean. Check this flag, not `visitorConsent.preferences`,\n * before storing or reading buyer preference data.\n */\n preferences: boolean;\n /**\n * Whether data can be shared with third parties based on the visitor's\n * consent, the merchant's privacy configuration, and the visitor's region.\n * This typically applies to behavioral advertising data.\n *\n * Whether buyer data can be shared with or sold to third parties right now.\n * Combines the buyer's consent, the merchant's privacy configuration, and\n * the buyer's region into a single boolean. Check this flag, not\n * `visitorConsent.saleOfData`, before sharing or selling buyer data with\n * third parties.\n */\n saleOfData: boolean;\n}" } }, "TrackingConsentMetafield": { @@ -2031,7 +2031,7 @@ "syntaxKind": "PropertySignature", "name": "countryCode", "value": "CountryCode", - "description": "The buyer's country code in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. The value is `undefined` if geolocation failed.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).", + "description": "The buyer's country code in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. The value is `undefined` if geolocation failed.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", "isOptional": true, "examples": [ { @@ -2051,7 +2051,7 @@ "syntaxKind": "PropertySignature", "name": "provinceCode", "value": "string", - "description": "The buyer's province, state, or region code in [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) format. The value is `undefined` if geolocation failed or only the country was detected.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).", + "description": "The buyer's province, state, or region code in [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) format. The value is `undefined` if geolocation failed or only the country was detected.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", "isOptional": true, "examples": [ { @@ -2067,7 +2067,7 @@ ] } ], - "value": "export interface CustomerPrivacyRegion {\n /**\n * The buyer's country code in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. The value is `undefined` if geolocation failed.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'CA' for Canada, 'US' for United States, 'GB' for Great Britain\n */\n countryCode?: CountryCode;\n /**\n * The buyer's province, state, or region code in [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) format. The value is `undefined` if geolocation failed or only the country was detected.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'ON' for Ontario, 'ENG' for England, 'CA' for California\n */\n provinceCode?: string;\n}" + "value": "export interface CustomerPrivacyRegion {\n /**\n * The buyer's country code in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. The value is `undefined` if geolocation failed.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'CA' for Canada, 'US' for United States, 'GB' for Great Britain\n */\n countryCode?: CountryCode;\n /**\n * The buyer's province, state, or region code in [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) format. The value is `undefined` if geolocation failed or only the country was detected.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'ON' for Ontario, 'ENG' for England, 'CA' for California\n */\n provinceCode?: string;\n}" } }, "DeliveryGroup": { @@ -2194,7 +2194,7 @@ "syntaxKind": "PropertySignature", "name": "metafields", "value": "Metafield[]", - "description": "Custom [metafields](https://shopify.dev/docs/apps/build/custom-data/metafields) attached to this delivery option by the carrier or a [Shopify Function](https://shopify.dev/docs/apps/build/functions). Use these to display additional information about the option." + "description": "Custom [metafields](/docs/apps/build/custom-data/metafields) attached to this delivery option by the carrier or a [Shopify Function](/docs/apps/build/functions). Use these to display additional information about the option." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -2281,7 +2281,7 @@ "src/surfaces/checkout/api/standard/standard.ts": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Metafield", - "description": "Metadata associated with the checkout. See the [metafields documentation](https://shopify.dev/docs/apps/build/custom-data/metafields) for more information on how metafields work.", + "description": "Metadata associated with the checkout. See the [metafields documentation](/docs/apps/build/custom-data/metafields) for more information on how metafields work.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -2400,7 +2400,7 @@ "syntaxKind": "PropertySignature", "name": "metafields", "value": "Metafield[]", - "description": "Custom [metafields](https://shopify.dev/docs/apps/build/custom-data/metafields) attached to this delivery option by the carrier or a [Shopify Function](https://shopify.dev/docs/apps/build/functions). Use these to display additional information about the option." + "description": "Custom [metafields](/docs/apps/build/custom-data/metafields) attached to this delivery option by the carrier or a [Shopify Function](/docs/apps/build/functions). Use these to display additional information about the option." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -2519,7 +2519,7 @@ "syntaxKind": "PropertySignature", "name": "metafields", "value": "Metafield[]", - "description": "Custom [metafields](https://shopify.dev/docs/apps/build/custom-data/metafields) attached to this delivery option by the carrier or a [Shopify Function](https://shopify.dev/docs/apps/build/functions). Use these to display additional information about the option." + "description": "Custom [metafields](/docs/apps/build/custom-data/metafields) attached to this delivery option by the carrier or a [Shopify Function](/docs/apps/build/functions). Use these to display additional information about the option." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -2571,7 +2571,7 @@ "syntaxKind": "TypeAliasDeclaration", "name": "DeliveryGroupType", "value": "'oneTimePurchase' | 'subscription'", - "description": "The possible types of a delivery group.\n\n- `'oneTimePurchase'`: Items bought as a single, non-recurring purchase.\n- `'subscription'`: Items bought through a [selling plan](https://shopify.dev/docs/apps/build/purchase-options/subscriptions) that results in recurring deliveries." + "description": "The possible types of a delivery group.\n\n- `'oneTimePurchase'`: Items bought as a single, non-recurring purchase.\n- `'subscription'`: Items bought through a [selling plan](/docs/apps/build/purchase-options/subscriptions) that results in recurring deliveries." } }, "DeliveryOptionReference": { @@ -2614,7 +2614,7 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CartDiscountAllocation", "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", - "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](https://shopify.dev/docs/api/functions/latest/discount)." + "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount)." } }, "CartCodeDiscountAllocation": { @@ -2697,17 +2697,17 @@ "syntaxKind": "PropertySignature", "name": "title", "value": "string", - "description": "The title of the custom discount, typically applied by a [Shopify Function](https://shopify.dev/docs/api/functions/latest/discount)." + "description": "The title of the custom discount, typically applied by a [Shopify Function](/docs/api/functions/latest/discount)." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "type", "value": "'custom'", - "description": "Identifies this as a custom discount applied by a [Shopify Function](https://shopify.dev/docs/api/functions/latest/discount)." + "description": "Identifies this as a custom discount applied by a [Shopify Function](/docs/api/functions/latest/discount)." } ], - "value": "export interface CartCustomDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the custom discount, typically applied by a [Shopify Function](https://shopify.dev/docs/api/functions/latest/discount).\n */\n title: string;\n\n /**\n * Identifies this as a custom discount applied by a [Shopify Function](https://shopify.dev/docs/api/functions/latest/discount).\n */\n type: 'custom';\n}" + "value": "export interface CartCustomDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the custom discount, typically applied by a [Shopify Function](/docs/api/functions/latest/discount).\n */\n title: string;\n\n /**\n * Identifies this as a custom discount applied by a [Shopify Function](/docs/api/functions/latest/discount).\n */\n type: 'custom';\n}" } }, "CartDiscountCode": { @@ -2731,7 +2731,7 @@ "src/surfaces/checkout/api/standard/standard.ts": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Extension", - "description": "The meta information about an extension target.", + "description": "Metadata about the running extension, including its API version, target, capabilities, and editor context. Use this to read configuration details or conditionally render content based on where the extension is running.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -2757,7 +2757,7 @@ "syntaxKind": "PropertySignature", "name": "capabilities", "value": "SubscribableSignalLike", - "description": "The allowed capabilities of the extension, defined in your [shopify.extension.toml](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n\n* [`api_access`](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#api-access): the extension can access the Storefront API.\n\n* [`network_access`](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access): the extension can make external network calls.\n\n* [`block_progress`](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n\n* [`collect_buyer_consent.sms_marketing`](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n\n* [`collect_buyer_consent.customer_privacy`](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can register customer consent decisions that are honored on Shopify-managed services.\n\n* [`iframe.sources`](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#iframe): the extension can embed an external URL in an iframe." + "description": "The allowed capabilities of the extension, defined in your [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -2805,7 +2805,7 @@ "syntaxKind": "PropertySignature", "name": "version", "value": "string", - "description": "The published version of the running extension target.\n\nFor unpublished extensions, the value is `undefined`.", + "description": "The published version of the running extension target.\n\nFor unpublished extensions, the value is `undefined`.\n\nDon't use this property as a stable identifier in development environments. It becomes available only after the extension is published.", "isOptional": true, "examples": [ { @@ -2821,7 +2821,7 @@ ] } ], - "value": "export interface Extension {\n /**\n * The API version that was set in the extension config file.\n *\n * @example '2024-10', '2025-01', '2025-04', '2025-07', '2025-10'\n */\n apiVersion: ApiVersion;\n\n /**\n * The allowed capabilities of the extension, defined\n * in your [shopify.extension.toml](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n *\n * * [`api_access`](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#api-access): the extension can access the Storefront API.\n *\n * * [`network_access`](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access): the extension can make external network calls.\n *\n * * [`block_progress`](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n *\n * * [`collect_buyer_consent.sms_marketing`](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n *\n * * [`collect_buyer_consent.customer_privacy`](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can register customer consent decisions that are honored on Shopify-managed services.\n *\n * * [`iframe.sources`](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#iframe): the extension can embed an external URL in an iframe.\n */\n capabilities: SubscribableSignalLike;\n\n /**\n * Information about the editor where the extension is being rendered.\n *\n * If the value is undefined, then the extension isn't running in an editor.\n */\n editor?: Editor;\n\n /**\n * A Boolean to show whether your extension is currently rendered to the screen.\n *\n * Shopify might render your extension before it's visible in the UI,\n * typically to pre-render extensions that appear on a later step of the\n * checkout.\n *\n * Your extension might also continue to run after the customer has navigated away\n * from where it was rendered. The extension continues running so that\n * your extension is immediately available to render if the customer navigates back.\n */\n rendered: SubscribableSignalLike;\n\n /**\n * The URL to the script that started the extension target.\n */\n scriptUrl: string;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see https://shopify.dev/docs/apps/app-extensions/configuration#targets\n */\n target: Target;\n\n /**\n * The published version of the running extension target.\n *\n * For unpublished extensions, the value is `undefined`.\n *\n * @example 3.0.10\n */\n version?: string;\n}" + "value": "export interface Extension {\n /**\n * The API version that was set in the extension config file.\n *\n * @example '2024-10', '2025-01', '2025-04', '2025-07', '2025-10'\n */\n apiVersion: ApiVersion;\n\n /**\n * The allowed capabilities of the extension, defined in your\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n */\n capabilities: SubscribableSignalLike;\n\n /**\n * Information about the editor where the extension is being rendered.\n *\n * If the value is undefined, then the extension isn't running in an editor.\n */\n editor?: Editor;\n\n /**\n * A Boolean to show whether your extension is currently rendered to the screen.\n *\n * Shopify might render your extension before it's visible in the UI,\n * typically to pre-render extensions that appear on a later step of the\n * checkout.\n *\n * Your extension might also continue to run after the customer has navigated away\n * from where it was rendered. The extension continues running so that\n * your extension is immediately available to render if the customer navigates back.\n */\n rendered: SubscribableSignalLike;\n\n /**\n * The URL to the script that started the extension target.\n */\n scriptUrl: string;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n */\n target: Target;\n\n /**\n * The published version of the running extension target.\n *\n * For unpublished extensions, the value is `undefined`.\n *\n * Don't use this property as a stable identifier in development environments.\n * It becomes available only after the extension is published.\n *\n * @example 3.0.10\n */\n version?: string;\n}" } }, "ApiVersion": { @@ -2846,24 +2846,24 @@ "src/surfaces/checkout/api/standard/standard.ts": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Editor", - "description": "", + "description": "Information about the editor environment when an extension is rendered inside the checkout editor. The value is `undefined` when the extension is not rendering in an editor.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "type", "value": "'checkout'", - "description": "Indicates whether the extension is rendering in the [checkout editor](https://shopify.dev/docs/apps/checkout). Always `'checkout'`." + "description": "Indicates whether the extension is rendering in the [checkout editor](/docs/apps/checkout). Always `'checkout'`." } ], - "value": "export interface Editor {\n /**\n * Indicates whether the extension is rendering in the [checkout editor](https://shopify.dev/docs/apps/checkout). Always `'checkout'`.\n */\n type: 'checkout';\n}" + "value": "export interface Editor {\n /**\n * Indicates whether the extension is rendering in the [checkout editor](/docs/apps/checkout). Always `'checkout'`.\n */\n type: 'checkout';\n}" } }, "I18n": { "src/surfaces/checkout/api/standard/standard.ts": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18n", - "description": "", + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use the I18n API alongside the Localization API to build fully localized extensions.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -2901,7 +2901,7 @@ "src/surfaces/checkout/api/standard/standard.ts": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18nTranslate", - "description": "This returns a translated string matching a key in a locale file.", + "description": "Translates a key from your extension's locale files into a localized string. Supports interpolation with placeholder replacements and pluralization via the special `count` option.", "members": [], "value": "export interface I18nTranslate {\n (\n key: string,\n options?: Record,\n ): ReplacementType extends string | number\n ? string\n : (string | ReplacementType)[];\n}" } @@ -3132,7 +3132,7 @@ "syntaxKind": "PropertySignature", "name": "lineComponents", "value": "CartBundleLineComponent[]", - "description": "The individual components of a [bundle](https://shopify.dev/docs/apps/build/product-merchandising/bundles) line item. Each component represents a separate product within the bundle. Returns an empty array if the line item isn't a bundle." + "description": "The individual components of a [bundle](/docs/apps/build/product-merchandising/bundles) line item. Each component represents a separate product within the bundle. Returns an empty array if the line item isn't a bundle." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -3156,7 +3156,7 @@ "description": "The number of units of this merchandise that the buyer purchased." } ], - "value": "export interface CartLine {\n /**\n * A unique identifier for the cart line in the format `gid://shopify/CartLine/`. This ID isn't stable and can change after any cart operation, so avoid persisting it. Always look up the current ID before calling `applyCartLinesChange()`, because you'll need it to create a `CartLineChange` object.\n *\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n\n /**\n * The product variant or other merchandise associated with this line item. Use this to access product details such as the title, image, SKU, and selected options.\n */\n merchandise: Merchandise;\n\n /**\n * The number of units of this merchandise that the buyer purchased.\n */\n quantity: number;\n\n /**\n * The cost breakdown for this line item, including the total price after any line-level discounts have been applied.\n */\n cost: CartLineCost;\n\n /**\n * Custom key-value attributes attached to this cart line, such as gift messages or engraving text. Use `applyCartLinesChange()` to update these values.\n */\n attributes: Attribute[];\n\n /**\n * Discounts applied to this cart line, including code-based, automatic, and custom discounts. Each allocation shows the discounted amount and how the discount was triggered.\n */\n discountAllocations: CartDiscountAllocation[];\n\n /**\n * The individual components of a [bundle](https://shopify.dev/docs/apps/build/product-merchandising/bundles) line item. Each component represents a separate product within the bundle. Returns an empty array if the line item isn't a bundle.\n */\n lineComponents: CartLineComponentType[];\n\n /**\n * The parent line item that this line belongs to, or `null` if this is a\n * top-level line item. Used to identify lines added as children of a bundle\n * or other grouped product.\n */\n parentRelationship: CartLineParentRelationship | null;\n}" + "value": "export interface CartLine {\n /**\n * A unique identifier for the cart line in the format `gid://shopify/CartLine/`. This ID isn't stable and can change after any cart operation, so avoid persisting it. Always look up the current ID before calling `applyCartLinesChange()`, because you'll need it to create a `CartLineChange` object.\n *\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n\n /**\n * The product variant or other merchandise associated with this line item. Use this to access product details such as the title, image, SKU, and selected options.\n */\n merchandise: Merchandise;\n\n /**\n * The number of units of this merchandise that the buyer purchased.\n */\n quantity: number;\n\n /**\n * The cost breakdown for this line item, including the total price after any line-level discounts have been applied.\n */\n cost: CartLineCost;\n\n /**\n * Custom key-value attributes attached to this cart line, such as gift messages or engraving text. Use `applyCartLinesChange()` to update these values.\n */\n attributes: Attribute[];\n\n /**\n * Discounts applied to this cart line, including code-based, automatic, and custom discounts. Each allocation shows the discounted amount and how the discount was triggered.\n */\n discountAllocations: CartDiscountAllocation[];\n\n /**\n * The individual components of a [bundle](/docs/apps/build/product-merchandising/bundles) line item. Each component represents a separate product within the bundle. Returns an empty array if the line item isn't a bundle.\n */\n lineComponents: CartLineComponentType[];\n\n /**\n * The parent line item that this line belongs to, or `null` if this is a\n * top-level line item. Used to identify lines added as children of a bundle\n * or other grouped product.\n */\n parentRelationship: CartLineParentRelationship | null;\n}" } }, "CartLineCost": { @@ -3313,7 +3313,7 @@ "syntaxKind": "PropertySignature", "name": "sellingPlan", "value": "SellingPlan", - "description": "The [selling plan](https://shopify.dev/docs/apps/build/purchase-options/subscriptions) associated with this variant, such as a subscription or pre-order plan. The value is `undefined` if the item isn't being purchased through a selling plan.", + "description": "The [selling plan](/docs/apps/build/purchase-options/subscriptions) associated with this variant, such as a subscription or pre-order plan. The value is `undefined` if the item isn't being purchased through a selling plan.", "isOptional": true }, { @@ -3444,7 +3444,7 @@ "src/surfaces/checkout/api/shared.ts": { "filePath": "src/surfaces/checkout/api/shared.ts", "name": "SellingPlan", - "description": "A [selling plan](https://shopify.dev/docs/apps/build/purchase-options/subscriptions) represents a recurring or deferred purchasing option for a product, such as a subscription, pre-order, or try-before-you-buy plan. The merchant configures selling plans to define how and when the buyer is charged.", + "description": "A [selling plan](/docs/apps/build/purchase-options/subscriptions) represents a recurring or deferred purchasing option for a product, such as a subscription, pre-order, or try-before-you-buy plan. The merchant configures selling plans to define how and when the buyer is charged.", "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -3497,14 +3497,14 @@ "src/surfaces/checkout/api/standard/standard.ts": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Localization", - "description": "", + "description": "The buyer's language, country, currency, and timezone context. Use this to adapt your extension to the buyer's region and display localized content.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "country", "value": "SubscribableSignalLike", - "description": "The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown." + "description": "The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n\nDerived from the buyer's shipping address. Returns `undefined` until the buyer enters a shipping address." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -3532,18 +3532,18 @@ "syntaxKind": "PropertySignature", "name": "market", "value": "SubscribableSignalLike", - "description": "The [market](https://shopify.dev/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n\n> Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.", - "deprecationMessage": "Deprecated as of version `2025-04`" + "description": "The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. The market context updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.", + "deprecationMessage": "Merchants now manage which extensions load for each\nmarket, so extensions no longer need to check this value." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "timezone", "value": "SubscribableSignalLike", - "description": "The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time." + "description": "The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time." } ], - "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](https://shopify.dev/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n *\n * > Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" + "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n *\n * Derived from the buyer's shipping address. Returns `undefined` until the\n * buyer enters a shipping address.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout,\n * carried over from the cart context. Markets group countries and\n * regions with shared pricing, languages, and domains. The market\n * context updates when the buyer changes the country of their\n * shipping address. The value is `undefined` if the market is unknown.\n *\n * @deprecated Merchants now manage which extensions load for each\n * market, so extensions no longer need to check this value.\n */\n market: SubscribableSignalLike;\n}" } }, "Country": { @@ -3623,14 +3623,14 @@ "src/surfaces/checkout/api/standard/standard.ts": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Market", - "description": "A [Shopify Market](https://shopify.dev/docs/apps/build/markets) that represents a group of one or more regions for international selling.", + "description": "A [Shopify Market](/docs/apps/build/markets) that represents a group of one or more regions for international selling.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "handle", "value": "string", - "description": "The human-readable, shop-scoped identifier for the market, such as `'us'` or `'eu'`. Merchants define these handles when configuring [Shopify Markets](https://shopify.dev/docs/apps/build/markets)." + "description": "The human-readable, shop-scoped identifier for the market, such as `'us'` or `'eu'`. Merchants define these handles when configuring [Shopify Markets](/docs/apps/build/markets)." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -3640,7 +3640,7 @@ "description": "A globally-unique identifier for the market in the format `gid://shopify/Market/`." } ], - "value": "export interface Market {\n /**\n * A globally-unique identifier for the market in the format `gid://shopify/Market/`.\n */\n id: string;\n\n /**\n * The human-readable, shop-scoped identifier for the market, such as `'us'` or `'eu'`. Merchants define these handles when configuring [Shopify Markets](https://shopify.dev/docs/apps/build/markets).\n */\n handle: string;\n}" + "value": "export interface Market {\n /**\n * A globally-unique identifier for the market in the format `gid://shopify/Market/`.\n */\n id: string;\n\n /**\n * The human-readable, shop-scoped identifier for the market, such as `'us'` or `'eu'`. Merchants define these handles when configuring [Shopify Markets](/docs/apps/build/markets).\n */\n handle: string;\n}" } }, "Timezone": { @@ -3766,7 +3766,7 @@ "src/surfaces/checkout/api/standard/standard.ts": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SessionToken", - "description": "", + "description": "Authenticates requests between your extension and your app backend. Use session tokens to verify the identity of the buyer and the shop context when making server-side API calls. The token is a signed JWT that contains claims such as the customer ID, shop domain, and expiration.\n\nThe `sub` claim in the decoded token is present only when the buyer is logged in and the app has permission to read customer accounts. Absent for anonymous buyers.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -3800,7 +3800,7 @@ "syntaxKind": "PropertySignature", "name": "address1", "value": "string", - "description": "The first line of the street address, including the street number and name. The value is `undefined` if the buyer hasn't entered an address yet.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).", + "description": "The first line of the street address, including the street number and name. The value is `undefined` if the buyer hasn't entered an address yet.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", "isOptional": true, "examples": [ { @@ -3820,7 +3820,7 @@ "syntaxKind": "PropertySignature", "name": "address2", "value": "string", - "description": "The second line of the buyer's address, such as apartment number, suite, or unit. The value is `undefined` if the buyer didn't provide a second address line.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).", + "description": "The second line of the buyer's address, such as apartment number, suite, or unit. The value is `undefined` if the buyer didn't provide a second address line.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", "isOptional": true, "examples": [ { @@ -3840,7 +3840,7 @@ "syntaxKind": "PropertySignature", "name": "city", "value": "string", - "description": "The city, town, or village of the address. The value is `undefined` if the buyer hasn't entered a city yet.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).", + "description": "The city, town, or village of the address. The value is `undefined` if the buyer hasn't entered a city yet.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", "isOptional": true, "examples": [ { @@ -3860,7 +3860,7 @@ "syntaxKind": "PropertySignature", "name": "company", "value": "string", - "description": "The buyer's company name. The value is `undefined` if the buyer didn't enter a company or the store doesn't collect company names.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).", + "description": "The buyer's company name. The value is `undefined` if the buyer didn't enter a company or the store doesn't collect company names.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", "isOptional": true, "examples": [ { @@ -3880,7 +3880,7 @@ "syntaxKind": "PropertySignature", "name": "countryCode", "value": "CountryCode", - "description": "The two-letter country code in [ISO 3166 Alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. The value is `undefined` if the buyer hasn't selected a country yet.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).", + "description": "The two-letter country code in [ISO 3166 Alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. The value is `undefined` if the buyer hasn't selected a country yet.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", "isOptional": true, "examples": [ { @@ -3900,7 +3900,7 @@ "syntaxKind": "PropertySignature", "name": "firstName", "value": "string", - "description": "The buyer's first name. Use this alongside `lastName` when you need to display or process name parts separately. The value is `undefined` if the buyer didn't provide a first name or the store doesn't collect split names.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).", + "description": "The buyer's first name. Use this alongside `lastName` when you need to display or process name parts separately. The value is `undefined` if the buyer didn't provide a first name or the store doesn't collect split names.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", "isOptional": true, "examples": [ { @@ -3920,7 +3920,7 @@ "syntaxKind": "PropertySignature", "name": "lastName", "value": "string", - "description": "The buyer's last name. Use this alongside `firstName` when you need to display or process name parts separately. The value is `undefined` if the buyer didn't provide a last name or the store doesn't collect split names.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).", + "description": "The buyer's last name. Use this alongside `firstName` when you need to display or process name parts separately. The value is `undefined` if the buyer didn't provide a last name or the store doesn't collect split names.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", "isOptional": true, "examples": [ { @@ -3940,7 +3940,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "The buyer's full name, typically a combination of first and last name. The value is `undefined` if the buyer didn't provide a name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).", + "description": "The buyer's full name, typically a combination of first and last name. The value is `undefined` if the buyer didn't provide a name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", "isOptional": true, "examples": [ { @@ -3968,7 +3968,7 @@ "syntaxKind": "PropertySignature", "name": "phone", "value": "string", - "description": "The phone number associated with the address, typically in international format. The value is `undefined` if the buyer didn't provide a phone number or the store doesn't collect phone numbers.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).", + "description": "The phone number associated with the address, typically in international format. The value is `undefined` if the buyer didn't provide a phone number or the store doesn't collect phone numbers.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", "isOptional": true, "examples": [ { @@ -3988,7 +3988,7 @@ "syntaxKind": "PropertySignature", "name": "provinceCode", "value": "string", - "description": "The province, state, prefecture, or region code of the address. The format varies by country. The value is `undefined` if the buyer hasn't selected one yet or the country doesn't have provinces.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).", + "description": "The province, state, prefecture, or region code of the address. The format varies by country. The value is `undefined` if the buyer hasn't selected one yet or the country doesn't have provinces.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", "isOptional": true, "examples": [ { @@ -4008,7 +4008,7 @@ "syntaxKind": "PropertySignature", "name": "zip", "value": "string", - "description": "The postal code or ZIP code of the address, used for mail sorting and delivery routing. The value is `undefined` if the buyer hasn't entered one yet or the country doesn't use postal codes.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).", + "description": "The postal code or ZIP code of the address, used for mail sorting and delivery routing. The value is `undefined` if the buyer hasn't entered one yet or the country doesn't use postal codes.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", "isOptional": true, "examples": [ { @@ -4031,7 +4031,7 @@ "src/surfaces/checkout/api/standard/standard.ts": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Shop", - "description": "", + "description": "Metadata about the merchant's store, including its name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -4071,32 +4071,32 @@ "syntaxKind": "PropertySignature", "name": "storefrontUrl", "value": "string", - "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n\n> Caution: > As of version `2024-04` this value no longer has a trailing slash.", + "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.", "isOptional": true } ], - "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n *\n * > Caution:\n * > As of version `2024-04` this value no longer has a trailing slash.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom domain.\n */\n myshopifyDomain: string;\n}" + "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom domain.\n */\n myshopifyDomain: string;\n}" } }, "Storage": { "src/surfaces/checkout/api/standard/standard.ts": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Storage", - "description": "A key-value storage object for the extension.\n\nStored data is available only to this specific extension and any of its instances.\n\nThe storage backend is implemented with `localStorage` and should persist across the buyer's checkout session. However, data persistence isn't guaranteed.", + "description": "Key-value storage for a specific extension. Use storage to save preferences or cached data that should survive page reloads without requiring a backend call. Stored data is only available to this specific extension. The storage backend is implemented with `localStorage` and data persistence isn't guaranteed.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "delete", "value": "(key: string) => Promise", - "description": "Delete stored data by key." + "description": "Deletes a previously stored value by key." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "read", "value": "(key: string) => Promise", - "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original primitive.\n\nReturns `null` if no stored data exists." + "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original type.\n\nReturns the stored value for the given key, or `null` when no value exists. Doesn't throw on a missing key." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -4106,7 +4106,7 @@ "description": "Write stored data for this key.\n\nThe data must be serializable to JSON." } ], - "value": "export interface Storage {\n /**\n * Read and return a stored value by key.\n *\n * The stored data is deserialized from JSON and returned as\n * its original primitive.\n *\n * Returns `null` if no stored data exists.\n */\n read(key: string): Promise;\n\n /**\n * Write stored data for this key.\n *\n * The data must be serializable to JSON.\n */\n write(key: string, data: any): Promise;\n\n /**\n * Delete stored data by key.\n */\n delete(key: string): Promise;\n}" + "value": "export interface Storage {\n /**\n * Read and return a stored value by key.\n *\n * The stored data is deserialized from JSON and returned as\n * its original type.\n *\n * Returns the stored value for the given key, or `null` when no value\n * exists. Doesn't throw on a missing key.\n */\n read(key: string): Promise;\n\n /**\n * Write stored data for this key.\n *\n * The data must be serializable to JSON.\n */\n write(key: string, data: any): Promise;\n\n /**\n * Deletes a previously stored value by key.\n */\n delete(key: string): Promise;\n}" } }, "Version": { @@ -4129,7 +4129,7 @@ "syntaxKind": "MethodSignature", "name": "applyAttributeChange", "value": "(change: AttributeChange) => Promise", - "description": "Updates or removes an attribute on the cart and checkout. On success, the [`attributes`](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/attributes#standardapi-propertydetail-attributes) property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.", + "description": "Updates or removes an attribute on the cart and checkout. On success, the [`attributes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/attributes#properties-propertydetail-attributes) property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.", "deprecationMessage": "Use cart metafields instead." }, { @@ -4137,42 +4137,42 @@ "syntaxKind": "MethodSignature", "name": "applyCartLinesChange", "value": "(change: CartLineChange) => Promise", - "description": "Adds, removes, or updates line items in the cart. The returned promise resolves when the change has been applied by the server, and the [`lines`](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-lines#standardapi-propertydetail-lines) property updates with the new state.\n\n> Note: This method returns an error if the [cart instruction](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Adds, removes, or updates line items in the cart. The returned promise resolves when the change has been applied by the server, and the [`lines`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-lines#properties-propertydetail-lines) property updates with the new state.\n\nAccepts a single change per call. To make multiple changes, call this method separately for each one.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyDiscountCodeChange", "value": "(change: DiscountCodeChange) => Promise", - "description": "Adds or removes a discount code on the checkout. The returned promise resolves when the change has been applied by the server, and the [`discountCodes`](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/discounts#standardapi-propertydetail-discountcodes) property updates with the new state.\n\n> Caution: > See [security considerations](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves discount codes through a network call.\n\n> Note: This method returns an error if the [cart instruction](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Adds or removes a discount code on the checkout. The returned promise resolves when the change has been applied by the server, and the [`discountCodes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/discounts#properties-propertydetail-discountcodes) property updates with the new state.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves discount codes through a network call.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyGiftCardChange", "value": "(change: GiftCardChange) => Promise", - "description": "Adds or removes a gift card from the checkout. The returned promise resolves when the change has been applied by the server, and the [`appliedGiftCards`](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/gift-cards#standardapi-propertydetail-appliedgiftcards) property updates with the new state.\n\n> Caution: > See [security considerations](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves gift card codes through a network call.\n\n> Note: This method returns an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Adds or removes a gift card from the checkout. The returned promise resolves when the change has been applied by the server, and the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/gift-cards#properties-propertydetail-appliedgiftcards) property updates with the new state.\n\nUnlike other write operations, gift card changes aren't gated by a cart instruction flag.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves gift card codes through a network call.\n\n> Note: This method returns an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyMetafieldChange", "value": "(change: MetafieldChange) => Promise", - "description": "Creates, updates, or removes a cart metafield on the checkout. On success, the [`metafields`](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/metafields#standardapi-propertydetail-metafields) property updates to reflect the change.\n\nCart metafields are copied to order metafields at order creation time if there's a matching order metafield definition with the [`cart to order copyable`](https://shopify.dev/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n\n> Caution: `MetafieldRemoveChange` and `MetafieldUpdateChange` are deprecated. Use cart metafields with `MetafieldRemoveCartChange` and `MetafieldUpdateCartChange` instead. If `MetafieldUpdateChange` writes a metafield with the same namespace and key as a cart metafield that's configured to copy, the cart metafield won't be copied.\n\n> Note: This method returns an error if the [cart instruction](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Creates, updates, or removes a cart metafield on the checkout. On success, the [`metafields`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/metafields#properties-propertydetail-metafields) property updates to reflect the change.\n\nCart metafields are copied to order metafields at order creation time if there's a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n\n> Caution: `MetafieldRemoveChange` and `MetafieldUpdateChange` are deprecated. Use cart metafields with `MetafieldRemoveCartChange` and `MetafieldUpdateCartChange` instead. If `MetafieldUpdateChange` writes a metafield with the same namespace and key as a cart metafield that's configured to copy, the cart metafield won't be copied.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyNoteChange", "value": "(change: NoteChange) => Promise", - "description": "Sets or removes the buyer's note on the checkout. On success, the [`note`](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/note#standardapi-propertydetail-note) property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Sets or removes the buyer's note on the checkout. On success, the [`note`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/note#properties-propertydetail-note) property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyShippingAddressChange", "value": "(change: ShippingAddressUpdateChange) => Promise", - "description": "Updates the buyer's shipping address on the checkout. The provided fields are merged into the existing address without prompting the buyer. On success, the `shippingAddress` property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).", + "description": "Updates the buyer's shipping address on the checkout. The provided fields are merged into the existing address without prompting the buyer. On success, the `shippingAddress` property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", "isOptional": true }, { @@ -4185,7 +4185,7 @@ "isPrivate": true } ], - "value": "export interface CheckoutApi {\n /**\n * Updates or removes an attribute on the cart and checkout. On success, the\n * [`attributes`](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/attributes#standardapi-propertydetail-attributes) property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * @deprecated Use cart metafields instead.\n */\n applyAttributeChange(change: AttributeChange): Promise;\n\n /**\n * Adds, removes, or updates line items in the cart. The returned promise resolves when the change has been applied by the server, and the [`lines`](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-lines#standardapi-propertydetail-lines) property updates with the new state.\n *\n * > Note: This method returns an error if the [cart instruction](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyCartLinesChange(change: CartLineChange): Promise;\n\n /**\n * Adds or removes a discount code on the checkout. The returned promise resolves when the change has been applied by the server, and the [`discountCodes`](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/discounts#standardapi-propertydetail-discountcodes) property updates with the new state.\n *\n * > Caution:\n * > See [security considerations](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves discount codes through a network call.\n *\n * > Note: This method returns an error if the [cart instruction](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyDiscountCodeChange(\n change: DiscountCodeChange,\n ): Promise;\n\n /**\n * Adds or removes a gift card from the checkout. The returned promise resolves when the change has been applied by the server, and the [`appliedGiftCards`](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/gift-cards#standardapi-propertydetail-appliedgiftcards) property updates with the new state.\n *\n * > Caution:\n * > See [security considerations](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves gift card codes through a network call.\n *\n * > Note: This method returns an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyGiftCardChange(change: GiftCardChange): Promise;\n\n /**\n * Creates, updates, or removes a cart metafield on the checkout. On success, the\n * [`metafields`](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/metafields#standardapi-propertydetail-metafields) property updates to reflect the change.\n *\n * Cart metafields are copied to order metafields at order creation time if there's a matching order metafield definition with the [`cart to order copyable`](https://shopify.dev/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n *\n * > Caution: `MetafieldRemoveChange` and `MetafieldUpdateChange` are deprecated. Use cart metafields with `MetafieldRemoveCartChange` and `MetafieldUpdateCartChange` instead. If `MetafieldUpdateChange` writes a metafield with the same namespace and key as a cart metafield that's configured to copy, the cart metafield won't be copied.\n *\n * > Note: This method returns an error if the [cart instruction](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyMetafieldChange(change: MetafieldChange): Promise;\n\n /**\n * Sets or removes the buyer's note on the checkout. On success, the\n * [`note`](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/note#standardapi-propertydetail-note)\n * property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyNoteChange(change: NoteChange): Promise;\n\n /**\n * @private\n */\n experimentalIsShopAppStyle?: boolean;\n\n /**\n * Updates the buyer's shipping address on the checkout. The provided fields\n * are merged into the existing address without prompting the buyer. On success,\n * the `shippingAddress` property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).\n */\n applyShippingAddressChange?(\n change: ShippingAddressChange,\n ): Promise;\n}" + "value": "export interface CheckoutApi {\n /**\n * Updates or removes an attribute on the cart and checkout. On success, the\n * [`attributes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/attributes#properties-propertydetail-attributes) property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * @deprecated Use cart metafields instead.\n */\n applyAttributeChange(change: AttributeChange): Promise;\n\n /**\n * Adds, removes, or updates line items in the cart. The returned promise resolves when the change has been applied by the server, and the [`lines`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-lines#properties-propertydetail-lines) property updates with the new state.\n *\n * Accepts a single change per call. To make multiple changes, call this\n * method separately for each one.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyCartLinesChange(change: CartLineChange): Promise;\n\n /**\n * Adds or removes a discount code on the checkout. The returned promise resolves when the change has been applied by the server, and the [`discountCodes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/discounts#properties-propertydetail-discountcodes) property updates with the new state.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves discount codes through a network call.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyDiscountCodeChange(\n change: DiscountCodeChange,\n ): Promise;\n\n /**\n * Adds or removes a gift card from the checkout. The returned promise resolves when the change has been applied by the server, and the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/gift-cards#properties-propertydetail-appliedgiftcards) property updates with the new state.\n *\n * Unlike other write operations, gift card changes aren't gated by a cart\n * instruction flag.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves gift card codes through a network call.\n *\n * > Note: This method returns an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyGiftCardChange(change: GiftCardChange): Promise;\n\n /**\n * Creates, updates, or removes a cart metafield on the checkout. On success, the\n * [`metafields`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/metafields#properties-propertydetail-metafields) property updates to reflect the change.\n *\n * Cart metafields are copied to order metafields at order creation time if there's a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n *\n * > Caution: `MetafieldRemoveChange` and `MetafieldUpdateChange` are deprecated. Use cart metafields with `MetafieldRemoveCartChange` and `MetafieldUpdateCartChange` instead. If `MetafieldUpdateChange` writes a metafield with the same namespace and key as a cart metafield that's configured to copy, the cart metafield won't be copied.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyMetafieldChange(change: MetafieldChange): Promise;\n\n /**\n * Sets or removes the buyer's note on the checkout. On success, the\n * [`note`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/note#properties-propertydetail-note)\n * property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyNoteChange(change: NoteChange): Promise;\n\n /**\n * @private\n */\n experimentalIsShopAppStyle?: boolean;\n\n /**\n * Updates the buyer's shipping address on the checkout. The provided fields\n * are merged into the existing address without prompting the buyer. On success,\n * the `shippingAddress` property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyShippingAddressChange?(\n change: ShippingAddressChange,\n ): Promise;\n}" } }, "AttributeChange": { @@ -4364,7 +4364,7 @@ "syntaxKind": "PropertySignature", "name": "sellingPlanId", "value": "string", - "description": "The identifier of the [selling plan](https://shopify.dev/docs/apps/build/purchase-options/subscriptions) to associate with this line item, such as a subscription or pre-order plan.", + "description": "The identifier of the [selling plan](/docs/apps/build/purchase-options/subscriptions) to associate with this line item, such as a subscription or pre-order plan.", "isOptional": true }, { @@ -4375,7 +4375,7 @@ "description": "Identifies this as a line item addition. Set this when creating a change to add a new product to the cart." } ], - "value": "export interface CartLineAddChange {\n /**\n * Identifies this as a line item addition. Set this when creating a change to add a new product to the cart.\n */\n type: 'addCartLine';\n\n /**\n * The globally-unique identifier of the product variant to add.\n * @example 'gid://shopify/ProductVariant/123'\n */\n merchandiseId: string;\n\n /**\n * The number of items to add. Must be a positive integer.\n */\n quantity: number;\n\n /**\n * Custom key-value attributes to attach to the new line item.\n */\n attributes?: Attribute[];\n\n /**\n * The identifier of the [selling plan](https://shopify.dev/docs/apps/build/purchase-options/subscriptions) to associate with this line item, such as a subscription or pre-order plan.\n */\n sellingPlanId?: SellingPlan['id'];\n\n /**\n * The parent cart line to associate the new item with, identified by either `lineId` or `merchandiseId`. Use this when adding child items to a bundle.\n */\n parent?: {lineId: string} | {merchandiseId: string};\n}" + "value": "export interface CartLineAddChange {\n /**\n * Identifies this as a line item addition. Set this when creating a change to add a new product to the cart.\n */\n type: 'addCartLine';\n\n /**\n * The globally-unique identifier of the product variant to add.\n * @example 'gid://shopify/ProductVariant/123'\n */\n merchandiseId: string;\n\n /**\n * The number of items to add. Must be a positive integer.\n */\n quantity: number;\n\n /**\n * Custom key-value attributes to attach to the new line item.\n */\n attributes?: Attribute[];\n\n /**\n * The identifier of the [selling plan](/docs/apps/build/purchase-options/subscriptions) to associate with this line item, such as a subscription or pre-order plan.\n */\n sellingPlanId?: SellingPlan['id'];\n\n /**\n * The parent cart line to associate the new item with, identified by either `lineId` or `merchandiseId`. Use this when adding child items to a bundle.\n */\n parent?: {lineId: string} | {merchandiseId: string};\n}" } }, "CartLineRemoveChange": { @@ -4495,7 +4495,7 @@ "syntaxKind": "PropertySignature", "name": "sellingPlanId", "value": "SellingPlan['id'] | null", - "description": "The [selling plan](https://shopify.dev/docs/apps/build/purchase-options/subscriptions) to associate with this line item. Pass `null` to remove the item from its current selling plan.", + "description": "The [selling plan](/docs/apps/build/purchase-options/subscriptions) to associate with this line item. Pass `null` to remove the item from its current selling plan.", "isOptional": true }, { @@ -4506,7 +4506,7 @@ "description": "Identifies this as a line item update. Set this when creating a change to modify a line item's quantity, variant, or attributes." } ], - "value": "export interface CartLineUpdateChange {\n /**\n * Identifies this as a line item update. Set this when creating a change to modify a line item's quantity, variant, or attributes.\n */\n type: 'updateCartLine';\n\n /**\n * The unique identifier of the cart line to update. Look up the current ID from `lines` before calling, because cart line IDs aren't stable.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n\n /**\n * The new product variant to swap in for this line item. Only provide this if you want to change the variant.\n * @example 'gid://shopify/ProductVariant/123'\n */\n\n merchandiseId?: string;\n /**\n * The new quantity for this line item. Only provide this if you want to change the quantity.\n */\n quantity?: number;\n\n /**\n * The new custom key-value attributes for this line item. Replaces all existing attributes when provided.\n */\n attributes?: Attribute[];\n\n /**\n * The [selling plan](https://shopify.dev/docs/apps/build/purchase-options/subscriptions) to associate with this line item. Pass `null` to remove the item from its current selling plan.\n */\n sellingPlanId?: SellingPlan['id'] | null;\n\n /**\n * The parent cart line to associate this item with. Use this when updating the parent relationship for bundled items.\n */\n parent?: {lineId: string} | {merchandiseId: string};\n}" + "value": "export interface CartLineUpdateChange {\n /**\n * Identifies this as a line item update. Set this when creating a change to modify a line item's quantity, variant, or attributes.\n */\n type: 'updateCartLine';\n\n /**\n * The unique identifier of the cart line to update. Look up the current ID from `lines` before calling, because cart line IDs aren't stable.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n\n /**\n * The new product variant to swap in for this line item. Only provide this if you want to change the variant.\n * @example 'gid://shopify/ProductVariant/123'\n */\n\n merchandiseId?: string;\n /**\n * The new quantity for this line item. Only provide this if you want to change the quantity.\n */\n quantity?: number;\n\n /**\n * The new custom key-value attributes for this line item. Replaces all existing attributes when provided.\n */\n attributes?: Attribute[];\n\n /**\n * The [selling plan](/docs/apps/build/purchase-options/subscriptions) to associate with this line item. Pass `null` to remove the item from its current selling plan.\n */\n sellingPlanId?: SellingPlan['id'] | null;\n\n /**\n * The parent cart line to associate this item with. Use this when updating the parent relationship for bundled items.\n */\n parent?: {lineId: string} | {merchandiseId: string};\n}" } }, "CartLineChangeResult": { @@ -4546,7 +4546,7 @@ "syntaxKind": "PropertySignature", "name": "message", "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer." + "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer.\n\nRender your own localized error text rather than displaying this message to the buyer." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -4556,7 +4556,7 @@ "description": "Indicates that the line item wasn't changed successfully. Refer to the `message` property for details about the error." } ], - "value": "export interface CartLineChangeResultError {\n /**\n * Indicates that the line item wasn't changed successfully. Refer to the `message` property for details about the error.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface CartLineChangeResultError {\n /**\n * Indicates that the line item wasn't changed successfully. Refer to the `message` property for details about the error.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n *\n * Render your own localized error text rather than displaying this message\n * to the buyer.\n */\n message: string;\n}" } }, "DiscountCodeChange": { @@ -4760,7 +4760,7 @@ "syntaxKind": "PropertySignature", "name": "message", "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer." + "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer.\n\nRender your own localized error text rather than displaying this message to the buyer." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -4770,7 +4770,7 @@ "description": "Indicates that the gift card change couldn't be applied. Check the `message` property for details." } ], - "value": "export interface GiftCardChangeResultError {\n /**\n * Indicates that the gift card change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface GiftCardChangeResultError {\n /**\n * Indicates that the gift card change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n *\n * Render your own localized error text rather than displaying this message\n * to the buyer.\n */\n message: string;\n}" } }, "MetafieldChange": { @@ -4779,7 +4779,7 @@ "syntaxKind": "TypeAliasDeclaration", "name": "MetafieldChange", "value": "MetafieldRemoveChange | MetafieldUpdateChange | MetafieldRemoveCartChange | MetafieldUpdateCartChange", - "description": "The input for `applyMetafieldChange()`. Use the `type` property to specify the operation.\n\n- `MetafieldRemoveCartChange` (`type: 'removeCartMetafield'`): Removes an existing cart [metafield](https://shopify.dev/docs/apps/build/custom-data/metafields).\n- `MetafieldUpdateCartChange` (`type: 'updateCartMetafield'`): Creates or updates a cart metafield.\n- `MetafieldRemoveChange` (`type: 'removeMetafield'`) - Deprecated. Use `MetafieldRemoveCartChange` instead.\n- `MetafieldUpdateChange` (`type: 'updateMetafield'`) - Deprecated. Use `MetafieldUpdateCartChange` instead." + "description": "The input for `applyMetafieldChange()`. Use the `type` property to specify the operation.\n\n- `MetafieldRemoveCartChange` (`type: 'removeCartMetafield'`): Removes an existing cart [metafield](/docs/apps/build/custom-data/metafields).\n- `MetafieldUpdateCartChange` (`type: 'updateCartMetafield'`): Creates or updates a cart metafield.\n- `MetafieldRemoveChange` (`type: 'removeMetafield'`) - Deprecated. Use `MetafieldRemoveCartChange` instead.\n- `MetafieldUpdateChange` (`type: 'updateMetafield'`) - Deprecated. Use `MetafieldUpdateCartChange` instead." } }, "MetafieldRemoveChange": { @@ -4862,7 +4862,7 @@ "src/surfaces/checkout/api/checkout/checkout.ts": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "MetafieldRemoveCartChange", - "description": "Removes a cart [metafield](https://shopify.dev/docs/apps/build/custom-data/metafields). Pass this to `applyMetafieldChange()` to delete a metafield by key and namespace.", + "description": "Removes a cart [metafield](/docs/apps/build/custom-data/metafields). Pass this to `applyMetafieldChange()` to delete a metafield by key and namespace.", "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -4894,7 +4894,7 @@ "src/surfaces/checkout/api/standard/standard.ts": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartMetafield", - "description": "Represents a custom metadata attached to the cart. Unlike `AppMetafield`, cart metafield values are always strings and don't include a `valueType` discriminator.\n\nCart [metafields](https://shopify.dev/docs/apps/build/custom-data/metafields) are set by extensions using `applyMetafieldChange()` and can be copied to order metafields at order creation time.", + "description": "Represents a custom metadata attached to the cart. Unlike `AppMetafield`, cart metafield values are always strings and don't include a `valueType` discriminator.\n\nCart [metafields](/docs/apps/build/custom-data/metafields) are set by extensions using `applyMetafieldChange()` and can be copied to order metafields at order creation time.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -4915,7 +4915,7 @@ "syntaxKind": "PropertySignature", "name": "type", "value": "string", - "description": "The metafield's [type name](https://shopify.dev/docs/apps/build/custom-data/metafields/list-of-data-types), such as `'single_line_text_field'` or `'json'`." + "description": "The metafield's [type name](/docs/apps/build/custom-data/metafields/list-of-data-types), such as `'single_line_text_field'` or `'json'`." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -4925,14 +4925,14 @@ "description": "The string value stored in the cart metafield. Unlike `AppMetafield`, cart metafield values are always strings." } ], - "value": "export interface CartMetafield {\n /**\n * The key name of a metafield, such as `'delivery_instructions'` or `'gift_message'`. Together with `namespace`, this uniquely identifies the metafield on the cart.\n */\n key: string;\n\n /**\n * The namespace for a metafield, such as `'custom'` or `'my_app'`. Together with `key`, this uniquely identifies the metafield on the cart.\n */\n namespace: string;\n\n /**\n * The string value stored in the cart metafield. Unlike `AppMetafield`, cart metafield values are always strings.\n */\n value: string;\n\n /**\n * The metafield's [type name](https://shopify.dev/docs/apps/build/custom-data/metafields/list-of-data-types), such as `'single_line_text_field'` or `'json'`.\n */\n type: string;\n}" + "value": "export interface CartMetafield {\n /**\n * The key name of a metafield, such as `'delivery_instructions'` or `'gift_message'`. Together with `namespace`, this uniquely identifies the metafield on the cart.\n */\n key: string;\n\n /**\n * The namespace for a metafield, such as `'custom'` or `'my_app'`. Together with `key`, this uniquely identifies the metafield on the cart.\n */\n namespace: string;\n\n /**\n * The string value stored in the cart metafield. Unlike `AppMetafield`, cart metafield values are always strings.\n */\n value: string;\n\n /**\n * The metafield's [type name](/docs/apps/build/custom-data/metafields/list-of-data-types), such as `'single_line_text_field'` or `'json'`.\n */\n type: string;\n}" } }, "MetafieldUpdateCartChange": { "src/surfaces/checkout/api/checkout/checkout.ts": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "MetafieldUpdateCartChange", - "description": "Creates or updates a cart [metafield](https://shopify.dev/docs/apps/build/custom-data/metafields). Pass this to `applyMetafieldChange()` to set a metafield value. If a metafield with the provided key and namespace doesn't already exist, then it gets created.", + "description": "Creates or updates a cart [metafield](/docs/apps/build/custom-data/metafields). Pass this to `applyMetafieldChange()` to set a metafield value. If a metafield with the provided key and namespace doesn't already exist, then it gets created.", "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -4949,7 +4949,7 @@ "description": "Identifies this as a cart metafield creation or update. Set this when creating a change to set a metafield value." } ], - "value": "export interface MetafieldUpdateCartChange {\n /**\n * Identifies this as a cart metafield creation or update. Set this when creating a change to set a metafield value.\n */\n type: 'updateCartMetafield';\n\n /**\n * The metafield data to set on the cart. If a metafield with this key and namespace already exists, then its value is replaced.\n */\n metafield: {\n /** The name of the metafield to update. */\n key: string;\n\n /** The namespace of the metafield to update. */\n namespace?: string;\n\n /** The new information to store in the metafield. */\n value: string;\n\n /**\n * The metafield's information type.\n * See the [metafield types documentation](https://shopify.dev/docs/apps/build/custom-data/metafields/list-of-data-types) for a list of supported types.\n */\n type: string;\n };\n}" + "value": "export interface MetafieldUpdateCartChange {\n /**\n * Identifies this as a cart metafield creation or update. Set this when creating a change to set a metafield value.\n */\n type: 'updateCartMetafield';\n\n /**\n * The metafield data to set on the cart. If a metafield with this key and namespace already exists, then its value is replaced.\n */\n metafield: {\n /** The name of the metafield to update. */\n key: string;\n\n /** The namespace of the metafield to update. */\n namespace?: string;\n\n /** The new information to store in the metafield. */\n value: string;\n\n /**\n * The metafield's information type.\n * See the [metafield types documentation](/docs/apps/build/custom-data/metafields/list-of-data-types) for a list of supported types.\n */\n type: string;\n };\n}" } }, "MetafieldChangeResult": { @@ -4989,7 +4989,7 @@ "syntaxKind": "PropertySignature", "name": "message", "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer." + "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer.\n\nRender your own localized error text rather than displaying this message to the buyer." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -4999,7 +4999,7 @@ "description": "Indicates that the metafield change couldn't be applied. Check the `message` property for details." } ], - "value": "export interface MetafieldChangeResultError {\n /**\n * Indicates that the metafield change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface MetafieldChangeResultError {\n /**\n * Indicates that the metafield change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n *\n * Render your own localized error text rather than displaying this message\n * to the buyer.\n */\n message: string;\n}" } }, "NoteChange": { @@ -5089,7 +5089,7 @@ "syntaxKind": "PropertySignature", "name": "message", "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer." + "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer.\n\nRender your own localized error text rather than displaying this message to the buyer." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -5099,7 +5099,7 @@ "description": "Indicates that the note change couldn't be applied. Check the `message` property for details." } ], - "value": "export interface NoteChangeResultError {\n /**\n * Indicates that the note change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface NoteChangeResultError {\n /**\n * Indicates that the note change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n *\n * Render your own localized error text rather than displaying this message\n * to the buyer.\n */\n message: string;\n}" } }, "ShippingAddressUpdateChange": { @@ -5312,10 +5312,10 @@ "syntaxKind": "PropertySignature", "name": "target", "value": "SubscribableSignalLike", - "description": "The cart line that this extension is attached to. Use this to read the line item's merchandise, quantity, cost, and attributes.\n\n> Note: Until version `2023-04`, this property was a `ReadonlySignalLike`." + "description": "The cart line that this extension is attached to. Use this to read the line item's merchandise, quantity, cost, and attributes.\n\nAvailable only on the corresponding item target. Shipping option item targets expose shipping option properties; pickup location item targets expose pickup location properties.\n\n> Note: Until version `2023-04`, this property was a `ReadonlySignalLike`." } ], - "value": "export interface CartLineItemApi {\n /**\n * The cart line that this extension is attached to. Use this to read the\n * line item's merchandise, quantity, cost, and attributes.\n *\n * > Note: Until version `2023-04`, this property was a `ReadonlySignalLike`.\n */\n target: SubscribableSignalLike;\n}" + "value": "export interface CartLineItemApi {\n /**\n * The cart line that this extension is attached to. Use this to read the\n * line item's merchandise, quantity, cost, and attributes.\n *\n * Available only on the corresponding item target. Shipping option item\n * targets expose shipping option properties; pickup location item targets\n * expose pickup location properties.\n *\n * > Note: Until version `2023-04`, this property was a `ReadonlySignalLike`.\n */\n target: SubscribableSignalLike;\n}" } }, "PickupLocationListApi": { @@ -5348,10 +5348,10 @@ "syntaxKind": "PropertySignature", "name": "isLocationFormVisible", "value": "SubscribableSignalLike", - "description": "Whether the location search form is currently visible to the buyer. Use this to conditionally render UI that depends on the buyer actively searching for pickup points." + "description": "Reflects which view was active when the extension loaded. When the buyer moves to the next view, the extension restarts with the current value rather than updating in place." } ], - "value": "export interface PickupPointListApi {\n /**\n * Whether the location search form is currently visible to the buyer.\n * Use this to conditionally render UI that depends on the buyer actively\n * searching for pickup points.\n */\n isLocationFormVisible: SubscribableSignalLike;\n}" + "value": "export interface PickupPointListApi {\n /**\n * Reflects which view was active when the extension loaded. When the\n * buyer moves to the next view, the extension restarts with the\n * current value rather than updating in place.\n */\n isLocationFormVisible: SubscribableSignalLike;\n}" } }, "PickupLocationItemApi": { @@ -5366,17 +5366,17 @@ "syntaxKind": "PropertySignature", "name": "isTargetSelected", "value": "SubscribableSignalLike", - "description": "Whether the buyer has selected the target pickup location. When `true`, the target location is the buyer's active choice. When `false`, the buyer has chosen a different pickup location." + "description": "Whether the buyer has selected the target pickup location. When `true`, the target location is the buyer's active choice. When `false`, the buyer has chosen a different pickup location.\n\nAvailable only on the corresponding item target. Shipping option item targets expose shipping option properties; pickup location item targets expose pickup location properties." }, { "filePath": "src/surfaces/checkout/api/pickup/pickup-location-item.ts", "syntaxKind": "PropertySignature", "name": "target", "value": "SubscribableSignalLike", - "description": "The pickup location that this extension is attached to. Use this to read the location's name, address, and other details." + "description": "The pickup location that this extension is attached to. Use this to read the location's name, address, and other details.\n\nAvailable only on the corresponding item target. Shipping option item targets expose shipping option properties; pickup location item targets expose pickup location properties." } ], - "value": "export interface PickupLocationItemApi {\n /**\n * The pickup location that this extension is attached to. Use this to read the location's name, address, and other details.\n */\n target: SubscribableSignalLike;\n\n /**\n * Whether the buyer has selected the target pickup location. When `true`, the target location is the buyer's active choice. When `false`, the buyer has chosen a different pickup location.\n */\n isTargetSelected: SubscribableSignalLike;\n}" + "value": "export interface PickupLocationItemApi {\n /**\n * The pickup location that this extension is attached to. Use this to read the location's name, address, and other details.\n *\n * Available only on the corresponding item target. Shipping option item\n * targets expose shipping option properties; pickup location item targets\n * expose pickup location properties.\n */\n target: SubscribableSignalLike;\n\n /**\n * Whether the buyer has selected the target pickup location. When `true`, the target location is the buyer's active choice. When `false`, the buyer has chosen a different pickup location.\n *\n * Available only on the corresponding item target. Shipping option item\n * targets expose shipping option properties; pickup location item targets\n * expose pickup location properties.\n */\n isTargetSelected: SubscribableSignalLike;\n}" } }, "ShippingOptionItemApi": { @@ -5391,7 +5391,7 @@ "syntaxKind": "PropertySignature", "name": "isTargetSelected", "value": "SubscribableSignalLike", - "description": "Whether the buyer has selected the target shipping option. When `true`, the target option is the buyer's active choice. When `false`, the buyer has chosen a different shipping option." + "description": "Whether the buyer has selected the target shipping option. When `true`, the target option is the buyer's active choice. When `false`, the buyer has chosen a different shipping option.\n\nAvailable only on the corresponding item target. Shipping option item targets expose shipping option properties; pickup location item targets expose pickup location properties." }, { "filePath": "src/surfaces/checkout/api/shipping/shipping-option-item.ts", @@ -5405,10 +5405,10 @@ "syntaxKind": "PropertySignature", "name": "target", "value": "SubscribableSignalLike", - "description": "The shipping option that this extension is attached to. Use this to read the option's cost, carrier, delivery estimate, and other details." + "description": "The shipping option that this extension is attached to. Use this to read the option's cost, carrier, delivery estimate, and other details.\n\nAvailable only on the corresponding item target. Shipping option item targets expose shipping option properties; pickup location item targets expose pickup location properties." } ], - "value": "export interface ShippingOptionItemApi {\n /**\n * The shipping option that this extension is attached to. Use this to read the option's cost, carrier, delivery estimate, and other details.\n */\n target: SubscribableSignalLike;\n\n /**\n * Whether the buyer has selected the target shipping option. When `true`, the target option is the buyer's active choice. When `false`, the buyer has chosen a different shipping option.\n */\n isTargetSelected: SubscribableSignalLike;\n\n /**\n * The render mode of this shipping option, indicating how the extension is displayed in the checkout UI.\n */\n renderMode: ShippingOptionItemRenderMode;\n}" + "value": "export interface ShippingOptionItemApi {\n /**\n * The shipping option that this extension is attached to. Use this to read the option's cost, carrier, delivery estimate, and other details.\n *\n * Available only on the corresponding item target. Shipping option item\n * targets expose shipping option properties; pickup location item targets\n * expose pickup location properties.\n */\n target: SubscribableSignalLike;\n\n /**\n * Whether the buyer has selected the target shipping option. When `true`, the target option is the buyer's active choice. When `false`, the buyer has chosen a different shipping option.\n *\n * Available only on the corresponding item target. Shipping option item\n * targets expose shipping option properties; pickup location item targets\n * expose pickup location properties.\n */\n isTargetSelected: SubscribableSignalLike;\n\n /**\n * The render mode of this shipping option, indicating how the extension is displayed in the checkout UI.\n */\n renderMode: ShippingOptionItemRenderMode;\n}" } }, "ShippingOptionItemRenderMode": { @@ -5523,10 +5523,10 @@ "syntaxKind": "PropertySignature", "name": "groupType", "value": "DeliveryGroupType", - "description": "The type of delivery groups in this list. This is the same `DeliveryGroupType` used on `DeliveryGroup.groupType`.\n\n- `'oneTimePurchase'`: Items bought as a single, non-recurring purchase.\n- `'subscription'`: Items bought through a [selling plan](https://shopify.dev/docs/apps/build/purchase-options/subscriptions) that results in recurring deliveries." + "description": "The type of delivery groups in this list. This is the same `DeliveryGroupType` used on `DeliveryGroup.groupType`.\n\n- `'oneTimePurchase'`: Items bought as a single, non-recurring purchase.\n- `'subscription'`: Items bought through a [selling plan](/docs/apps/build/purchase-options/subscriptions) that results in recurring deliveries." } ], - "value": "export interface DeliveryGroupList {\n /**\n * The type of delivery groups in this list. This is the same `DeliveryGroupType` used on `DeliveryGroup.groupType`.\n *\n * - `'oneTimePurchase'`: Items bought as a single, non-recurring purchase.\n * - `'subscription'`: Items bought through a [selling plan](https://shopify.dev/docs/apps/build/purchase-options/subscriptions) that results in recurring deliveries.\n */\n groupType: DeliveryGroupType;\n /**\n * The delivery groups in this list. Each group contains cart lines and available delivery options for those items.\n */\n deliveryGroups: DeliveryGroup[];\n}" + "value": "export interface DeliveryGroupList {\n /**\n * The type of delivery groups in this list. This is the same `DeliveryGroupType` used on `DeliveryGroup.groupType`.\n *\n * - `'oneTimePurchase'`: Items bought as a single, non-recurring purchase.\n * - `'subscription'`: Items bought through a [selling plan](/docs/apps/build/purchase-options/subscriptions) that results in recurring deliveries.\n */\n groupType: DeliveryGroupType;\n /**\n * The delivery groups in this list. Each group contains cart lines and available delivery options for those items.\n */\n deliveryGroups: DeliveryGroup[];\n}" } }, "AddressAutocompleteFormatSuggestionApi": { @@ -5652,7 +5652,7 @@ "syntaxKind": "PropertySignature", "name": "address1", "value": "string", - "description": "The first line of the street address, including the street number and name. The value is `undefined` if the buyer hasn't entered an address yet.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).", + "description": "The first line of the street address, including the street number and name. The value is `undefined` if the buyer hasn't entered an address yet.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", "isOptional": true, "examples": [ { @@ -5672,7 +5672,7 @@ "syntaxKind": "PropertySignature", "name": "address2", "value": "string", - "description": "The second line of the buyer's address, such as apartment number, suite, or unit. The value is `undefined` if the buyer didn't provide a second address line.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).", + "description": "The second line of the buyer's address, such as apartment number, suite, or unit. The value is `undefined` if the buyer didn't provide a second address line.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", "isOptional": true, "examples": [ { @@ -5692,7 +5692,7 @@ "syntaxKind": "PropertySignature", "name": "city", "value": "string", - "description": "The city, town, or village of the address. The value is `undefined` if the buyer hasn't entered a city yet.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).", + "description": "The city, town, or village of the address. The value is `undefined` if the buyer hasn't entered a city yet.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", "isOptional": true, "examples": [ { @@ -5712,7 +5712,7 @@ "syntaxKind": "PropertySignature", "name": "company", "value": "string", - "description": "The buyer's company name. The value is `undefined` if the buyer didn't enter a company or the store doesn't collect company names.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).", + "description": "The buyer's company name. The value is `undefined` if the buyer didn't enter a company or the store doesn't collect company names.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", "isOptional": true, "examples": [ { @@ -5732,7 +5732,7 @@ "syntaxKind": "PropertySignature", "name": "countryCode", "value": "CountryCode", - "description": "The two-letter country code in [ISO 3166 Alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. The value is `undefined` if the buyer hasn't selected a country yet.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).", + "description": "The two-letter country code in [ISO 3166 Alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. The value is `undefined` if the buyer hasn't selected a country yet.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", "isOptional": true, "examples": [ { @@ -5792,7 +5792,7 @@ "syntaxKind": "PropertySignature", "name": "provinceCode", "value": "string", - "description": "The province, state, prefecture, or region code of the address. The format varies by country. The value is `undefined` if the buyer hasn't selected one yet or the country doesn't have provinces.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).", + "description": "The province, state, prefecture, or region code of the address. The format varies by country. The value is `undefined` if the buyer hasn't selected one yet or the country doesn't have provinces.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", "isOptional": true, "examples": [ { @@ -5812,7 +5812,7 @@ "syntaxKind": "PropertySignature", "name": "zip", "value": "string", - "description": "The postal code or ZIP code of the address, used for mail sorting and delivery routing. The value is `undefined` if the buyer hasn't entered one yet or the country doesn't use postal codes.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).", + "description": "The postal code or ZIP code of the address, used for mail sorting and delivery routing. The value is `undefined` if the buyer hasn't entered one yet or the country doesn't use postal codes.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", "isOptional": true, "examples": [ { @@ -5892,14 +5892,14 @@ "syntaxKind": "PropertySignature", "name": "analytics", "value": "Analytics", - "description": "The methods for interacting with [Web Pixels](https://shopify.dev/docs/apps/marketing), such as emitting an event." + "description": "The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event." }, { "filePath": "src/surfaces/checkout/api/address-autocomplete/standard.ts", "syntaxKind": "PropertySignature", "name": "appMetafields", "value": "AppMetafieldEntry[]", - "description": "The metafields requested in the [`shopify.extension.toml`](https://shopify.dev/docs/api/checkout-ui-extensions/configuration) file. These metafields are updated when there's a change in the merchandise items being purchased by the customer.\n\nApp owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` is not supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n\n> Tip: > Cart metafields are only available on carts created via the Storefront API version `2023-04` or later.*" + "description": "The metafields requested in the [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration) file. These metafields are updated when there's a change in the merchandise items being purchased by the customer.\n\nApp owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` is not supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n\n> Tip: > Cart metafields are only available on carts created via the Storefront API version `2023-04` or later.*" }, { "filePath": "src/surfaces/checkout/api/address-autocomplete/standard.ts", @@ -5921,7 +5921,7 @@ "syntaxKind": "PropertySignature", "name": "checkoutToken", "value": "CheckoutToken | undefined", - "description": "A stable ID that represents the current checkout.\n\nThis matches the `data.checkout.token` field in a [checkout-related WebPixel event](https://shopify.dev/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data) and the `checkout_token` field in the [REST Admin API `Order` resource](https://shopify.dev/docs/api/admin-rest/unstable/resources/order#resource-object)." + "description": "A stable ID that represents the current checkout.\n\nThis matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data) and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object)." }, { "filePath": "src/surfaces/checkout/api/address-autocomplete/standard.ts", @@ -5935,21 +5935,21 @@ "syntaxKind": "PropertySignature", "name": "i18n", "value": "I18n", - "description": "Utilities for translating content and formatting values according to the current [`localization`](https://shopify.dev/docs/api/checkout-ui-extensions/apis/localization) Type 'RunnableExtensionInstance' is not assignable to type 'ExtensionInstance'.\n\nRefer to [`localization` examples](https://shopify.dev/docs/api/checkout-ui-extensions/apis/localization#examples) for more information." + "description": "Utilities for translating content and formatting values according to the current [`localization`](/docs/api/checkout-ui-extensions/apis/localization) Type 'RunnableExtensionInstance' is not assignable to type 'ExtensionInstance'.\n\nRefer to [`localization` examples](/docs/api/checkout-ui-extensions/apis/localization#examples) for more information." }, { "filePath": "src/surfaces/checkout/api/address-autocomplete/standard.ts", "syntaxKind": "PropertySignature", "name": "localization", "value": "Localization", - "description": "The details about the location, language, and currency of the customer. For utilities to easily format and translate content based on these details, you can use the [`i18n`](https://shopify.dev/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-i18n) object instead." + "description": "The details about the location, language, and currency of the customer. For utilities to easily format and translate content based on these details, you can use the [`i18n`](/docs/api/checkout-ui-extensions/apis/localization#properties-propertydetail-i18n) object instead." }, { "filePath": "src/surfaces/checkout/api/address-autocomplete/standard.ts", "syntaxKind": "PropertySignature", "name": "metafields", "value": "Metafield[]", - "description": "The metafields that apply to the current checkout.\n\nMetafields are stored locally on the client and are applied to the order object after the checkout completes. They are shared by all extensions running on checkout, and persist for as long as the customer is working on this checkout.\n\nOnce the order is created, you can query these metafields using the [GraphQL Admin API](https://shopify.dev/docs/admin-api/graphql/reference/orders/order#metafield-2021-01)\n\n> Caution: `metafields` is deprecated. Use `appMetafields` with cart metafields instead.", + "description": "The metafields that apply to the current checkout.\n\nMetafields are stored locally on the client and are applied to the order object after the checkout completes. They are shared by all extensions running on checkout, and persist for as long as the customer is working on this checkout.\n\nOnce the order is created, you can query these metafields using the [GraphQL Admin API](/docs/admin-api/graphql/reference/orders/order#metafield-2021-01)\n\n> Caution: `metafields` is deprecated. Use `appMetafields` with cart metafields instead.", "deprecationMessage": "Use `appMetafields` with cart metafields instead." }, { @@ -5957,21 +5957,21 @@ "syntaxKind": "PropertySignature", "name": "query", "value": ">(query: string, options?: { variables?: Variables; version?: StorefrontApiVersion; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>", - "description": "The method used to query the Storefront GraphQL API with a prefetched token.\n\nRefer to [Storefront API access examples](https://shopify.dev/docs/api/checkout-ui-extensions/apis/storefront-api) for more information." + "description": "The method used to query the Storefront GraphQL API with a prefetched token.\n\nRefer to [Storefront API access examples](/docs/api/checkout-ui-extensions/apis/storefront-api) for more information." }, { "filePath": "src/surfaces/checkout/api/address-autocomplete/standard.ts", "syntaxKind": "PropertySignature", "name": "sessionToken", "value": "SessionToken", - "description": "The session token providing a set of claims as a signed JSON Web Token (JWT).\n\nThe token has a TTL of 5 minutes.\n\nIf the previous token expires, this value will reflect a new session token with a new signature and expiry.\n\nRefer to [session token examples](https://shopify.dev/docs/api/checkout-ui-extensions/apis/session-token) for more information." + "description": "The session token providing a set of claims as a signed JSON Web Token (JWT).\n\nThe token has a TTL of 5 minutes.\n\nIf the previous token expires, this value will reflect a new session token with a new signature and expiry.\n\nLearn more about [session tokens](/docs/apps/build/authentication-authorization/session-tokens)." }, { "filePath": "src/surfaces/checkout/api/address-autocomplete/standard.ts", "syntaxKind": "PropertySignature", "name": "settings", "value": "ExtensionSettings", - "description": "The settings matching the settings definition written in the [`shopify.extension.toml`](https://shopify.dev/docs/api/checkout-ui-extensions/configuration) file.\n\n Refer to [settings examples](https://shopify.dev/docs/api/checkout-ui-extensions/apis/settings#examples) for more information.\n\n> Note: The settings are empty when an extension is being installed in the [checkout editor](https://help.shopify.com/en/manual/checkout-settings/checkout-extensibility/checkout-editor)." + "description": "The settings matching the settings definition written in the [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration) file.\n\n Refer to [settings examples](/docs/api/checkout-ui-extensions/apis/settings#examples) for more information.\n\n> Note: The settings are empty when an extension is being installed in the [checkout editor](https://help.shopify.com/en/manual/checkout-settings/checkout-extensibility/checkout-editor)." }, { "filePath": "src/surfaces/checkout/api/address-autocomplete/standard.ts", @@ -6015,7 +6015,7 @@ ] } ], - "value": "export interface AddressAutocompleteStandardApi<\n Target extends\n | 'purchase.address-autocomplete.suggest'\n | 'purchase.address-autocomplete.format-suggestion',\n> {\n /**\n * The metafields requested in the\n * [`shopify.extension.toml`](https://shopify.dev/docs/api/checkout-ui-extensions/configuration)\n * file. These metafields are updated when there's a change in the merchandise items\n * being purchased by the customer.\n *\n * App owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` is not supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * > Tip:\n * > Cart metafields are only available on carts created via the Storefront API version `2023-04` or later.*\n */\n appMetafields: AppMetafieldEntry[];\n\n /**\n * The methods for interacting with [Web Pixels](https://shopify.dev/docs/apps/marketing), such as emitting an event.\n */\n analytics: Analytics;\n\n /**\n * The custom attributes left by the customer to the merchant, either in their cart or during checkout.\n */\n attributes: Attribute[] | undefined;\n\n /**\n * The proposed customer billing address. The address updates when the field is\n * committed (on change) rather than every keystroke.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n billingAddress?: MailingAddress | undefined;\n\n /**\n * A stable ID that represents the current checkout.\n *\n * This matches the `data.checkout.token` field in a [checkout-related WebPixel event](https://shopify.dev/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data)\n * and the `checkout_token` field in the [REST Admin API `Order` resource](https://shopify.dev/docs/api/admin-rest/unstable/resources/order#resource-object).\n */\n checkoutToken: CheckoutToken | undefined;\n\n /**\n * The meta information about the extension.\n */\n extension: Extension;\n\n /**\n * Utilities for translating content and formatting values according to the current\n * [`localization`](https://shopify.dev/docs/api/checkout-ui-extensions/apis/localization)\n * Type 'RunnableExtensionInstance' is not assignable to type 'ExtensionInstance'.\n *\n * Refer to [`localization` examples](https://shopify.dev/docs/api/checkout-ui-extensions/apis/localization#examples)\n * for more information.\n */\n i18n: I18n;\n\n /**\n * The details about the location, language, and currency of the customer. For utilities to easily\n * format and translate content based on these details, you can use the\n * [`i18n`](https://shopify.dev/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-i18n)\n * object instead.\n */\n localization: Localization;\n\n /**\n * The metafields that apply to the current checkout.\n *\n * Metafields are stored locally on the client and are applied to the order object after the checkout completes.\n * They are shared by all extensions running on checkout, and\n * persist for as long as the customer is working on this checkout.\n *\n * Once the order is created, you can query these metafields using the\n * [GraphQL Admin API](https://shopify.dev/docs/admin-api/graphql/reference/orders/order#metafield-2021-01)\n *\n * > Caution:\n * `metafields` is deprecated. Use `appMetafields` with cart metafields instead.\n *\n * @deprecated Use `appMetafields` with cart metafields instead.\n */\n metafields: Metafield[];\n\n /**\n * The method used to query the Storefront GraphQL API with a prefetched token.\n *\n * Refer to [Storefront API access examples](https://shopify.dev/docs/api/checkout-ui-extensions/apis/storefront-api) for more information.\n */\n query: >(\n query: string,\n options?: {variables?: Variables; version?: StorefrontApiVersion},\n ) => Promise<{data?: Data; errors?: GraphQLError[]}>;\n\n /**\n * The session token providing a set of claims as a signed JSON Web Token (JWT).\n *\n * The token has a TTL of 5 minutes.\n *\n * If the previous token expires, this value will reflect a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](https://shopify.dev/docs/api/checkout-ui-extensions/apis/session-token) for more information.\n */\n sessionToken: SessionToken;\n\n /**\n * The settings matching the settings definition written in the\n * [`shopify.extension.toml`](https://shopify.dev/docs/api/checkout-ui-extensions/configuration) file.\n *\n * Refer to [settings examples](https://shopify.dev/docs/api/checkout-ui-extensions/apis/settings#examples) for more information.\n *\n * > Note: The settings are empty when an extension is being installed in the [checkout editor](https://help.shopify.com/en/manual/checkout-settings/checkout-extensibility/checkout-editor).\n\n */\n settings: ExtensionSettings;\n\n /**\n * The proposed customer shipping address. During the information step,\n * the address updates when the field is committed (on change) rather than every keystroke.\n *\n * > Note: An address value is only present if delivery is required. Otherwise, the subscribable value is undefined.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n shippingAddress?: MailingAddress | undefined;\n\n /** The shop where the checkout is taking place. */\n shop: Shop;\n\n /**\n * The key-value storage for the extension.\n *\n * It uses `localStorage` and should persist across the customer's current checkout session.\n *\n * > Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n *\n * Data is shared across all activated extension targets of this extension. In versions 2023-07 and earlier,\n * each activated extension target had its own storage.\n */\n storage: Storage;\n\n /**\n * The runner version being used for the extension.\n *\n * @example 'unstable'\n */\n version: Version;\n}" + "value": "export interface AddressAutocompleteStandardApi<\n Target extends\n | 'purchase.address-autocomplete.suggest'\n | 'purchase.address-autocomplete.format-suggestion',\n> {\n /**\n * The metafields requested in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration)\n * file. These metafields are updated when there's a change in the merchandise items\n * being purchased by the customer.\n *\n * App owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` is not supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * > Tip:\n * > Cart metafields are only available on carts created via the Storefront API version `2023-04` or later.*\n */\n appMetafields: AppMetafieldEntry[];\n\n /**\n * The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event.\n */\n analytics: Analytics;\n\n /**\n * The custom attributes left by the customer to the merchant, either in their cart or during checkout.\n */\n attributes: Attribute[] | undefined;\n\n /**\n * The proposed customer billing address. The address updates when the field is\n * committed (on change) rather than every keystroke.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n billingAddress?: MailingAddress | undefined;\n\n /**\n * A stable ID that represents the current checkout.\n *\n * This matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data)\n * and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n */\n checkoutToken: CheckoutToken | undefined;\n\n /**\n * The meta information about the extension.\n */\n extension: Extension;\n\n /**\n * Utilities for translating content and formatting values according to the current\n * [`localization`](/docs/api/checkout-ui-extensions/apis/localization)\n * Type 'RunnableExtensionInstance' is not assignable to type 'ExtensionInstance'.\n *\n * Refer to [`localization` examples](/docs/api/checkout-ui-extensions/apis/localization#examples)\n * for more information.\n */\n i18n: I18n;\n\n /**\n * The details about the location, language, and currency of the customer. For utilities to easily\n * format and translate content based on these details, you can use the\n * [`i18n`](/docs/api/checkout-ui-extensions/apis/localization#properties-propertydetail-i18n)\n * object instead.\n */\n localization: Localization;\n\n /**\n * The metafields that apply to the current checkout.\n *\n * Metafields are stored locally on the client and are applied to the order object after the checkout completes.\n * They are shared by all extensions running on checkout, and\n * persist for as long as the customer is working on this checkout.\n *\n * Once the order is created, you can query these metafields using the\n * [GraphQL Admin API](/docs/admin-api/graphql/reference/orders/order#metafield-2021-01)\n *\n * > Caution:\n * `metafields` is deprecated. Use `appMetafields` with cart metafields instead.\n *\n * @deprecated Use `appMetafields` with cart metafields instead.\n */\n metafields: Metafield[];\n\n /**\n * The method used to query the Storefront GraphQL API with a prefetched token.\n *\n * Refer to [Storefront API access examples](/docs/api/checkout-ui-extensions/apis/storefront-api) for more information.\n */\n query: >(\n query: string,\n options?: {variables?: Variables; version?: StorefrontApiVersion},\n ) => Promise<{data?: Data; errors?: GraphQLError[]}>;\n\n /**\n * The session token providing a set of claims as a signed JSON Web Token (JWT).\n *\n * The token has a TTL of 5 minutes.\n *\n * If the previous token expires, this value will reflect a new session token with a new signature and expiry.\n *\n * Learn more about [session tokens](/docs/apps/build/authentication-authorization/session-tokens).\n */\n sessionToken: SessionToken;\n\n /**\n * The settings matching the settings definition written in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/apis/settings#examples) for more information.\n *\n * > Note: The settings are empty when an extension is being installed in the [checkout editor](https://help.shopify.com/en/manual/checkout-settings/checkout-extensibility/checkout-editor).\n\n */\n settings: ExtensionSettings;\n\n /**\n * The proposed customer shipping address. During the information step,\n * the address updates when the field is committed (on change) rather than every keystroke.\n *\n * > Note: An address value is only present if delivery is required. Otherwise, the subscribable value is undefined.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n shippingAddress?: MailingAddress | undefined;\n\n /** The shop where the checkout is taking place. */\n shop: Shop;\n\n /**\n * The key-value storage for the extension.\n *\n * It uses `localStorage` and should persist across the customer's current checkout session.\n *\n * > Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n *\n * Data is shared across all activated extension targets of this extension. In versions 2023-07 and earlier,\n * each activated extension target had its own storage.\n */\n storage: Storage;\n\n /**\n * The runner version being used for the extension.\n *\n * @example 'unstable'\n */\n version: Version;\n}" } }, "DocsStyle": { @@ -6287,7 +6287,7 @@ "syntaxKind": "PropertySignature", "name": "Checkout::Dynamic::Render", "value": "RenderExtension<\n CheckoutApi & StandardApi<'Checkout::Dynamic::Render'>,\n AnyCheckoutComponent\n >", - "description": "A [block extension target](https://shopify.dev/docs/api/checkout-ui-extensions/extension-targets-overview#block-extension-targets) that isn't tied to a specific checkout section or feature. Unlike static extension targets, block extension targets render where the merchant sets them using the [checkout editor](https://shopify.dev/apps/checkout/test-ui-extensions#test-the-extension-in-the-checkout-editor).\n\nThe [supported locations](https://shopify.dev/docs/api/checkout-ui-extensions/extension-targets-overview#supported-locations) for block extension targets can be previewed during development by [using a URL parameter](https://shopify.dev/docs/apps/checkout/best-practices/testing-ui-extensions#block-extension-targets).", + "description": "A [block extension target](/docs/api/checkout-ui-extensions/extension-targets-overview#block-extension-targets) that isn't tied to a specific checkout section or feature. Unlike static extension targets, block extension targets render where the merchant sets them using the [checkout editor](/apps/checkout/test-ui-extensions#test-the-extension-in-the-checkout-editor).\n\nThe [supported locations](/docs/api/checkout-ui-extensions/extension-targets-overview#supported-locations) for block extension targets can be previewed during development by [using a URL parameter](/docs/apps/checkout/best-practices/testing-ui-extensions#block-extension-targets).", "deprecationMessage": "Use `purchase.checkout.block.render` instead.", "isPrivate": true }, @@ -6449,7 +6449,7 @@ "syntaxKind": "PropertySignature", "name": "Checkout::ThankYou::Dynamic::Render", "value": "RenderExtension<\n OrderConfirmationApi & StandardApi<'Checkout::ThankYou::Dynamic::Render'>,\n AnyCheckoutComponent\n >", - "description": "A [block extension target](https://shopify.dev/docs/api/checkout-ui-extensions/extension-targets-overview#block-extension-targets) that renders exclusively on the **Thank you** page. Unlike static extension targets, block extension targets render where the merchant sets them using the [checkout editor](https://shopify.dev/apps/checkout/test-ui-extensions#test-the-extension-in-the-checkout-editor).\n\nThe [supported locations](https://shopify.dev/docs/api/checkout-ui-extensions/extension-targets-overview#supported-locations) for block extension targets can be previewed during development by [using a URL parameter](https://shopify.dev/docs/apps/checkout/best-practices/testing-ui-extensions#block-extension-targets).", + "description": "A [block extension target](/docs/api/checkout-ui-extensions/extension-targets-overview#block-extension-targets) that renders exclusively on the **Thank you** page. Unlike static extension targets, block extension targets render where the merchant sets them using the [checkout editor](/apps/checkout/test-ui-extensions#test-the-extension-in-the-checkout-editor).\n\nThe [supported locations](/docs/api/checkout-ui-extensions/extension-targets-overview#supported-locations) for block extension targets can be previewed during development by [using a URL parameter](/docs/apps/checkout/best-practices/testing-ui-extensions#block-extension-targets).", "deprecationMessage": "Use `purchase.thank-you.block.render` instead.", "isPrivate": true }, @@ -6487,7 +6487,7 @@ "syntaxKind": "PropertySignature", "name": "purchase.checkout.block.render", "value": "RenderExtension<\n CheckoutApi & StandardApi<'purchase.checkout.block.render'>,\n AnyCheckoutComponent\n >", - "description": "A [block extension target](https://shopify.dev/docs/api/checkout-ui-extensions/extension-targets-overview#block-extension-targets) that isn't tied to a specific checkout section or feature. Unlike static extension targets, block extension targets render where the merchant sets them using the [checkout editor](https://shopify.dev/apps/checkout/test-ui-extensions#test-the-extension-in-the-checkout-editor).\n\nThe [supported locations](https://shopify.dev/docs/api/checkout-ui-extensions/extension-targets-overview#supported-locations) for block extension targets can be previewed during development by [using a URL parameter](https://shopify.dev/docs/apps/checkout/best-practices/testing-ui-extensions#block-extension-targets)." + "description": "A [block extension target](/docs/api/checkout-ui-extensions/extension-targets-overview#block-extension-targets) that isn't tied to a specific checkout section or feature. Unlike static extension targets, block extension targets render where the merchant sets them using the [checkout editor](/apps/checkout/test-ui-extensions#test-the-extension-in-the-checkout-editor).\n\nThe [supported locations](/docs/api/checkout-ui-extensions/extension-targets-overview#supported-locations) for block extension targets can be previewed during development by [using a URL parameter](/docs/apps/checkout/best-practices/testing-ui-extensions#block-extension-targets)." }, { "filePath": "src/surfaces/checkout/extension-targets.ts", @@ -6680,7 +6680,7 @@ "syntaxKind": "PropertySignature", "name": "purchase.thank-you.block.render", "value": "RenderExtension<\n OrderConfirmationApi & StandardApi<'purchase.thank-you.block.render'>,\n AnyCheckoutComponent\n >", - "description": "A [block extension target](https://shopify.dev/docs/api/checkout-ui-extensions/extension-targets-overview#block-extension-targets) that renders exclusively on the **Thank you** page. Unlike static extension targets, block extension targets render where the merchant sets them using the [checkout editor](https://shopify.dev/apps/checkout/test-ui-extensions#test-the-extension-in-the-checkout-editor).\n\nThe [supported locations](https://shopify.dev/docs/api/checkout-ui-extensions/extension-targets-overview#supported-locations) for block extension targets can be previewed during development by [using a URL parameter](https://shopify.dev/docs/apps/checkout/best-practices/testing-ui-extensions#block-extension-targets)." + "description": "A [block extension target](/docs/api/checkout-ui-extensions/extension-targets-overview#block-extension-targets) that renders exclusively on the **Thank you** page. Unlike static extension targets, block extension targets render where the merchant sets them using the [checkout editor](/apps/checkout/test-ui-extensions#test-the-extension-in-the-checkout-editor).\n\nThe [supported locations](/docs/api/checkout-ui-extensions/extension-targets-overview#supported-locations) for block extension targets can be previewed during development by [using a URL parameter](/docs/apps/checkout/best-practices/testing-ui-extensions#block-extension-targets)." }, { "filePath": "src/surfaces/checkout/extension-targets.ts", @@ -7065,7 +7065,7 @@ "syntaxKind": "PropertySignature", "name": "number", "value": "string", - "description": "A randomly generated alpha-numeric identifier for the order, distinct from `order.id`. The value is `undefined` for orders that were created before this field was introduced. All recent orders have a number.", + "description": "A randomly generated alpha-numeric identifier for the order, distinct from `order.id`. The value is `undefined` for orders that were created before this field was introduced. All recent orders have a number.\n\nOptional. Might not be present for orders created before 2024.", "isOptional": true }, { @@ -7076,7 +7076,7 @@ "description": "" } ], - "value": "export interface OrderConfirmation {\n order: {\n /**\n * A globally unique identifier for the order. This becomes the\n * [`Order`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Order) object ID in the\n * GraphQL Admin API after the order is created.\n *\n * @example 'gid://shopify/Order/123'\n */\n id: string;\n };\n /**\n * A randomly generated alpha-numeric identifier for the order, distinct\n * from `order.id`. The value is `undefined` for orders that were created\n * before this field was introduced. All recent orders have a number.\n */\n number?: string;\n\n /**\n * Whether this is the customer's first completed order with this shop. `true` means the buyer hasn't placed an order here before. Use this to show first-purchase messaging or trigger welcome offers.\n */\n isFirstOrder: boolean;\n}" + "value": "export interface OrderConfirmation {\n order: {\n /**\n * A globally unique identifier for the order. This becomes the\n * [`Order`](/docs/api/admin-graphql/latest/objects/Order) object ID in the\n * GraphQL Admin API after the order is created.\n *\n * @example 'gid://shopify/Order/123'\n */\n id: string;\n };\n /**\n * A randomly generated alpha-numeric identifier for the order, distinct\n * from `order.id`. The value is `undefined` for orders that were created\n * before this field was introduced. All recent orders have a number.\n *\n * Optional. Might not be present for orders created before 2024.\n */\n number?: string;\n\n /**\n * Whether this is the customer's first completed order with this shop. `true` means the buyer hasn't placed an order here before. Use this to show first-purchase messaging or trigger welcome offers.\n */\n isFirstOrder: boolean;\n}" } }, "RunnableExtension": { @@ -7131,10 +7131,10 @@ "syntaxKind": "PropertySignature", "name": "suggestions", "value": "AddressAutocompleteSuggestion[]", - "description": "An array of address autocomplete suggestions to show to the buyer.\n\n> Note: Only the first five suggestions will be displayed to the buyer." + "description": "An array of address autocomplete suggestions to show to the buyer. Checkout displays up to five address suggestions. Return no more than five. Additional suggestions are ignored." } ], - "value": "export interface AddressAutocompleteSuggestOutput {\n /**\n * An array of address autocomplete suggestions to show to the buyer.\n *\n * > Note: Only the first five suggestions will be displayed to the buyer.\n */\n suggestions: AddressAutocompleteSuggestion[];\n}" + "value": "export interface AddressAutocompleteSuggestOutput {\n /**\n * An array of address autocomplete suggestions to show to the buyer.\n * Checkout displays up to five address suggestions. Return no more\n * than five. Additional suggestions are ignored.\n */\n suggestions: AddressAutocompleteSuggestion[];\n}" } }, "AllowedComponents": { @@ -7247,7 +7247,7 @@ "syntaxKind": "PropertySignature", "name": "Checkout::Dynamic::Render", "value": "RenderExtension<\n CheckoutApi & StandardApi<'Checkout::Dynamic::Render'>,\n AnyCheckoutComponent\n >", - "description": "A [block extension target](https://shopify.dev/docs/api/checkout-ui-extensions/extension-targets-overview#block-extension-targets) that isn't tied to a specific checkout section or feature. Unlike static extension targets, block extension targets render where the merchant sets them using the [checkout editor](https://shopify.dev/apps/checkout/test-ui-extensions#test-the-extension-in-the-checkout-editor).\n\nThe [supported locations](https://shopify.dev/docs/api/checkout-ui-extensions/extension-targets-overview#supported-locations) for block extension targets can be previewed during development by [using a URL parameter](https://shopify.dev/docs/apps/checkout/best-practices/testing-ui-extensions#block-extension-targets).", + "description": "A [block extension target](/docs/api/checkout-ui-extensions/extension-targets-overview#block-extension-targets) that isn't tied to a specific checkout section or feature. Unlike static extension targets, block extension targets render where the merchant sets them using the [checkout editor](/apps/checkout/test-ui-extensions#test-the-extension-in-the-checkout-editor).\n\nThe [supported locations](/docs/api/checkout-ui-extensions/extension-targets-overview#supported-locations) for block extension targets can be previewed during development by [using a URL parameter](/docs/apps/checkout/best-practices/testing-ui-extensions#block-extension-targets).", "deprecationMessage": "Use `purchase.checkout.block.render` instead.", "isPrivate": true }, @@ -7409,7 +7409,7 @@ "syntaxKind": "PropertySignature", "name": "Checkout::ThankYou::Dynamic::Render", "value": "RenderExtension<\n OrderConfirmationApi & StandardApi<'Checkout::ThankYou::Dynamic::Render'>,\n AnyCheckoutComponent\n >", - "description": "A [block extension target](https://shopify.dev/docs/api/checkout-ui-extensions/extension-targets-overview#block-extension-targets) that renders exclusively on the **Thank you** page. Unlike static extension targets, block extension targets render where the merchant sets them using the [checkout editor](https://shopify.dev/apps/checkout/test-ui-extensions#test-the-extension-in-the-checkout-editor).\n\nThe [supported locations](https://shopify.dev/docs/api/checkout-ui-extensions/extension-targets-overview#supported-locations) for block extension targets can be previewed during development by [using a URL parameter](https://shopify.dev/docs/apps/checkout/best-practices/testing-ui-extensions#block-extension-targets).", + "description": "A [block extension target](/docs/api/checkout-ui-extensions/extension-targets-overview#block-extension-targets) that renders exclusively on the **Thank you** page. Unlike static extension targets, block extension targets render where the merchant sets them using the [checkout editor](/apps/checkout/test-ui-extensions#test-the-extension-in-the-checkout-editor).\n\nThe [supported locations](/docs/api/checkout-ui-extensions/extension-targets-overview#supported-locations) for block extension targets can be previewed during development by [using a URL parameter](/docs/apps/checkout/best-practices/testing-ui-extensions#block-extension-targets).", "deprecationMessage": "Use `purchase.thank-you.block.render` instead.", "isPrivate": true }, @@ -7433,7 +7433,7 @@ "syntaxKind": "PropertySignature", "name": "purchase.checkout.block.render", "value": "RenderExtension<\n CheckoutApi & StandardApi<'purchase.checkout.block.render'>,\n AnyCheckoutComponent\n >", - "description": "A [block extension target](https://shopify.dev/docs/api/checkout-ui-extensions/extension-targets-overview#block-extension-targets) that isn't tied to a specific checkout section or feature. Unlike static extension targets, block extension targets render where the merchant sets them using the [checkout editor](https://shopify.dev/apps/checkout/test-ui-extensions#test-the-extension-in-the-checkout-editor).\n\nThe [supported locations](https://shopify.dev/docs/api/checkout-ui-extensions/extension-targets-overview#supported-locations) for block extension targets can be previewed during development by [using a URL parameter](https://shopify.dev/docs/apps/checkout/best-practices/testing-ui-extensions#block-extension-targets)." + "description": "A [block extension target](/docs/api/checkout-ui-extensions/extension-targets-overview#block-extension-targets) that isn't tied to a specific checkout section or feature. Unlike static extension targets, block extension targets render where the merchant sets them using the [checkout editor](/apps/checkout/test-ui-extensions#test-the-extension-in-the-checkout-editor).\n\nThe [supported locations](/docs/api/checkout-ui-extensions/extension-targets-overview#supported-locations) for block extension targets can be previewed during development by [using a URL parameter](/docs/apps/checkout/best-practices/testing-ui-extensions#block-extension-targets)." }, { "filePath": "src/surfaces/checkout/extension-targets.ts", @@ -7626,7 +7626,7 @@ "syntaxKind": "PropertySignature", "name": "purchase.thank-you.block.render", "value": "RenderExtension<\n OrderConfirmationApi & StandardApi<'purchase.thank-you.block.render'>,\n AnyCheckoutComponent\n >", - "description": "A [block extension target](https://shopify.dev/docs/api/checkout-ui-extensions/extension-targets-overview#block-extension-targets) that renders exclusively on the **Thank you** page. Unlike static extension targets, block extension targets render where the merchant sets them using the [checkout editor](https://shopify.dev/apps/checkout/test-ui-extensions#test-the-extension-in-the-checkout-editor).\n\nThe [supported locations](https://shopify.dev/docs/api/checkout-ui-extensions/extension-targets-overview#supported-locations) for block extension targets can be previewed during development by [using a URL parameter](https://shopify.dev/docs/apps/checkout/best-practices/testing-ui-extensions#block-extension-targets)." + "description": "A [block extension target](/docs/api/checkout-ui-extensions/extension-targets-overview#block-extension-targets) that renders exclusively on the **Thank you** page. Unlike static extension targets, block extension targets render where the merchant sets them using the [checkout editor](/apps/checkout/test-ui-extensions#test-the-extension-in-the-checkout-editor).\n\nThe [supported locations](/docs/api/checkout-ui-extensions/extension-targets-overview#supported-locations) for block extension targets can be previewed during development by [using a URL parameter](/docs/apps/checkout/best-practices/testing-ui-extensions#block-extension-targets)." }, { "filePath": "src/surfaces/checkout/extension-targets.ts", @@ -7671,7 +7671,7 @@ "description": "A static extension target that is rendered below the header on the **Thank you** page." } ], - "value": "export interface RenderExtensionTargets {\n /**\n * A static extension target that is rendered immediately before any actions within each step.\n */\n 'purchase.checkout.actions.render-before': RenderExtension<\n CheckoutApi & StandardApi<'purchase.checkout.actions.render-before'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered immediately before any actions within each step.\n *\n * @deprecated Use `purchase.checkout.actions.render-before` instead.\n * @private\n */\n 'Checkout::Actions::RenderBefore': RenderExtension<\n CheckoutApi & StandardApi<'Checkout::Actions::RenderBefore'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered after all line items.\n */\n 'purchase.checkout.cart-line-list.render-after': RenderExtension<\n CheckoutApi & StandardApi<'purchase.checkout.cart-line-list.render-after'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered after all line items.\n *\n * @deprecated Use `purchase.checkout.cart-line-list.render-after` instead.\n * @private\n */\n 'Checkout::CartLines::RenderAfter': RenderExtension<\n CheckoutApi & StandardApi<'Checkout::CartLines::RenderAfter'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that renders on every line item, inside the details\n * under the line item properties element.\n */\n 'purchase.checkout.cart-line-item.render-after': RenderExtension<\n CheckoutApi &\n CartLineItemApi &\n StandardApi<'purchase.checkout.cart-line-item.render-after'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that renders on every line item, inside the details\n * under the line item properties element.\n *\n * @deprecated Use `purchase.checkout.cart-line-item.render-after` instead.\n * @private\n */\n 'Checkout::CartLineDetails::RenderAfter': RenderExtension<\n CheckoutApi &\n CartLineItemApi &\n StandardApi<'Checkout::CartLineDetails::RenderAfter'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that renders on every bundle line item, inside the details\n * under the line item properties element. It replaces the default bundle products rendering.\n * @private\n */\n 'purchase.cart-line-item.line-components.render': RenderExtension<\n CartLineItemApi &\n StandardApi<'purchase.cart-line-item.line-components.render'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that renders on every bundle line item, inside the details\n * under the line item properties element. It replaces the default bundle products rendering.\n *\n * @deprecated Use `purchase.cart-line-item.line-components.render` instead.\n * @private\n */\n 'Checkout::CartLineDetails::RenderLineComponents': RenderExtension<\n CartLineItemApi &\n StandardApi<'Checkout::CartLineDetails::RenderLineComponents'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered immediately after the contact form element.\n */\n 'purchase.checkout.contact.render-after': RenderExtension<\n CheckoutApi & StandardApi<'purchase.checkout.contact.render-after'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered immediately after the contact form element.\n *\n * @deprecated Use `purchase.checkout.contact.render-after` instead.\n * @private\n */\n 'Checkout::Contact::RenderAfter': RenderExtension<\n CheckoutApi & StandardApi<'Checkout::Contact::RenderAfter'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered after a purchase below the customer information.\n *\n * @deprecated Use `purchase.thank-you.customer-information.render-after` or\n * `customer-account.order-status.customer-information.render-after` from `@shopify/ui-extension/customer-account` instead.\n * @private\n */\n 'Checkout::CustomerInformation::RenderAfter': RenderExtension<\n CheckoutApi & StandardApi<'Checkout::CustomerInformation::RenderAfter'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered between the shipping address header\n * and shipping address form elements.\n */\n 'purchase.checkout.delivery-address.render-before': RenderExtension<\n CheckoutApi &\n StandardApi<'purchase.checkout.delivery-address.render-before'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered between the shipping address header\n * and shipping address form elements.\n *\n * @deprecated Use `purchase.checkout.delivery-address.render-before` instead.\n * @private\n */\n 'Checkout::DeliveryAddress::RenderBefore': RenderExtension<\n CheckoutApi & StandardApi<'Checkout::DeliveryAddress::RenderBefore'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered after the shipping address form elements.\n */\n 'purchase.checkout.delivery-address.render-after': RenderExtension<\n CheckoutApi &\n StandardApi<'purchase.checkout.delivery-address.render-after'>,\n AnyCheckoutComponent\n >;\n /**\n * A [block extension target](https://shopify.dev/docs/api/checkout-ui-extensions/extension-targets-overview#block-extension-targets) that isn't tied to a specific checkout section or feature.\n * Unlike static extension targets, block extension targets render where the merchant\n * sets them using the [checkout editor](https://shopify.dev/apps/checkout/test-ui-extensions#test-the-extension-in-the-checkout-editor).\n *\n * The [supported locations](https://shopify.dev/docs/api/checkout-ui-extensions/extension-targets-overview#supported-locations) for block extension targets can be previewed during development\n * by [using a URL parameter](https://shopify.dev/docs/apps/checkout/best-practices/testing-ui-extensions#block-extension-targets).\n */\n 'purchase.checkout.block.render': RenderExtension<\n CheckoutApi & StandardApi<'purchase.checkout.block.render'>,\n AnyCheckoutComponent\n >;\n /**\n * A [block extension target](https://shopify.dev/docs/api/checkout-ui-extensions/extension-targets-overview#block-extension-targets) that isn't tied to a specific checkout section or feature.\n * Unlike static extension targets, block extension targets render where the merchant\n * sets them using the [checkout editor](https://shopify.dev/apps/checkout/test-ui-extensions#test-the-extension-in-the-checkout-editor).\n *\n * The [supported locations](https://shopify.dev/docs/api/checkout-ui-extensions/extension-targets-overview#supported-locations) for block extension targets can be previewed during development\n * by [using a URL parameter](https://shopify.dev/docs/apps/checkout/best-practices/testing-ui-extensions#block-extension-targets).\n *\n * @deprecated Use `purchase.checkout.block.render` instead.\n * @private\n */\n 'Checkout::Dynamic::Render': RenderExtension<\n CheckoutApi & StandardApi<'Checkout::Dynamic::Render'>,\n AnyCheckoutComponent\n >;\n /**\n * A [block extension target](https://shopify.dev/docs/api/checkout-ui-extensions/extension-targets-overview#block-extension-targets) that renders exclusively on the **Thank you** page.\n * Unlike static extension targets, block extension targets render where the merchant\n * sets them using the [checkout editor](https://shopify.dev/apps/checkout/test-ui-extensions#test-the-extension-in-the-checkout-editor).\n *\n * The [supported locations](https://shopify.dev/docs/api/checkout-ui-extensions/extension-targets-overview#supported-locations) for block extension targets can be previewed during development\n * by [using a URL parameter](https://shopify.dev/docs/apps/checkout/best-practices/testing-ui-extensions#block-extension-targets).\n *\n */\n 'purchase.thank-you.block.render': RenderExtension<\n OrderConfirmationApi & StandardApi<'purchase.thank-you.block.render'>,\n AnyCheckoutComponent\n >;\n /**\n * A [block extension target](https://shopify.dev/docs/api/checkout-ui-extensions/extension-targets-overview#block-extension-targets) that renders exclusively on the **Thank you** page.\n * Unlike static extension targets, block extension targets render where the merchant\n * sets them using the [checkout editor](https://shopify.dev/apps/checkout/test-ui-extensions#test-the-extension-in-the-checkout-editor).\n *\n * The [supported locations](https://shopify.dev/docs/api/checkout-ui-extensions/extension-targets-overview#supported-locations) for block extension targets can be previewed during development\n * by [using a URL parameter](https://shopify.dev/docs/apps/checkout/best-practices/testing-ui-extensions#block-extension-targets).\n *\n * @deprecated Use `purchase.thank-you.block.render` instead.\n * @private\n */\n 'Checkout::ThankYou::Dynamic::Render': RenderExtension<\n OrderConfirmationApi & StandardApi<'Checkout::ThankYou::Dynamic::Render'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that renders on every line item, inside the details\n * under the line item properties element on the **Thank you** page.\n */\n 'purchase.thank-you.cart-line-item.render-after': RenderExtension<\n OrderConfirmationApi &\n CartLineItemApi &\n StandardApi<'purchase.thank-you.cart-line-item.render-after'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that renders on every line item, inside the details\n * under the line item properties element on the **Thank you** page.\n *\n * @deprecated Use `purchase.thank-you.cart-line-item.render-after` instead.\n * @private\n */\n 'Checkout::ThankYou::CartLineDetails::RenderAfter': RenderExtension<\n OrderConfirmationApi &\n CartLineItemApi &\n StandardApi<'Checkout::ThankYou::CartLineDetails::RenderAfter'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered after all line items on the **Thank you** page.\n */\n 'purchase.thank-you.cart-line-list.render-after': RenderExtension<\n OrderConfirmationApi &\n StandardApi<'purchase.thank-you.cart-line-list.render-after'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered after all line items on the **Thank you** page.\n *\n * @deprecated Use `purchase.thank-you.cart-line-list.render-after` instead.\n * @private\n */\n 'Checkout::ThankYou::CartLines::RenderAfter': RenderExtension<\n OrderConfirmationApi &\n StandardApi<'Checkout::ThankYou::CartLines::RenderAfter'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered after a purchase below the customer information on the **Thank you** page.\n */\n 'purchase.thank-you.customer-information.render-after': RenderExtension<\n OrderConfirmationApi &\n StandardApi<'purchase.thank-you.customer-information.render-after'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered after a purchase below the customer information on the **Thank you** page.\n *\n * @deprecated Use `purchase.thank-you.customer-information.render-after` instead.\n * @private\n */\n 'Checkout::ThankYou::CustomerInformation::RenderAfter': RenderExtension<\n OrderConfirmationApi &\n StandardApi<'Checkout::ThankYou::CustomerInformation::RenderAfter'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that renders the gift card entry form fields after\n * the buyer ticks a box to use a gift card. This does not replace the\n * native gift card entry form which is rendered in a separate part of checkout.\n *\n * @private\n */\n 'purchase.checkout.gift-card.render': RenderExtension<\n RedeemableApi &\n CheckoutApi &\n StandardApi<'purchase.checkout.gift-card.render'>,\n AnyCheckoutComponentExcept<'Image' | 'Banner'>\n >;\n /**\n * A static extension target that renders the gift card entry form fields after\n * the buyer ticks a box to use a gift card. This does not replace the\n * native gift card entry form which is rendered in a separate part of checkout.\n *\n * @private\n * @deprecated Use `purchase.checkout.gift-card.render` instead.\n */\n 'Checkout::GiftCard::Render': RenderExtension<\n RedeemableApi & CheckoutApi & StandardApi<'Checkout::GiftCard::Render'>,\n AnyCheckoutComponentExcept<'Image' | 'Banner'>\n >;\n /**\n * A static extension target that renders the form fields for a payment method when selected by the buyer.\n *\n * @private\n */\n 'purchase.checkout.payment-option-item.details.render': RenderExtension<\n PaymentOptionItemApi &\n CheckoutApi &\n StandardApi<'purchase.checkout.payment-option-item.details.render'>,\n AnyCheckoutComponentExcept<'Image' | 'Banner'>\n >;\n /**\n * A static extension target that renders the form fields for a payment method when selected by the buyer.\n *\n * @private\n * @deprecated Use `purchase.checkout.payment-option-item.details.render` instead.\n */\n 'Checkout::PaymentMethod::Render': RenderExtension<\n PaymentOptionItemApi &\n CheckoutApi &\n StandardApi<'Checkout::PaymentMethod::Render'>,\n AnyCheckoutComponentExcept<'Image' | 'Banner'>\n >;\n /**\n * A static extension target that renders after the hosted fields of a credit card payment method.\n *\n * @private\n */\n 'purchase.checkout.payment-option-item.hosted-fields.render-after': RenderExtension<\n PaymentOptionItemApi &\n CheckoutApi &\n StandardApi<'purchase.checkout.payment-option-item.hosted-fields.render-after'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that renders after the hosted fields of a credit card payment method.\n * for a credit card payment method when selected by the buyer.\n *\n * @private\n * @deprecated Use `purchase.checkout.payment-option-item.hosted-fields.render-after` instead.\n */\n 'Checkout::PaymentMethod::HostedFields::RenderAfter': RenderExtension<\n PaymentOptionItemApi &\n CheckoutApi &\n StandardApi<'Checkout::PaymentMethod::HostedFields::RenderAfter'>,\n AnyCheckoutComponentExcept<'Image' | 'Banner'>\n >;\n /**\n * A static extension target that renders a form modal when a buyer selects the custom onsite payment method.\n *\n * @private\n */\n 'purchase.checkout.payment-option-item.action-required.render': RenderExtension<\n CheckoutApi &\n StandardApi<'purchase.checkout.payment-option-item.action-required.render'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that renders a form modal when a buyer selects the custom onsite payment method.\n *\n * @private\n * @deprecated Use `purchase.checkout.payment-option-item.action-required.render` instead.\n */\n 'Checkout::PaymentMethod::RenderRequiredAction': RenderExtension<\n CheckoutApi & StandardApi<'Checkout::PaymentMethod::RenderRequiredAction'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that renders between the payment heading and payment method list.\n *\n */\n 'purchase.checkout.payment-method-list.render-before': RenderExtension<\n CheckoutApi &\n StandardApi<'purchase.checkout.payment-method-list.render-before'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that renders below the list of payment methods.\n *\n */\n 'purchase.checkout.payment-method-list.render-after': RenderExtension<\n CheckoutApi &\n StandardApi<'purchase.checkout.payment-method-list.render-after'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered in the order summary, before the discount form element.\n */\n 'purchase.checkout.reductions.render-before': RenderExtension<\n CheckoutApi & StandardApi<'purchase.checkout.reductions.render-before'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered in the order summary, before the discount form element.\n *\n * @deprecated Use `purchase.checkout.reductions.render-before` instead.\n * @private\n */\n 'Checkout::Reductions::RenderBefore': RenderExtension<\n CheckoutApi & StandardApi<'Checkout::Reductions::RenderBefore'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered in the order summary, after the discount form\n * and discount tag elements.\n */\n 'purchase.checkout.reductions.render-after': RenderExtension<\n CheckoutApi & StandardApi<'purchase.checkout.reductions.render-after'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered in the order summary, after the discount form\n * and discount tag elements.\n *\n * @deprecated Use `purchase.checkout.reductions.render-after` instead.\n * @private\n */\n 'Checkout::Reductions::RenderAfter': RenderExtension<\n CheckoutApi & StandardApi<'Checkout::Reductions::RenderAfter'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered between the shipping method\n * header and shipping method options.\n */\n 'purchase.checkout.shipping-option-list.render-before': RenderExtension<\n ShippingOptionListApi &\n CheckoutApi &\n StandardApi<'purchase.checkout.shipping-option-list.render-before'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered between the shipping method\n * header and shipping method options.\n *\n * @deprecated Use `purchase.checkout.shipping-option-list.render-before` instead.\n * @private\n */\n 'Checkout::ShippingMethods::RenderBefore': RenderExtension<\n ShippingOptionListApi &\n CheckoutApi &\n StandardApi<'Checkout::ShippingMethods::RenderBefore'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered after the shipping method\n * options.\n */\n 'purchase.checkout.shipping-option-list.render-after': RenderExtension<\n ShippingOptionListApi &\n CheckoutApi &\n StandardApi<'purchase.checkout.shipping-option-list.render-after'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered after the shipping method\n * options.\n *\n * @deprecated Use `purchase.checkout.shipping-option-list.render-after` instead.\n * @private\n */\n 'Checkout::ShippingMethods::RenderAfter': RenderExtension<\n ShippingOptionListApi &\n CheckoutApi &\n StandardApi<'Checkout::ShippingMethods::RenderAfter'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered before pickup location options.\n */\n 'purchase.checkout.pickup-location-list.render-before': RenderExtension<\n PickupLocationListApi &\n CheckoutApi &\n StandardApi<'purchase.checkout.pickup-location-list.render-before'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered before pickup location options.\n *\n * @deprecated Use `purchase.checkout.pickup-location-list.render-before` instead.\n * @private\n */\n 'Checkout::PickupLocations::RenderBefore': RenderExtension<\n PickupLocationListApi &\n CheckoutApi &\n StandardApi<'Checkout::PickupLocations::RenderBefore'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered after pickup location options.\n */\n 'purchase.checkout.pickup-location-list.render-after': RenderExtension<\n PickupLocationListApi &\n CheckoutApi &\n StandardApi<'purchase.checkout.pickup-location-list.render-after'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered after pickup location options.\n *\n * @deprecated Use `purchase.checkout.pickup-location-list.render-after` instead.\n * @private\n */\n 'Checkout::PickupLocations::RenderAfter': RenderExtension<\n PickupLocationListApi &\n CheckoutApi &\n StandardApi<'Checkout::PickupLocations::RenderAfter'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered after the shipping method\n * details within the shipping method option list, for each option.\n */\n 'purchase.checkout.shipping-option-item.render-after': RenderExtension<\n ShippingOptionItemApi &\n CheckoutApi &\n StandardApi<'purchase.checkout.shipping-option-item.render-after'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered after the shipping method\n * details within the shipping method option list, for each option.\n *\n * @deprecated Use `purchase.checkout.shipping-option-item.render-after` instead.\n * @private\n */\n 'Checkout::ShippingMethodDetails::RenderAfter': RenderExtension<\n ShippingOptionItemApi &\n CheckoutApi &\n StandardApi<'Checkout::ShippingMethodDetails::RenderAfter'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered under the shipping method\n * within the shipping method option list, for each option.\n */\n 'purchase.checkout.shipping-option-item.details.render': RenderExtension<\n ShippingOptionItemApi &\n CheckoutApi &\n StandardApi<'purchase.checkout.shipping-option-item.details.render'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered under the shipping method\n * within the shipping method option list, for each option.\n *\n * @deprecated Use `purchase.checkout.shipping-option-item.details.render` instead.\n * @private\n */\n 'Checkout::ShippingMethodDetails::RenderExpanded': RenderExtension<\n ShippingOptionItemApi &\n CheckoutApi &\n StandardApi<'Checkout::ShippingMethodDetails::RenderExpanded'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered immediately before the pickup points.\n */\n 'purchase.checkout.pickup-point-list.render-before': RenderExtension<\n PickupPointListApi &\n CheckoutApi &\n StandardApi<'purchase.checkout.pickup-point-list.render-before'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered immediately before the pickup points.\n *\n * @deprecated Use `purchase.checkout.pickup-point-list.render-before` instead.\n * @private\n */\n 'Checkout::PickupPoints::RenderBefore': RenderExtension<\n PickupPointListApi &\n CheckoutApi &\n StandardApi<'Checkout::PickupPoints::RenderBefore'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered immediately after the pickup points.\n */\n 'purchase.checkout.pickup-point-list.render-after': RenderExtension<\n PickupPointListApi &\n CheckoutApi &\n StandardApi<'purchase.checkout.pickup-point-list.render-after'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered immediately after the pickup points.\n *\n * @deprecated Use `purchase.checkout.pickup-point-list.render-after` instead.\n * @private\n */\n 'Checkout::PickupPoints::RenderAfter': RenderExtension<\n PickupPointListApi &\n CheckoutApi &\n StandardApi<'Checkout::PickupPoints::RenderAfter'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered after the pickup location\n * details within the local pickup option list, for each option.\n */\n 'purchase.checkout.pickup-location-option-item.render-after': RenderExtension<\n PickupLocationItemApi &\n CheckoutApi &\n StandardApi<'purchase.checkout.pickup-location-option-item.render-after'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered below the header.\n */\n 'purchase.checkout.header.render-after': RenderExtension<\n CheckoutApi & StandardApi<'purchase.checkout.header.render-after'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered below the footer.\n */\n 'purchase.checkout.footer.render-after': RenderExtension<\n CheckoutApi & StandardApi<'purchase.checkout.footer.render-after'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered on top of the checkout page as an overlay.\n * It is positioned in the bottom right corner of the screen.\n */\n 'purchase.checkout.chat.render': RenderExtension<\n CheckoutApi & StandardApi<'purchase.checkout.chat.render'>,\n AllowedComponents<'Chat'>\n >;\n /**\n * A static extension target that is rendered below the header on the **Thank you** page.\n */\n 'purchase.thank-you.header.render-after': RenderExtension<\n OrderConfirmationApi &\n StandardApi<'purchase.thank-you.header.render-after'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered below the footer on the **Thank you** page.\n */\n 'purchase.thank-you.footer.render-after': RenderExtension<\n OrderConfirmationApi &\n StandardApi<'purchase.thank-you.footer.render-after'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered on top of the **Thank you page** as an overlay.\n * It is positioned in the bottom right corner of the screen.\n */\n 'purchase.thank-you.chat.render': RenderExtension<\n OrderConfirmationApi & StandardApi<'purchase.thank-you.chat.render'>,\n AllowedComponents<'Chat'>\n >;\n /**\n * A static extension target that is rendered on top of the **Thank you page** as a dismissable announcement.\n */\n 'purchase.thank-you.announcement.render': RenderExtension<\n OrderConfirmationApi &\n StandardApi<'purchase.thank-you.announcement.render'>,\n AnyThankYouComponent\n >;\n}" + "value": "export interface RenderExtensionTargets {\n /**\n * A static extension target that is rendered immediately before any actions within each step.\n */\n 'purchase.checkout.actions.render-before': RenderExtension<\n CheckoutApi & StandardApi<'purchase.checkout.actions.render-before'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered immediately before any actions within each step.\n *\n * @deprecated Use `purchase.checkout.actions.render-before` instead.\n * @private\n */\n 'Checkout::Actions::RenderBefore': RenderExtension<\n CheckoutApi & StandardApi<'Checkout::Actions::RenderBefore'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered after all line items.\n */\n 'purchase.checkout.cart-line-list.render-after': RenderExtension<\n CheckoutApi & StandardApi<'purchase.checkout.cart-line-list.render-after'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered after all line items.\n *\n * @deprecated Use `purchase.checkout.cart-line-list.render-after` instead.\n * @private\n */\n 'Checkout::CartLines::RenderAfter': RenderExtension<\n CheckoutApi & StandardApi<'Checkout::CartLines::RenderAfter'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that renders on every line item, inside the details\n * under the line item properties element.\n */\n 'purchase.checkout.cart-line-item.render-after': RenderExtension<\n CheckoutApi &\n CartLineItemApi &\n StandardApi<'purchase.checkout.cart-line-item.render-after'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that renders on every line item, inside the details\n * under the line item properties element.\n *\n * @deprecated Use `purchase.checkout.cart-line-item.render-after` instead.\n * @private\n */\n 'Checkout::CartLineDetails::RenderAfter': RenderExtension<\n CheckoutApi &\n CartLineItemApi &\n StandardApi<'Checkout::CartLineDetails::RenderAfter'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that renders on every bundle line item, inside the details\n * under the line item properties element. It replaces the default bundle products rendering.\n * @private\n */\n 'purchase.cart-line-item.line-components.render': RenderExtension<\n CartLineItemApi &\n StandardApi<'purchase.cart-line-item.line-components.render'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that renders on every bundle line item, inside the details\n * under the line item properties element. It replaces the default bundle products rendering.\n *\n * @deprecated Use `purchase.cart-line-item.line-components.render` instead.\n * @private\n */\n 'Checkout::CartLineDetails::RenderLineComponents': RenderExtension<\n CartLineItemApi &\n StandardApi<'Checkout::CartLineDetails::RenderLineComponents'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered immediately after the contact form element.\n */\n 'purchase.checkout.contact.render-after': RenderExtension<\n CheckoutApi & StandardApi<'purchase.checkout.contact.render-after'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered immediately after the contact form element.\n *\n * @deprecated Use `purchase.checkout.contact.render-after` instead.\n * @private\n */\n 'Checkout::Contact::RenderAfter': RenderExtension<\n CheckoutApi & StandardApi<'Checkout::Contact::RenderAfter'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered after a purchase below the customer information.\n *\n * @deprecated Use `purchase.thank-you.customer-information.render-after` or\n * `customer-account.order-status.customer-information.render-after` from `@shopify/ui-extension/customer-account` instead.\n * @private\n */\n 'Checkout::CustomerInformation::RenderAfter': RenderExtension<\n CheckoutApi & StandardApi<'Checkout::CustomerInformation::RenderAfter'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered between the shipping address header\n * and shipping address form elements.\n */\n 'purchase.checkout.delivery-address.render-before': RenderExtension<\n CheckoutApi &\n StandardApi<'purchase.checkout.delivery-address.render-before'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered between the shipping address header\n * and shipping address form elements.\n *\n * @deprecated Use `purchase.checkout.delivery-address.render-before` instead.\n * @private\n */\n 'Checkout::DeliveryAddress::RenderBefore': RenderExtension<\n CheckoutApi & StandardApi<'Checkout::DeliveryAddress::RenderBefore'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered after the shipping address form elements.\n */\n 'purchase.checkout.delivery-address.render-after': RenderExtension<\n CheckoutApi &\n StandardApi<'purchase.checkout.delivery-address.render-after'>,\n AnyCheckoutComponent\n >;\n /**\n * A [block extension target](/docs/api/checkout-ui-extensions/extension-targets-overview#block-extension-targets) that isn't tied to a specific checkout section or feature.\n * Unlike static extension targets, block extension targets render where the merchant\n * sets them using the [checkout editor](/apps/checkout/test-ui-extensions#test-the-extension-in-the-checkout-editor).\n *\n * The [supported locations](/docs/api/checkout-ui-extensions/extension-targets-overview#supported-locations) for block extension targets can be previewed during development\n * by [using a URL parameter](/docs/apps/checkout/best-practices/testing-ui-extensions#block-extension-targets).\n */\n 'purchase.checkout.block.render': RenderExtension<\n CheckoutApi & StandardApi<'purchase.checkout.block.render'>,\n AnyCheckoutComponent\n >;\n /**\n * A [block extension target](/docs/api/checkout-ui-extensions/extension-targets-overview#block-extension-targets) that isn't tied to a specific checkout section or feature.\n * Unlike static extension targets, block extension targets render where the merchant\n * sets them using the [checkout editor](/apps/checkout/test-ui-extensions#test-the-extension-in-the-checkout-editor).\n *\n * The [supported locations](/docs/api/checkout-ui-extensions/extension-targets-overview#supported-locations) for block extension targets can be previewed during development\n * by [using a URL parameter](/docs/apps/checkout/best-practices/testing-ui-extensions#block-extension-targets).\n *\n * @deprecated Use `purchase.checkout.block.render` instead.\n * @private\n */\n 'Checkout::Dynamic::Render': RenderExtension<\n CheckoutApi & StandardApi<'Checkout::Dynamic::Render'>,\n AnyCheckoutComponent\n >;\n /**\n * A [block extension target](/docs/api/checkout-ui-extensions/extension-targets-overview#block-extension-targets) that renders exclusively on the **Thank you** page.\n * Unlike static extension targets, block extension targets render where the merchant\n * sets them using the [checkout editor](/apps/checkout/test-ui-extensions#test-the-extension-in-the-checkout-editor).\n *\n * The [supported locations](/docs/api/checkout-ui-extensions/extension-targets-overview#supported-locations) for block extension targets can be previewed during development\n * by [using a URL parameter](/docs/apps/checkout/best-practices/testing-ui-extensions#block-extension-targets).\n *\n */\n 'purchase.thank-you.block.render': RenderExtension<\n OrderConfirmationApi & StandardApi<'purchase.thank-you.block.render'>,\n AnyCheckoutComponent\n >;\n /**\n * A [block extension target](/docs/api/checkout-ui-extensions/extension-targets-overview#block-extension-targets) that renders exclusively on the **Thank you** page.\n * Unlike static extension targets, block extension targets render where the merchant\n * sets them using the [checkout editor](/apps/checkout/test-ui-extensions#test-the-extension-in-the-checkout-editor).\n *\n * The [supported locations](/docs/api/checkout-ui-extensions/extension-targets-overview#supported-locations) for block extension targets can be previewed during development\n * by [using a URL parameter](/docs/apps/checkout/best-practices/testing-ui-extensions#block-extension-targets).\n *\n * @deprecated Use `purchase.thank-you.block.render` instead.\n * @private\n */\n 'Checkout::ThankYou::Dynamic::Render': RenderExtension<\n OrderConfirmationApi & StandardApi<'Checkout::ThankYou::Dynamic::Render'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that renders on every line item, inside the details\n * under the line item properties element on the **Thank you** page.\n */\n 'purchase.thank-you.cart-line-item.render-after': RenderExtension<\n OrderConfirmationApi &\n CartLineItemApi &\n StandardApi<'purchase.thank-you.cart-line-item.render-after'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that renders on every line item, inside the details\n * under the line item properties element on the **Thank you** page.\n *\n * @deprecated Use `purchase.thank-you.cart-line-item.render-after` instead.\n * @private\n */\n 'Checkout::ThankYou::CartLineDetails::RenderAfter': RenderExtension<\n OrderConfirmationApi &\n CartLineItemApi &\n StandardApi<'Checkout::ThankYou::CartLineDetails::RenderAfter'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered after all line items on the **Thank you** page.\n */\n 'purchase.thank-you.cart-line-list.render-after': RenderExtension<\n OrderConfirmationApi &\n StandardApi<'purchase.thank-you.cart-line-list.render-after'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered after all line items on the **Thank you** page.\n *\n * @deprecated Use `purchase.thank-you.cart-line-list.render-after` instead.\n * @private\n */\n 'Checkout::ThankYou::CartLines::RenderAfter': RenderExtension<\n OrderConfirmationApi &\n StandardApi<'Checkout::ThankYou::CartLines::RenderAfter'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered after a purchase below the customer information on the **Thank you** page.\n */\n 'purchase.thank-you.customer-information.render-after': RenderExtension<\n OrderConfirmationApi &\n StandardApi<'purchase.thank-you.customer-information.render-after'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered after a purchase below the customer information on the **Thank you** page.\n *\n * @deprecated Use `purchase.thank-you.customer-information.render-after` instead.\n * @private\n */\n 'Checkout::ThankYou::CustomerInformation::RenderAfter': RenderExtension<\n OrderConfirmationApi &\n StandardApi<'Checkout::ThankYou::CustomerInformation::RenderAfter'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that renders the gift card entry form fields after\n * the buyer ticks a box to use a gift card. This does not replace the\n * native gift card entry form which is rendered in a separate part of checkout.\n *\n * @private\n */\n 'purchase.checkout.gift-card.render': RenderExtension<\n RedeemableApi &\n CheckoutApi &\n StandardApi<'purchase.checkout.gift-card.render'>,\n AnyCheckoutComponentExcept<'Image' | 'Banner'>\n >;\n /**\n * A static extension target that renders the gift card entry form fields after\n * the buyer ticks a box to use a gift card. This does not replace the\n * native gift card entry form which is rendered in a separate part of checkout.\n *\n * @private\n * @deprecated Use `purchase.checkout.gift-card.render` instead.\n */\n 'Checkout::GiftCard::Render': RenderExtension<\n RedeemableApi & CheckoutApi & StandardApi<'Checkout::GiftCard::Render'>,\n AnyCheckoutComponentExcept<'Image' | 'Banner'>\n >;\n /**\n * A static extension target that renders the form fields for a payment method when selected by the buyer.\n *\n * @private\n */\n 'purchase.checkout.payment-option-item.details.render': RenderExtension<\n PaymentOptionItemApi &\n CheckoutApi &\n StandardApi<'purchase.checkout.payment-option-item.details.render'>,\n AnyCheckoutComponentExcept<'Image' | 'Banner'>\n >;\n /**\n * A static extension target that renders the form fields for a payment method when selected by the buyer.\n *\n * @private\n * @deprecated Use `purchase.checkout.payment-option-item.details.render` instead.\n */\n 'Checkout::PaymentMethod::Render': RenderExtension<\n PaymentOptionItemApi &\n CheckoutApi &\n StandardApi<'Checkout::PaymentMethod::Render'>,\n AnyCheckoutComponentExcept<'Image' | 'Banner'>\n >;\n /**\n * A static extension target that renders after the hosted fields of a credit card payment method.\n *\n * @private\n */\n 'purchase.checkout.payment-option-item.hosted-fields.render-after': RenderExtension<\n PaymentOptionItemApi &\n CheckoutApi &\n StandardApi<'purchase.checkout.payment-option-item.hosted-fields.render-after'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that renders after the hosted fields of a credit card payment method.\n * for a credit card payment method when selected by the buyer.\n *\n * @private\n * @deprecated Use `purchase.checkout.payment-option-item.hosted-fields.render-after` instead.\n */\n 'Checkout::PaymentMethod::HostedFields::RenderAfter': RenderExtension<\n PaymentOptionItemApi &\n CheckoutApi &\n StandardApi<'Checkout::PaymentMethod::HostedFields::RenderAfter'>,\n AnyCheckoutComponentExcept<'Image' | 'Banner'>\n >;\n /**\n * A static extension target that renders a form modal when a buyer selects the custom onsite payment method.\n *\n * @private\n */\n 'purchase.checkout.payment-option-item.action-required.render': RenderExtension<\n CheckoutApi &\n StandardApi<'purchase.checkout.payment-option-item.action-required.render'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that renders a form modal when a buyer selects the custom onsite payment method.\n *\n * @private\n * @deprecated Use `purchase.checkout.payment-option-item.action-required.render` instead.\n */\n 'Checkout::PaymentMethod::RenderRequiredAction': RenderExtension<\n CheckoutApi & StandardApi<'Checkout::PaymentMethod::RenderRequiredAction'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that renders between the payment heading and payment method list.\n *\n */\n 'purchase.checkout.payment-method-list.render-before': RenderExtension<\n CheckoutApi &\n StandardApi<'purchase.checkout.payment-method-list.render-before'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that renders below the list of payment methods.\n *\n */\n 'purchase.checkout.payment-method-list.render-after': RenderExtension<\n CheckoutApi &\n StandardApi<'purchase.checkout.payment-method-list.render-after'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered in the order summary, before the discount form element.\n */\n 'purchase.checkout.reductions.render-before': RenderExtension<\n CheckoutApi & StandardApi<'purchase.checkout.reductions.render-before'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered in the order summary, before the discount form element.\n *\n * @deprecated Use `purchase.checkout.reductions.render-before` instead.\n * @private\n */\n 'Checkout::Reductions::RenderBefore': RenderExtension<\n CheckoutApi & StandardApi<'Checkout::Reductions::RenderBefore'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered in the order summary, after the discount form\n * and discount tag elements.\n */\n 'purchase.checkout.reductions.render-after': RenderExtension<\n CheckoutApi & StandardApi<'purchase.checkout.reductions.render-after'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered in the order summary, after the discount form\n * and discount tag elements.\n *\n * @deprecated Use `purchase.checkout.reductions.render-after` instead.\n * @private\n */\n 'Checkout::Reductions::RenderAfter': RenderExtension<\n CheckoutApi & StandardApi<'Checkout::Reductions::RenderAfter'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered between the shipping method\n * header and shipping method options.\n */\n 'purchase.checkout.shipping-option-list.render-before': RenderExtension<\n ShippingOptionListApi &\n CheckoutApi &\n StandardApi<'purchase.checkout.shipping-option-list.render-before'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered between the shipping method\n * header and shipping method options.\n *\n * @deprecated Use `purchase.checkout.shipping-option-list.render-before` instead.\n * @private\n */\n 'Checkout::ShippingMethods::RenderBefore': RenderExtension<\n ShippingOptionListApi &\n CheckoutApi &\n StandardApi<'Checkout::ShippingMethods::RenderBefore'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered after the shipping method\n * options.\n */\n 'purchase.checkout.shipping-option-list.render-after': RenderExtension<\n ShippingOptionListApi &\n CheckoutApi &\n StandardApi<'purchase.checkout.shipping-option-list.render-after'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered after the shipping method\n * options.\n *\n * @deprecated Use `purchase.checkout.shipping-option-list.render-after` instead.\n * @private\n */\n 'Checkout::ShippingMethods::RenderAfter': RenderExtension<\n ShippingOptionListApi &\n CheckoutApi &\n StandardApi<'Checkout::ShippingMethods::RenderAfter'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered before pickup location options.\n */\n 'purchase.checkout.pickup-location-list.render-before': RenderExtension<\n PickupLocationListApi &\n CheckoutApi &\n StandardApi<'purchase.checkout.pickup-location-list.render-before'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered before pickup location options.\n *\n * @deprecated Use `purchase.checkout.pickup-location-list.render-before` instead.\n * @private\n */\n 'Checkout::PickupLocations::RenderBefore': RenderExtension<\n PickupLocationListApi &\n CheckoutApi &\n StandardApi<'Checkout::PickupLocations::RenderBefore'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered after pickup location options.\n */\n 'purchase.checkout.pickup-location-list.render-after': RenderExtension<\n PickupLocationListApi &\n CheckoutApi &\n StandardApi<'purchase.checkout.pickup-location-list.render-after'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered after pickup location options.\n *\n * @deprecated Use `purchase.checkout.pickup-location-list.render-after` instead.\n * @private\n */\n 'Checkout::PickupLocations::RenderAfter': RenderExtension<\n PickupLocationListApi &\n CheckoutApi &\n StandardApi<'Checkout::PickupLocations::RenderAfter'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered after the shipping method\n * details within the shipping method option list, for each option.\n */\n 'purchase.checkout.shipping-option-item.render-after': RenderExtension<\n ShippingOptionItemApi &\n CheckoutApi &\n StandardApi<'purchase.checkout.shipping-option-item.render-after'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered after the shipping method\n * details within the shipping method option list, for each option.\n *\n * @deprecated Use `purchase.checkout.shipping-option-item.render-after` instead.\n * @private\n */\n 'Checkout::ShippingMethodDetails::RenderAfter': RenderExtension<\n ShippingOptionItemApi &\n CheckoutApi &\n StandardApi<'Checkout::ShippingMethodDetails::RenderAfter'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered under the shipping method\n * within the shipping method option list, for each option.\n */\n 'purchase.checkout.shipping-option-item.details.render': RenderExtension<\n ShippingOptionItemApi &\n CheckoutApi &\n StandardApi<'purchase.checkout.shipping-option-item.details.render'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered under the shipping method\n * within the shipping method option list, for each option.\n *\n * @deprecated Use `purchase.checkout.shipping-option-item.details.render` instead.\n * @private\n */\n 'Checkout::ShippingMethodDetails::RenderExpanded': RenderExtension<\n ShippingOptionItemApi &\n CheckoutApi &\n StandardApi<'Checkout::ShippingMethodDetails::RenderExpanded'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered immediately before the pickup points.\n */\n 'purchase.checkout.pickup-point-list.render-before': RenderExtension<\n PickupPointListApi &\n CheckoutApi &\n StandardApi<'purchase.checkout.pickup-point-list.render-before'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered immediately before the pickup points.\n *\n * @deprecated Use `purchase.checkout.pickup-point-list.render-before` instead.\n * @private\n */\n 'Checkout::PickupPoints::RenderBefore': RenderExtension<\n PickupPointListApi &\n CheckoutApi &\n StandardApi<'Checkout::PickupPoints::RenderBefore'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered immediately after the pickup points.\n */\n 'purchase.checkout.pickup-point-list.render-after': RenderExtension<\n PickupPointListApi &\n CheckoutApi &\n StandardApi<'purchase.checkout.pickup-point-list.render-after'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered immediately after the pickup points.\n *\n * @deprecated Use `purchase.checkout.pickup-point-list.render-after` instead.\n * @private\n */\n 'Checkout::PickupPoints::RenderAfter': RenderExtension<\n PickupPointListApi &\n CheckoutApi &\n StandardApi<'Checkout::PickupPoints::RenderAfter'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered after the pickup location\n * details within the local pickup option list, for each option.\n */\n 'purchase.checkout.pickup-location-option-item.render-after': RenderExtension<\n PickupLocationItemApi &\n CheckoutApi &\n StandardApi<'purchase.checkout.pickup-location-option-item.render-after'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered below the header.\n */\n 'purchase.checkout.header.render-after': RenderExtension<\n CheckoutApi & StandardApi<'purchase.checkout.header.render-after'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered below the footer.\n */\n 'purchase.checkout.footer.render-after': RenderExtension<\n CheckoutApi & StandardApi<'purchase.checkout.footer.render-after'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered on top of the checkout page as an overlay.\n * It is positioned in the bottom right corner of the screen.\n */\n 'purchase.checkout.chat.render': RenderExtension<\n CheckoutApi & StandardApi<'purchase.checkout.chat.render'>,\n AllowedComponents<'Chat'>\n >;\n /**\n * A static extension target that is rendered below the header on the **Thank you** page.\n */\n 'purchase.thank-you.header.render-after': RenderExtension<\n OrderConfirmationApi &\n StandardApi<'purchase.thank-you.header.render-after'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered below the footer on the **Thank you** page.\n */\n 'purchase.thank-you.footer.render-after': RenderExtension<\n OrderConfirmationApi &\n StandardApi<'purchase.thank-you.footer.render-after'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered on top of the **Thank you page** as an overlay.\n * It is positioned in the bottom right corner of the screen.\n */\n 'purchase.thank-you.chat.render': RenderExtension<\n OrderConfirmationApi & StandardApi<'purchase.thank-you.chat.render'>,\n AllowedComponents<'Chat'>\n >;\n /**\n * A static extension target that is rendered on top of the **Thank you page** as a dismissable announcement.\n */\n 'purchase.thank-you.announcement.render': RenderExtension<\n OrderConfirmationApi &\n StandardApi<'purchase.thank-you.announcement.render'>,\n AnyThankYouComponent\n >;\n}" } }, "RunnableExtensionTargets": { @@ -7791,7 +7791,7 @@ "syntaxKind": "PropertySignature", "name": "billingAddress", "value": "SubscribableSignalLike", - "description": "The proposed customer billing address. The address updates when the field is committed (on change) rather than every keystroke. The property is available only if the extension has access to protected customer data. The subscribable value is `undefined` if the billing address hasn't been provided yet.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).", + "description": "The proposed customer billing address. The address updates when the field is committed (on change) rather than every keystroke. The property is available only if the extension has access to protected customer data. The subscribable value is `undefined` if the billing address hasn't been provided yet.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", "isOptional": true }, { @@ -7799,7 +7799,7 @@ "syntaxKind": "PropertySignature", "name": "shippingAddress", "value": "SubscribableSignalLike", - "description": "The proposed customer shipping address. During the information step, the address updates when the field is committed (on change) rather than every keystroke. The property is available only if the extension has access to protected customer data. When available, the subscribable value is `undefined` if delivery isn't required.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).", + "description": "The proposed customer shipping address. During the information step, the address updates when the field is committed (on change) rather than every keystroke. The property is available only if the extension has access to protected customer data. When available, the subscribable value is `undefined` if delivery isn't required.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", "isOptional": true } ], @@ -7818,7 +7818,7 @@ "syntaxKind": "MethodSignature", "name": "applyShippingAddressChange", "value": "(change: ShippingAddressUpdateChange) => Promise", - "description": "Updates the buyer's shipping address on the checkout. The provided fields are merged into the existing address without prompting the buyer. On success, the `shippingAddress` property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).", + "description": "Updates the buyer's shipping address on the checkout. The provided fields are merged into the existing address without prompting the buyer. On success, the `shippingAddress` property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", "isOptional": true } ], @@ -7855,7 +7855,7 @@ "syntaxKind": "MethodSignature", "name": "applyAttributeChange", "value": "(change: AttributeChange) => Promise", - "description": "Updates or removes an attribute on the cart and checkout. On success, the [`attributes`](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/attributes#standardapi-propertydetail-attributes) property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.", + "description": "Updates or removes an attribute on the cart and checkout. On success, the [`attributes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/attributes#properties-propertydetail-attributes) property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.", "deprecationMessage": "Use cart metafields instead." } ], @@ -7874,7 +7874,7 @@ "syntaxKind": "PropertySignature", "name": "buyerIdentity", "value": "BuyerIdentity", - "description": "Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).", + "description": "Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", "isOptional": true } ], @@ -7893,7 +7893,7 @@ "syntaxKind": "PropertySignature", "name": "buyerJourney", "value": "BuyerJourney", - "description": "Provides details on the buyer's progression through the checkout and lets you intercept navigation to validate data before the buyer continues.\n\nRefer to [buyer journey](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/buyer-journey#examples) examples for more information." + "description": "Provides details on the buyer's progression through the checkout and lets you intercept navigation to validate data before the buyer continues.\n\nRefer to [buyer journey](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/buyer-journey#examples) examples for more information." } ], "value": "export interface Docs_Standard_BuyerJourneyApi\n extends Pick {}" @@ -7911,7 +7911,7 @@ "syntaxKind": "PropertySignature", "name": "instructions", "value": "SubscribableSignalLike", - "description": "The cart instructions used to create the checkout and possibly limit extension capabilities.\n\nThese instructions should be checked before performing any actions that might be affected by them.\n\nFor example, if you intend to add a discount code via the `applyDiscountCodeChange` method, check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n\n> Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs aren't available. See the [update guide](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples) for more information." + "description": "The cart instructions used to create the checkout and possibly limit extension capabilities.\n\nThese instructions should be checked before performing any actions that might be affected by them.\n\nFor example, if you intend to add a discount code via the `applyDiscountCodeChange` method, check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n\n> Caution: Check cart instructions before calling select APIs, as > some may not be available. See the > [Cart Instructions API](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples) > for more information." } ], "value": "export interface Docs_Standard_CartInstructionsApi\n extends Pick {}" @@ -7947,7 +7947,7 @@ "syntaxKind": "MethodSignature", "name": "applyCartLinesChange", "value": "(change: CartLineChange) => Promise", - "description": "Adds, removes, or updates line items in the cart. The returned promise resolves when the change has been applied by the server, and the [`lines`](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-lines#standardapi-propertydetail-lines) property updates with the new state.\n\n> Note: This method returns an error if the [cart instruction](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Adds, removes, or updates line items in the cart. The returned promise resolves when the change has been applied by the server, and the [`lines`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-lines#properties-propertydetail-lines) property updates with the new state.\n\nAccepts a single change per call. To make multiple changes, call this method separately for each one.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." } ], "value": "export interface Docs_Checkout_CartLinesApi\n extends Pick {}" @@ -7965,7 +7965,7 @@ "syntaxKind": "PropertySignature", "name": "target", "value": "SubscribableSignalLike", - "description": "The cart line that this extension is attached to. Use this to read the line item's merchandise, quantity, cost, and attributes.\n\n> Note: Until version `2023-04`, this property was a `ReadonlySignalLike`." + "description": "The cart line that this extension is attached to. Use this to read the line item's merchandise, quantity, cost, and attributes.\n\nAvailable only on the corresponding item target. Shipping option item targets expose shipping option properties; pickup location item targets expose pickup location properties.\n\n> Note: Until version `2023-04`, this property was a `ReadonlySignalLike`." } ], "value": "export interface Docs_CartLineItem_CartLinesApi\n extends Pick {}" @@ -8001,14 +8001,14 @@ "syntaxKind": "PropertySignature", "name": "i18n", "value": "I18n", - "description": "Utilities for translating content and formatting values according to the current [`localization`](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) of the checkout.\n\nRefer to [`localization` examples](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples) for more information." + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use alongside [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) to build fully localized extensions." }, { "filePath": "src/surfaces/checkout/api/docs.ts", "syntaxKind": "PropertySignature", "name": "localization", "value": "Localization", - "description": "The details about the location, language, and currency of the customer. For utilities to easily format and translate content based on these details, you can use the [`i18n`](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n) object instead." + "description": "The buyer's language, country, currency, and timezone context. For formatting and translation helpers, use the [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#properties-propertydetail-i18n) object instead." } ], "value": "export interface Docs_Standard_LocalizationApi\n extends Pick {}" @@ -8045,14 +8045,14 @@ "syntaxKind": "PropertySignature", "name": "appMetafields", "value": "SubscribableSignalLike", - "description": "The metafields requested in the [`shopify.extension.toml`](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file. These metafields are updated when there's a change in the merchandise items being purchased by the customer.\n\nApp owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` isn't supported. See [app owned metafields](https://shopify.dev/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data)." + "description": "The metafields requested in the [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file. These metafields are updated when there's a change in the merchandise items being purchased by the customer.\n\nApp owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` isn't supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." }, { "filePath": "src/surfaces/checkout/api/docs.ts", "syntaxKind": "PropertySignature", "name": "metafields", "value": "SubscribableSignalLike", - "description": "The metafields that apply to the current checkout.\n\nMetafields are stored locally on the client and are applied to the order object after the checkout completes.\n\nThese metafields are shared by all extensions running on checkout, and persist for as long as the customer is working on this checkout.\n\nOnce the order is created, you can query these metafields using the [GraphQL Admin API](https://shopify.dev/docs/admin-api/graphql/reference/orders/order#metafield-2021-01)\n\n> Caution: `metafields` is deprecated. Use `appMetafields` with cart metafields instead.", + "description": "The metafields that apply to the current checkout.\n\nMetafields are stored locally on the client and are applied to the order object after the checkout completes.\n\nThese metafields are shared by all extensions running on checkout, and persist for as long as the customer is working on this checkout.\n\nOnce the order is created, you can query these metafields using the [GraphQL Admin API](/docs/admin-api/graphql/reference/orders/order#metafield-2021-01)\n\n> Caution: `metafields` is deprecated. Use `appMetafields` with cart metafields instead.", "deprecationMessage": "Use `appMetafields` with cart metafields instead." } ], @@ -8071,7 +8071,7 @@ "syntaxKind": "MethodSignature", "name": "applyMetafieldChange", "value": "(change: MetafieldChange) => Promise", - "description": "Creates, updates, or removes a cart metafield on the checkout. On success, the [`metafields`](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/metafields#standardapi-propertydetail-metafields) property updates to reflect the change.\n\nCart metafields are copied to order metafields at order creation time if there's a matching order metafield definition with the [`cart to order copyable`](https://shopify.dev/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n\n> Caution: `MetafieldRemoveChange` and `MetafieldUpdateChange` are deprecated. Use cart metafields with `MetafieldRemoveCartChange` and `MetafieldUpdateCartChange` instead. If `MetafieldUpdateChange` writes a metafield with the same namespace and key as a cart metafield that's configured to copy, the cart metafield won't be copied.\n\n> Note: This method returns an error if the [cart instruction](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Creates, updates, or removes a cart metafield on the checkout. On success, the [`metafields`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/metafields#properties-propertydetail-metafields) property updates to reflect the change.\n\nCart metafields are copied to order metafields at order creation time if there's a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n\n> Caution: `MetafieldRemoveChange` and `MetafieldUpdateChange` are deprecated. Use cart metafields with `MetafieldRemoveCartChange` and `MetafieldUpdateCartChange` instead. If `MetafieldUpdateChange` writes a metafield with the same namespace and key as a cart metafield that's configured to copy, the cart metafield won't be copied.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." } ], "value": "export interface Docs_Checkout_MetafieldsApi\n extends Pick {}" @@ -8089,7 +8089,7 @@ "syntaxKind": "PropertySignature", "name": "deliveryGroups", "value": "SubscribableSignalLike", - "description": "The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items." + "description": "The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n\nEmpty until the buyer enters enough address information for Shopify to calculate shipping rates." } ], "value": "export interface Docs_Standard_DeliveryApi\n extends Pick {}" @@ -8107,7 +8107,7 @@ "syntaxKind": "PropertySignature", "name": "checkoutToken", "value": "SubscribableSignalLike", - "description": "A stable ID that represents the current checkout.\n\nThe value is `undefined` when the checkout hasn't been created on the server yet.\n\nUse this to correlate checkout sessions across your extension, web pixels, and backend systems.\n\nThis matches the `data.checkout.token` field in a [checkout-related WebPixel event](https://shopify.dev/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data) and the `checkout_token` field in the [REST Admin API `Order` resource](https://shopify.dev/docs/api/admin-rest/unstable/resources/order#resource-object)." + "description": "A stable ID that represents the current checkout.\n\nThe value is `undefined` when the checkout hasn't been created on the server yet.\n\nUse this to correlate checkout sessions across your extension, web pixels, and backend systems.\n\nThis matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data) and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n\nCan be `undefined`. Handle the `undefined` state before using the value." } ], "value": "export interface Docs_Standard_CheckoutTokenApi\n extends Pick {}" @@ -8125,7 +8125,7 @@ "syntaxKind": "PropertySignature", "name": "extension", "value": "Extension", - "description": "The meta information about the extension." + "description": "Metadata about the running extension, including the current target, API version, capabilities, and editor context. Use this to conditionally render content based on where the extension is running." } ], "value": "export interface Docs_Standard_ExtensionMetaApi\n extends Pick {}" @@ -8161,7 +8161,7 @@ "syntaxKind": "PropertySignature", "name": "shop", "value": "Shop", - "description": "The shop where the checkout is taking place." + "description": "The store where the checkout is taking place, including the shop name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID." } ], "value": "export interface Docs_Standard_ShopApi extends Pick {}" @@ -8197,7 +8197,7 @@ "syntaxKind": "MethodSignature", "name": "applyNoteChange", "value": "(change: NoteChange) => Promise", - "description": "Sets or removes the buyer's note on the checkout. On success, the [`note`](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/note#standardapi-propertydetail-note) property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Sets or removes the buyer's note on the checkout. On success, the [`note`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/note#properties-propertydetail-note) property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." } ], "value": "export interface Docs_Checkout_NoteApi\n extends Pick {}" @@ -8215,14 +8215,14 @@ "syntaxKind": "PropertySignature", "name": "availablePaymentOptions", "value": "SubscribableSignalLike", - "description": "All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region." + "description": "All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n\nThe set of payment options can change when the buyer updates their address or cart, so subscribe to changes rather than reading once during initialization. Each option exposes `handle` and `type` only. Provider names, logos, fees, and installment terms aren't available." }, { "filePath": "src/surfaces/checkout/api/docs.ts", "syntaxKind": "PropertySignature", "name": "selectedPaymentOptions", "value": "SubscribableSignalLike", - "description": "The payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card)." + "description": "The payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\n\nEach option exposes `handle` and `type` only. Provider names, logos, fees, and installment terms aren't available." } ], "value": "export interface Docs_Standard_PaymentOptionsApi\n extends Pick<\n StandardApi,\n 'availablePaymentOptions' | 'selectedPaymentOptions'\n > {}" @@ -8258,7 +8258,7 @@ "syntaxKind": "MethodSignature", "name": "applyGiftCardChange", "value": "(change: GiftCardChange) => Promise", - "description": "Adds or removes a gift card from the checkout. The returned promise resolves when the change has been applied by the server, and the [`appliedGiftCards`](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/gift-cards#standardapi-propertydetail-appliedgiftcards) property updates with the new state.\n\n> Caution: > See [security considerations](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves gift card codes through a network call.\n\n> Note: This method returns an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Adds or removes a gift card from the checkout. The returned promise resolves when the change has been applied by the server, and the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/gift-cards#properties-propertydetail-appliedgiftcards) property updates with the new state.\n\nUnlike other write operations, gift card changes aren't gated by a cart instruction flag.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves gift card codes through a network call.\n\n> Note: This method returns an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." } ], "value": "export interface Docs_Checkout_GiftCardsApi\n extends Pick {}" @@ -8276,7 +8276,7 @@ "syntaxKind": "PropertySignature", "name": "discountAllocations", "value": "SubscribableSignalLike", - "description": "The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](https://shopify.dev/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered." + "description": "The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered." }, { "filePath": "src/surfaces/checkout/api/docs.ts", @@ -8301,7 +8301,7 @@ "syntaxKind": "MethodSignature", "name": "applyDiscountCodeChange", "value": "(change: DiscountCodeChange) => Promise", - "description": "Adds or removes a discount code on the checkout. The returned promise resolves when the change has been applied by the server, and the [`discountCodes`](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/discounts#standardapi-propertydetail-discountcodes) property updates with the new state.\n\n> Caution: > See [security considerations](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves discount codes through a network call.\n\n> Note: This method returns an error if the [cart instruction](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Adds or removes a discount code on the checkout. The returned promise resolves when the change has been applied by the server, and the [`discountCodes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/discounts#properties-propertydetail-discountcodes) property updates with the new state.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves discount codes through a network call.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." } ], "value": "export interface Docs_Checkout_DiscountsApi\n extends Pick {}" @@ -8319,7 +8319,7 @@ "syntaxKind": "PropertySignature", "name": "sessionToken", "value": "SessionToken", - "description": "The session token providing a set of claims as a signed JSON Web Token (JWT).\n\nThe token has a TTL of five minutes.\n\nIf the previous token expires, this value reflects a new session token with a new signature and expiry.\n\nRefer to [session token examples](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/session-token) for more information." + "description": "The session token providing a set of claims as a signed JSON Web Token (JWT).\n\nThe token has a TTL of five minutes.\n\nIf the previous token expires, this value reflects a new session token with a new signature and expiry.\n\nLearn more about [session tokens](/docs/apps/build/authentication-authorization/session-tokens)." } ], "value": "export interface Docs_Standard_SessionTokenApi\n extends Pick {}" @@ -8337,7 +8337,7 @@ "syntaxKind": "PropertySignature", "name": "settings", "value": "SubscribableSignalLike", - "description": "The settings matching the settings definition written in the [`shopify.extension.toml`](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n\n Refer to [settings examples](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n\n> Note: When an extension is being installed in the editor, the settings are empty until a merchant sets a value. In that case, this object updates in real time as a merchant fills in the settings." + "description": "The settings matching the settings definition written in the [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n\n Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n\n> Note: When an extension is being installed in the editor, the settings are empty until a merchant sets a value. In that case, this object updates in real time as a merchant fills in the settings." } ], "value": "export interface Docs_Standard_SettingsApi\n extends Pick {}" @@ -8355,7 +8355,7 @@ "syntaxKind": "PropertySignature", "name": "storage", "value": "Storage", - "description": "The key-value storage for the extension.\n\nIt uses `localStorage` and should persist across the customer's current checkout session.\n\n> Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n\nData is shared across all activated extension targets of this extension. In versions 2023-07 and earlier, each activated extension target had its own storage." + "description": "Key-value storage that persists across page loads within the current checkout session. Data is shared across all activated targets associated with this extension.\n\n> Caution: Data persistence isn't guaranteed and storage is cleared when the buyer starts a new checkout." } ], "value": "export interface Docs_Standard_StorageApi\n extends Pick {}" @@ -8373,7 +8373,7 @@ "syntaxKind": "PropertySignature", "name": "query", "value": ">(query: string, options?: { variables?: Variables; version?: StorefrontApiVersion; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>", - "description": "The method used to query the Storefront GraphQL API with a prefetched token.\n\nRefer to [Storefront API access examples](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/storefront-api) for more information." + "description": "The method used to query the Storefront GraphQL API with a prefetched token." } ], "value": "export interface Docs_Standard_QueryApi extends Pick {}" @@ -8391,7 +8391,7 @@ "syntaxKind": "PropertySignature", "name": "analytics", "value": "Analytics", - "description": "The methods for interacting with [Web Pixels](https://shopify.dev/docs/apps/marketing), such as emitting an event." + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details." } ], "value": "export interface Docs_Standard_AnalyticsApi\n extends Pick {}" @@ -8409,7 +8409,7 @@ "syntaxKind": "PropertySignature", "name": "applyTrackingConsentChange", "value": "ApplyTrackingConsentChangeType", - "description": "Enables setting and updating customer privacy consent settings and tracking consent metafields.\n\n> Note: Requires the [`customer_privacy` capability](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent) to be set to `true`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data)." + "description": "Enables setting and updating customer privacy consent settings and tracking consent metafields.\n\n> Note: Requires the [`collect_buyer_consent` capability](/docs/apps/build/customer-accounts/capabilities#collect-buyer-consent) to be set to `true`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." }, { "filePath": "src/surfaces/checkout/api/docs.ts", @@ -8426,7 +8426,7 @@ "src/surfaces/checkout/components/Abbreviation.ts": { "filePath": "src/surfaces/checkout/components/Abbreviation.ts", "name": "BaseElementProps", - "description": "Used when an element does not have children.", + "description": "", "isPublicDocs": true, "members": [ { @@ -8514,7 +8514,7 @@ "src/surfaces/checkout/components/Abbreviation.ts": { "filePath": "src/surfaces/checkout/components/Abbreviation.ts", "name": "AbbreviationElementProps", - "description": "Displays abbreviated text or acronyms, revealing their full meaning or additional context through a tooltip on hover or focus. Use to clarify shortened terms, initialisms, or technical language without interrupting the reading flow.", + "description": "", "isPublicDocs": true, "members": [ { @@ -8522,7 +8522,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -8530,7 +8530,7 @@ "syntaxKind": "PropertySignature", "name": "title", "value": "string", - "description": "Defines the full expansion of the abbreviation or acronym.\n\nHelps user agents and users understand the meaning of the abbreviated text.", + "description": "Defines the full expansion of the abbreviation or acronym, helping user agents and users understand the meaning of the abbreviated text. Learn more about the [abbreviation element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/abbr).", "isOptional": true, "defaultValue": "''" } @@ -8564,7 +8564,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/Abbreviation.ts", @@ -9461,7 +9461,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -10573,7 +10573,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/Abbreviation.ts", @@ -10783,7 +10783,7 @@ "syntaxKind": "PropertySignature", "name": "title", "value": "string", - "description": "Defines the full expansion of the abbreviation or acronym.\n\nHelps user agents and users understand the meaning of the abbreviated text.", + "description": "Defines the full expansion of the abbreviation or acronym, helping user agents and users understand the meaning of the abbreviated text. Learn more about the [abbreviation element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/abbr).", "isOptional": true, "defaultValue": "''" }, @@ -10839,7 +10839,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -10847,7 +10847,7 @@ "syntaxKind": "PropertySignature", "name": "title", "value": "string", - "description": "Defines the full expansion of the abbreviation or acronym.\n\nHelps user agents and users understand the meaning of the abbreviated text.", + "description": "Defines the full expansion of the abbreviation or acronym, helping user agents and users understand the meaning of the abbreviated text. Learn more about the [abbreviation element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/abbr).", "isOptional": true, "defaultValue": "''" } @@ -10881,23 +10881,21 @@ "syntaxKind": "TypeAliasDeclaration", "name": "ToggleState", "value": "'open' | 'closed'", - "description": "", - "isPublicDocs": true + "description": "The visibility state of a toggleable element.\n\n- `open`: The element is visible and showing its content.\n- `closed`: The element is hidden and its content is not visible." } }, "ToggleArgumentsEvent": { "src/surfaces/checkout/components/Announcement.ts": { "filePath": "src/surfaces/checkout/components/Announcement.ts", "name": "ToggleArgumentsEvent", - "description": "", - "isPublicDocs": true, + "description": "The event data provided to toggle-related callbacks. Contains the previous and next visibility states of the element.", "members": [ { "filePath": "src/surfaces/checkout/components/Announcement.ts", "syntaxKind": "PropertySignature", "name": "newState", "value": "ToggleState", - "description": "", + "description": "The visibility state of the element after the toggle occurred.", "isOptional": true }, { @@ -10905,11 +10903,11 @@ "syntaxKind": "PropertySignature", "name": "oldState", "value": "ToggleState", - "description": "", + "description": "The visibility state of the element before the toggle occurred.", "isOptional": true } ], - "value": "export interface ToggleArgumentsEvent {\n oldState?: ToggleState;\n newState?: ToggleState;\n}" + "value": "export interface ToggleArgumentsEvent {\n /**\n * The visibility state of the element before the toggle occurred.\n */\n oldState?: ToggleState;\n /**\n * The visibility state of the element after the toggle occurred.\n */\n newState?: ToggleState;\n}" } }, "AnnouncementEvents": { @@ -10924,7 +10922,7 @@ "syntaxKind": "PropertySignature", "name": "onAfterToggle", "value": "(event: ToggleEvent$1) => void", - "description": "A callback fired when the element state changes, after any toggle animations have finished.\n\n- If the element transitioned from hidden to showing, the `oldState` property will be set to `closed` and the `newState` property will be set to `open`.\n- If the element transitioned from showing to hidden, the `oldState` property will be set to `open` and the `newState` will be `closed`.\n\nLearn more about [ToggleEvent.newState](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/newState) and [ToggleEvent.oldState](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/oldState).", + "description": "A callback fired when the element state changes, after any toggle animations have finished.\n\n- If the element transitioned from hidden to showing, the `oldState` property will be set to `closed` and the `newState` property will be set to `open`.\n- If the element transitioned from showing to hidden, the `oldState` property will be set to `open` and the `newState` will be `closed`.\n\nLearn more about 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.", "isOptional": true }, { @@ -10940,7 +10938,7 @@ "syntaxKind": "PropertySignature", "name": "onToggle", "value": "(event: ToggleEvent$1) => void", - "description": "A callback fired immediately when the element state changes, before any animations.\n\n- If the element is transitioning from hidden to showing, the `oldState` property will be set to `closed` and the `newState` property will be set to `open`.\n- If the element is transitioning from showing to hidden, then `oldState` property will be set to `open` and the `newState` will be `closed`.\n\nLearn more about the [toggle event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/toggle_event), [ToggleEvent.newState](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/newState), and [ToggleEvent.oldState](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/oldState).", + "description": "A callback fired immediately when the element state changes, before any animations.\n\n- If the element is transitioning from hidden to showing, the `oldState` property will be set to `closed` and the `newState` property will be set to `open`.\n- If the element is transitioning from showing to hidden, then the `oldState` property will be set to `open` and the `newState` will be `closed`.\n\nLearn 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.", "isOptional": true } ], @@ -10951,7 +10949,7 @@ "src/surfaces/checkout/components/Announcement.ts": { "filePath": "src/surfaces/checkout/components/Announcement.ts", "name": "AnnouncementElementEvents", - "description": "Learn more about [registering events](/docs/api/checkout-ui-extensions/latest/using-polaris-components#event-handling).", + "description": "", "isPublicDocs": true, "members": [ { @@ -10959,7 +10957,7 @@ "syntaxKind": "PropertySignature", "name": "aftertoggle", "value": "CallbackEventListener", - "description": "Callback fired when the element state changes **after** any animations have finished.\n\n- If the element transitioned from hidden to showing, the `oldState` property will be set to `closed` and the `newState` property will be set to `open`.\n- If the element transitioned from showing to hidden, the `oldState` property will be set to `open` and the `newState` will be `closed`.", + "description": "A callback that fires when the element state changes, after any toggle animations have finished.\n\n- If the element transitioned from hidden to showing, the `oldState` property will be set to `closed` and the `newState` property will be set to `open`.\n- If the element transitioned from showing to hidden, the `oldState` property will be set to `open` and the `newState` will be `closed`.\n\nLearn more about [`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).", "isOptional": true }, { @@ -10967,7 +10965,7 @@ "syntaxKind": "PropertySignature", "name": "dismiss", "value": "CallbackEventListener", - "description": "Callback fired when the announcement is dismissed by the user (either via the built-in dismiss button or programmatically).", + "description": "A callback that fires when the announcement is dismissed by the user clicking the close button or by calling the `dismiss()` method programmatically.", "isOptional": true }, { @@ -10975,11 +10973,11 @@ "syntaxKind": "PropertySignature", "name": "toggle", "value": "CallbackEventListener", - "description": "Callback straight after the element state changes.\n\n- If the element is transitioning from hidden to showing, the `oldState` property will be set to `closed` and the `newState` property will be set to `open`.\n- If the element is transitioning from showing to hidden, then `oldState` property will be set to `open` and the `newState` will be `closed`.", + "description": "A callback that fires immediately when the element state changes, before any animations.\n\n- If the element is transitioning from hidden to showing, the `oldState` property will be set to `closed` and the `newState` property will be set to `open`.\n- If the element is transitioning from showing to hidden, then the `oldState` property will be set to `open` and the `newState` will be `closed`.\n\nLearn more about the [`toggle` event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/toggle_event), [`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).", "isOptional": true } ], - "value": "export interface AnnouncementElementEvents {\n /**\n * Callback fired when the element state changes **after** any animations have finished.\n *\n * - If the element transitioned from hidden to showing, the `oldState` property will be set to `closed` and the\n * `newState` property will be set to `open`.\n * - If the element transitioned from showing to hidden, the `oldState` property will be set to `open` and the\n * `newState` will be `closed`.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/newState\n * @see https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/oldState\n */\n aftertoggle?: CallbackEventListener;\n /**\n * Callback fired when the announcement is dismissed by the user\n * (either via the built-in dismiss button or programmatically).\n */\n dismiss?: CallbackEventListener;\n /**\n * Callback straight after the element state changes.\n *\n * - If the element is transitioning from hidden to showing, the `oldState` property will be set to `closed` and the\n * `newState` property will be set to `open`.\n * - If the element is transitioning from showing to hidden, then `oldState` property will be set to `open` and the\n * `newState` will be `closed`.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/toggle_event\n * @see https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/newState\n * @see https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/oldState\n */\n toggle?: CallbackEventListener;\n}" + "value": "export interface AnnouncementElementEvents {\n /**\n * A callback that fires when the element state changes, after any toggle animations have finished.\n *\n * - If the element transitioned from hidden to showing, the `oldState` property will be set to `closed` and the\n * `newState` property will be set to `open`.\n * - If the element transitioned from showing to hidden, the `oldState` property will be set to `open` and the\n * `newState` will be `closed`.\n *\n * Learn more about [`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).\n */\n aftertoggle?: CallbackEventListener;\n /**\n * A callback that fires when the announcement is dismissed by the user clicking the close button or by calling the `dismiss()` method programmatically.\n */\n dismiss?: CallbackEventListener;\n /**\n * A callback that fires immediately when the element state changes, before any animations.\n *\n * - If the element is transitioning from hidden to showing, the `oldState` property will be set to `closed` and the\n * `newState` property will be set to `open`.\n * - If the element is transitioning from showing to hidden, then the `oldState` property will be set to `open` and the\n * `newState` will be `closed`.\n *\n * Learn more about the [`toggle` event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/toggle_event), [`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).\n */\n toggle?: CallbackEventListener;\n}" } }, "AnnouncementElement": { @@ -11008,7 +11006,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/Announcement.ts", @@ -11638,7 +11636,7 @@ "syntaxKind": "PropertySignature", "name": "dismiss", "value": "() => void", - "description": "" + "description": "Programmatically dismisses the announcement. This triggers the `dismiss` event callback." }, { "filePath": "src/surfaces/checkout/components/Announcement.ts", @@ -13033,7 +13031,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/Announcement.ts", @@ -13297,7 +13295,7 @@ "syntaxKind": "PropertySignature", "name": "onAfterToggle", "value": "(event: ToggleEvent$1) => void", - "description": "A callback fired when the element state changes, after any toggle animations have finished.\n\n- If the element transitioned from hidden to showing, the `oldState` property will be set to `closed` and the `newState` property will be set to `open`.\n- If the element transitioned from showing to hidden, the `oldState` property will be set to `open` and the `newState` will be `closed`.\n\nLearn more about [ToggleEvent.newState](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/newState) and [ToggleEvent.oldState](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/oldState).", + "description": "A callback fired when the element state changes, after any toggle animations have finished.\n\n- If the element transitioned from hidden to showing, the `oldState` property will be set to `closed` and the `newState` property will be set to `open`.\n- If the element transitioned from showing to hidden, the `oldState` property will be set to `open` and the `newState` will be `closed`.\n\nLearn more about 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.", "isOptional": true }, { @@ -13313,7 +13311,7 @@ "syntaxKind": "PropertySignature", "name": "onToggle", "value": "(event: ToggleEvent$1) => void", - "description": "A callback fired immediately when the element state changes, before any animations.\n\n- If the element is transitioning from hidden to showing, the `oldState` property will be set to `closed` and the `newState` property will be set to `open`.\n- If the element is transitioning from showing to hidden, then `oldState` property will be set to `open` and the `newState` will be `closed`.\n\nLearn more about the [toggle event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/toggle_event), [ToggleEvent.newState](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/newState), and [ToggleEvent.oldState](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/oldState).", + "description": "A callback fired immediately when the element state changes, before any animations.\n\n- If the element is transitioning from hidden to showing, the `oldState` property will be set to `closed` and the `newState` property will be set to `open`.\n- If the element is transitioning from showing to hidden, then the `oldState` property will be set to `open` and the `newState` will be `closed`.\n\nLearn 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.", "isOptional": true } ], @@ -13332,17 +13330,17 @@ "syntaxKind": "PropertySignature", "name": "dismiss", "value": "() => void", - "description": "" + "description": "Programmatically dismisses the announcement. This triggers the `dismiss` event callback." } ], - "value": "export interface AnnouncementMethods {\n dismiss: () => void;\n}" + "value": "export interface AnnouncementMethods {\n /**\n * Programmatically dismisses the announcement. This triggers the `dismiss` event callback.\n */\n dismiss: () => void;\n}" } }, "AnnouncementElementMethods": { "src/surfaces/checkout/components/Announcement.ts": { "filePath": "src/surfaces/checkout/components/Announcement.ts", "name": "AnnouncementElementMethods", - "description": "Learn more about [component methods](/docs/api/checkout-ui-extensions/latest/using-polaris-components#methods).", + "description": "", "isPublicDocs": true, "members": [ { @@ -13350,10 +13348,10 @@ "syntaxKind": "PropertySignature", "name": "dismiss", "value": "() => void", - "description": "" + "description": "Programmatically dismisses the announcement. This triggers the `dismiss` event callback." } ], - "value": "export interface AnnouncementElementMethods {\n dismiss: AnnouncementMethods['dismiss'];\n}" + "value": "export interface AnnouncementElementMethods {\n /**\n * Programmatically dismisses the announcement. This triggers the `dismiss` event callback.\n */\n dismiss: AnnouncementMethods['dismiss'];\n}" } }, "ReducedIconTypes": { @@ -13362,7 +13360,7 @@ "syntaxKind": "TypeAliasDeclaration", "name": "ReducedIconTypes", "value": "'cart' | 'note' | 'settings' | 'reset' | 'map' | 'menu' | 'search' | 'circle' | 'filter' | 'image' | 'alert-circle' | 'alert-triangle-filled' | 'alert-triangle' | 'arrow-down' | 'arrow-left' | 'arrow-right' | 'arrow-up-right' | 'arrow-up' | 'bag' | 'bullet' | 'calendar' | 'camera' | 'caret-down' | 'cash-dollar' | 'categories' | 'check-circle' | 'check-circle-filled' | 'check' | 'chevron-down' | 'chevron-left' | 'chevron-right' | 'chevron-up' | 'clipboard' | 'clock' | 'credit-card' | 'delete' | 'delivered' | 'delivery' | 'disabled' | 'discount' | 'edit' | 'email' | 'empty' | 'external' | 'geolocation' | 'gift-card' | 'globe' | 'grid' | 'info-filled' | 'info' | 'list-bulleted' | 'location' | 'lock' | 'menu-horizontal' | 'menu-vertical' | 'minus' | 'mobile' | 'order' | 'organization' | 'plus' | 'profile' | 'question-circle-filled' | 'question-circle' | 'reorder' | 'return' | 'savings' | 'star-filled' | 'star-half' | 'star' | 'store' | 'truck' | 'upload' | 'x-circle-filled' | 'x-circle' | 'x'", - "description": "", + "description": "The subset of icon types available in checkout and customer account surfaces. This is a narrowed set from the full Shopify icon library, containing only the icons supported in these contexts.", "isPublicDocs": true } }, @@ -13370,7 +13368,7 @@ "src/surfaces/checkout/components/Badge.ts": { "filePath": "src/surfaces/checkout/components/Badge.ts", "name": "BadgeElementProps", - "description": "Properties for the Badge component element.", + "description": "", "isPublicDocs": true, "members": [ { @@ -13378,7 +13376,7 @@ "syntaxKind": "PropertySignature", "name": "color", "value": "'base' | 'subdued'", - "description": "Modify the color to be more or less intense.", + "description": "Controls the visual weight and emphasis of the badge.\n\n- `base`: Standard weight with moderate emphasis, suitable for most use cases.\n- `subdued`: Reduced visual weight for less prominent or secondary badges.", "isOptional": true, "defaultValue": "'base'" }, @@ -13387,7 +13385,7 @@ "syntaxKind": "PropertySignature", "name": "icon", "value": "'' | ReducedIconTypes", - "description": "The type of icon to be displayed in the badge.", + "description": "An icon displayed inside the badge to provide additional visual context or reinforce the badge's meaning. Set to an empty string to display no icon.", "isOptional": true, "defaultValue": "''" }, @@ -13396,7 +13394,7 @@ "syntaxKind": "PropertySignature", "name": "iconPosition", "value": "'start' | 'end'", - "description": "The position of the icon in relation to the text.", + "description": "The position of the icon relative to the badge text.\n\n- `start`: Places the icon before the text.\n- `end`: Places the icon after the text.", "isOptional": true }, { @@ -13404,7 +13402,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -13412,7 +13410,7 @@ "syntaxKind": "PropertySignature", "name": "size", "value": "'small' | 'base' | 'small-100'", - "description": "Adjusts the size.", + "description": "The size of the badge.\n\n- `base`: The default size, suitable for most use cases.\n- `small`: A smaller badge for compact layouts.\n- `small-100`: The smallest badge for tight spaces or dense lists.", "isOptional": true, "defaultValue": "'base'" }, @@ -13421,12 +13419,12 @@ "syntaxKind": "PropertySignature", "name": "tone", "value": "'auto' | 'neutral' | 'critical'", - "description": "Sets the tone of the Badge, based on the intention of the information being conveyed.", + "description": "The semantic meaning and color treatment of the badge.\n\n- `auto`: Automatically determined based on context.\n- `neutral`: General information without specific intent.\n- `critical`: Urgent problems or destructive actions.", "isOptional": true, "defaultValue": "'auto'" } ], - "value": "export interface BadgeElementProps extends Pick {\n size?: Extract;\n tone?: Extract;\n color?: Extract;\n icon?: '' | ReducedIconTypes;\n}" + "value": "export interface BadgeElementProps extends Pick {\n /**\n * The size of the badge.\n *\n * - `base`: The default size, suitable for most use cases.\n * - `small`: A smaller badge for compact layouts.\n * - `small-100`: The smallest badge for tight spaces or dense lists.\n *\n * @default 'base'\n */\n size?: Extract;\n /**\n * The semantic meaning and color treatment of the badge.\n *\n * - `auto`: Automatically determined based on context.\n * - `neutral`: General information without specific intent.\n * - `critical`: Urgent problems or destructive actions.\n *\n * @default 'auto'\n */\n tone?: Extract;\n /**\n * Controls the visual weight and emphasis of the badge.\n *\n * - `base`: Standard weight with moderate emphasis, suitable for most use cases.\n * - `subdued`: Reduced visual weight for less prominent or secondary badges.\n *\n * @default 'base'\n */\n color?: Extract;\n /**\n * An icon displayed inside the badge to provide additional visual context or reinforce the badge's meaning. Set to an empty string to display no icon.\n *\n * @default ''\n */\n icon?: '' | ReducedIconTypes;\n /**\n * The position of the icon relative to the badge text.\n *\n * - `start`: Places the icon before the text.\n * - `end`: Places the icon after the text.\n */\n iconPosition?: BadgeProps$1['iconPosition'];\n}" } }, "BadgeElement": { @@ -13455,7 +13453,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/Badge.ts", @@ -14029,7 +14027,7 @@ "syntaxKind": "PropertySignature", "name": "color", "value": "'base' | 'subdued'", - "description": "Modify the color to be more or less intense.", + "description": "Controls the visual weight and emphasis of the badge.\n\n- `base`: Standard weight with moderate emphasis, suitable for most use cases.\n- `subdued`: Reduced visual weight for less prominent or secondary badges.", "isOptional": true, "defaultValue": "'base'" }, @@ -14361,15 +14359,16 @@ "syntaxKind": "PropertySignature", "name": "icon", "value": "'' | ReducedIconTypes", - "description": "The type of icon to be displayed in the badge.", - "isOptional": true + "description": "An icon displayed inside the badge to provide additional visual context or reinforce the badge's meaning. Set to an empty string to display no icon.", + "isOptional": true, + "defaultValue": "''" }, { "filePath": "src/surfaces/checkout/components/Badge.ts", "syntaxKind": "PropertySignature", "name": "iconPosition", "value": "'start' | 'end'", - "description": "The position of the icon in relation to the text.", + "description": "The position of the icon relative to the badge text.\n\n- `start`: Places the icon before the text.\n- `end`: Places the icon after the text.", "isOptional": true }, { @@ -14377,7 +14376,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -15489,7 +15488,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/Badge.ts", @@ -15650,7 +15649,7 @@ "syntaxKind": "PropertySignature", "name": "size", "value": "'small' | 'base' | 'small-100'", - "description": "Adjusts the size.", + "description": "The size of the badge.\n\n- `base`: The default size, suitable for most use cases.\n- `small`: A smaller badge for compact layouts.\n- `small-100`: The smallest badge for tight spaces or dense lists.", "isOptional": true, "defaultValue": "'base'" }, @@ -15729,7 +15728,7 @@ "syntaxKind": "PropertySignature", "name": "tone", "value": "'auto' | 'neutral' | 'critical'", - "description": "Sets the tone of the Badge, based on the intention of the information being conveyed.", + "description": "The semantic meaning and color treatment of the badge.\n\n- `auto`: Automatically determined based on context.\n- `neutral`: General information without specific intent.\n- `critical`: Urgent problems or destructive actions.", "isOptional": true, "defaultValue": "'auto'" }, @@ -15771,7 +15770,7 @@ "syntaxKind": "PropertySignature", "name": "color", "value": "'base' | 'subdued'", - "description": "Modify the color to be more or less intense.", + "description": "Controls the visual weight and emphasis of the badge.\n\n- `base`: Standard weight with moderate emphasis, suitable for most use cases.\n- `subdued`: Reduced visual weight for less prominent or secondary badges.", "isOptional": true, "defaultValue": "'base'" }, @@ -15780,15 +15779,16 @@ "syntaxKind": "PropertySignature", "name": "icon", "value": "'' | ReducedIconTypes", - "description": "The type of icon to be displayed in the badge.", - "isOptional": true + "description": "An icon displayed inside the badge to provide additional visual context or reinforce the badge's meaning. Set to an empty string to display no icon.", + "isOptional": true, + "defaultValue": "''" }, { "filePath": "src/surfaces/checkout/components/Badge.ts", "syntaxKind": "PropertySignature", "name": "iconPosition", "value": "'start' | 'end'", - "description": "The position of the icon in relation to the text.", + "description": "The position of the icon relative to the badge text.\n\n- `start`: Places the icon before the text.\n- `end`: Places the icon after the text.", "isOptional": true }, { @@ -15796,7 +15796,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -15804,7 +15804,7 @@ "syntaxKind": "PropertySignature", "name": "size", "value": "'small' | 'base' | 'small-100'", - "description": "Adjusts the size.", + "description": "The size of the badge.\n\n- `base`: The default size, suitable for most use cases.\n- `small`: A smaller badge for compact layouts.\n- `small-100`: The smallest badge for tight spaces or dense lists.", "isOptional": true, "defaultValue": "'base'" }, @@ -15813,7 +15813,7 @@ "syntaxKind": "PropertySignature", "name": "tone", "value": "'auto' | 'neutral' | 'critical'", - "description": "Sets the tone of the Badge, based on the intention of the information being conveyed.", + "description": "The semantic meaning and color treatment of the badge.\n\n- `auto`: Automatically determined based on context.\n- `neutral`: General information without specific intent.\n- `critical`: Urgent problems or destructive actions.", "isOptional": true, "defaultValue": "'auto'" } @@ -15825,7 +15825,7 @@ "src/surfaces/checkout/components/Banner.ts": { "filePath": "src/surfaces/checkout/components/Banner.ts", "name": "BannerElementProps", - "description": "The banner component highlights important information or required actions prominently within the interface. Use banner to communicate statuses, provide feedback, draw attention to critical updates, or guide users toward necessary actions.\n\nBanners support multiple tones to convey urgency levels, optional actions for next steps, and can be positioned contextually within sections or page-wide at the top. For inline status indicators on individual items, use [badge](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/feedback-and-status-indicators/badge).", + "description": "", "isPublicDocs": true, "members": [ { @@ -15833,7 +15833,7 @@ "syntaxKind": "PropertySignature", "name": "collapsible", "value": "boolean", - "description": "Makes the content collapsible. A collapsible banner will conceal child elements initially, but allow the user to expand the banner to see them.", + "description": "Whether the banner content can be collapsed and expanded by the user. A collapsible banner conceals child elements initially, allowing the user to expand the banner to reveal them.", "isOptional": true, "defaultValue": "false" }, @@ -15842,7 +15842,7 @@ "syntaxKind": "PropertySignature", "name": "dismissible", "value": "boolean", - "description": "Determines whether the close button of the banner is present.\n\nWhen the close button is pressed, the `dismiss` event will fire, then `hidden` will be true, any animation will complete, and the `afterhide` event will fire.", + "description": "Whether the banner displays a close button that allows users to dismiss it.\n\nWhen the close button is pressed, the `dismiss` event will fire, then `hidden` will be set to `true`, any animation will complete, and the `afterhide` event will fire.", "isOptional": true, "defaultValue": "false" }, @@ -15851,7 +15851,7 @@ "syntaxKind": "PropertySignature", "name": "heading", "value": "string", - "description": "The title of the banner.", + "description": "The heading text displayed at the top of the banner to summarize the message or alert.", "isOptional": true, "defaultValue": "''" }, @@ -15860,7 +15860,7 @@ "syntaxKind": "PropertySignature", "name": "hidden", "value": "boolean", - "description": "Determines whether the banner is hidden.\n\nIf this property is being set on each framework render (as in 'controlled' usage), and the banner is `dismissible`, ensure you update app state for this property when the `dismiss` event fires.\n\nIf the banner is not `dismissible`, it can still be hidden by setting this property.", + "description": "Controls whether the banner is visible or hidden.\n\nWhen using a controlled component pattern and the banner is `dismissible`, update this property to `true` when the `dismiss` event fires.\n\nYou can hide the banner programmatically by setting this to `true` even if it's not `dismissible`.", "isOptional": true, "defaultValue": "false" }, @@ -15869,7 +15869,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -15877,12 +15877,12 @@ "syntaxKind": "PropertySignature", "name": "tone", "value": "'success' | 'info' | 'auto' | 'warning' | 'critical'", - "description": "Sets the tone of the Banner, based on the intention of the information being conveyed.\n\nThe banner is a live region and the type of status will be dictated by the Tone selected.\n\n- `critical` creates an [assertive live region](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/alert_role) that is announced by screen readers immediately.\n- `neutral`, `info`, `success`, `warning` and `caution` creates an [informative live region](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/status_role) that is announced by screen readers after the current message.", + "description": "The semantic meaning and color treatment of the component. The banner is a live region and the type of status is dictated by the tone selected.\n\n- `info`: Informational content or helpful tips.\n- `auto`: Automatically determined based on context.\n- `success`: Positive outcomes or successful states.\n- `warning`: Important warnings about potential issues.\n- `critical`: Urgent problems or destructive actions.\n\nThe `critical` tone creates an [assertive live region](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/alert_role) that is announced by screen readers immediately. The `info`, `success`, and `warning` tones create an [informative live region](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/status_role) that is announced by screen readers after the current message.", "isOptional": true, "defaultValue": "'auto'" } ], - "value": "export interface BannerElementProps extends Pick {\n tone?: Extract;\n}" + "value": "export interface BannerElementProps extends Pick {\n /**\n * Whether the banner content can be collapsed and expanded by the user. A collapsible banner conceals child elements initially, allowing the user to expand the banner to reveal them.\n *\n * @default false\n */\n collapsible?: BannerProps$1['collapsible'];\n /**\n * Whether the banner displays a close button that allows users to dismiss it.\n *\n * When the close button is pressed, the `dismiss` event will fire,\n * then `hidden` will be set to `true`,\n * any animation will complete,\n * and the `afterhide` event will fire.\n *\n * @default false\n */\n dismissible?: BannerProps$1['dismissible'];\n /**\n * The heading text displayed at the top of the banner to summarize the message or alert.\n *\n * @default ''\n */\n heading?: BannerProps$1['heading'];\n /**\n * Controls whether the banner is visible or hidden.\n *\n * When using a controlled component pattern and the banner is `dismissible`,\n * update this property to `true` when the `dismiss` event fires.\n *\n * You can hide the banner programmatically by setting this to `true` even if it's not `dismissible`.\n *\n * @default false\n */\n hidden?: BannerProps$1['hidden'];\n /**\n * The semantic meaning and color treatment of the component. The banner is a live region and the type of status is dictated by the tone selected.\n *\n * - `info`: Informational content or helpful tips.\n * - `auto`: Automatically determined based on context.\n * - `success`: Positive outcomes or successful states.\n * - `warning`: Important warnings about potential issues.\n * - `critical`: Urgent problems or destructive actions.\n *\n * The `critical` tone creates an [assertive live region](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/alert_role) that is announced by screen readers immediately. The `info`, `success`, and `warning` tones create an [informative live region](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/status_role) that is announced by screen readers after the current message.\n *\n * @default 'auto'\n */\n tone?: Extract;\n}" } }, "BannerEvents": { @@ -15916,7 +15916,7 @@ "src/surfaces/checkout/components/Banner.ts": { "filePath": "src/surfaces/checkout/components/Banner.ts", "name": "BannerElementEvents", - "description": "Learn more about [registering events](/docs/api/checkout-ui-extensions/latest/using-polaris-components#event-handling).", + "description": "", "isPublicDocs": true, "members": [ { @@ -15924,7 +15924,7 @@ "syntaxKind": "PropertySignature", "name": "afterhide", "value": "CallbackEventListener", - "description": "Event handler when the banner has fully hidden.\n\nThe `hidden` property will be `true` when this event fires.", + "description": "A callback that fires when the banner has fully hidden, including after any hide animations have completed.\n\nThe `hidden` property is `true` when this event fires.", "isOptional": true }, { @@ -15932,11 +15932,11 @@ "syntaxKind": "PropertySignature", "name": "dismiss", "value": "CallbackEventListener", - "description": "Event handler when the banner is dismissed by the user.\n\nThis does not fire when setting `hidden` manually.\n\nThe `hidden` property will be `false` when this event fires.", + "description": "A callback that fires when the banner is dismissed by the user clicking the close button.\n\nThis doesn't fire when setting `hidden` manually.\n\nThe `hidden` property is `false` when this event fires.", "isOptional": true } ], - "value": "export interface BannerElementEvents {\n /**\n * Event handler when the banner has fully hidden.\n *\n * The `hidden` property will be `true` when this event fires.\n *\n * @implementation If implementations animate the hiding of the banner,\n * this event must fire after the banner has fully hidden.\n * We can add an `onHide` event in future if we want to provide a hook for the start of the animation.\n */\n afterhide?: CallbackEventListener;\n /**\n * Event handler when the banner is dismissed by the user.\n *\n * This does not fire when setting `hidden` manually.\n *\n * The `hidden` property will be `false` when this event fires.\n */\n dismiss?: CallbackEventListener;\n}" + "value": "export interface BannerElementEvents {\n /**\n * A callback that fires when the banner has fully hidden, including after any hide animations have completed.\n *\n * The `hidden` property is `true` when this event fires.\n */\n afterhide?: CallbackEventListener;\n /**\n * A callback that fires when the banner is dismissed by the user clicking the close button.\n *\n * This doesn't fire when setting `hidden` manually.\n *\n * The `hidden` property is `false` when this event fires.\n */\n dismiss?: CallbackEventListener;\n}" } }, "BannerElement": { @@ -15965,7 +15965,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/Banner.ts", @@ -16539,7 +16539,7 @@ "syntaxKind": "PropertySignature", "name": "collapsible", "value": "boolean", - "description": "Makes the content collapsible. A collapsible banner will conceal child elements initially, but allow the user to expand the banner to see them.", + "description": "Whether the banner content can be collapsed and expanded by the user. A collapsible banner conceals child elements initially, allowing the user to expand the banner to reveal them.", "isOptional": true, "defaultValue": "false" }, @@ -16604,7 +16604,7 @@ "syntaxKind": "PropertySignature", "name": "dismissible", "value": "boolean", - "description": "Determines whether the close button of the banner is present.\n\nWhen the close button is pressed, the `dismiss` event will fire, then `hidden` will be true, any animation will complete, and the `afterhide` event will fire.", + "description": "Whether the banner displays a close button that allows users to dismiss it.\n\nWhen the close button is pressed, the `dismiss` event will fire, then `hidden` will be set to `true`, any animation will complete, and the `afterhide` event will fire.", "isOptional": true, "defaultValue": "false" }, @@ -16866,7 +16866,7 @@ "syntaxKind": "PropertySignature", "name": "heading", "value": "string", - "description": "The title of the banner.", + "description": "The heading text displayed at the top of the banner to summarize the message or alert.", "isOptional": true, "defaultValue": "''" }, @@ -16875,7 +16875,7 @@ "syntaxKind": "PropertySignature", "name": "hidden", "value": "boolean", - "description": "Determines whether the banner is hidden.\n\nIf this property is being set on each framework render (as in 'controlled' usage), and the banner is `dismissible`, ensure you update app state for this property when the `dismiss` event fires.\n\nIf the banner is not `dismissible`, it can still be hidden by setting this property.", + "description": "Controls whether the banner is visible or hidden.\n\nWhen using a controlled component pattern and the banner is `dismissible`, update this property to `true` when the `dismiss` event fires.\n\nYou can hide the banner programmatically by setting this to `true` even if it's not `dismissible`.", "isOptional": true, "defaultValue": "false" }, @@ -16891,7 +16891,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -18017,7 +18017,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/Banner.ts", @@ -18241,7 +18241,7 @@ "syntaxKind": "PropertySignature", "name": "tone", "value": "'success' | 'info' | 'auto' | 'warning' | 'critical'", - "description": "Sets the tone of the Banner, based on the intention of the information being conveyed.\n\nThe banner is a live region and the type of status will be dictated by the Tone selected.\n\n- `critical` creates an [assertive live region](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/alert_role) that is announced by screen readers immediately.\n- `neutral`, `info`, `success`, `warning` and `caution` creates an [informative live region](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/status_role) that is announced by screen readers after the current message.", + "description": "The semantic meaning and color treatment of the component. The banner is a live region and the type of status is dictated by the tone selected.\n\n- `info`: Informational content or helpful tips.\n- `auto`: Automatically determined based on context.\n- `success`: Positive outcomes or successful states.\n- `warning`: Important warnings about potential issues.\n- `critical`: Urgent problems or destructive actions.\n\nThe `critical` tone creates an [assertive live region](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/alert_role) that is announced by screen readers immediately. The `info`, `success`, and `warning` tones create an [informative live region](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/status_role) that is announced by screen readers after the current message.", "isOptional": true, "defaultValue": "'auto'" }, @@ -18283,7 +18283,7 @@ "syntaxKind": "PropertySignature", "name": "collapsible", "value": "boolean", - "description": "Makes the content collapsible. A collapsible banner will conceal child elements initially, but allow the user to expand the banner to see them.", + "description": "Whether the banner content can be collapsed and expanded by the user. A collapsible banner conceals child elements initially, allowing the user to expand the banner to reveal them.", "isOptional": true, "defaultValue": "false" }, @@ -18292,7 +18292,7 @@ "syntaxKind": "PropertySignature", "name": "dismissible", "value": "boolean", - "description": "Determines whether the close button of the banner is present.\n\nWhen the close button is pressed, the `dismiss` event will fire, then `hidden` will be true, any animation will complete, and the `afterhide` event will fire.", + "description": "Whether the banner displays a close button that allows users to dismiss it.\n\nWhen the close button is pressed, the `dismiss` event will fire, then `hidden` will be set to `true`, any animation will complete, and the `afterhide` event will fire.", "isOptional": true, "defaultValue": "false" }, @@ -18301,7 +18301,7 @@ "syntaxKind": "PropertySignature", "name": "heading", "value": "string", - "description": "The title of the banner.", + "description": "The heading text displayed at the top of the banner to summarize the message or alert.", "isOptional": true, "defaultValue": "''" }, @@ -18310,7 +18310,7 @@ "syntaxKind": "PropertySignature", "name": "hidden", "value": "boolean", - "description": "Determines whether the banner is hidden.\n\nIf this property is being set on each framework render (as in 'controlled' usage), and the banner is `dismissible`, ensure you update app state for this property when the `dismiss` event fires.\n\nIf the banner is not `dismissible`, it can still be hidden by setting this property.", + "description": "Controls whether the banner is visible or hidden.\n\nWhen using a controlled component pattern and the banner is `dismissible`, update this property to `true` when the `dismiss` event fires.\n\nYou can hide the banner programmatically by setting this to `true` even if it's not `dismissible`.", "isOptional": true, "defaultValue": "false" }, @@ -18319,7 +18319,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -18343,7 +18343,7 @@ "syntaxKind": "PropertySignature", "name": "tone", "value": "'success' | 'info' | 'auto' | 'warning' | 'critical'", - "description": "Sets the tone of the Banner, based on the intention of the information being conveyed.\n\nThe banner is a live region and the type of status will be dictated by the Tone selected.\n\n- `critical` creates an [assertive live region](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/alert_role) that is announced by screen readers immediately.\n- `neutral`, `info`, `success`, `warning` and `caution` creates an [informative live region](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/status_role) that is announced by screen readers after the current message.", + "description": "The semantic meaning and color treatment of the component. The banner is a live region and the type of status is dictated by the tone selected.\n\n- `info`: Informational content or helpful tips.\n- `auto`: Automatically determined based on context.\n- `success`: Positive outcomes or successful states.\n- `warning`: Important warnings about potential issues.\n- `critical`: Urgent problems or destructive actions.\n\nThe `critical` tone creates an [assertive live region](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/alert_role) that is announced by screen readers immediately. The `info`, `success`, and `warning` tones create an [informative live region](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/status_role) that is announced by screen readers after the current message.", "isOptional": true, "defaultValue": "'auto'" } @@ -18377,7 +18377,7 @@ "syntaxKind": "TypeAliasDeclaration", "name": "BorderShorthand", "value": "ReducedBorderSizeKeyword | `${ReducedBorderSizeKeyword} ${ReducedColorKeyword}` | `${ReducedBorderSizeKeyword} ${ReducedColorKeyword} ${BorderStyleKeyword}`", - "description": "", + "description": "A shorthand string for specifying border properties. Accepts a size alone (`'base'`), size with color (`'base base'`), or size with color and style (`'base base dashed'`). Omitted values use their defaults.", "isPublicDocs": true } }, @@ -18395,7 +18395,7 @@ "src/surfaces/checkout/components/Box.ts": { "filePath": "src/surfaces/checkout/components/Box.ts", "name": "BoxElementProps", - "description": "The box component provides a generic, flexible container for custom designs and layouts. Use box to apply styling like backgrounds, padding, borders, or border radius when existing components don't meet your needs, or to nest and group other components.\n\nBox contents maintain their natural size, making it especially useful within layout components that would otherwise stretch their children. For structured layouts, use [stack](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/layout-and-structure/stack) or [grid](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/layout-and-structure/grid).", + "description": "", "isPublicDocs": true, "members": [ { @@ -18420,7 +18420,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityVisibility", "value": "'visible' | 'hidden' | 'exclusive'", - "description": "Changes the visibility of the element.\n\n- `visible`: the element is visible to all users.\n- `hidden`: the element is removed from the accessibility tree but remains visible.\n- `exclusive`: the element is visually hidden but remains in the accessibility tree.", + "description": "Controls how the element is exposed to sighted users and to assistive technologies such as screen readers.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", "isOptional": true, "defaultValue": "'visible'" }, @@ -18429,7 +18429,7 @@ "syntaxKind": "PropertySignature", "name": "background", "value": "'base' | 'subdued' | 'transparent'", - "description": "Adjust the background of the element.\n\n- `'transparent'`: No visible background.\n- `'subdued'`: A subtle, low-emphasis background.\n- `'base'`: The standard background color.\n- `'strong'`: A high-emphasis background for prominence.", + "description": "The background color of the box.\n\n- `base`: The standard background color for general content areas.\n- `subdued`: A muted background for secondary or supporting content.\n- `transparent`: No background color (the default).", "isOptional": true, "defaultValue": "'transparent'" }, @@ -18447,9 +18447,9 @@ "syntaxKind": "PropertySignature", "name": "border", "value": "BorderShorthand", - "description": "Applies a border using shorthand syntax to specify width, color, and style in a single property.\n\nAccepts a size value, optionally followed by a color, optionally followed by a style. Omitted values use defaults: color defaults to `base`, style defaults to `auto`.\n\nIndividual properties (`borderWidth`, `borderStyle`, `borderColor`) can override values set here.", + "description": "A shorthand for setting the border width, color, and style in a single property. Individual border properties (`borderWidth`, `borderStyle`) can override values set here.", "isOptional": true, - "defaultValue": "'none' - equivalent to `none base auto`.", + "defaultValue": "'none'", "examples": [ { "title": "Example", @@ -18468,7 +18468,7 @@ "syntaxKind": "PropertySignature", "name": "borderRadius", "value": "MaybeAllValuesShorthandProperty>", - "description": "Controls the roundedness of the element's corners using the design system's radius scale.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) using flow-relative values:\n- One value: applies to all corners\n- Two values: applies to start corners (top-left & bottom-right) and end corners (top-right & bottom-left) respectively\n- Three values: applies to start-start (top-left), end corners (top-right & bottom-left), and end-end (bottom-right) respectively\n- Four values: applies to start-start (top-left), start-end (top-right), end-end (bottom-right), and end-start (bottom-left) respectively\n\nExamples:\n- `small-100`: All corners have `small-100` radius\n- `small-100 none`: Top-left and bottom-right are `small-100`, top-right and bottom-left are `none`\n- `small-100 none large-100`: Top-left is `small-100`, top-right and bottom-left are `none`, bottom-right is `large-100`\n- `small-100 none large-100 base`: Each corner has its specified radius value", + "description": "The roundedness of the box's corners.\n\n- `none`: Sharp corners with no rounding.\n- `small-100` / `small`: Subtle rounding for compact elements.\n- `base`: Standard rounding for most use cases.\n- `large` / `large-100`: More pronounced rounding for prominent containers.\n- `max`: Maximum rounding, creating a pill or circular shape.\n\nSupports 1-to-4-value shorthand syntax for specifying different radii per corner.", "isOptional": true, "defaultValue": "'none'" }, @@ -18486,7 +18486,7 @@ "syntaxKind": "PropertySignature", "name": "borderWidth", "value": "MaybeAllValuesShorthandProperty | ''", - "description": "Controls the thickness of the border on all sides. When set, this overrides the width value specified in the `border` property.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) for specifying different widths per side:\n- One value: applies to all sides\n- Two values: applies to block sides (top/bottom) and inline sides (left/right) respectively\n- Three values: applies to block-start (top), inline sides (left/right), and block-end (bottom) respectively\n- Four values: applies to block-start (top), inline-end (right), block-end (bottom), and inline-start (left) respectively", + "description": "The thickness of the border on all sides. Supports 1-to-4-value shorthand syntax for specifying different widths per side. Overrides the width value set by `border`.", "isOptional": true, "defaultValue": "'' - meaning no override" }, @@ -18495,7 +18495,7 @@ "syntaxKind": "PropertySignature", "name": "display", "value": "MaybeResponsive<\"auto\" | \"none\">", - "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.", + "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.\n\nLearn more about the [display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display).", "isOptional": true, "defaultValue": "'auto'" }, @@ -18504,7 +18504,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -18625,7 +18625,7 @@ "defaultValue": "'' - meaning no override" } ], - "value": "export interface BoxElementProps extends Pick {\n background?: Extract;\n border?: BorderShorthand;\n borderWidth?: MaybeAllValuesShorthandProperty | '';\n borderRadius?: MaybeAllValuesShorthandProperty>;\n}" + "value": "export interface BoxElementProps extends Pick {\n /**\n * The background color of the box.\n *\n * - `base`: The standard background color for general content areas.\n * - `subdued`: A muted background for secondary or supporting content.\n * - `transparent`: No background color (the default).\n *\n * @default 'transparent'\n */\n background?: Extract;\n /**\n * A shorthand for setting the border width, color, and style in a single property. Individual border properties (`borderWidth`, `borderStyle`) can override values set here.\n *\n * @default 'none'\n */\n border?: BorderShorthand;\n /**\n * The thickness of the border on all sides. Supports 1-to-4-value shorthand syntax for specifying different widths per side. Overrides the width value set by `border`.\n *\n * @default '' - meaning no override\n */\n borderWidth?: MaybeAllValuesShorthandProperty | '';\n /**\n * The roundedness of the box's corners.\n *\n * - `none`: Sharp corners with no rounding.\n * - `small-100` / `small`: Subtle rounding for compact elements.\n * - `base`: Standard rounding for most use cases.\n * - `large` / `large-100`: More pronounced rounding for prominent containers.\n * - `max`: Maximum rounding, creating a pill or circular shape.\n *\n * Supports 1-to-4-value shorthand syntax for specifying different radii per corner.\n *\n * @default 'none'\n */\n borderRadius?: MaybeAllValuesShorthandProperty>;\n}" } }, "AccessibilityRole": { @@ -18634,7 +18634,7 @@ "syntaxKind": "TypeAliasDeclaration", "name": "AccessibilityRole", "value": "\"main\" | \"header\" | \"footer\" | \"section\" | \"aside\" | \"navigation\" | \"ordered-list\" | \"list-item\" | \"list-item-separator\" | \"unordered-list\" | \"separator\" | \"status\" | \"alert\" | \"generic\" | \"presentation\" | \"none\"", - "description": "", + "description": "The semantic role of a component, used by assistive technologies to convey the element’s purpose to users. Each role maps to a specific HTML element or ARIA role.\n\n- `main`: The primary content of the page.\n- `header`: A page or section header.\n- `footer`: Information such as copyright, navigation links, and privacy statements.\n- `section`: A generic section that should have a heading or `accessibilityLabel`.\n- `aside`: Supporting content related to the main content.\n- `navigation`: A major group of navigation links.\n- `ordered-list`: A list of ordered items.\n- `list-item`: An item inside a list.\n- `list-item-separator`: A divider between list items.\n- `unordered-list`: A list of unordered items.\n- `separator`: A divider that separates sections of content.\n- `status`: A live region with advisory information that is not urgent.\n- `alert`: Important, usually time-sensitive information.\n- `generic`: A nameless container with no semantic meaning (renders a `
`).\n- `presentation`: Strips semantic meaning while keeping visual styling. Synonym for `none`.\n- `none`: Strips semantic meaning while keeping visual styling. Synonym for `presentation`.", "isPublicDocs": true } }, @@ -18707,7 +18707,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityVisibility", "value": "'visible' | 'hidden' | 'exclusive'", - "description": "Changes the visibility of the element.\n\n- `visible`: the element is visible to all users.\n- `hidden`: the element is removed from the accessibility tree but remains visible.\n- `exclusive`: the element is visually hidden but remains in the accessibility tree.", + "description": "Controls how the element is exposed to sighted users and to assistive technologies such as screen readers.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", "isOptional": true, "defaultValue": "'visible'" }, @@ -18716,7 +18716,7 @@ "syntaxKind": "PropertySignature", "name": "background", "value": "'base' | 'subdued' | 'transparent'", - "description": "Adjust the background of the element.\n\n- `'transparent'`: No visible background.\n- `'subdued'`: A subtle, low-emphasis background.\n- `'base'`: The standard background color.\n- `'strong'`: A high-emphasis background for prominence.", + "description": "The background color of the box.\n\n- `base`: The standard background color for general content areas.\n- `subdued`: A muted background for secondary or supporting content.\n- `transparent`: No background color (the default).", "isOptional": true, "defaultValue": "'transparent'" }, @@ -18734,15 +18734,16 @@ "syntaxKind": "PropertySignature", "name": "border", "value": "BorderShorthand", - "description": "Applies a border using shorthand syntax to specify width, color, and style in a single property.\n\nAccepts a size value, optionally followed by a color, optionally followed by a style. Omitted values use defaults: color defaults to `base`, style defaults to `auto`.\n\nIndividual properties (`borderWidth`, `borderStyle`, `borderColor`) can override values set here.", - "isOptional": true + "description": "A shorthand for setting the border width, color, and style in a single property. Individual border properties (`borderWidth`, `borderStyle`) can override values set here.", + "isOptional": true, + "defaultValue": "'none'" }, { "filePath": "src/surfaces/checkout/components/Box.ts", "syntaxKind": "PropertySignature", "name": "borderRadius", "value": "MaybeAllValuesShorthandProperty>", - "description": "Controls the roundedness of the element's corners using the design system's radius scale.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) using flow-relative values:\n- One value: applies to all corners\n- Two values: applies to start corners (top-left & bottom-right) and end corners (top-right & bottom-left) respectively\n- Three values: applies to start-start (top-left), end corners (top-right & bottom-left), and end-end (bottom-right) respectively\n- Four values: applies to start-start (top-left), start-end (top-right), end-end (bottom-right), and end-start (bottom-left) respectively\n\nExamples:\n- `small-100`: All corners have `small-100` radius\n- `small-100 none`: Top-left and bottom-right are `small-100`, top-right and bottom-left are `none`\n- `small-100 none large-100`: Top-left is `small-100`, top-right and bottom-left are `none`, bottom-right is `large-100`\n- `small-100 none large-100 base`: Each corner has its specified radius value", + "description": "The roundedness of the box's corners.\n\n- `none`: Sharp corners with no rounding.\n- `small-100` / `small`: Subtle rounding for compact elements.\n- `base`: Standard rounding for most use cases.\n- `large` / `large-100`: More pronounced rounding for prominent containers.\n- `max`: Maximum rounding, creating a pill or circular shape.\n\nSupports 1-to-4-value shorthand syntax for specifying different radii per corner.", "isOptional": true, "defaultValue": "'none'" }, @@ -18760,15 +18761,16 @@ "syntaxKind": "PropertySignature", "name": "borderWidth", "value": "MaybeAllValuesShorthandProperty | ''", - "description": "Controls the thickness of the border on all sides. When set, this overrides the width value specified in the `border` property.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) for specifying different widths per side:\n- One value: applies to all sides\n- Two values: applies to block sides (top/bottom) and inline sides (left/right) respectively\n- Three values: applies to block-start (top), inline sides (left/right), and block-end (bottom) respectively\n- Four values: applies to block-start (top), inline-end (right), block-end (bottom), and inline-start (left) respectively", - "isOptional": true + "description": "The thickness of the border on all sides. Supports 1-to-4-value shorthand syntax for specifying different widths per side. Overrides the width value set by `border`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" }, { "filePath": "src/surfaces/checkout/components/Box.ts", "syntaxKind": "PropertySignature", "name": "display", "value": "MaybeResponsive<\"auto\" | \"none\">", - "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.", + "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.\n\nLearn more about the [display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display).", "isOptional": true, "defaultValue": "'auto'" }, @@ -18777,7 +18779,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -18970,7 +18972,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityVisibility", "value": "'visible' | 'hidden' | 'exclusive'", - "description": "Changes the visibility of the element.\n\n- `visible`: the element is visible to all users.\n- `hidden`: the element is removed from the accessibility tree but remains visible.\n- `exclusive`: the element is visually hidden but remains in the accessibility tree.", + "description": "Controls how the element is exposed to sighted users and to assistive technologies such as screen readers.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", "isOptional": true, "defaultValue": "'visible'" }, @@ -18993,7 +18995,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/Box.ts", @@ -19448,7 +19450,7 @@ "syntaxKind": "PropertySignature", "name": "background", "value": "'base' | 'subdued' | 'transparent'", - "description": "Adjust the background of the element.\n\n- `'transparent'`: No visible background.\n- `'subdued'`: A subtle, low-emphasis background.\n- `'base'`: The standard background color.\n- `'strong'`: A high-emphasis background for prominence.", + "description": "The background color of the box.\n\n- `base`: The standard background color for general content areas.\n- `subdued`: A muted background for secondary or supporting content.\n- `transparent`: No background color (the default).", "isOptional": true, "defaultValue": "'transparent'" }, @@ -19487,15 +19489,16 @@ "syntaxKind": "PropertySignature", "name": "border", "value": "BorderShorthand", - "description": "Applies a border using shorthand syntax to specify width, color, and style in a single property.\n\nAccepts a size value, optionally followed by a color, optionally followed by a style. Omitted values use defaults: color defaults to `base`, style defaults to `auto`.\n\nIndividual properties (`borderWidth`, `borderStyle`, `borderColor`) can override values set here.", - "isOptional": true + "description": "A shorthand for setting the border width, color, and style in a single property. Individual border properties (`borderWidth`, `borderStyle`) can override values set here.", + "isOptional": true, + "defaultValue": "'none'" }, { "filePath": "src/surfaces/checkout/components/Box.ts", "syntaxKind": "PropertySignature", "name": "borderRadius", "value": "MaybeAllValuesShorthandProperty>", - "description": "Controls the roundedness of the element's corners using the design system's radius scale.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) using flow-relative values:\n- One value: applies to all corners\n- Two values: applies to start corners (top-left & bottom-right) and end corners (top-right & bottom-left) respectively\n- Three values: applies to start-start (top-left), end corners (top-right & bottom-left), and end-end (bottom-right) respectively\n- Four values: applies to start-start (top-left), start-end (top-right), end-end (bottom-right), and end-start (bottom-left) respectively\n\nExamples:\n- `small-100`: All corners have `small-100` radius\n- `small-100 none`: Top-left and bottom-right are `small-100`, top-right and bottom-left are `none`\n- `small-100 none large-100`: Top-left is `small-100`, top-right and bottom-left are `none`, bottom-right is `large-100`\n- `small-100 none large-100 base`: Each corner has its specified radius value", + "description": "The roundedness of the box's corners.\n\n- `none`: Sharp corners with no rounding.\n- `small-100` / `small`: Subtle rounding for compact elements.\n- `base`: Standard rounding for most use cases.\n- `large` / `large-100`: More pronounced rounding for prominent containers.\n- `max`: Maximum rounding, creating a pill or circular shape.\n\nSupports 1-to-4-value shorthand syntax for specifying different radii per corner.", "isOptional": true, "defaultValue": "'none'" }, @@ -19513,8 +19516,9 @@ "syntaxKind": "PropertySignature", "name": "borderWidth", "value": "MaybeAllValuesShorthandProperty | ''", - "description": "Controls the thickness of the border on all sides. When set, this overrides the width value specified in the `border` property.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) for specifying different widths per side:\n- One value: applies to all sides\n- Two values: applies to block sides (top/bottom) and inline sides (left/right) respectively\n- Three values: applies to block-start (top), inline sides (left/right), and block-end (bottom) respectively\n- Four values: applies to block-start (top), inline-end (right), block-end (bottom), and inline-start (left) respectively", - "isOptional": true + "description": "The thickness of the border on all sides. Supports 1-to-4-value shorthand syntax for specifying different widths per side. Overrides the width value set by `border`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" }, { "filePath": "src/surfaces/checkout/components/Box.ts", @@ -19682,7 +19686,7 @@ "syntaxKind": "PropertySignature", "name": "display", "value": "MaybeResponsive<\"auto\" | \"none\">", - "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.", + "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.\n\nLearn more about the [display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display).", "isOptional": true, "defaultValue": "'auto'" }, @@ -19951,7 +19955,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -21180,7 +21184,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/Box.ts", @@ -21436,7 +21440,7 @@ "src/surfaces/checkout/components/Button.ts": { "filePath": "src/surfaces/checkout/components/Button.ts", "name": "ButtonElementProps", - "description": "Properties for the button component element.", + "description": "", "isPublicDocs": true, "members": [ { @@ -21452,7 +21456,7 @@ "syntaxKind": "PropertySignature", "name": "command", "value": "'--auto' | '--show' | '--hide' | '--toggle' | '--copy'", - "description": "Sets the action the `commandFor` should take when this clickable is activated.\n\nSee the documentation of particular components for the actions they support.\n\n- `--auto`: Performs the default action for the target component.\n- `--show`: Displays the target component.\n- `--hide`: Conceals the target component.\n- `--toggle`: Alternates the target component.\n- `--copy`: Copies the target ClipboardItem.", + "description": "Sets the action the `commandFor` target should take when this component is activated.\n\n- `--auto`: Performs the default action for the target component.\n- `--show`: Displays the target component.\n- `--hide`: Conceals the target component.\n- `--toggle`: Alternates the target component.\n- `--copy`: Copies the target ClipboardItem.\n\nLearn more about the [`command` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).", "isOptional": true, "defaultValue": "'--auto'" }, @@ -21461,7 +21465,7 @@ "syntaxKind": "PropertySignature", "name": "commandFor", "value": "string", - "description": "ID of a component that should respond to activations (such as clicks) on this component.\n\nSee `command` for how to control the behavior of the target.", + "description": "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).\n\nWhen both `commandFor` and `href` are set, `commandFor` takes precedence. The command runs and the link doesn't navigate.", "isOptional": true }, { @@ -21486,7 +21490,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -21538,7 +21542,7 @@ "syntaxKind": "PropertySignature", "name": "type", "value": "'submit' | 'button'", - "description": "The behavioral type of the button component, which determines what action it performs when activated.\n\n- `submit`: Submits the closest form.\n- `button`: Performs no default action when activated.\n- `reset`: Resets the closest form (returning fields to their default values).\n\nThis property is ignored if the component supports `href` or `commandFor`/`command` and one of them is set.", + "description": "The behavioral type of the button component, which determines what action it performs when activated.\n\n- `submit`: Submits the nearest containing form.\n- `button`: Performs no default action, relying on the `click` event handler for behavior.\n\nThis property is ignored if `href` or `commandFor`/`command` is set.", "isOptional": true, "defaultValue": "'button'" }, @@ -21552,7 +21556,7 @@ "defaultValue": "'auto'" } ], - "value": "export interface ButtonElementProps extends Pick {\n target?: Extract;\n tone?: Extract;\n type?: Extract;\n variant?: Extract;\n}" + "value": "export interface ButtonElementProps extends Pick {\n target?: Extract;\n tone?: Extract;\n /**\n * The behavioral type of the button component, which determines what action it performs when activated.\n *\n * - `submit`: Submits the nearest containing form.\n * - `button`: Performs no default action, relying on the `click` event handler for behavior.\n *\n * This property is ignored if `href` or `commandFor`/`command` is set.\n *\n * @default 'button'\n */\n type?: Extract;\n variant?: Extract;\n}" } }, "ButtonEvents": { @@ -21578,7 +21582,7 @@ "src/surfaces/checkout/components/Button.ts": { "filePath": "src/surfaces/checkout/components/Button.ts", "name": "ButtonElementEvents", - "description": "The button component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", + "description": "", "isPublicDocs": true, "members": [ { @@ -21627,7 +21631,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", @@ -22201,7 +22205,7 @@ "syntaxKind": "PropertySignature", "name": "command", "value": "'--auto' | '--show' | '--hide' | '--toggle' | '--copy'", - "description": "Sets the action the `commandFor` should take when this clickable is activated.\n\nSee the documentation of particular components for the actions they support.\n\n- `--auto`: Performs the default action for the target component.\n- `--show`: Displays the target component.\n- `--hide`: Conceals the target component.\n- `--toggle`: Alternates the target component.\n- `--copy`: Copies the target ClipboardItem.", + "description": "Sets the action the `commandFor` target should take when this component is activated.\n\n- `--auto`: Performs the default action for the target component.\n- `--show`: Displays the target component.\n- `--hide`: Conceals the target component.\n- `--toggle`: Alternates the target component.\n- `--copy`: Copies the target ClipboardItem.\n\nLearn more about the [`command` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).", "isOptional": true, "defaultValue": "'--auto'" }, @@ -22210,7 +22214,7 @@ "syntaxKind": "PropertySignature", "name": "commandFor", "value": "string", - "description": "ID of a component that should respond to activations (such as clicks) on this component.\n\nSee `command` for how to control the behavior of the target.", + "description": "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).\n\nWhen both `commandFor` and `href` are set, `commandFor` takes precedence. The command runs and the link doesn't navigate.", "isOptional": true }, { @@ -22558,7 +22562,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -23696,7 +23700,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", @@ -23952,7 +23956,7 @@ "syntaxKind": "PropertySignature", "name": "type", "value": "'submit' | 'button'", - "description": "The behavioral type of the button component, which determines what action it performs when activated.\n\n- `submit`: Submits the closest form.\n- `button`: Performs no default action when activated.\n- `reset`: Resets the closest form (returning fields to their default values).\n\nThis property is ignored if the component supports `href` or `commandFor`/`command` and one of them is set.", + "description": "The behavioral type of the button component, which determines what action it performs when activated.\n\n- `submit`: Submits the nearest containing form.\n- `button`: Performs no default action, relying on the `click` event handler for behavior.\n\nThis property is ignored if `href` or `commandFor`/`command` is set.", "isOptional": true, "defaultValue": "'button'" }, @@ -24004,7 +24008,7 @@ "syntaxKind": "PropertySignature", "name": "command", "value": "'--auto' | '--show' | '--hide' | '--toggle' | '--copy'", - "description": "Sets the action the `commandFor` should take when this clickable is activated.\n\nSee the documentation of particular components for the actions they support.\n\n- `--auto`: Performs the default action for the target component.\n- `--show`: Displays the target component.\n- `--hide`: Conceals the target component.\n- `--toggle`: Alternates the target component.\n- `--copy`: Copies the target ClipboardItem.", + "description": "Sets the action the `commandFor` target should take when this component is activated.\n\n- `--auto`: Performs the default action for the target component.\n- `--show`: Displays the target component.\n- `--hide`: Conceals the target component.\n- `--toggle`: Alternates the target component.\n- `--copy`: Copies the target ClipboardItem.\n\nLearn more about the [`command` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).", "isOptional": true, "defaultValue": "'--auto'" }, @@ -24013,7 +24017,7 @@ "syntaxKind": "PropertySignature", "name": "commandFor", "value": "string", - "description": "ID of a component that should respond to activations (such as clicks) on this component.\n\nSee `command` for how to control the behavior of the target.", + "description": "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).\n\nWhen both `commandFor` and `href` are set, `commandFor` takes precedence. The command runs and the link doesn't navigate.", "isOptional": true }, { @@ -24038,7 +24042,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -24098,7 +24102,7 @@ "syntaxKind": "PropertySignature", "name": "type", "value": "'submit' | 'button'", - "description": "The behavioral type of the button component, which determines what action it performs when activated.\n\n- `submit`: Submits the closest form.\n- `button`: Performs no default action when activated.\n- `reset`: Resets the closest form (returning fields to their default values).\n\nThis property is ignored if the component supports `href` or `commandFor`/`command` and one of them is set.", + "description": "The behavioral type of the button component, which determines what action it performs when activated.\n\n- `submit`: Submits the nearest containing form.\n- `button`: Performs no default action, relying on the `click` event handler for behavior.\n\nThis property is ignored if `href` or `commandFor`/`command` is set.", "isOptional": true, "defaultValue": "'button'" }, @@ -24119,7 +24123,7 @@ "src/surfaces/checkout/components/Checkbox.ts": { "filePath": "src/surfaces/checkout/components/Checkbox.ts", "name": "CheckboxElementProps", - "description": "Properties for the Checkbox component element.", + "description": "", "isPublicDocs": true, "members": [ { @@ -24135,7 +24139,7 @@ "syntaxKind": "PropertySignature", "name": "checked", "value": "boolean", - "description": "Whether the control is active.", + "description": "Whether the control is currently checked.", "isOptional": true, "defaultValue": "false" }, @@ -24144,7 +24148,7 @@ "syntaxKind": "PropertySignature", "name": "command", "value": "'--auto' | '--show' | '--hide' | '--toggle'", - "description": "Sets the action the `commandFor` should take when this clickable is activated.\n\nSee the documentation of particular components for the actions they support.\n\n- `--auto`: Performs the default action for the target component.\n- `--show`: Displays the target component.\n- `--hide`: Conceals the target component.\n- `--toggle`: Alternates the target component.\n- `--copy`: Copies the target ClipboardItem.", + "description": "Sets the action the `commandFor` target should take when this component is activated.\n\n- `--auto`: Performs the default action for the target component.\n- `--show`: Displays the target component.\n- `--hide`: Conceals the target component.\n- `--toggle`: Alternates the target component.\n- `--copy`: Copies the target ClipboardItem.\n\nLearn more about the [`command` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).", "isOptional": true, "defaultValue": "'--auto'" }, @@ -24153,7 +24157,7 @@ "syntaxKind": "PropertySignature", "name": "commandFor", "value": "string", - "description": "ID of a component that should respond to activations (such as clicks) on this component.\n\nSee `command` for how to control the behavior of the target.", + "description": "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).\n\nWhen both `commandFor` and `href` are set, `commandFor` takes precedence. The command runs and the link doesn't navigate.", "isOptional": true }, { @@ -24161,7 +24165,7 @@ "syntaxKind": "PropertySignature", "name": "defaultChecked", "value": "boolean", - "description": "Whether the control is active by default.", + "description": "Whether the control is checked by default.", "isOptional": true, "defaultValue": "false" }, @@ -24170,7 +24174,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the control, disallowing any interaction.", + "description": "Whether the control is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -24179,7 +24183,7 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -24187,7 +24191,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -24195,7 +24199,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Visual content to use as the control label.", + "description": "The visual content to use as the control label. Use a string to provide a simple text label displayed to the user.\n\nIf a `label` slot is also provided, the slot content takes precedence. [Learn more about slots](/docs/api/{API_NAME}/{API_VERSION}/web-components/forms/checkbox#slots-propertydetail-label).", "isOptional": true }, { @@ -24203,7 +24207,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the control that is unique within the nearest containing `Form` component.", + "description": "The name attribute for the control, used to identify its value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -24211,7 +24215,7 @@ "syntaxKind": "PropertySignature", "name": "required", "value": "boolean", - "description": "Whether the field needs a value. This requirement adds semantic value to the field, but it will not cause an error to appear automatically. If you want to present an error when this field is empty, you can do so with the `error` property.", + "description": "Whether the field needs a value. This requirement adds semantic value to the field, but it will not cause an error to appear automatically. If you want to present an error when this field is empty, you can do so with the `error` property.\n\nAdds semantic meaning for accessibility. Doesn't trigger automatic validation or display an error. Implement validation logic yourself and use the `error` prop to show results.", "isOptional": true, "defaultValue": "false" }, @@ -24224,7 +24228,7 @@ "isOptional": true } ], - "value": "export interface CheckboxElementProps extends Pick {\n command?: Extract;\n}" + "value": "export interface CheckboxElementProps extends Pick {\n command?: Extract;\n /**\n * The visual content to use as the control label. Use a string to provide a simple text label displayed to the user.\n *\n * If a `label` slot is also provided, the slot content takes precedence. [Learn more about slots](/docs/api/{API_NAME}/{API_VERSION}/web-components/forms/checkbox#slots-propertydetail-label).\n */\n label?: string;\n}" } }, "CheckboxEvents": { @@ -24250,7 +24254,7 @@ "src/surfaces/checkout/components/Checkbox.ts": { "filePath": "src/surfaces/checkout/components/Checkbox.ts", "name": "CheckboxElementEvents", - "description": "Events for the Checkbox component element.", + "description": "", "isPublicDocs": true, "members": [ { @@ -24258,11 +24262,11 @@ "syntaxKind": "PropertySignature", "name": "change", "value": "CallbackEventListener", - "description": "A callback that is run whenever the control is changed.", + "description": "A callback fired when the checkbox value changes.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", "isOptional": true } ], - "value": "export interface CheckboxElementEvents {\n /**\n * A callback that is run whenever the control is changed.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event\n */\n change?: CallbackEventListener;\n}" + "value": "export interface CheckboxElementEvents {\n /**\n * A callback fired when the checkbox value changes.\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change?: CallbackEventListener;\n}" } }, "CheckboxElement": { @@ -24299,7 +24303,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/Checkbox.ts", @@ -24782,7 +24786,7 @@ "syntaxKind": "PropertySignature", "name": "checked", "value": "boolean", - "description": "Whether the control is active.", + "description": "Whether the control is currently checked.", "isOptional": true, "defaultValue": "false" }, @@ -24882,7 +24886,7 @@ "syntaxKind": "PropertySignature", "name": "command", "value": "'--auto' | '--show' | '--hide' | '--toggle'", - "description": "Sets the action the `commandFor` should take when this clickable is activated.\n\nSee the documentation of particular components for the actions they support.\n\n- `--auto`: Performs the default action for the target component.\n- `--show`: Displays the target component.\n- `--hide`: Conceals the target component.\n- `--toggle`: Alternates the target component.\n- `--copy`: Copies the target ClipboardItem.", + "description": "Sets the action the `commandFor` target should take when this component is activated.\n\n- `--auto`: Performs the default action for the target component.\n- `--show`: Displays the target component.\n- `--hide`: Conceals the target component.\n- `--toggle`: Alternates the target component.\n- `--copy`: Copies the target ClipboardItem.\n\nLearn more about the [`command` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).", "isOptional": true, "defaultValue": "'--auto'" }, @@ -24891,7 +24895,7 @@ "syntaxKind": "PropertySignature", "name": "commandFor", "value": "string", - "description": "ID of a component that should respond to activations (such as clicks) on this component.\n\nSee `command` for how to control the behavior of the target.", + "description": "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).\n\nWhen both `commandFor` and `href` are set, `commandFor` takes precedence. The command runs and the link doesn't navigate.", "isOptional": true }, { @@ -24948,7 +24952,7 @@ "syntaxKind": "PropertySignature", "name": "defaultChecked", "value": "boolean", - "description": "Whether the control is active by default.", + "description": "Whether the control is checked by default.", "isOptional": true, "defaultValue": "false" }, @@ -24964,7 +24968,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the control, disallowing any interaction.", + "description": "Whether the control is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -25078,7 +25082,7 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -25248,7 +25252,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -25347,7 +25351,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Visual content to use as the control label.", + "description": "The visual content to use as the control label. Use a string to provide a simple text label displayed to the user.\n\nIf a `label` slot is also provided, the slot content takes precedence. [Learn more about slots](/docs/api/{API_NAME}/{API_VERSION}/web-components/forms/checkbox#slots-propertydetail-label).", "isOptional": true }, { @@ -25404,7 +25408,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the control that is unique within the nearest containing `Form` component.", + "description": "The name attribute for the control, used to identify its value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -26376,7 +26380,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/Checkbox.ts", @@ -26418,7 +26422,7 @@ "syntaxKind": "PropertySignature", "name": "required", "value": "boolean", - "description": "Whether the field needs a value. This requirement adds semantic value to the field, but it will not cause an error to appear automatically. If you want to present an error when this field is empty, you can do so with the `error` property.", + "description": "Whether the field needs a value. This requirement adds semantic value to the field, but it will not cause an error to appear automatically. If you want to present an error when this field is empty, you can do so with the `error` property.\n\nAdds semantic meaning for accessibility. Doesn't trigger automatic validation or display an error. Implement validation logic yourself and use the `error` prop to show results.", "isOptional": true, "defaultValue": "false" }, @@ -26645,6 +26649,25 @@ "value": "export interface CheckboxElement extends CheckboxElementProps, Omit {\n onchange: CheckboxEvents['onChange'];\n}" } }, + "CheckboxElementSlots": { + "src/surfaces/checkout/components/Checkbox.ts": { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "name": "CheckboxElementSlots", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "label", + "value": "HTMLElement", + "description": "The visual content to use as the control label.\n\nUse an `HTMLElement` as a rich control label composed of elements. Only an `s-text` element is supported with plain text and `s-link` as its only allowed children. Any other elements are stripped while preserving their text content.", + "isOptional": true + } + ], + "value": "export interface CheckboxElementSlots {\n /**\n * The visual content to use as the control label.\n *\n * Use an `HTMLElement` as a rich control label composed of elements. Only an `s-text` element is supported with plain text and `s-link` as its only allowed children. Any other elements are stripped while preserving their text content.\n */\n label?: HTMLElement;\n}" + } + }, "CheckboxProps": { "src/surfaces/checkout/components/Checkbox.ts": { "filePath": "src/surfaces/checkout/components/Checkbox.ts", @@ -26665,7 +26688,7 @@ "syntaxKind": "PropertySignature", "name": "checked", "value": "boolean", - "description": "Whether the control is active.", + "description": "Whether the control is currently checked.", "isOptional": true, "defaultValue": "false" }, @@ -26674,7 +26697,7 @@ "syntaxKind": "PropertySignature", "name": "command", "value": "'--auto' | '--show' | '--hide' | '--toggle'", - "description": "Sets the action the `commandFor` should take when this clickable is activated.\n\nSee the documentation of particular components for the actions they support.\n\n- `--auto`: Performs the default action for the target component.\n- `--show`: Displays the target component.\n- `--hide`: Conceals the target component.\n- `--toggle`: Alternates the target component.\n- `--copy`: Copies the target ClipboardItem.", + "description": "Sets the action the `commandFor` target should take when this component is activated.\n\n- `--auto`: Performs the default action for the target component.\n- `--show`: Displays the target component.\n- `--hide`: Conceals the target component.\n- `--toggle`: Alternates the target component.\n- `--copy`: Copies the target ClipboardItem.\n\nLearn more about the [`command` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).", "isOptional": true, "defaultValue": "'--auto'" }, @@ -26683,7 +26706,7 @@ "syntaxKind": "PropertySignature", "name": "commandFor", "value": "string", - "description": "ID of a component that should respond to activations (such as clicks) on this component.\n\nSee `command` for how to control the behavior of the target.", + "description": "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).\n\nWhen both `commandFor` and `href` are set, `commandFor` takes precedence. The command runs and the link doesn't navigate.", "isOptional": true }, { @@ -26691,7 +26714,7 @@ "syntaxKind": "PropertySignature", "name": "defaultChecked", "value": "boolean", - "description": "Whether the control is active by default.", + "description": "Whether the control is checked by default.", "isOptional": true, "defaultValue": "false" }, @@ -26700,7 +26723,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the control, disallowing any interaction.", + "description": "Whether the control is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -26709,7 +26732,7 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -26717,7 +26740,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -26725,7 +26748,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Visual content to use as the control label.", + "description": "The visual content to use as the control label. Use a string to provide a simple text label displayed to the user.\n\nIf a `label` slot is also provided, the slot content takes precedence. [Learn more about slots](/docs/api/{API_NAME}/{API_VERSION}/web-components/forms/checkbox#slots-propertydetail-label).", "isOptional": true }, { @@ -26733,7 +26756,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the control that is unique within the nearest containing `Form` component.", + "description": "The name attribute for the control, used to identify its value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -26749,7 +26772,7 @@ "syntaxKind": "PropertySignature", "name": "required", "value": "boolean", - "description": "Whether the field needs a value. This requirement adds semantic value to the field, but it will not cause an error to appear automatically. If you want to present an error when this field is empty, you can do so with the `error` property.", + "description": "Whether the field needs a value. This requirement adds semantic value to the field, but it will not cause an error to appear automatically. If you want to present an error when this field is empty, you can do so with the `error` property.\n\nAdds semantic meaning for accessibility. Doesn't trigger automatic validation or display an error. Implement validation logic yourself and use the `error` prop to show results.", "isOptional": true, "defaultValue": "false" }, @@ -26769,7 +26792,7 @@ "src/surfaces/checkout/components/Chip.ts": { "filePath": "src/surfaces/checkout/components/Chip.ts", "name": "ChipElementProps", - "description": "Properties for the Chip component element.", + "description": "", "isPublicDocs": true, "members": [ { @@ -26777,7 +26800,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityLabel", "value": "string", - "description": "A label that describes the purpose or contents of the chip. It will be read to users using assistive technologies such as screen readers.", + "description": "A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.", "isOptional": true }, { @@ -26785,7 +26808,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true } ], @@ -26796,7 +26819,7 @@ "src/surfaces/checkout/components/Chip.ts": { "filePath": "src/surfaces/checkout/components/Chip.ts", "name": "ChipElementSlots", - "description": "Slots for the Chip component element.", + "description": "", "isPublicDocs": true, "members": [ { @@ -26804,11 +26827,11 @@ "syntaxKind": "PropertySignature", "name": "graphic", "value": "HTMLElement", - "description": "The graphic to display inside of the chip.\n\nOnly `s-icon` element and its `type` attribute are supported.", + "description": "An optional graphic displayed at the start of the chip, such as an icon to visually reinforce the chip's label. Only the `s-icon` element and its `type` attribute are supported.", "isOptional": true } ], - "value": "export interface ChipElementSlots {\n /**\n * The graphic to display inside of the chip.\n *\n * Only `s-icon` element and its `type` attribute are supported.\n */\n graphic?: HTMLElement;\n}" + "value": "export interface ChipElementSlots {\n /**\n * An optional graphic displayed at the start of the chip, such as an icon to visually reinforce the chip's label. Only the `s-icon` element and its `type` attribute are supported.\n */\n graphic?: HTMLElement;\n}" } }, "ChipProps": { @@ -26823,7 +26846,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityLabel", "value": "string", - "description": "A label that describes the purpose or contents of the chip. It will be read to users using assistive technologies such as screen readers.", + "description": "A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.", "isOptional": true }, { @@ -26831,7 +26854,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true } ], @@ -26850,7 +26873,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityLabel", "value": "string", - "description": "A label that describes the purpose or contents of the chip. It will be read to users using assistive technologies such as screen readers.", + "description": "A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.", "isOptional": true }, { @@ -26872,7 +26895,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/Chip.ts", @@ -27769,7 +27792,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -28881,7 +28904,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/Chip.ts", @@ -29137,7 +29160,7 @@ "src/surfaces/checkout/components/Choice.ts": { "filePath": "src/surfaces/checkout/components/Choice.ts", "name": "ChoiceElementProps", - "description": "The choice component creates individual selectable options within a choice list. Use choice to define each option that merchants can select, supporting both single selection (radio buttons) and multiple selection (checkboxes) modes.\n\nChoice components support labels, help text, and custom content through slots, providing flexible option presentation within choice lists.", + "description": "", "isPublicDocs": true, "members": [ { @@ -29153,7 +29176,7 @@ "syntaxKind": "PropertySignature", "name": "defaultSelected", "value": "boolean", - "description": "Whether the control is active by default.", + "description": "Whether the control is selected by default.", "isOptional": true, "defaultValue": "false" }, @@ -29162,7 +29185,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the control, disallowing any interaction.", + "description": "Whether the control is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -29171,7 +29194,7 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "boolean", - "description": "Set to `true` to associate a choice with the error passed to `ChoiceList`", + "description": "Whether this choice is associated with the error state of the parent choice list. When `true`, the choice is visually marked as having an error.", "isOptional": true, "defaultValue": "false" }, @@ -29180,7 +29203,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -29188,7 +29211,7 @@ "syntaxKind": "PropertySignature", "name": "selected", "value": "boolean", - "description": "Whether the control is active.", + "description": "Whether the control is currently selected.", "isOptional": true, "defaultValue": "false" }, @@ -29208,7 +29231,7 @@ "src/surfaces/checkout/components/Choice.ts": { "filePath": "src/surfaces/checkout/components/Choice.ts", "name": "ChoiceElementSlots", - "description": "Learn more about [component slots](/docs/api/checkout-ui-extensions/latest/using-polaris-components#slots).", + "description": "", "isPublicDocs": true, "members": [ { @@ -29273,7 +29296,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/Choice.ts", @@ -29896,7 +29919,7 @@ "syntaxKind": "PropertySignature", "name": "defaultSelected", "value": "boolean", - "description": "Whether the control is active by default.", + "description": "Whether the control is selected by default.", "isOptional": true, "defaultValue": "false" }, @@ -29912,7 +29935,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the control, disallowing any interaction.", + "description": "Whether the control is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -30026,7 +30049,7 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "boolean", - "description": "Set to `true` to associate a choice with the error passed to `ChoiceList`", + "description": "Whether this choice is associated with the error state of the parent choice list. When `true`, the choice is visually marked as having an error.", "isOptional": true, "defaultValue": "false" }, @@ -30197,7 +30220,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -31309,7 +31332,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/Choice.ts", @@ -31414,7 +31437,7 @@ "syntaxKind": "PropertySignature", "name": "selected", "value": "boolean", - "description": "Whether the control is active.", + "description": "Whether the control is currently selected.", "isOptional": true, "defaultValue": "false" }, @@ -31598,7 +31621,7 @@ "syntaxKind": "PropertySignature", "name": "defaultSelected", "value": "boolean", - "description": "Whether the control is active by default.", + "description": "Whether the control is selected by default.", "isOptional": true, "defaultValue": "false" }, @@ -31607,7 +31630,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the control, disallowing any interaction.", + "description": "Whether the control is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -31616,7 +31639,7 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "boolean", - "description": "Set to `true` to associate a choice with the error passed to `ChoiceList`", + "description": "Whether this choice is associated with the error state of the parent choice list. When `true`, the choice is visually marked as having an error.", "isOptional": true, "defaultValue": "false" }, @@ -31625,7 +31648,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -31633,7 +31656,7 @@ "syntaxKind": "PropertySignature", "name": "selected", "value": "boolean", - "description": "Whether the control is active.", + "description": "Whether the control is currently selected.", "isOptional": true, "defaultValue": "false" }, @@ -31653,7 +31676,7 @@ "src/surfaces/checkout/components/ChoiceList.ts": { "filePath": "src/surfaces/checkout/components/ChoiceList.ts", "name": "ChoiceListElementProps", - "description": "The choice list component presents multiple options for single or multiple selections. Use it when merchants need to choose from a defined set of options, such as filtering results or collecting preferences.\n\nThe component supports both single selection (radio button behavior) and multiple selection (checkbox behavior) modes. It includes configurable labels, help text, and validation. For compact dropdown selection with four or more options, use [select](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/forms/select).", + "description": "", "isPublicDocs": true, "members": [ { @@ -31661,7 +31684,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.\n\n`disabled` on any child choices is ignored when this is true.", + "description": "Whether the field is disabled, preventing any user interaction.\n\n`disabled` on any child choices is ignored when this is true.", "isOptional": true, "defaultValue": "false" }, @@ -31670,7 +31693,7 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -31678,7 +31701,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -31686,7 +31709,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Content to use as the field label.", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", "isOptional": true }, { @@ -31694,7 +31717,7 @@ "syntaxKind": "PropertySignature", "name": "labelAccessibilityVisibility", "value": "'visible' | 'exclusive'", - "description": "Changes the visibility of the component's label.\n\n- `visible`: the label is visible to all users.\n- `exclusive`: the label is visually hidden but remains in the accessibility tree.", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone.\n- `exclusive`: The label is visually hidden but still announced by screen readers.", "isOptional": true, "defaultValue": "'visible'" }, @@ -31712,7 +31735,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -31720,7 +31743,7 @@ "syntaxKind": "PropertySignature", "name": "values", "value": "string[]", - "description": "An array of the `value`s of the selected options.\n\nThis is a convenience prop for setting the `selected` prop on child options.", + "description": "An array of `value` attributes for the currently selected options.\n\nThis is a convenience prop for setting the `selected` prop on child options.\n\nForm data captures the selected value strings only. Complex nested content inside choices is for display purposes and isn't included in form submissions.", "isOptional": true }, { @@ -31728,7 +31751,7 @@ "syntaxKind": "PropertySignature", "name": "variant", "value": "'auto' | 'list' | 'inline' | 'block' | 'grid'", - "description": "The variant of the choice grid.\n\n- `auto`: The variant is determined by the context.\n- `list`: The choices are displayed in a list.\n- `inline`: The choices are displayed on the inline axis.\n- `block`: The choices are displayed on the block axis.\n- `grid`: The choices are displayed in a grid.", + "description": "The variant of the choice grid.\n\n- `auto`: The variant is determined by the context.\n- `list`: The choices are displayed in a list.\n- `inline`: The choices are displayed on the inline axis.\n- `block`: The choices are displayed on the block axis.\n- `grid`: The choices are displayed in a grid.\n\nThe selected content slot is supported only in the default (stacked) variant. `inline` and `grid` ignore it.", "isOptional": true, "defaultValue": "'auto'" } @@ -31748,7 +31771,7 @@ "syntaxKind": "PropertySignature", "name": "onChange", "value": "(event: Event) => void", - "description": "Callback when the user has selected option(s).", + "description": "A callback fired when the user has selected one or more options.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", "isOptional": true } ], @@ -31759,7 +31782,7 @@ "src/surfaces/checkout/components/ChoiceList.ts": { "filePath": "src/surfaces/checkout/components/ChoiceList.ts", "name": "ChoiceListElementEvents", - "description": "Learn more about [registering events](/docs/api/checkout-ui-extensions/latest/using-polaris-components#event-handling).", + "description": "", "isPublicDocs": true, "members": [ { @@ -31767,11 +31790,11 @@ "syntaxKind": "PropertySignature", "name": "change", "value": "CallbackEventListener", - "description": "A callback that is run whenever the control is changed.", + "description": "A callback fired when the choice list value changes.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", "isOptional": true } ], - "value": "export interface ChoiceListElementEvents {\n /**\n * A callback that is run whenever the control is changed.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event\n */\n change?: CallbackEventListener;\n}" + "value": "export interface ChoiceListElementEvents {\n /**\n * A callback fired when the choice list value changes.\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change?: CallbackEventListener;\n}" } }, "ChoiceListElement": { @@ -31800,7 +31823,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/ChoiceList.ts", @@ -32430,7 +32453,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.\n\n`disabled` on any child choices is ignored when this is true.", + "description": "Whether the field is disabled, preventing any user interaction.\n\n`disabled` on any child choices is ignored when this is true.", "isOptional": true, "defaultValue": "false" }, @@ -32544,7 +32567,7 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -32714,7 +32737,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -32813,7 +32836,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Content to use as the field label.", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", "isOptional": true }, { @@ -32821,7 +32844,7 @@ "syntaxKind": "PropertySignature", "name": "labelAccessibilityVisibility", "value": "'visible' | 'exclusive'", - "description": "Changes the visibility of the component's label.\n\n- `visible`: the label is visible to all users.\n- `exclusive`: the label is visually hidden but remains in the accessibility tree.", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone.\n- `exclusive`: The label is visually hidden but still announced by screen readers.", "isOptional": true, "defaultValue": "'visible'" }, @@ -32888,7 +32911,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -33860,7 +33883,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/ChoiceList.ts", @@ -34098,7 +34121,7 @@ "syntaxKind": "PropertySignature", "name": "values", "value": "string[]", - "description": "An array of the `value`s of the selected options.\n\nThis is a convenience prop for setting the `selected` prop on child options.", + "description": "An array of `value` attributes for the currently selected options.\n\nThis is a convenience prop for setting the `selected` prop on child options.\n\nForm data captures the selected value strings only. Complex nested content inside choices is for display purposes and isn't included in form submissions.", "isOptional": true }, { @@ -34106,7 +34129,7 @@ "syntaxKind": "PropertySignature", "name": "variant", "value": "'auto' | 'list' | 'inline' | 'block' | 'grid'", - "description": "The variant of the choice grid.\n\n- `auto`: The variant is determined by the context.\n- `list`: The choices are displayed in a list.\n- `inline`: The choices are displayed on the inline axis.\n- `block`: The choices are displayed on the block axis.\n- `grid`: The choices are displayed in a grid.", + "description": "The variant of the choice grid.\n\n- `auto`: The variant is determined by the context.\n- `list`: The choices are displayed in a list.\n- `inline`: The choices are displayed on the inline axis.\n- `block`: The choices are displayed on the block axis.\n- `grid`: The choices are displayed in a grid.\n\nThe selected content slot is supported only in the default (stacked) variant. `inline` and `grid` ignore it.", "isOptional": true, "defaultValue": "'auto'" }, @@ -34141,7 +34164,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.\n\n`disabled` on any child choices is ignored when this is true.", + "description": "Whether the field is disabled, preventing any user interaction.\n\n`disabled` on any child choices is ignored when this is true.", "isOptional": true, "defaultValue": "false" }, @@ -34150,7 +34173,7 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -34158,7 +34181,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -34166,7 +34189,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Content to use as the field label.", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", "isOptional": true }, { @@ -34174,7 +34197,7 @@ "syntaxKind": "PropertySignature", "name": "labelAccessibilityVisibility", "value": "'visible' | 'exclusive'", - "description": "Changes the visibility of the component's label.\n\n- `visible`: the label is visible to all users.\n- `exclusive`: the label is visually hidden but remains in the accessibility tree.", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone.\n- `exclusive`: The label is visually hidden but still announced by screen readers.", "isOptional": true, "defaultValue": "'visible'" }, @@ -34192,7 +34215,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -34200,7 +34223,7 @@ "syntaxKind": "PropertySignature", "name": "onChange", "value": "(event: Event) => void", - "description": "Callback when the user has selected option(s).", + "description": "A callback fired when the user has selected one or more options.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", "isOptional": true }, { @@ -34208,7 +34231,7 @@ "syntaxKind": "PropertySignature", "name": "values", "value": "string[]", - "description": "An array of the `value`s of the selected options.\n\nThis is a convenience prop for setting the `selected` prop on child options.", + "description": "An array of `value` attributes for the currently selected options.\n\nThis is a convenience prop for setting the `selected` prop on child options.\n\nForm data captures the selected value strings only. Complex nested content inside choices is for display purposes and isn't included in form submissions.", "isOptional": true }, { @@ -34216,7 +34239,7 @@ "syntaxKind": "PropertySignature", "name": "variant", "value": "'auto' | 'list' | 'inline' | 'block' | 'grid'", - "description": "The variant of the choice grid.\n\n- `auto`: The variant is determined by the context.\n- `list`: The choices are displayed in a list.\n- `inline`: The choices are displayed on the inline axis.\n- `block`: The choices are displayed on the block axis.\n- `grid`: The choices are displayed in a grid.", + "description": "The variant of the choice grid.\n\n- `auto`: The variant is determined by the context.\n- `list`: The choices are displayed in a list.\n- `inline`: The choices are displayed on the inline axis.\n- `block`: The choices are displayed on the block axis.\n- `grid`: The choices are displayed in a grid.\n\nThe selected content slot is supported only in the default (stacked) variant. `inline` and `grid` ignore it.", "isOptional": true, "defaultValue": "'auto'" } @@ -34244,7 +34267,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityVisibility", "value": "'visible' | 'hidden' | 'exclusive'", - "description": "Changes the visibility of the element.\n\n- `visible`: the element is visible to all users.\n- `hidden`: the element is removed from the accessibility tree but remains visible.\n- `exclusive`: the element is visually hidden but remains in the accessibility tree.", + "description": "Controls how the element is exposed to sighted users and to assistive technologies such as screen readers.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", "isOptional": true, "defaultValue": "'visible'" }, @@ -34319,7 +34342,7 @@ "syntaxKind": "PropertySignature", "name": "command", "value": "'--auto' | '--show' | '--hide' | '--toggle' | '--copy'", - "description": "Sets the action the `commandFor` should take when this clickable is activated.\n\nSee the documentation of particular components for the actions they support.\n\n- `--auto`: Performs the default action for the target component.\n- `--show`: Displays the target component.\n- `--hide`: Conceals the target component.\n- `--toggle`: Alternates the target component.\n- `--copy`: Copies the target ClipboardItem.", + "description": "Sets the action the `commandFor` target should take when this component is activated.\n\n- `--auto`: Performs the default action for the target component.\n- `--show`: Displays the target component.\n- `--hide`: Conceals the target component.\n- `--toggle`: Alternates the target component.\n- `--copy`: Copies the target ClipboardItem.\n\nLearn more about the [`command` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).", "isOptional": true, "defaultValue": "'--auto'" }, @@ -34328,7 +34351,7 @@ "syntaxKind": "PropertySignature", "name": "commandFor", "value": "string", - "description": "ID of a component that should respond to activations (such as clicks) on this component.\n\nSee `command` for how to control the behavior of the target.", + "description": "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).\n\nWhen both `commandFor` and `href` are set, `commandFor` takes precedence. The command runs and the link doesn't navigate.", "isOptional": true }, { @@ -34345,7 +34368,7 @@ "syntaxKind": "PropertySignature", "name": "display", "value": "MaybeResponsive<\"auto\" | \"none\">", - "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.", + "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.\n\nLearn more about the [display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display).", "isOptional": true, "defaultValue": "'auto'" }, @@ -34362,7 +34385,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -34522,12 +34545,12 @@ "syntaxKind": "PropertySignature", "name": "type", "value": "'submit' | 'button'", - "description": "The behavioral type of the button component, which determines what action it performs when activated.\n\n- `submit`: Submits the closest form.\n- `button`: Performs no default action when activated.\n- `reset`: Resets the closest form (returning fields to their default values).\n\nThis property is ignored if the component supports `href` or `commandFor`/`command` and one of them is set.", + "description": "The behavioral type of the clickable component, which determines what action it performs when activated.\n\n- `submit`: Submits the nearest containing form.\n- `button`: Performs no default action, relying on the `click` event handler for behavior.\n\nThis property is ignored if `href` or `commandFor`/`command` is set.", "isOptional": true, "defaultValue": "'button'" } ], - "value": "export interface ClickableElementProps extends Pick {\n background?: Extract;\n border?: BorderShorthand;\n borderWidth?: MaybeAllValuesShorthandProperty | '';\n borderRadius?: MaybeAllValuesShorthandProperty>;\n target?: Extract;\n type?: Extract;\n}" + "value": "export interface ClickableElementProps extends Pick {\n background?: Extract;\n border?: BorderShorthand;\n borderWidth?: MaybeAllValuesShorthandProperty | '';\n borderRadius?: MaybeAllValuesShorthandProperty>;\n target?: Extract;\n /**\n * The behavioral type of the clickable component, which determines what action it performs when activated.\n *\n * - `submit`: Submits the nearest containing form.\n * - `button`: Performs no default action, relying on the `click` event handler for behavior.\n *\n * This property is ignored if `href` or `commandFor`/`command` is set.\n *\n * @default 'button'\n */\n type?: Extract;\n}" } }, "ClickableProps": { @@ -34550,7 +34573,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityVisibility", "value": "'visible' | 'hidden' | 'exclusive'", - "description": "Changes the visibility of the element.\n\n- `visible`: the element is visible to all users.\n- `hidden`: the element is removed from the accessibility tree but remains visible.\n- `exclusive`: the element is visually hidden but remains in the accessibility tree.", + "description": "Controls how the element is exposed to sighted users and to assistive technologies such as screen readers.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", "isOptional": true, "defaultValue": "'visible'" }, @@ -34611,7 +34634,7 @@ "syntaxKind": "PropertySignature", "name": "command", "value": "'--auto' | '--show' | '--hide' | '--toggle' | '--copy'", - "description": "Sets the action the `commandFor` should take when this clickable is activated.\n\nSee the documentation of particular components for the actions they support.\n\n- `--auto`: Performs the default action for the target component.\n- `--show`: Displays the target component.\n- `--hide`: Conceals the target component.\n- `--toggle`: Alternates the target component.\n- `--copy`: Copies the target ClipboardItem.", + "description": "Sets the action the `commandFor` target should take when this component is activated.\n\n- `--auto`: Performs the default action for the target component.\n- `--show`: Displays the target component.\n- `--hide`: Conceals the target component.\n- `--toggle`: Alternates the target component.\n- `--copy`: Copies the target ClipboardItem.\n\nLearn more about the [`command` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).", "isOptional": true, "defaultValue": "'--auto'" }, @@ -34620,7 +34643,7 @@ "syntaxKind": "PropertySignature", "name": "commandFor", "value": "string", - "description": "ID of a component that should respond to activations (such as clicks) on this component.\n\nSee `command` for how to control the behavior of the target.", + "description": "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).\n\nWhen both `commandFor` and `href` are set, `commandFor` takes precedence. The command runs and the link doesn't navigate.", "isOptional": true }, { @@ -34637,7 +34660,7 @@ "syntaxKind": "PropertySignature", "name": "display", "value": "MaybeResponsive<\"auto\" | \"none\">", - "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.", + "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.\n\nLearn more about the [display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display).", "isOptional": true, "defaultValue": "'auto'" }, @@ -34654,7 +34677,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -34838,7 +34861,7 @@ "syntaxKind": "PropertySignature", "name": "type", "value": "'submit' | 'button'", - "description": "The behavioral type of the button component, which determines what action it performs when activated.\n\n- `submit`: Submits the closest form.\n- `button`: Performs no default action when activated.\n- `reset`: Resets the closest form (returning fields to their default values).\n\nThis property is ignored if the component supports `href` or `commandFor`/`command` and one of them is set.", + "description": "The behavioral type of the clickable component, which determines what action it performs when activated.\n\n- `submit`: Submits the nearest containing form.\n- `button`: Performs no default action, relying on the `click` event handler for behavior.\n\nThis property is ignored if `href` or `commandFor`/`command` is set.", "isOptional": true, "defaultValue": "'button'" } @@ -34885,7 +34908,7 @@ "src/surfaces/checkout/components/Clickable.ts": { "filePath": "src/surfaces/checkout/components/Clickable.ts", "name": "ClickableElementEvents", - "description": "The clickable component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", + "description": "", "isPublicDocs": true, "members": [ { @@ -34936,7 +34959,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityVisibility", "value": "'visible' | 'hidden' | 'exclusive'", - "description": "Changes the visibility of the element.\n\n- `visible`: the element is visible to all users.\n- `hidden`: the element is removed from the accessibility tree but remains visible.\n- `exclusive`: the element is visually hidden but remains in the accessibility tree.", + "description": "Controls how the element is exposed to sighted users and to assistive technologies such as screen readers.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", "isOptional": true, "defaultValue": "'visible'" }, @@ -34959,7 +34982,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/Clickable.ts", @@ -35585,7 +35608,7 @@ "syntaxKind": "PropertySignature", "name": "command", "value": "'--auto' | '--show' | '--hide' | '--toggle' | '--copy'", - "description": "Sets the action the `commandFor` should take when this clickable is activated.\n\nSee the documentation of particular components for the actions they support.\n\n- `--auto`: Performs the default action for the target component.\n- `--show`: Displays the target component.\n- `--hide`: Conceals the target component.\n- `--toggle`: Alternates the target component.\n- `--copy`: Copies the target ClipboardItem.", + "description": "Sets the action the `commandFor` target should take when this component is activated.\n\n- `--auto`: Performs the default action for the target component.\n- `--show`: Displays the target component.\n- `--hide`: Conceals the target component.\n- `--toggle`: Alternates the target component.\n- `--copy`: Copies the target ClipboardItem.\n\nLearn more about the [`command` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).", "isOptional": true, "defaultValue": "'--auto'" }, @@ -35594,7 +35617,7 @@ "syntaxKind": "PropertySignature", "name": "commandFor", "value": "string", - "description": "ID of a component that should respond to activations (such as clicks) on this component.\n\nSee `command` for how to control the behavior of the target.", + "description": "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).\n\nWhen both `commandFor` and `href` are set, `commandFor` takes precedence. The command runs and the link doesn't navigate.", "isOptional": true }, { @@ -35674,7 +35697,7 @@ "syntaxKind": "PropertySignature", "name": "display", "value": "MaybeResponsive<\"auto\" | \"none\">", - "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.", + "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.\n\nLearn more about the [display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display).", "isOptional": true, "defaultValue": "'auto'" }, @@ -35951,7 +35974,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -37199,7 +37222,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/Clickable.ts", @@ -37446,7 +37469,7 @@ "syntaxKind": "PropertySignature", "name": "type", "value": "'submit' | 'button'", - "description": "The behavioral type of the button component, which determines what action it performs when activated.\n\n- `submit`: Submits the closest form.\n- `button`: Performs no default action when activated.\n- `reset`: Resets the closest form (returning fields to their default values).\n\nThis property is ignored if the component supports `href` or `commandFor`/`command` and one of them is set.", + "description": "The behavioral type of the clickable component, which determines what action it performs when activated.\n\n- `submit`: Submits the nearest containing form.\n- `button`: Performs no default action, relying on the `click` event handler for behavior.\n\nThis property is ignored if `href` or `commandFor`/`command` is set.", "isOptional": true, "defaultValue": "'button'" }, @@ -37473,7 +37496,7 @@ "src/surfaces/checkout/components/ClickableChip.ts": { "filePath": "src/surfaces/checkout/components/ClickableChip.ts", "name": "ClickableChipElementProps", - "description": "The clickable chip component displays interactive labels or categories that users can click or remove. Use clickable chip to show filter tags, selected options, or merchant-created labels that users need to interact with or dismiss.\n\nClickable chips support multiple visual variants, optional icons, and can function as both clickable buttons and removable tags for flexible interaction patterns. For non-interactive labels, use [chip](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/typography-and-content/chip).", + "description": "", "isPublicDocs": true, "members": [ { @@ -37481,7 +37504,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityLabel", "value": "string", - "description": "A label that describes the purpose or contents of the chip. It will be read to users using assistive technologies such as screen readers.", + "description": "A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.", "isOptional": true }, { @@ -37489,7 +37512,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the chip, disallowing any interaction.", + "description": "Disables the chip, preventing all user interaction including clicks and removal. Disabled chips are visually dimmed to indicate they are not interactive.", "isOptional": true, "defaultValue": "false" }, @@ -37498,7 +37521,7 @@ "syntaxKind": "PropertySignature", "name": "hidden", "value": "boolean", - "description": "Determines whether the chip is hidden.\n\nIf this property is being set on each framework render (as in 'controlled' usage), and the chip is `removable`, ensure you update app state for this property when the `remove` event fires.\n\nIf the chip is not `removable`, it can still be hidden by setting this property.", + "description": "Determines whether the chip is hidden.\n\nIf this property is being set on each framework render (as in 'controlled' usage), and the chip is `removable`, ensure you update app state for this property when the `remove` event fires.\n\nIf the chip is not `removable`, it can still be hidden by setting this property.\n\nWhen using the `removable` variant, keep `hidden` synced with your app state. If `hidden` isn't updated after the chip is removed, the chip can become permanently hidden.", "isOptional": true, "defaultValue": "false" }, @@ -37515,7 +37538,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -37523,7 +37546,7 @@ "syntaxKind": "PropertySignature", "name": "removable", "value": "boolean", - "description": "Whether the chip is removable.", + "description": "Whether the chip displays a remove button, allowing users to dismiss it. When `true`, clicking the remove button fires the `remove` event.", "isOptional": true, "defaultValue": "false" } @@ -37543,7 +37566,7 @@ "syntaxKind": "PropertySignature", "name": "onAfterHide", "value": "(event: Event) => void", - "description": "Event handler when the chip has fully hidden.\n\nThe `hidden` property will be `true` when this event fires.", + "description": "A callback fired when the chip has fully hidden after a removal animation.\n\nThe `hidden` property will be `true` when this event fires.", "isOptional": true }, { @@ -37551,7 +37574,7 @@ "syntaxKind": "PropertySignature", "name": "onClick", "value": "(event: Event) => void", - "description": "Callback when the chip is clicked.", + "description": "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).", "isOptional": true }, { @@ -37559,7 +37582,7 @@ "syntaxKind": "PropertySignature", "name": "onRemove", "value": "(event: Event) => void", - "description": "Callback when the chip is removed.", + "description": "A callback fired when the chip is removed by the user clicking the remove button.", "isOptional": true } ], @@ -37570,7 +37593,7 @@ "src/surfaces/checkout/components/ClickableChip.ts": { "filePath": "src/surfaces/checkout/components/ClickableChip.ts", "name": "ClickableChipElementEvents", - "description": "The clickable chip component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", + "description": "", "isPublicDocs": true, "members": [ { @@ -37605,7 +37628,7 @@ "src/surfaces/checkout/components/ClickableChip.ts": { "filePath": "src/surfaces/checkout/components/ClickableChip.ts", "name": "ClickableChipElementSlots", - "description": "The clickable chip component supports slots for additional content placement. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", + "description": "", "isPublicDocs": true, "members": [ { @@ -37613,11 +37636,11 @@ "syntaxKind": "PropertySignature", "name": "graphic", "value": "HTMLElement", - "description": "The graphic to display inside of the chip.\n\nOnly `s-icon` element and its `type` attribute are supported.", + "description": "An optional graphic displayed at the start of the chip, such as an icon to visually reinforce the chip's label. Only the `s-icon` element and its `type` attribute are supported.", "isOptional": true } ], - "value": "export interface ClickableChipElementSlots {\n /**\n * The graphic to display inside of the chip.\n *\n * Only `s-icon` element and its `type` attribute are supported.\n */\n graphic?: HTMLElement;\n}" + "value": "export interface ClickableChipElementSlots {\n /**\n * An optional graphic displayed at the start of the chip, such as an icon to visually reinforce the chip's label. Only the `s-icon` element and its `type` attribute are supported.\n */\n graphic?: HTMLElement;\n}" } }, "ClickableChipElement": { @@ -37632,7 +37655,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityLabel", "value": "string", - "description": "A label that describes the purpose or contents of the chip. It will be read to users using assistive technologies such as screen readers.", + "description": "A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.", "isOptional": true }, { @@ -37654,7 +37677,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/ClickableChip.ts", @@ -38284,7 +38307,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the chip, disallowing any interaction.", + "description": "Disables the chip, preventing all user interaction including clicks and removal. Disabled chips are visually dimmed to indicate they are not interactive.", "isOptional": true, "defaultValue": "false" }, @@ -38546,7 +38569,7 @@ "syntaxKind": "PropertySignature", "name": "hidden", "value": "boolean", - "description": "Determines whether the chip is hidden.\n\nIf this property is being set on each framework render (as in 'controlled' usage), and the chip is `removable`, ensure you update app state for this property when the `remove` event fires.\n\nIf the chip is not `removable`, it can still be hidden by setting this property.", + "description": "Determines whether the chip is hidden.\n\nIf this property is being set on each framework render (as in 'controlled' usage), and the chip is `removable`, ensure you update app state for this property when the `remove` event fires.\n\nIf the chip is not `removable`, it can still be hidden by setting this property.\n\nWhen using the `removable` variant, keep `hidden` synced with your app state. If `hidden` isn't updated after the chip is removed, the chip can become permanently hidden.", "isOptional": true, "defaultValue": "false" }, @@ -38570,7 +38593,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -39661,7 +39684,7 @@ "syntaxKind": "PropertySignature", "name": "removable", "value": "boolean", - "description": "Whether the chip is removable.", + "description": "Whether the chip displays a remove button, allowing users to dismiss it. When `true`, clicking the remove button fires the `remove` event.", "isOptional": true, "defaultValue": "false" }, @@ -39705,7 +39728,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/ClickableChip.ts", @@ -39969,7 +39992,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityLabel", "value": "string", - "description": "A label that describes the purpose or contents of the chip. It will be read to users using assistive technologies such as screen readers.", + "description": "A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.", "isOptional": true }, { @@ -39977,7 +40000,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the chip, disallowing any interaction.", + "description": "Disables the chip, preventing all user interaction including clicks and removal. Disabled chips are visually dimmed to indicate they are not interactive.", "isOptional": true, "defaultValue": "false" }, @@ -39986,7 +40009,7 @@ "syntaxKind": "PropertySignature", "name": "hidden", "value": "boolean", - "description": "Determines whether the chip is hidden.\n\nIf this property is being set on each framework render (as in 'controlled' usage), and the chip is `removable`, ensure you update app state for this property when the `remove` event fires.\n\nIf the chip is not `removable`, it can still be hidden by setting this property.", + "description": "Determines whether the chip is hidden.\n\nIf this property is being set on each framework render (as in 'controlled' usage), and the chip is `removable`, ensure you update app state for this property when the `remove` event fires.\n\nIf the chip is not `removable`, it can still be hidden by setting this property.\n\nWhen using the `removable` variant, keep `hidden` synced with your app state. If `hidden` isn't updated after the chip is removed, the chip can become permanently hidden.", "isOptional": true, "defaultValue": "false" }, @@ -40003,7 +40026,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -40011,7 +40034,7 @@ "syntaxKind": "PropertySignature", "name": "onAfterHide", "value": "(event: Event) => void", - "description": "Event handler when the chip has fully hidden.\n\nThe `hidden` property will be `true` when this event fires.", + "description": "A callback fired when the chip has fully hidden after a removal animation.\n\nThe `hidden` property will be `true` when this event fires.", "isOptional": true }, { @@ -40019,7 +40042,7 @@ "syntaxKind": "PropertySignature", "name": "onClick", "value": "(event: Event) => void", - "description": "Callback when the chip is clicked.", + "description": "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).", "isOptional": true }, { @@ -40027,7 +40050,7 @@ "syntaxKind": "PropertySignature", "name": "onRemove", "value": "(event: Event) => void", - "description": "Callback when the chip is removed.", + "description": "A callback fired when the chip is removed by the user clicking the remove button.", "isOptional": true }, { @@ -40035,7 +40058,7 @@ "syntaxKind": "PropertySignature", "name": "removable", "value": "boolean", - "description": "Whether the chip is removable.", + "description": "Whether the chip displays a remove button, allowing users to dismiss it. When `true`, clicking the remove button fires the `remove` event.", "isOptional": true, "defaultValue": "false" } @@ -40047,7 +40070,7 @@ "src/surfaces/checkout/components/ClipboardItem.ts": { "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", "name": "ClipboardItemElementProps", - "description": "Enables copying text to the user’s clipboard. Use alongside Button or Link components to let users easily copy content. `` doesn’t render visually.", + "description": "", "isPublicDocs": true, "members": [ { @@ -40055,7 +40078,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -40063,7 +40086,7 @@ "syntaxKind": "PropertySignature", "name": "text", "value": "string", - "description": "Plain text to be written to the clipboard.", + "description": "Plain text to be written to the clipboard.\n\nRich text, HTML, and binary content aren't supported.", "isOptional": true, "defaultValue": "''" } @@ -40102,7 +40125,7 @@ "src/surfaces/checkout/components/ClipboardItem.ts": { "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", "name": "ClipboardItemElementEvents", - "description": "The clipboard item component provides event callbacks for handling copy interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", + "description": "", "isPublicDocs": true, "members": [ { @@ -40151,7 +40174,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", @@ -41048,7 +41071,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -42167,7 +42190,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", @@ -42363,7 +42386,7 @@ "syntaxKind": "PropertySignature", "name": "text", "value": "string", - "description": "Plain text to be written to the clipboard.", + "description": "Plain text to be written to the clipboard.\n\nRich text, HTML, and binary content aren't supported.", "isOptional": true, "defaultValue": "''" }, @@ -42440,7 +42463,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -42464,7 +42487,7 @@ "syntaxKind": "PropertySignature", "name": "text", "value": "string", - "description": "Plain text to be written to the clipboard.", + "description": "Plain text to be written to the clipboard.\n\nRich text, HTML, and binary content aren't supported.", "isOptional": true, "defaultValue": "''" } @@ -42476,7 +42499,7 @@ "src/surfaces/checkout/components/ConsentCheckbox.ts": { "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", "name": "ConsentCheckboxElementProps", - "description": "Use buyer consent checkboxes for collecting the buyer’s approval for a given policy.", + "description": "", "isPublicDocs": true, "members": [ { @@ -42492,7 +42515,7 @@ "syntaxKind": "PropertySignature", "name": "checked", "value": "boolean", - "description": "Whether the control is active.", + "description": "Whether the control is currently checked.", "isOptional": true, "defaultValue": "false" }, @@ -42501,7 +42524,7 @@ "syntaxKind": "PropertySignature", "name": "command", "value": "'--auto' | '--show' | '--hide' | '--toggle'", - "description": "Sets the action the `commandFor` should take when this clickable is activated.\n\nSee the documentation of particular components for the actions they support.\n\n- `--auto`: Performs the default action for the target component.\n- `--show`: Displays the target component.\n- `--hide`: Conceals the target component.\n- `--toggle`: Alternates the target component.\n- `--copy`: Copies the target ClipboardItem.", + "description": "Sets the action the `commandFor` target should take when this component is activated.\n\n- `--auto`: Performs the default action for the target component.\n- `--show`: Displays the target component.\n- `--hide`: Conceals the target component.\n- `--toggle`: Alternates the target component.\n- `--copy`: Copies the target ClipboardItem.\n\nLearn more about the [`command` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).", "isOptional": true, "defaultValue": "'--auto'" }, @@ -42510,7 +42533,7 @@ "syntaxKind": "PropertySignature", "name": "commandFor", "value": "string", - "description": "ID of a component that should respond to activations (such as clicks) on this component.\n\nSee `command` for how to control the behavior of the target.", + "description": "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).\n\nWhen both `commandFor` and `href` are set, `commandFor` takes precedence. The command runs and the link doesn't navigate.", "isOptional": true }, { @@ -42518,7 +42541,7 @@ "syntaxKind": "PropertySignature", "name": "defaultChecked", "value": "boolean", - "description": "Whether the control is active by default.", + "description": "Whether the control is checked by default.", "isOptional": true, "defaultValue": "false" }, @@ -42527,7 +42550,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the control, disallowing any interaction.", + "description": "Whether the control is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -42536,7 +42559,7 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -42544,7 +42567,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -42552,7 +42575,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Visual content to use as the control label.", + "description": "The text displayed as the control label, which identifies the purpose of the control to users. This label is associated with the control for accessibility.", "isOptional": true }, { @@ -42560,15 +42583,15 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the control that is unique within the nearest containing `Form` component.", + "description": "The name attribute for the control, used to identify its value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", "syntaxKind": "PropertySignature", "name": "policy", - "value": "ConsentPolicy", - "description": "The policy for which user consent is being collected for.\n\n`sms-marketing`: Represents the policy for SMS marketing consent.", + "value": "'sms-marketing'", + "description": "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.\n\n- `sms-marketing`: Represents the policy for SMS marketing consent.", "isOptional": true }, { @@ -42580,17 +42603,7 @@ "isOptional": true } ], - "value": "export interface ConsentCheckboxElementProps extends Pick {\n command?: Extract;\n}" - } - }, - "ConsentPolicy": { - "src/surfaces/checkout/components/components.ts": { - "filePath": "src/surfaces/checkout/components/components.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "ConsentPolicy", - "value": "\"sms-marketing\"", - "description": "", - "isPublicDocs": true + "value": "export interface ConsentCheckboxElementProps extends Pick {\n command?: Extract;\n /**\n * 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.\n *\n * - `sms-marketing`: Represents the policy for SMS marketing consent.\n */\n policy?: ConsentCheckboxProps$1['policy'];\n}" } }, "ConsentCheckboxEvents": { @@ -42616,7 +42629,7 @@ "src/surfaces/checkout/components/ConsentCheckbox.ts": { "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", "name": "ConsentCheckboxElementEvents", - "description": "Learn more about [registering events](/docs/api/checkout-ui-extensions/latest/using-polaris-components#event-handling).", + "description": "", "isPublicDocs": true, "members": [ { @@ -42624,11 +42637,11 @@ "syntaxKind": "PropertySignature", "name": "change", "value": "CallbackEventListener", - "description": "A callback that is run whenever the control is changed.", + "description": "A callback fired when the consent checkbox value changes.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", "isOptional": true } ], - "value": "export interface ConsentCheckboxElementEvents {\n /**\n * A callback that is run whenever the control is changed.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event\n */\n change?: CallbackEventListener;\n}" + "value": "export interface ConsentCheckboxElementEvents {\n /**\n * A callback fired when the consent checkbox value changes.\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change?: CallbackEventListener;\n}" } }, "ConsentCheckboxElement": { @@ -42665,7 +42678,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", @@ -43148,7 +43161,7 @@ "syntaxKind": "PropertySignature", "name": "checked", "value": "boolean", - "description": "Whether the control is active.", + "description": "Whether the control is currently checked.", "isOptional": true, "defaultValue": "false" }, @@ -43248,7 +43261,7 @@ "syntaxKind": "PropertySignature", "name": "command", "value": "'--auto' | '--show' | '--hide' | '--toggle'", - "description": "Sets the action the `commandFor` should take when this clickable is activated.\n\nSee the documentation of particular components for the actions they support.\n\n- `--auto`: Performs the default action for the target component.\n- `--show`: Displays the target component.\n- `--hide`: Conceals the target component.\n- `--toggle`: Alternates the target component.\n- `--copy`: Copies the target ClipboardItem.", + "description": "Sets the action the `commandFor` target should take when this component is activated.\n\n- `--auto`: Performs the default action for the target component.\n- `--show`: Displays the target component.\n- `--hide`: Conceals the target component.\n- `--toggle`: Alternates the target component.\n- `--copy`: Copies the target ClipboardItem.\n\nLearn more about the [`command` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).", "isOptional": true, "defaultValue": "'--auto'" }, @@ -43257,7 +43270,7 @@ "syntaxKind": "PropertySignature", "name": "commandFor", "value": "string", - "description": "ID of a component that should respond to activations (such as clicks) on this component.\n\nSee `command` for how to control the behavior of the target.", + "description": "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).\n\nWhen both `commandFor` and `href` are set, `commandFor` takes precedence. The command runs and the link doesn't navigate.", "isOptional": true }, { @@ -43314,7 +43327,7 @@ "syntaxKind": "PropertySignature", "name": "defaultChecked", "value": "boolean", - "description": "Whether the control is active by default.", + "description": "Whether the control is checked by default.", "isOptional": true, "defaultValue": "false" }, @@ -43330,7 +43343,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the control, disallowing any interaction.", + "description": "Whether the control is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -43444,7 +43457,7 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -43614,7 +43627,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -43713,7 +43726,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Visual content to use as the control label.", + "description": "The text displayed as the control label, which identifies the purpose of the control to users. This label is associated with the control for accessibility.", "isOptional": true }, { @@ -43770,7 +43783,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the control that is unique within the nearest containing `Form` component.", + "description": "The name attribute for the control, used to identify its value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -44641,8 +44654,8 @@ "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", "syntaxKind": "PropertySignature", "name": "policy", - "value": "ConsentPolicy", - "description": "The policy for which user consent is being collected for.\n\n`sms-marketing`: Represents the policy for SMS marketing consent.", + "value": "'sms-marketing'", + "description": "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.\n\n- `sms-marketing`: Represents the policy for SMS marketing consent.", "isOptional": true }, { @@ -44750,7 +44763,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", @@ -45030,7 +45043,7 @@ "syntaxKind": "PropertySignature", "name": "checked", "value": "boolean", - "description": "Whether the control is active.", + "description": "Whether the control is currently checked.", "isOptional": true, "defaultValue": "false" }, @@ -45039,7 +45052,7 @@ "syntaxKind": "PropertySignature", "name": "command", "value": "'--auto' | '--show' | '--hide' | '--toggle'", - "description": "Sets the action the `commandFor` should take when this clickable is activated.\n\nSee the documentation of particular components for the actions they support.\n\n- `--auto`: Performs the default action for the target component.\n- `--show`: Displays the target component.\n- `--hide`: Conceals the target component.\n- `--toggle`: Alternates the target component.\n- `--copy`: Copies the target ClipboardItem.", + "description": "Sets the action the `commandFor` target should take when this component is activated.\n\n- `--auto`: Performs the default action for the target component.\n- `--show`: Displays the target component.\n- `--hide`: Conceals the target component.\n- `--toggle`: Alternates the target component.\n- `--copy`: Copies the target ClipboardItem.\n\nLearn more about the [`command` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).", "isOptional": true, "defaultValue": "'--auto'" }, @@ -45048,7 +45061,7 @@ "syntaxKind": "PropertySignature", "name": "commandFor", "value": "string", - "description": "ID of a component that should respond to activations (such as clicks) on this component.\n\nSee `command` for how to control the behavior of the target.", + "description": "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).\n\nWhen both `commandFor` and `href` are set, `commandFor` takes precedence. The command runs and the link doesn't navigate.", "isOptional": true }, { @@ -45056,7 +45069,7 @@ "syntaxKind": "PropertySignature", "name": "defaultChecked", "value": "boolean", - "description": "Whether the control is active by default.", + "description": "Whether the control is checked by default.", "isOptional": true, "defaultValue": "false" }, @@ -45065,7 +45078,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the control, disallowing any interaction.", + "description": "Whether the control is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -45074,7 +45087,7 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -45082,7 +45095,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -45090,7 +45103,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Visual content to use as the control label.", + "description": "The text displayed as the control label, which identifies the purpose of the control to users. This label is associated with the control for accessibility.", "isOptional": true }, { @@ -45098,7 +45111,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the control that is unique within the nearest containing `Form` component.", + "description": "The name attribute for the control, used to identify its value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -45113,8 +45126,8 @@ "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", "syntaxKind": "PropertySignature", "name": "policy", - "value": "ConsentPolicy", - "description": "The policy for which user consent is being collected for.\n\n`sms-marketing`: Represents the policy for SMS marketing consent.", + "value": "'sms-marketing'", + "description": "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.\n\n- `sms-marketing`: Represents the policy for SMS marketing consent.", "isOptional": true }, { @@ -45141,7 +45154,7 @@ "syntaxKind": "PropertySignature", "name": "autocomplete", "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", "isOptional": true, "defaultValue": "'on' for everything else" }, @@ -45150,7 +45163,7 @@ "syntaxKind": "PropertySignature", "name": "defaultValue", "value": "string", - "description": "The default value for the field.", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces this value.", "isOptional": true }, { @@ -45158,7 +45171,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -45167,7 +45180,7 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -45175,7 +45188,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -45183,7 +45196,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Content to use as the field label.", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", "isOptional": true }, { @@ -45191,7 +45204,7 @@ "syntaxKind": "PropertySignature", "name": "labelAccessibilityVisibility", "value": "'visible' | 'exclusive'", - "description": "Changes the visibility of the component's label.\n\n- `visible`: the label is visible to all users.\n- `exclusive`: the label is visually hidden but remains in the accessibility tree.", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone.\n- `exclusive`: The label is visually hidden but still announced by screen readers.", "isOptional": true, "defaultValue": "'visible'" }, @@ -45200,7 +45213,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -45218,7 +45231,7 @@ "syntaxKind": "PropertySignature", "name": "readOnly", "value": "boolean", - "description": "The field cannot be edited by the user. It is focusable will be announced by screen readers.", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", "isOptional": true, "defaultValue": "false" }, @@ -45236,9 +45249,9 @@ "syntaxKind": "PropertySignature", "name": "type", "value": "'mobile' | ''", - "description": "The type of number to collect.\n\nSpecific style may be applied to each type to provide extra guidance to users. Note that no extra validation is performed based on the type.", + "description": "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.\n\nStyling hint for the input keyboard. Doesn't validate the phone number format. Implement validation in your extension and use the `error` prop to show results.", "isOptional": true, - "defaultValue": "'' meaning no specific kind of phone number" + "defaultValue": "''" }, { "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", @@ -45292,7 +45305,7 @@ "syntaxKind": "PropertySignature", "name": "onChange", "value": "(event: Event) => void", - "description": "Callback when the user has **finished editing** a field, for example, once they have blurred the field.", + "description": "A callback fired when the user has **finished editing** a field, such as when they blur the field or press Enter.", "isOptional": true }, { @@ -45308,7 +45321,7 @@ "syntaxKind": "PropertySignature", "name": "onInput", "value": "(event: Event) => void", - "description": "Callback when the user makes any changes in the field.", + "description": "A callback fired when the user makes any changes in the field, such as typing a character.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).", "isOptional": true } ], @@ -45341,7 +45354,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", @@ -45782,7 +45795,7 @@ "syntaxKind": "PropertySignature", "name": "autocomplete", "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", "isOptional": true, "defaultValue": "'on' for everything else" }, @@ -45973,7 +45986,7 @@ "syntaxKind": "PropertySignature", "name": "defaultValue", "value": "string", - "description": "The default value for the field.", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces this value.", "isOptional": true }, { @@ -45988,7 +46001,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -46102,7 +46115,7 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -46272,7 +46285,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -46371,7 +46384,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Content to use as the field label.", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", "isOptional": true }, { @@ -46379,7 +46392,7 @@ "syntaxKind": "PropertySignature", "name": "labelAccessibilityVisibility", "value": "'visible' | 'exclusive'", - "description": "Changes the visibility of the component's label.\n\n- `visible`: the label is visible to all users.\n- `exclusive`: the label is visually hidden but remains in the accessibility tree.", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone.\n- `exclusive`: The label is visually hidden but still announced by screen readers.", "isOptional": true, "defaultValue": "'visible'" }, @@ -46437,7 +46450,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -47370,7 +47383,7 @@ "syntaxKind": "PropertySignature", "name": "readOnly", "value": "boolean", - "description": "The field cannot be edited by the user. It is focusable will be announced by screen readers.", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", "isOptional": true, "defaultValue": "false" }, @@ -47421,7 +47434,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", @@ -47668,9 +47681,9 @@ "syntaxKind": "PropertySignature", "name": "type", "value": "'mobile' | ''", - "description": "The type of number to collect.\n\nSpecific style may be applied to each type to provide extra guidance to users. Note that no extra validation is performed based on the type.", + "description": "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.\n\nStyling hint for the input keyboard. Doesn't validate the phone number format. Implement validation in your extension and use the `error` prop to show results.", "isOptional": true, - "defaultValue": "'' meaning no specific kind of phone number" + "defaultValue": "''" }, { "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", @@ -47711,7 +47724,7 @@ "syntaxKind": "PropertySignature", "name": "autocomplete", "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", "isOptional": true, "defaultValue": "'on' for everything else" }, @@ -47720,7 +47733,7 @@ "syntaxKind": "PropertySignature", "name": "defaultValue", "value": "string", - "description": "The default value for the field.", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces this value.", "isOptional": true }, { @@ -47728,7 +47741,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -47737,7 +47750,7 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -47745,7 +47758,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -47753,7 +47766,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Content to use as the field label.", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", "isOptional": true }, { @@ -47761,7 +47774,7 @@ "syntaxKind": "PropertySignature", "name": "labelAccessibilityVisibility", "value": "'visible' | 'exclusive'", - "description": "Changes the visibility of the component's label.\n\n- `visible`: the label is visible to all users.\n- `exclusive`: the label is visually hidden but remains in the accessibility tree.", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone.\n- `exclusive`: The label is visually hidden but still announced by screen readers.", "isOptional": true, "defaultValue": "'visible'" }, @@ -47770,7 +47783,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -47786,7 +47799,7 @@ "syntaxKind": "PropertySignature", "name": "onChange", "value": "(event: Event) => void", - "description": "Callback when the user has **finished editing** a field, for example, once they have blurred the field.", + "description": "A callback fired when the user has **finished editing** a field, such as when they blur the field or press Enter.", "isOptional": true }, { @@ -47802,7 +47815,7 @@ "syntaxKind": "PropertySignature", "name": "onInput", "value": "(event: Event) => void", - "description": "Callback when the user makes any changes in the field.", + "description": "A callback fired when the user makes any changes in the field, such as typing a character.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).", "isOptional": true }, { @@ -47820,7 +47833,7 @@ "syntaxKind": "PropertySignature", "name": "readOnly", "value": "boolean", - "description": "The field cannot be edited by the user. It is focusable will be announced by screen readers.", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", "isOptional": true, "defaultValue": "false" }, @@ -47838,9 +47851,9 @@ "syntaxKind": "PropertySignature", "name": "type", "value": "'mobile' | ''", - "description": "The type of number to collect.\n\nSpecific style may be applied to each type to provide extra guidance to users. Note that no extra validation is performed based on the type.", + "description": "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.\n\nStyling hint for the input keyboard. Doesn't validate the phone number format. Implement validation in your extension and use the `error` prop to show results.", "isOptional": true, - "defaultValue": "'' meaning no specific kind of phone number" + "defaultValue": "''" }, { "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", @@ -47858,7 +47871,7 @@ "src/surfaces/checkout/components/ConsentPhoneField.ts": { "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", "name": "ConsentPhoneFieldElementProps", - "description": "Display a phone field for customers to sign up for text message marketing, noting that the phone field value will be automatically saved during checkout.", + "description": "", "isPublicDocs": true, "members": [ { @@ -47866,7 +47879,7 @@ "syntaxKind": "PropertySignature", "name": "autocomplete", "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", "isOptional": true, "defaultValue": "'on' for everything else" }, @@ -47875,7 +47888,7 @@ "syntaxKind": "PropertySignature", "name": "defaultValue", "value": "string", - "description": "The default value for the field.", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces this value.", "isOptional": true }, { @@ -47883,7 +47896,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -47892,7 +47905,7 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -47900,7 +47913,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -47908,7 +47921,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Content to use as the field label.", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", "isOptional": true }, { @@ -47916,7 +47929,7 @@ "syntaxKind": "PropertySignature", "name": "labelAccessibilityVisibility", "value": "'visible' | 'exclusive'", - "description": "Changes the visibility of the component's label.\n\n- `visible`: the label is visible to all users.\n- `exclusive`: the label is visually hidden but remains in the accessibility tree.", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone.\n- `exclusive`: The label is visually hidden but still announced by screen readers.", "isOptional": true, "defaultValue": "'visible'" }, @@ -47925,7 +47938,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -47942,8 +47955,8 @@ "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", "syntaxKind": "PropertySignature", "name": "policy", - "value": "ConsentPolicy", - "description": "The policy for which user consent is being collected for.\n\n`sms-marketing`: Represents the policy for SMS marketing consent.", + "value": "'sms-marketing'", + "description": "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.\n\n- `sms-marketing`: Represents the policy for SMS marketing consent.", "isOptional": true }, { @@ -47951,7 +47964,7 @@ "syntaxKind": "PropertySignature", "name": "readOnly", "value": "boolean", - "description": "The field cannot be edited by the user. It is focusable will be announced by screen readers.", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", "isOptional": true, "defaultValue": "false" }, @@ -47969,9 +47982,9 @@ "syntaxKind": "PropertySignature", "name": "type", "value": "'mobile' | ''", - "description": "The type of number to collect.\n\nSpecific style may be applied to each type to provide extra guidance to users. Note that no extra validation is performed based on the type.", + "description": "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.\n\nStyling hint for the input keyboard. Doesn't validate the phone number format. Implement validation in your extension and use the `error` prop to show results.", "isOptional": true, - "defaultValue": "'' meaning no specific kind of phone number" + "defaultValue": "''" }, { "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", @@ -47982,7 +47995,7 @@ "isOptional": true } ], - "value": "export interface ConsentPhoneFieldElementProps extends Pick {\n /**\n * @deprecated Use `label` instead.\n * @private\n */\n placeholder?: string;\n}" + "value": "export interface ConsentPhoneFieldElementProps extends Pick {\n /**\n * @deprecated Use `label` instead.\n * @private\n */\n placeholder?: string;\n /**\n * 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.\n *\n * - `sms-marketing`: Represents the policy for SMS marketing consent.\n */\n policy?: ConsentPhoneFieldProps$1['policy'];\n}" } }, "ConsentPhoneFieldEvents": { @@ -48005,7 +48018,7 @@ "syntaxKind": "PropertySignature", "name": "onChange", "value": "(event: Event) => void", - "description": "Callback when the user has **finished editing** a field, for example, once they have blurred the field.", + "description": "A callback fired when the user has **finished editing** a field, such as when they blur the field or press Enter.", "isOptional": true }, { @@ -48021,7 +48034,7 @@ "syntaxKind": "PropertySignature", "name": "onInput", "value": "(event: Event) => void", - "description": "Callback when the user makes any changes in the field.", + "description": "A callback fired when the user makes any changes in the field, such as typing a character.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).", "isOptional": true } ], @@ -48032,7 +48045,7 @@ "src/surfaces/checkout/components/ConsentPhoneField.ts": { "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", "name": "ConsentPhoneFieldElementEvents", - "description": "Learn more about [registering events](/docs/api/checkout-ui-extensions/latest/using-polaris-components#event-handling).", + "description": "", "isPublicDocs": true, "members": [ { @@ -48040,7 +48053,7 @@ "syntaxKind": "PropertySignature", "name": "blur", "value": "CallbackEventListener", - "description": "A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "description": "A callback fired when the consent phone field loses focus.\n\nLearn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", "isOptional": true }, { @@ -48048,7 +48061,7 @@ "syntaxKind": "PropertySignature", "name": "change", "value": "CallbackEventListener", - "description": "Callback when the user has **finished editing** a field, for example, once they have blurred the field.", + "description": "A callback fired when the consent phone field value changes.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", "isOptional": true }, { @@ -48056,7 +48069,7 @@ "syntaxKind": "PropertySignature", "name": "focus", "value": "CallbackEventListener", - "description": "A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "description": "A callback fired when the consent phone field receives focus.\n\nLearn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", "isOptional": true }, { @@ -48064,11 +48077,11 @@ "syntaxKind": "PropertySignature", "name": "input", "value": "CallbackEventListener", - "description": "Callback when the user makes any changes in the field.", + "description": "A callback fired when the user inputs data into the consent phone field.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).", "isOptional": true } ], - "value": "export interface ConsentPhoneFieldElementEvents {\n /**\n * A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event\n */\n blur?: CallbackEventListener;\n /**\n * Callback when the user has **finished editing** a field, for example, once they have blurred the field.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event\n */\n change?: CallbackEventListener;\n /**\n * A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event\n */\n focus?: CallbackEventListener;\n /**\n * Callback when the user makes any changes in the field.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event\n */\n input?: CallbackEventListener;\n}" + "value": "export interface ConsentPhoneFieldElementEvents {\n /**\n * A callback fired when the consent phone field loses focus.\n *\n * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur?: CallbackEventListener;\n /**\n * A callback fired when the consent phone field value changes.\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change?: CallbackEventListener;\n /**\n * A callback fired when the consent phone field receives focus.\n *\n * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus?: CallbackEventListener;\n /**\n * A callback fired when the user inputs data into the consent phone field.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input?: CallbackEventListener;\n}" } }, "ConsentPhoneFieldElement": { @@ -48083,7 +48096,7 @@ "syntaxKind": "PropertySignature", "name": "autocomplete", "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", "isOptional": true, "defaultValue": "'on' for everything else" }, @@ -48092,7 +48105,7 @@ "syntaxKind": "PropertySignature", "name": "defaultValue", "value": "string", - "description": "The default value for the field.", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces this value.", "isOptional": true }, { @@ -48100,7 +48113,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -48109,7 +48122,7 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -48117,7 +48130,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -48125,7 +48138,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Content to use as the field label.", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", "isOptional": true }, { @@ -48133,7 +48146,7 @@ "syntaxKind": "PropertySignature", "name": "labelAccessibilityVisibility", "value": "'visible' | 'exclusive'", - "description": "Changes the visibility of the component's label.\n\n- `visible`: the label is visible to all users.\n- `exclusive`: the label is visually hidden but remains in the accessibility tree.", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone.\n- `exclusive`: The label is visually hidden but still announced by screen readers.", "isOptional": true, "defaultValue": "'visible'" }, @@ -48142,7 +48155,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -48187,8 +48200,8 @@ "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", "syntaxKind": "PropertySignature", "name": "policy", - "value": "ConsentPolicy", - "description": "The policy for which user consent is being collected for.\n\n`sms-marketing`: Represents the policy for SMS marketing consent.", + "value": "'sms-marketing'", + "description": "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.\n\n- `sms-marketing`: Represents the policy for SMS marketing consent.", "isOptional": true }, { @@ -48196,7 +48209,7 @@ "syntaxKind": "PropertySignature", "name": "readOnly", "value": "boolean", - "description": "The field cannot be edited by the user. It is focusable will be announced by screen readers.", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", "isOptional": true, "defaultValue": "false" }, @@ -48214,9 +48227,9 @@ "syntaxKind": "PropertySignature", "name": "type", "value": "'mobile' | ''", - "description": "The type of number to collect.\n\nSpecific style may be applied to each type to provide extra guidance to users. Note that no extra validation is performed based on the type.", + "description": "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.\n\nStyling hint for the input keyboard. Doesn't validate the phone number format. Implement validation in your extension and use the `error` prop to show results.", "isOptional": true, - "defaultValue": "'' meaning no specific kind of phone number" + "defaultValue": "''" }, { "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", @@ -48234,7 +48247,7 @@ "src/surfaces/checkout/components/ConsentPhoneField.ts": { "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", "name": "ConsentPhoneFieldElementSlots", - "description": "Learn more about [component slots](/docs/api/checkout-ui-extensions/latest/using-polaris-components#slots).", + "description": "", "isPublicDocs": true, "members": [ { @@ -48242,11 +48255,11 @@ "syntaxKind": "PropertySignature", "name": "accessory", "value": "HTMLElement", - "description": "Additional content to be displayed in the field. Commonly used to display an icon that activates a tooltip providing more information.", + "description": "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.", "isOptional": true } ], - "value": "export interface ConsentPhoneFieldElementSlots {\n /**\n * Additional content to be displayed in the field.\n * Commonly used to display an icon that activates a tooltip providing more information.\n */\n accessory?: HTMLElement;\n}" + "value": "export interface ConsentPhoneFieldElementSlots {\n /**\n * 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.\n */\n accessory?: HTMLElement;\n}" } }, "ConsentPhoneFieldProps": { @@ -48261,7 +48274,7 @@ "syntaxKind": "PropertySignature", "name": "autocomplete", "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", "isOptional": true, "defaultValue": "'on' for everything else" }, @@ -48270,7 +48283,7 @@ "syntaxKind": "PropertySignature", "name": "defaultValue", "value": "string", - "description": "The default value for the field.", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces this value.", "isOptional": true }, { @@ -48278,7 +48291,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -48287,7 +48300,7 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -48295,7 +48308,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -48303,7 +48316,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Content to use as the field label.", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", "isOptional": true }, { @@ -48311,7 +48324,7 @@ "syntaxKind": "PropertySignature", "name": "labelAccessibilityVisibility", "value": "'visible' | 'exclusive'", - "description": "Changes the visibility of the component's label.\n\n- `visible`: the label is visible to all users.\n- `exclusive`: the label is visually hidden but remains in the accessibility tree.", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone.\n- `exclusive`: The label is visually hidden but still announced by screen readers.", "isOptional": true, "defaultValue": "'visible'" }, @@ -48320,7 +48333,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -48336,7 +48349,7 @@ "syntaxKind": "PropertySignature", "name": "onChange", "value": "(event: Event) => void", - "description": "Callback when the user has **finished editing** a field, for example, once they have blurred the field.", + "description": "A callback fired when the user has **finished editing** a field, such as when they blur the field or press Enter.", "isOptional": true }, { @@ -48352,7 +48365,7 @@ "syntaxKind": "PropertySignature", "name": "onInput", "value": "(event: Event) => void", - "description": "Callback when the user makes any changes in the field.", + "description": "A callback fired when the user makes any changes in the field, such as typing a character.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).", "isOptional": true }, { @@ -48369,8 +48382,8 @@ "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", "syntaxKind": "PropertySignature", "name": "policy", - "value": "ConsentPolicy", - "description": "The policy for which user consent is being collected for.\n\n`sms-marketing`: Represents the policy for SMS marketing consent.", + "value": "'sms-marketing'", + "description": "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.\n\n- `sms-marketing`: Represents the policy for SMS marketing consent.", "isOptional": true }, { @@ -48378,7 +48391,7 @@ "syntaxKind": "PropertySignature", "name": "readOnly", "value": "boolean", - "description": "The field cannot be edited by the user. It is focusable will be announced by screen readers.", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", "isOptional": true, "defaultValue": "false" }, @@ -48396,9 +48409,9 @@ "syntaxKind": "PropertySignature", "name": "type", "value": "'mobile' | ''", - "description": "The type of number to collect.\n\nSpecific style may be applied to each type to provide extra guidance to users. Note that no extra validation is performed based on the type.", + "description": "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.\n\nStyling hint for the input keyboard. Doesn't validate the phone number format. Implement validation in your extension and use the `error` prop to show results.", "isOptional": true, - "defaultValue": "'' meaning no specific kind of phone number" + "defaultValue": "''" }, { "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", @@ -48416,7 +48429,7 @@ "src/surfaces/checkout/components/DateField.ts": { "filePath": "src/surfaces/checkout/components/DateField.ts", "name": "DateFieldElementProps", - "description": "The date field component captures date input with a consistent interface for date selection and proper validation. Use it to collect date information in forms, scheduling interfaces, or data entry workflows.\n\nThe component supports manual text entry. For visual calendar-based selection, consider using [date picker](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/forms/date-picker).", + "description": "", "isPublicDocs": true, "members": [ { @@ -48424,7 +48437,7 @@ "syntaxKind": "PropertySignature", "name": "allow", "value": "string", - "description": "Dates that can be selected.\n\nA comma-separated list of dates, date ranges. Whitespace is allowed after commas.\n\nThe default `''` allows all dates.\n\n- Dates in `YYYY-MM-DD` format allow a single date.\n- Dates in `YYYY-MM` format allow a whole month.\n- Dates in `YYYY` format allow a whole year.\n- Ranges are expressed as `start--end`. - Ranges are inclusive.\n - If either `start` or `end` is omitted, the range is unbounded in that direction.\n - If parts of the date are omitted for `start`, they are assumed to be the minimum possible value.\n So `2024--` is equivalent to `2024-01-01--`.\n - If parts of the date are omitted for `end`, they are assumed to be the maximum possible value.\n So `--2024` is equivalent to `--2024-12-31`.\n - Whitespace is allowed either side of `--`.", + "description": "Restricts which dates the user can select. Accepts a comma-separated list of dates and date ranges. Whitespace is allowed after commas.\n\nThe default `''` allows all dates.\n\n- Dates in `YYYY-MM-DD` format allow a single date.\n- Dates in `YYYY-MM` format allow a whole month.\n- Dates in `YYYY` format allow a whole year.\n- Ranges are expressed as `start--end`. - Ranges are inclusive.\n - If either `start` or `end` is omitted, the range is unbounded in that direction.\n - If parts of the date are omitted for `start`, they are assumed to be the minimum possible value.\n So `2024--` is equivalent to `2024-01-01--`.\n - If parts of the date are omitted for `end`, they are assumed to be the maximum possible value.\n So `--2024` is equivalent to `--2024-12-31`.\n - Whitespace is allowed either side of `--`.\n\nComma-separated list of allowed dates in `YYYY-MM-DD` format.", "isOptional": true, "defaultValue": "\"\"", "examples": [ @@ -48445,7 +48458,7 @@ "syntaxKind": "PropertySignature", "name": "allowDays", "value": "string", - "description": "Days of the week that can be selected. These intersect with the result of `allow` and `disallow`.\n\nA comma-separated list of days. Whitespace is allowed after commas.\n\nThe default `''` has no effect on the result of `allow` and `disallow`.\n\nDays are `sunday`, `monday`, `tuesday`, `wednesday`, `thursday`, `friday`, `saturday`.", + "description": "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.\n\nA comma-separated list of days. Whitespace is allowed after commas.\n\nThe default `''` has no effect on the result of `allow` and `disallow`.\n\nDays are `sunday`, `monday`, `tuesday`, `wednesday`, `thursday`, `friday`, `saturday`.", "isOptional": true, "defaultValue": "\"\"", "examples": [ @@ -48466,7 +48479,7 @@ "syntaxKind": "PropertySignature", "name": "autocomplete", "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", "isOptional": true, "defaultValue": "'on' for everything else" }, @@ -48475,7 +48488,7 @@ "syntaxKind": "PropertySignature", "name": "defaultValue", "value": "string", - "description": "The default value for the field.", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces this value.", "isOptional": true }, { @@ -48491,7 +48504,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -48500,7 +48513,7 @@ "syntaxKind": "PropertySignature", "name": "disallow", "value": "string", - "description": "Dates that cannot be selected. These subtract from `allow`.\n\nA comma-separated list of dates, date ranges. Whitespace is allowed after commas.\n\nThe default `''` has no effect on `allow`.\n\n- Dates in `YYYY-MM-DD` format disallow a single date.\n- Dates in `YYYY-MM` format disallow a whole month.\n- Dates in `YYYY` format disallow a whole year.\n- Ranges are expressed as `start--end`. - Ranges are inclusive.\n - If either `start` or `end` is omitted, the range is unbounded in that direction.\n - If parts of the date are omitted for `start`, they are assumed to be the minimum possible value.\n So `2024--` is equivalent to `2024-01-01--`.\n - If parts of the date are omitted for `end`, they are assumed to be the maximum possible value.\n So `--2024` is equivalent to `--2024-12-31`.\n - Whitespace is allowed either side of `--`.", + "description": "Dates that cannot be selected. These subtract from `allow`.\n\nA comma-separated list of dates, date ranges. Whitespace is allowed after commas.\n\nThe default `''` has no effect on `allow`.\n\n- Dates in `YYYY-MM-DD` format disallow a single date.\n- Dates in `YYYY-MM` format disallow a whole month.\n- Dates in `YYYY` format disallow a whole year.\n- Ranges are expressed as `start--end`. - Ranges are inclusive.\n - If either `start` or `end` is omitted, the range is unbounded in that direction.\n - If parts of the date are omitted for `start`, they are assumed to be the minimum possible value.\n So `2024--` is equivalent to `2024-01-01--`.\n - If parts of the date are omitted for `end`, they are assumed to be the maximum possible value.\n So `--2024` is equivalent to `--2024-12-31`.\n - Whitespace is allowed either side of `--`.\n\nComma-separated list of disallowed dates in `YYYY-MM-DD` format.", "isOptional": true, "defaultValue": "\"\"", "examples": [ @@ -48542,7 +48555,7 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -48550,7 +48563,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -48558,7 +48571,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Content to use as the field label.", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", "isOptional": true }, { @@ -48566,7 +48579,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -48584,7 +48597,7 @@ "syntaxKind": "PropertySignature", "name": "readOnly", "value": "boolean", - "description": "The field cannot be edited by the user. It is focusable will be announced by screen readers.", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", "isOptional": true, "defaultValue": "false" }, @@ -48637,7 +48650,7 @@ "syntaxKind": "PropertySignature", "name": "onChange", "value": "(event: Event) => void", - "description": "Callback when the user has **finished editing** a field, for example, once they have blurred the field.", + "description": "A callback fired when the user has **finished editing** a field, such as when they blur the field or press Enter.", "isOptional": true }, { @@ -48653,7 +48666,7 @@ "syntaxKind": "PropertySignature", "name": "onInput", "value": "(event: Event) => void", - "description": "Callback when the user makes any changes in the field.", + "description": "A callback fired when the user makes any changes in the field, such as typing a character.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).", "isOptional": true }, { @@ -48661,7 +48674,7 @@ "syntaxKind": "PropertySignature", "name": "onInvalid", "value": "(event: Event) => void", - "description": "Callback when the field has an invalid date. This callback will be called, if the date typed is invalid or disabled.\n\nDates that don’t exist or have formatting errors are considered invalid. Some examples of invalid dates are:\n- 2021-02-31: February doesn’t have 31 days\n- 2021-02-00: The day can’t be 00\n\nDisallowed dates are considered invalid.\n\nIt’s important to note that this callback will be called only when the user **finishes editing** the date, and it’s called right after the `onChange` callback. The field is **not** validated on every change to the input. Once the buyer has signalled that 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.", + "description": "Callback when the field has an invalid date. This callback will be called, if the date typed is invalid or disabled.\n\nDates that don’t exist or have formatting errors are considered invalid. Some examples of invalid dates are:\n- 2021-02-31: February doesn’t have 31 days\n- 2021-02-00: The day can’t be 00\n\nDisallowed dates are considered invalid.\n\nThis callback fires only when the user finishes editing the date, right after the `change` callback. The field isn’t validated on every change to the input. Once the user has signalled that 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.", "isOptional": true }, { @@ -48680,7 +48693,7 @@ "src/surfaces/checkout/components/DateField.ts": { "filePath": "src/surfaces/checkout/components/DateField.ts", "name": "DateFieldElementEvents", - "description": "Learn more about [registering events](/docs/api/checkout-ui-extensions/latest/using-polaris-components#event-handling).", + "description": "", "isPublicDocs": true, "members": [ { @@ -48688,7 +48701,7 @@ "syntaxKind": "PropertySignature", "name": "blur", "value": "CallbackEventListener", - "description": "A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "description": "A callback fired when the date field loses focus.\n\nLearn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", "isOptional": true }, { @@ -48696,7 +48709,7 @@ "syntaxKind": "PropertySignature", "name": "change", "value": "CallbackEventListener", - "description": "Callback when the user has **finished editing** a field, for example, once they have blurred the field.", + "description": "A callback fired when the date field value changes.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", "isOptional": true }, { @@ -48704,7 +48717,7 @@ "syntaxKind": "PropertySignature", "name": "focus", "value": "CallbackEventListener", - "description": "A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "description": "A callback fired when the date field receives focus.\n\nLearn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", "isOptional": true }, { @@ -48712,7 +48725,7 @@ "syntaxKind": "PropertySignature", "name": "input", "value": "CallbackEventListener", - "description": "Callback when the user makes any changes in the field.", + "description": "A callback fired when the user inputs data into the date field.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).", "isOptional": true }, { @@ -48720,7 +48733,7 @@ "syntaxKind": "PropertySignature", "name": "invalid", "value": "CallbackEventListener", - "description": "Callback when the user enters an invalid date.", + "description": "A callback fired when the date field value is invalid.\n\nLearn more about the [invalid event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement/invalid_event).", "isOptional": true }, { @@ -48728,11 +48741,11 @@ "syntaxKind": "PropertySignature", "name": "viewChange", "value": "CallbackEventListener", - "description": "Callback when the view changes.", + "description": "A callback fired when the calendar view changes, such as when navigating between months.", "isOptional": true } ], - "value": "export interface DateFieldElementEvents {\n /**\n * A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur?: CallbackEventListener;\n /**\n * Callback when the user has **finished editing** a field, for example, once they have blurred the field.\n */\n change?: CallbackEventListener;\n /**\n * A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus?: CallbackEventListener;\n /**\n * Callback when the user makes any changes in the field.\n */\n input?: CallbackEventListener;\n /**\n * Callback when the user enters an invalid date.\n */\n invalid?: CallbackEventListener;\n /**\n * Callback when the view changes.\n */\n viewChange?: CallbackEventListener;\n}" + "value": "export interface DateFieldElementEvents {\n /**\n * A callback fired when the date field loses focus.\n *\n * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur?: CallbackEventListener;\n /**\n * A callback fired when the date field value changes.\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change?: CallbackEventListener;\n /**\n * A callback fired when the date field receives focus.\n *\n * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus?: CallbackEventListener;\n /**\n * A callback fired when the user inputs data into the date field.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input?: CallbackEventListener;\n /**\n * A callback fired when the date field value is invalid.\n *\n * Learn more about the [invalid event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement/invalid_event).\n */\n invalid?: CallbackEventListener;\n /**\n * A callback fired when the calendar view changes, such as when navigating between months.\n */\n viewChange?: CallbackEventListener;\n}" } }, "DateFieldElement": { @@ -48761,7 +48774,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/DateField.ts", @@ -48775,7 +48788,7 @@ "syntaxKind": "PropertySignature", "name": "allow", "value": "string", - "description": "Dates that can be selected.\n\nA comma-separated list of dates, date ranges. Whitespace is allowed after commas.\n\nThe default `''` allows all dates.\n\n- Dates in `YYYY-MM-DD` format allow a single date.\n- Dates in `YYYY-MM` format allow a whole month.\n- Dates in `YYYY` format allow a whole year.\n- Ranges are expressed as `start--end`. - Ranges are inclusive.\n - If either `start` or `end` is omitted, the range is unbounded in that direction.\n - If parts of the date are omitted for `start`, they are assumed to be the minimum possible value.\n So `2024--` is equivalent to `2024-01-01--`.\n - If parts of the date are omitted for `end`, they are assumed to be the maximum possible value.\n So `--2024` is equivalent to `--2024-12-31`.\n - Whitespace is allowed either side of `--`.", + "description": "Restricts which dates the user can select. Accepts a comma-separated list of dates and date ranges. Whitespace is allowed after commas.\n\nThe default `''` allows all dates.\n\n- Dates in `YYYY-MM-DD` format allow a single date.\n- Dates in `YYYY-MM` format allow a whole month.\n- Dates in `YYYY` format allow a whole year.\n- Ranges are expressed as `start--end`. - Ranges are inclusive.\n - If either `start` or `end` is omitted, the range is unbounded in that direction.\n - If parts of the date are omitted for `start`, they are assumed to be the minimum possible value.\n So `2024--` is equivalent to `2024-01-01--`.\n - If parts of the date are omitted for `end`, they are assumed to be the maximum possible value.\n So `--2024` is equivalent to `--2024-12-31`.\n - Whitespace is allowed either side of `--`.\n\nComma-separated list of allowed dates in `YYYY-MM-DD` format.", "isOptional": true, "defaultValue": "\"\"", "examples": [ @@ -48796,7 +48809,7 @@ "syntaxKind": "PropertySignature", "name": "allowDays", "value": "string", - "description": "Days of the week that can be selected. These intersect with the result of `allow` and `disallow`.\n\nA comma-separated list of days. Whitespace is allowed after commas.\n\nThe default `''` has no effect on the result of `allow` and `disallow`.\n\nDays are `sunday`, `monday`, `tuesday`, `wednesday`, `thursday`, `friday`, `saturday`.", + "description": "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.\n\nA comma-separated list of days. Whitespace is allowed after commas.\n\nThe default `''` has no effect on the result of `allow` and `disallow`.\n\nDays are `sunday`, `monday`, `tuesday`, `wednesday`, `thursday`, `friday`, `saturday`.", "isOptional": true, "defaultValue": "\"\"", "examples": [ @@ -49244,7 +49257,7 @@ "syntaxKind": "PropertySignature", "name": "autocomplete", "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", "isOptional": true, "defaultValue": "'on' for everything else" }, @@ -49435,7 +49448,7 @@ "syntaxKind": "PropertySignature", "name": "defaultValue", "value": "string", - "description": "The default value for the field.", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces this value.", "isOptional": true }, { @@ -49458,7 +49471,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -49467,7 +49480,7 @@ "syntaxKind": "PropertySignature", "name": "disallow", "value": "string", - "description": "Dates that cannot be selected. These subtract from `allow`.\n\nA comma-separated list of dates, date ranges. Whitespace is allowed after commas.\n\nThe default `''` has no effect on `allow`.\n\n- Dates in `YYYY-MM-DD` format disallow a single date.\n- Dates in `YYYY-MM` format disallow a whole month.\n- Dates in `YYYY` format disallow a whole year.\n- Ranges are expressed as `start--end`. - Ranges are inclusive.\n - If either `start` or `end` is omitted, the range is unbounded in that direction.\n - If parts of the date are omitted for `start`, they are assumed to be the minimum possible value.\n So `2024--` is equivalent to `2024-01-01--`.\n - If parts of the date are omitted for `end`, they are assumed to be the maximum possible value.\n So `--2024` is equivalent to `--2024-12-31`.\n - Whitespace is allowed either side of `--`.", + "description": "Dates that cannot be selected. These subtract from `allow`.\n\nA comma-separated list of dates, date ranges. Whitespace is allowed after commas.\n\nThe default `''` has no effect on `allow`.\n\n- Dates in `YYYY-MM-DD` format disallow a single date.\n- Dates in `YYYY-MM` format disallow a whole month.\n- Dates in `YYYY` format disallow a whole year.\n- Ranges are expressed as `start--end`. - Ranges are inclusive.\n - If either `start` or `end` is omitted, the range is unbounded in that direction.\n - If parts of the date are omitted for `start`, they are assumed to be the minimum possible value.\n So `2024--` is equivalent to `2024-01-01--`.\n - If parts of the date are omitted for `end`, they are assumed to be the maximum possible value.\n So `--2024` is equivalent to `--2024-12-31`.\n - Whitespace is allowed either side of `--`.\n\nComma-separated list of disallowed dates in `YYYY-MM-DD` format.", "isOptional": true, "defaultValue": "\"\"", "examples": [ @@ -49614,7 +49627,7 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -49784,7 +49797,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -49876,7 +49889,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Content to use as the field label.", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", "isOptional": true }, { @@ -49933,7 +49946,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -50873,7 +50886,7 @@ "syntaxKind": "PropertySignature", "name": "readOnly", "value": "boolean", - "description": "The field cannot be edited by the user. It is focusable will be announced by screen readers.", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", "isOptional": true, "defaultValue": "false" }, @@ -50924,7 +50937,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/DateField.ts", @@ -51213,7 +51226,7 @@ "syntaxKind": "PropertySignature", "name": "allow", "value": "string", - "description": "Dates that can be selected.\n\nA comma-separated list of dates, date ranges. Whitespace is allowed after commas.\n\nThe default `''` allows all dates.\n\n- Dates in `YYYY-MM-DD` format allow a single date.\n- Dates in `YYYY-MM` format allow a whole month.\n- Dates in `YYYY` format allow a whole year.\n- Ranges are expressed as `start--end`. - Ranges are inclusive.\n - If either `start` or `end` is omitted, the range is unbounded in that direction.\n - If parts of the date are omitted for `start`, they are assumed to be the minimum possible value.\n So `2024--` is equivalent to `2024-01-01--`.\n - If parts of the date are omitted for `end`, they are assumed to be the maximum possible value.\n So `--2024` is equivalent to `--2024-12-31`.\n - Whitespace is allowed either side of `--`.", + "description": "Restricts which dates the user can select. Accepts a comma-separated list of dates and date ranges. Whitespace is allowed after commas.\n\nThe default `''` allows all dates.\n\n- Dates in `YYYY-MM-DD` format allow a single date.\n- Dates in `YYYY-MM` format allow a whole month.\n- Dates in `YYYY` format allow a whole year.\n- Ranges are expressed as `start--end`. - Ranges are inclusive.\n - If either `start` or `end` is omitted, the range is unbounded in that direction.\n - If parts of the date are omitted for `start`, they are assumed to be the minimum possible value.\n So `2024--` is equivalent to `2024-01-01--`.\n - If parts of the date are omitted for `end`, they are assumed to be the maximum possible value.\n So `--2024` is equivalent to `--2024-12-31`.\n - Whitespace is allowed either side of `--`.\n\nComma-separated list of allowed dates in `YYYY-MM-DD` format.", "isOptional": true, "defaultValue": "\"\"", "examples": [ @@ -51234,7 +51247,7 @@ "syntaxKind": "PropertySignature", "name": "allowDays", "value": "string", - "description": "Days of the week that can be selected. These intersect with the result of `allow` and `disallow`.\n\nA comma-separated list of days. Whitespace is allowed after commas.\n\nThe default `''` has no effect on the result of `allow` and `disallow`.\n\nDays are `sunday`, `monday`, `tuesday`, `wednesday`, `thursday`, `friday`, `saturday`.", + "description": "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.\n\nA comma-separated list of days. Whitespace is allowed after commas.\n\nThe default `''` has no effect on the result of `allow` and `disallow`.\n\nDays are `sunday`, `monday`, `tuesday`, `wednesday`, `thursday`, `friday`, `saturday`.", "isOptional": true, "defaultValue": "\"\"", "examples": [ @@ -51255,7 +51268,7 @@ "syntaxKind": "PropertySignature", "name": "autocomplete", "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", "isOptional": true, "defaultValue": "'on' for everything else" }, @@ -51264,7 +51277,7 @@ "syntaxKind": "PropertySignature", "name": "defaultValue", "value": "string", - "description": "The default value for the field.", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces this value.", "isOptional": true }, { @@ -51280,7 +51293,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -51289,7 +51302,7 @@ "syntaxKind": "PropertySignature", "name": "disallow", "value": "string", - "description": "Dates that cannot be selected. These subtract from `allow`.\n\nA comma-separated list of dates, date ranges. Whitespace is allowed after commas.\n\nThe default `''` has no effect on `allow`.\n\n- Dates in `YYYY-MM-DD` format disallow a single date.\n- Dates in `YYYY-MM` format disallow a whole month.\n- Dates in `YYYY` format disallow a whole year.\n- Ranges are expressed as `start--end`. - Ranges are inclusive.\n - If either `start` or `end` is omitted, the range is unbounded in that direction.\n - If parts of the date are omitted for `start`, they are assumed to be the minimum possible value.\n So `2024--` is equivalent to `2024-01-01--`.\n - If parts of the date are omitted for `end`, they are assumed to be the maximum possible value.\n So `--2024` is equivalent to `--2024-12-31`.\n - Whitespace is allowed either side of `--`.", + "description": "Dates that cannot be selected. These subtract from `allow`.\n\nA comma-separated list of dates, date ranges. Whitespace is allowed after commas.\n\nThe default `''` has no effect on `allow`.\n\n- Dates in `YYYY-MM-DD` format disallow a single date.\n- Dates in `YYYY-MM` format disallow a whole month.\n- Dates in `YYYY` format disallow a whole year.\n- Ranges are expressed as `start--end`. - Ranges are inclusive.\n - If either `start` or `end` is omitted, the range is unbounded in that direction.\n - If parts of the date are omitted for `start`, they are assumed to be the minimum possible value.\n So `2024--` is equivalent to `2024-01-01--`.\n - If parts of the date are omitted for `end`, they are assumed to be the maximum possible value.\n So `--2024` is equivalent to `--2024-12-31`.\n - Whitespace is allowed either side of `--`.\n\nComma-separated list of disallowed dates in `YYYY-MM-DD` format.", "isOptional": true, "defaultValue": "\"\"", "examples": [ @@ -51331,7 +51344,7 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -51339,7 +51352,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -51347,7 +51360,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Content to use as the field label.", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", "isOptional": true }, { @@ -51355,7 +51368,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -51371,7 +51384,7 @@ "syntaxKind": "PropertySignature", "name": "onChange", "value": "(event: Event) => void", - "description": "Callback when the user has **finished editing** a field, for example, once they have blurred the field.", + "description": "A callback fired when the user has **finished editing** a field, such as when they blur the field or press Enter.", "isOptional": true }, { @@ -51387,7 +51400,7 @@ "syntaxKind": "PropertySignature", "name": "onInput", "value": "(event: Event) => void", - "description": "Callback when the user makes any changes in the field.", + "description": "A callback fired when the user makes any changes in the field, such as typing a character.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).", "isOptional": true }, { @@ -51395,7 +51408,7 @@ "syntaxKind": "PropertySignature", "name": "onInvalid", "value": "(event: Event) => void", - "description": "Callback when the field has an invalid date. This callback will be called, if the date typed is invalid or disabled.\n\nDates that don’t exist or have formatting errors are considered invalid. Some examples of invalid dates are:\n- 2021-02-31: February doesn’t have 31 days\n- 2021-02-00: The day can’t be 00\n\nDisallowed dates are considered invalid.\n\nIt’s important to note that this callback will be called only when the user **finishes editing** the date, and it’s called right after the `onChange` callback. The field is **not** validated on every change to the input. Once the buyer has signalled that 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.", + "description": "Callback when the field has an invalid date. This callback will be called, if the date typed is invalid or disabled.\n\nDates that don’t exist or have formatting errors are considered invalid. Some examples of invalid dates are:\n- 2021-02-31: February doesn’t have 31 days\n- 2021-02-00: The day can’t be 00\n\nDisallowed dates are considered invalid.\n\nThis callback fires only when the user finishes editing the date, right after the `change` callback. The field isn’t validated on every change to the input. Once the user has signalled that 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.", "isOptional": true }, { @@ -51421,7 +51434,7 @@ "syntaxKind": "PropertySignature", "name": "readOnly", "value": "boolean", - "description": "The field cannot be edited by the user. It is focusable will be announced by screen readers.", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", "isOptional": true, "defaultValue": "false" }, @@ -51458,7 +51471,7 @@ "src/surfaces/checkout/components/DatePicker.ts": { "filePath": "src/surfaces/checkout/components/DatePicker.ts", "name": "DatePickerElementProps", - "description": "The date picker component allows merchants to select dates using a calendar interface. Use it when merchants benefit from seeing dates in context of the full month, such as selecting dates relative to today or needing weekday context.\n\nThe component supports single dates, multiple dates, and date ranges. For text date entry, use [date field](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/forms/date-field).", + "description": "", "isPublicDocs": true, "members": [ { @@ -51466,7 +51479,7 @@ "syntaxKind": "PropertySignature", "name": "allow", "value": "string", - "description": "Dates that can be selected.\n\nA comma-separated list of dates, date ranges. Whitespace is allowed after commas.\n\nThe default `''` allows all dates.\n\n- Dates in `YYYY-MM-DD` format allow a single date.\n- Dates in `YYYY-MM` format allow a whole month.\n- Dates in `YYYY` format allow a whole year.\n- Ranges are expressed as `start--end`. - Ranges are inclusive.\n - If either `start` or `end` is omitted, the range is unbounded in that direction.\n - If parts of the date are omitted for `start`, they are assumed to be the minimum possible value.\n So `2024--` is equivalent to `2024-01-01--`.\n - If parts of the date are omitted for `end`, they are assumed to be the maximum possible value.\n So `--2024` is equivalent to `--2024-12-31`.\n - Whitespace is allowed either side of `--`.", + "description": "Restricts which dates the user can select. Accepts a comma-separated list of dates and date ranges. Whitespace is allowed after commas.\n\nThe default `''` allows all dates.\n\n- Dates in `YYYY-MM-DD` format allow a single date.\n- Dates in `YYYY-MM` format allow a whole month.\n- Dates in `YYYY` format allow a whole year.\n- Ranges are expressed as `start--end`. - Ranges are inclusive.\n - If either `start` or `end` is omitted, the range is unbounded in that direction.\n - If parts of the date are omitted for `start`, they are assumed to be the minimum possible value.\n So `2024--` is equivalent to `2024-01-01--`.\n - If parts of the date are omitted for `end`, they are assumed to be the maximum possible value.\n So `--2024` is equivalent to `--2024-12-31`.\n - Whitespace is allowed either side of `--`.\n\nComma-separated list of allowed dates in `YYYY-MM-DD` format.", "isOptional": true, "defaultValue": "\"\"", "examples": [ @@ -51487,7 +51500,7 @@ "syntaxKind": "PropertySignature", "name": "allowDays", "value": "string", - "description": "Days of the week that can be selected. These intersect with the result of `allow` and `disallow`.\n\nA comma-separated list of days. Whitespace is allowed after commas.\n\nThe default `''` has no effect on the result of `allow` and `disallow`.\n\nDays are `sunday`, `monday`, `tuesday`, `wednesday`, `thursday`, `friday`, `saturday`.", + "description": "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.\n\nA comma-separated list of days. Whitespace is allowed after commas.\n\nThe default `''` has no effect on the result of `allow` and `disallow`.\n\nDays are `sunday`, `monday`, `tuesday`, `wednesday`, `thursday`, `friday`, `saturday`.", "isOptional": true, "defaultValue": "\"\"", "examples": [ @@ -51525,7 +51538,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -51534,7 +51547,7 @@ "syntaxKind": "PropertySignature", "name": "disallow", "value": "string", - "description": "Dates that cannot be selected. These subtract from `allow`.\n\nA comma-separated list of dates, date ranges. Whitespace is allowed after commas.\n\nThe default `''` has no effect on `allow`.\n\n- Dates in `YYYY-MM-DD` format disallow a single date.\n- Dates in `YYYY-MM` format disallow a whole month.\n- Dates in `YYYY` format disallow a whole year.\n- Ranges are expressed as `start--end`. - Ranges are inclusive.\n - If either `start` or `end` is omitted, the range is unbounded in that direction.\n - If parts of the date are omitted for `start`, they are assumed to be the minimum possible value.\n So `2024--` is equivalent to `2024-01-01--`.\n - If parts of the date are omitted for `end`, they are assumed to be the maximum possible value.\n So `--2024` is equivalent to `--2024-12-31`.\n - Whitespace is allowed either side of `--`.", + "description": "Dates that cannot be selected. These subtract from `allow`.\n\nA comma-separated list of dates, date ranges. Whitespace is allowed after commas.\n\nThe default `''` has no effect on `allow`.\n\n- Dates in `YYYY-MM-DD` format disallow a single date.\n- Dates in `YYYY-MM` format disallow a whole month.\n- Dates in `YYYY` format disallow a whole year.\n- Ranges are expressed as `start--end`. - Ranges are inclusive.\n - If either `start` or `end` is omitted, the range is unbounded in that direction.\n - If parts of the date are omitted for `start`, they are assumed to be the minimum possible value.\n So `2024--` is equivalent to `2024-01-01--`.\n - If parts of the date are omitted for `end`, they are assumed to be the maximum possible value.\n So `--2024` is equivalent to `--2024-12-31`.\n - Whitespace is allowed either side of `--`.\n\nComma-separated list of disallowed dates in `YYYY-MM-DD` format.", "isOptional": true, "defaultValue": "\"\"", "examples": [ @@ -51576,7 +51589,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -51584,7 +51597,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -51601,7 +51614,7 @@ "syntaxKind": "PropertySignature", "name": "value", "value": "string", - "description": "Current selected value.\n\nThe default means no date is selected.\n\nIf the provided value is invalid, no date is selected.\n\nOtherwise:\n\n- If `type=\"single\"`, this is a date in `YYYY-MM-DD` format.\n- If `type=\"multiple\"`, this is a comma-separated list of dates in `YYYY-MM-DD` format.\n- If `type=\"range\"`, this is a range in `YYYY-MM-DD--YYYY-MM-DD` format. The range is inclusive.", + "description": "Current selected value.\n\nThe default means no date is selected.\n\nIf the provided value is invalid, no date is selected.\n\nOtherwise:\n\n- If `type=\"single\"`, this is a date in `YYYY-MM-DD` format.\n- If `type=\"multiple\"`, this is a comma-separated list of dates in `YYYY-MM-DD` format.\n- If `type=\"range\"`, this is a range in `YYYY-MM-DD--YYYY-MM-DD` format. The range is inclusive.\n\nSingle dates use ISO 8601 format (`YYYY-MM-DD`); ranges use `YYYY-MM-DD--YYYY-MM-DD`. Locale-specific formats aren't supported.", "isOptional": true, "defaultValue": "\"\"" }, @@ -51672,7 +51685,7 @@ "src/surfaces/checkout/components/DatePicker.ts": { "filePath": "src/surfaces/checkout/components/DatePicker.ts", "name": "DatePickerElementEvents", - "description": "Learn more about [registering events](/docs/api/checkout-ui-extensions/latest/using-polaris-components#event-handling).", + "description": "", "isPublicDocs": true, "members": [ { @@ -51680,7 +51693,7 @@ "syntaxKind": "PropertySignature", "name": "blur", "value": "CallbackEventListener", - "description": "A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "description": "A callback fired when the date picker loses focus.\n\nLearn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", "isOptional": true }, { @@ -51688,7 +51701,7 @@ "syntaxKind": "PropertySignature", "name": "change", "value": "CallbackEventListener", - "description": "Callback when the user has **finished editing** a field, for example, once they have blurred the field.", + "description": "A callback fired when the date picker value changes.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", "isOptional": true }, { @@ -51696,7 +51709,7 @@ "syntaxKind": "PropertySignature", "name": "focus", "value": "CallbackEventListener", - "description": "A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "description": "A callback fired when the date picker receives focus.\n\nLearn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", "isOptional": true }, { @@ -51704,7 +51717,7 @@ "syntaxKind": "PropertySignature", "name": "input", "value": "CallbackEventListener", - "description": "Callback when the user makes any changes in the field.", + "description": "A callback fired when the user inputs data into the date picker.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).", "isOptional": true }, { @@ -51712,11 +51725,11 @@ "syntaxKind": "PropertySignature", "name": "viewChange", "value": "CallbackEventListener", - "description": "Callback when the view changes.", + "description": "A callback fired when the calendar view changes, such as when navigating between months.", "isOptional": true } ], - "value": "export interface DatePickerElementEvents {\n /**\n * A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur?: CallbackEventListener;\n /**\n * Callback when the user has **finished editing** a field, for example, once they have blurred the field.\n */\n change?: CallbackEventListener;\n /**\n * A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus?: CallbackEventListener;\n /**\n * Callback when the user makes any changes in the field.\n */\n input?: CallbackEventListener;\n /**\n * Callback when the view changes.\n */\n viewChange?: CallbackEventListener;\n}" + "value": "export interface DatePickerElementEvents {\n /**\n * A callback fired when the date picker loses focus.\n *\n * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur?: CallbackEventListener;\n /**\n * A callback fired when the date picker value changes.\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change?: CallbackEventListener;\n /**\n * A callback fired when the date picker receives focus.\n *\n * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus?: CallbackEventListener;\n /**\n * A callback fired when the user inputs data into the date picker.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input?: CallbackEventListener;\n /**\n * A callback fired when the calendar view changes, such as when navigating between months.\n */\n viewChange?: CallbackEventListener;\n}" } }, "DatePickerElement": { @@ -51745,7 +51758,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/DatePicker.ts", @@ -51759,7 +51772,7 @@ "syntaxKind": "PropertySignature", "name": "allow", "value": "string", - "description": "Dates that can be selected.\n\nA comma-separated list of dates, date ranges. Whitespace is allowed after commas.\n\nThe default `''` allows all dates.\n\n- Dates in `YYYY-MM-DD` format allow a single date.\n- Dates in `YYYY-MM` format allow a whole month.\n- Dates in `YYYY` format allow a whole year.\n- Ranges are expressed as `start--end`. - Ranges are inclusive.\n - If either `start` or `end` is omitted, the range is unbounded in that direction.\n - If parts of the date are omitted for `start`, they are assumed to be the minimum possible value.\n So `2024--` is equivalent to `2024-01-01--`.\n - If parts of the date are omitted for `end`, they are assumed to be the maximum possible value.\n So `--2024` is equivalent to `--2024-12-31`.\n - Whitespace is allowed either side of `--`.", + "description": "Restricts which dates the user can select. Accepts a comma-separated list of dates and date ranges. Whitespace is allowed after commas.\n\nThe default `''` allows all dates.\n\n- Dates in `YYYY-MM-DD` format allow a single date.\n- Dates in `YYYY-MM` format allow a whole month.\n- Dates in `YYYY` format allow a whole year.\n- Ranges are expressed as `start--end`. - Ranges are inclusive.\n - If either `start` or `end` is omitted, the range is unbounded in that direction.\n - If parts of the date are omitted for `start`, they are assumed to be the minimum possible value.\n So `2024--` is equivalent to `2024-01-01--`.\n - If parts of the date are omitted for `end`, they are assumed to be the maximum possible value.\n So `--2024` is equivalent to `--2024-12-31`.\n - Whitespace is allowed either side of `--`.\n\nComma-separated list of allowed dates in `YYYY-MM-DD` format.", "isOptional": true, "defaultValue": "\"\"", "examples": [ @@ -51780,7 +51793,7 @@ "syntaxKind": "PropertySignature", "name": "allowDays", "value": "string", - "description": "Days of the week that can be selected. These intersect with the result of `allow` and `disallow`.\n\nA comma-separated list of days. Whitespace is allowed after commas.\n\nThe default `''` has no effect on the result of `allow` and `disallow`.\n\nDays are `sunday`, `monday`, `tuesday`, `wednesday`, `thursday`, `friday`, `saturday`.", + "description": "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.\n\nA comma-separated list of days. Whitespace is allowed after commas.\n\nThe default `''` has no effect on the result of `allow` and `disallow`.\n\nDays are `sunday`, `monday`, `tuesday`, `wednesday`, `thursday`, `friday`, `saturday`.", "isOptional": true, "defaultValue": "\"\"", "examples": [ @@ -52434,7 +52447,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -52443,7 +52456,7 @@ "syntaxKind": "PropertySignature", "name": "disallow", "value": "string", - "description": "Dates that cannot be selected. These subtract from `allow`.\n\nA comma-separated list of dates, date ranges. Whitespace is allowed after commas.\n\nThe default `''` has no effect on `allow`.\n\n- Dates in `YYYY-MM-DD` format disallow a single date.\n- Dates in `YYYY-MM` format disallow a whole month.\n- Dates in `YYYY` format disallow a whole year.\n- Ranges are expressed as `start--end`. - Ranges are inclusive.\n - If either `start` or `end` is omitted, the range is unbounded in that direction.\n - If parts of the date are omitted for `start`, they are assumed to be the minimum possible value.\n So `2024--` is equivalent to `2024-01-01--`.\n - If parts of the date are omitted for `end`, they are assumed to be the maximum possible value.\n So `--2024` is equivalent to `--2024-12-31`.\n - Whitespace is allowed either side of `--`.", + "description": "Dates that cannot be selected. These subtract from `allow`.\n\nA comma-separated list of dates, date ranges. Whitespace is allowed after commas.\n\nThe default `''` has no effect on `allow`.\n\n- Dates in `YYYY-MM-DD` format disallow a single date.\n- Dates in `YYYY-MM` format disallow a whole month.\n- Dates in `YYYY` format disallow a whole year.\n- Ranges are expressed as `start--end`. - Ranges are inclusive.\n - If either `start` or `end` is omitted, the range is unbounded in that direction.\n - If parts of the date are omitted for `start`, they are assumed to be the minimum possible value.\n So `2024--` is equivalent to `2024-01-01--`.\n - If parts of the date are omitted for `end`, they are assumed to be the maximum possible value.\n So `--2024` is equivalent to `--2024-12-31`.\n - Whitespace is allowed either side of `--`.\n\nComma-separated list of disallowed dates in `YYYY-MM-DD` format.", "isOptional": true, "defaultValue": "\"\"", "examples": [ @@ -52752,7 +52765,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -52900,7 +52913,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -53879,7 +53892,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/DatePicker.ts", @@ -54126,7 +54139,7 @@ "syntaxKind": "PropertySignature", "name": "value", "value": "string", - "description": "Current selected value.\n\nThe default means no date is selected.\n\nIf the provided value is invalid, no date is selected.\n\nOtherwise:\n\n- If `type=\"single\"`, this is a date in `YYYY-MM-DD` format.\n- If `type=\"multiple\"`, this is a comma-separated list of dates in `YYYY-MM-DD` format.\n- If `type=\"range\"`, this is a range in `YYYY-MM-DD--YYYY-MM-DD` format. The range is inclusive.", + "description": "Current selected value.\n\nThe default means no date is selected.\n\nIf the provided value is invalid, no date is selected.\n\nOtherwise:\n\n- If `type=\"single\"`, this is a date in `YYYY-MM-DD` format.\n- If `type=\"multiple\"`, this is a comma-separated list of dates in `YYYY-MM-DD` format.\n- If `type=\"range\"`, this is a range in `YYYY-MM-DD--YYYY-MM-DD` format. The range is inclusive.\n\nSingle dates use ISO 8601 format (`YYYY-MM-DD`); ranges use `YYYY-MM-DD--YYYY-MM-DD`. Locale-specific formats aren't supported.", "isOptional": true, "defaultValue": "\"\"" }, @@ -54169,7 +54182,7 @@ "syntaxKind": "PropertySignature", "name": "allow", "value": "string", - "description": "Dates that can be selected.\n\nA comma-separated list of dates, date ranges. Whitespace is allowed after commas.\n\nThe default `''` allows all dates.\n\n- Dates in `YYYY-MM-DD` format allow a single date.\n- Dates in `YYYY-MM` format allow a whole month.\n- Dates in `YYYY` format allow a whole year.\n- Ranges are expressed as `start--end`. - Ranges are inclusive.\n - If either `start` or `end` is omitted, the range is unbounded in that direction.\n - If parts of the date are omitted for `start`, they are assumed to be the minimum possible value.\n So `2024--` is equivalent to `2024-01-01--`.\n - If parts of the date are omitted for `end`, they are assumed to be the maximum possible value.\n So `--2024` is equivalent to `--2024-12-31`.\n - Whitespace is allowed either side of `--`.", + "description": "Restricts which dates the user can select. Accepts a comma-separated list of dates and date ranges. Whitespace is allowed after commas.\n\nThe default `''` allows all dates.\n\n- Dates in `YYYY-MM-DD` format allow a single date.\n- Dates in `YYYY-MM` format allow a whole month.\n- Dates in `YYYY` format allow a whole year.\n- Ranges are expressed as `start--end`. - Ranges are inclusive.\n - If either `start` or `end` is omitted, the range is unbounded in that direction.\n - If parts of the date are omitted for `start`, they are assumed to be the minimum possible value.\n So `2024--` is equivalent to `2024-01-01--`.\n - If parts of the date are omitted for `end`, they are assumed to be the maximum possible value.\n So `--2024` is equivalent to `--2024-12-31`.\n - Whitespace is allowed either side of `--`.\n\nComma-separated list of allowed dates in `YYYY-MM-DD` format.", "isOptional": true, "defaultValue": "\"\"", "examples": [ @@ -54190,7 +54203,7 @@ "syntaxKind": "PropertySignature", "name": "allowDays", "value": "string", - "description": "Days of the week that can be selected. These intersect with the result of `allow` and `disallow`.\n\nA comma-separated list of days. Whitespace is allowed after commas.\n\nThe default `''` has no effect on the result of `allow` and `disallow`.\n\nDays are `sunday`, `monday`, `tuesday`, `wednesday`, `thursday`, `friday`, `saturday`.", + "description": "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.\n\nA comma-separated list of days. Whitespace is allowed after commas.\n\nThe default `''` has no effect on the result of `allow` and `disallow`.\n\nDays are `sunday`, `monday`, `tuesday`, `wednesday`, `thursday`, `friday`, `saturday`.", "isOptional": true, "defaultValue": "\"\"", "examples": [ @@ -54228,7 +54241,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -54237,7 +54250,7 @@ "syntaxKind": "PropertySignature", "name": "disallow", "value": "string", - "description": "Dates that cannot be selected. These subtract from `allow`.\n\nA comma-separated list of dates, date ranges. Whitespace is allowed after commas.\n\nThe default `''` has no effect on `allow`.\n\n- Dates in `YYYY-MM-DD` format disallow a single date.\n- Dates in `YYYY-MM` format disallow a whole month.\n- Dates in `YYYY` format disallow a whole year.\n- Ranges are expressed as `start--end`. - Ranges are inclusive.\n - If either `start` or `end` is omitted, the range is unbounded in that direction.\n - If parts of the date are omitted for `start`, they are assumed to be the minimum possible value.\n So `2024--` is equivalent to `2024-01-01--`.\n - If parts of the date are omitted for `end`, they are assumed to be the maximum possible value.\n So `--2024` is equivalent to `--2024-12-31`.\n - Whitespace is allowed either side of `--`.", + "description": "Dates that cannot be selected. These subtract from `allow`.\n\nA comma-separated list of dates, date ranges. Whitespace is allowed after commas.\n\nThe default `''` has no effect on `allow`.\n\n- Dates in `YYYY-MM-DD` format disallow a single date.\n- Dates in `YYYY-MM` format disallow a whole month.\n- Dates in `YYYY` format disallow a whole year.\n- Ranges are expressed as `start--end`. - Ranges are inclusive.\n - If either `start` or `end` is omitted, the range is unbounded in that direction.\n - If parts of the date are omitted for `start`, they are assumed to be the minimum possible value.\n So `2024--` is equivalent to `2024-01-01--`.\n - If parts of the date are omitted for `end`, they are assumed to be the maximum possible value.\n So `--2024` is equivalent to `--2024-12-31`.\n - Whitespace is allowed either side of `--`.\n\nComma-separated list of disallowed dates in `YYYY-MM-DD` format.", "isOptional": true, "defaultValue": "\"\"", "examples": [ @@ -54279,7 +54292,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -54287,7 +54300,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -54344,7 +54357,7 @@ "syntaxKind": "PropertySignature", "name": "value", "value": "string", - "description": "Current selected value.\n\nThe default means no date is selected.\n\nIf the provided value is invalid, no date is selected.\n\nOtherwise:\n\n- If `type=\"single\"`, this is a date in `YYYY-MM-DD` format.\n- If `type=\"multiple\"`, this is a comma-separated list of dates in `YYYY-MM-DD` format.\n- If `type=\"range\"`, this is a range in `YYYY-MM-DD--YYYY-MM-DD` format. The range is inclusive.", + "description": "Current selected value.\n\nThe default means no date is selected.\n\nIf the provided value is invalid, no date is selected.\n\nOtherwise:\n\n- If `type=\"single\"`, this is a date in `YYYY-MM-DD` format.\n- If `type=\"multiple\"`, this is a comma-separated list of dates in `YYYY-MM-DD` format.\n- If `type=\"range\"`, this is a range in `YYYY-MM-DD--YYYY-MM-DD` format. The range is inclusive.\n\nSingle dates use ISO 8601 format (`YYYY-MM-DD`); ranges use `YYYY-MM-DD--YYYY-MM-DD`. Locale-specific formats aren't supported.", "isOptional": true, "defaultValue": "\"\"" }, @@ -54364,7 +54377,7 @@ "src/surfaces/checkout/components/Details.ts": { "filePath": "src/surfaces/checkout/components/Details.ts", "name": "DetailsElementProps", - "description": "Creates a collapsible content area that can be expanded or collapsed by users. Use with Summary to provide expandable sections for additional information or settings.", + "description": "", "isPublicDocs": true, "members": [ { @@ -54372,7 +54385,7 @@ "syntaxKind": "PropertySignature", "name": "defaultOpen", "value": "boolean", - "description": "Indicates whether the element should be open by default.\n\nThis reflects to the `open` attribute.", + "description": "Whether the element should be open when it first renders. This reflects to the `open` attribute and only takes effect on the initial render.", "isOptional": true, "defaultValue": "false" }, @@ -54381,7 +54394,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -54389,7 +54402,7 @@ "syntaxKind": "PropertySignature", "name": "open", "value": "boolean", - "description": "Whether the element is open.\n\nThis does not reflect to any attribute.", + "description": "Whether the element is currently open. Use this for controlled component patterns where your application manages the open state directly. This does not reflect to any attribute.", "isOptional": true, "defaultValue": "false" }, @@ -54398,7 +54411,7 @@ "syntaxKind": "PropertySignature", "name": "toggleTransition", "value": "'none' | 'auto'", - "description": "Sets the transition between the two states.", + "description": "The transition style used when toggling between open and closed states.\n\n- `none`: Switches states immediately without animation.\n- `auto`: Uses the default animated transition.", "isOptional": true, "defaultValue": "'auto'" } @@ -54418,7 +54431,7 @@ "syntaxKind": "PropertySignature", "name": "onAfterToggle", "value": "(event: ToggleEvent$1) => void", - "description": "A callback fired when the element state changes, after any toggle animations have finished.\n\n- If the element transitioned from hidden to showing, the `oldState` property will be set to `closed` and the `newState` property will be set to `open`.\n- If the element transitioned from showing to hidden, the `oldState` property will be set to `open` and the `newState` will be `closed`.\n\nLearn more about [ToggleEvent.newState](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/newState) and [ToggleEvent.oldState](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/oldState).", + "description": "A callback fired when the element state changes, after any toggle animations have finished.\n\n- If the element transitioned from hidden to showing, the `oldState` property will be set to `closed` and the `newState` property will be set to `open`.\n- If the element transitioned from showing to hidden, the `oldState` property will be set to `open` and the `newState` will be `closed`.\n\nLearn more about 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.", "isOptional": true }, { @@ -54426,7 +54439,7 @@ "syntaxKind": "PropertySignature", "name": "onToggle", "value": "(event: ToggleEvent$1) => void", - "description": "A callback fired immediately when the element state changes, before any animations.\n\n- If the element is transitioning from hidden to showing, the `oldState` property will be set to `closed` and the `newState` property will be set to `open`.\n- If the element is transitioning from showing to hidden, then `oldState` property will be set to `open` and the `newState` will be `closed`.\n\nLearn more about the [toggle event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/toggle_event), [ToggleEvent.newState](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/newState), and [ToggleEvent.oldState](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/oldState).", + "description": "A callback fired immediately when the element state changes, before any animations.\n\n- If the element is transitioning from hidden to showing, the `oldState` property will be set to `closed` and the `newState` property will be set to `open`.\n- If the element is transitioning from showing to hidden, then the `oldState` property will be set to `open` and the `newState` will be `closed`.\n\nLearn 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.", "isOptional": true } ], @@ -54437,7 +54450,7 @@ "src/surfaces/checkout/components/Details.ts": { "filePath": "src/surfaces/checkout/components/Details.ts", "name": "DetailsElementEvents", - "description": "Learn more about [registering events](/docs/api/checkout-ui-extensions/latest/using-polaris-components#event-handling).", + "description": "", "isPublicDocs": true, "members": [ { @@ -54445,7 +54458,7 @@ "syntaxKind": "PropertySignature", "name": "aftertoggle", "value": "CallbackEventListener", - "description": "Callback fired when the element state changes **after** any animations have finished.\n\n- If the element transitioned from hidden to showing, the `oldState` property will be set to `closed` and the `newState` property will be set to `open`.\n- If the element transitioned from showing to hidden, the `oldState` property will be set to `open` and the `newState` will be `closed`.", + "description": "A callback fired when the element state changes, after any toggle animations have finished.\n\n- If the element transitioned from hidden to showing, the `oldState` property will be set to `closed` and the `newState` property will be set to `open`.\n- If the element transitioned from showing to hidden, the `oldState` property will be set to `open` and the `newState` will be `closed`.\n\nLearn more about 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.", "isOptional": true }, { @@ -54453,11 +54466,11 @@ "syntaxKind": "PropertySignature", "name": "toggle", "value": "CallbackEventListener", - "description": "Callback straight after the element state changes.\n\n- If the element is transitioning from hidden to showing, the `oldState` property will be set to `closed` and the `newState` property will be set to `open`.\n- If the element is transitioning from showing to hidden, then `oldState` property will be set to `open` and the `newState` will be `closed`.", + "description": "A callback fired immediately when the element state changes, before any animations.\n\n- If the element is transitioning from hidden to showing, the `oldState` property will be set to `closed` and the `newState` property will be set to `open`.\n- If the element is transitioning from showing to hidden, then the `oldState` property will be set to `open` and the `newState` will be `closed`.\n\nLearn 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.", "isOptional": true } ], - "value": "export interface DetailsElementEvents {\n /**\n * Callback straight after the element state changes.\n *\n * - If the element is transitioning from hidden to showing, the `oldState` property will be set to `closed` and the\n * `newState` property will be set to `open`.\n * - If the element is transitioning from showing to hidden, then `oldState` property will be set to `open` and the\n * `newState` will be `closed`.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/toggle_event\n * @see https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/newState\n * @see https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/oldState\n */\n toggle?: CallbackEventListener;\n /**\n * Callback fired when the element state changes **after** any animations have finished.\n *\n * - If the element transitioned from hidden to showing, the `oldState` property will be set to `closed` and the\n * `newState` property will be set to `open`.\n * - If the element transitioned from showing to hidden, the `oldState` property will be set to `open` and the\n * `newState` will be `closed`.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/newState\n * @see https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/oldState\n */\n aftertoggle?: CallbackEventListener;\n}" + "value": "export interface DetailsElementEvents {\n /**\n * A callback fired immediately when the element state changes, before any animations.\n *\n * - If the element is transitioning from hidden to showing, the `oldState` property will be set to `closed` and the\n * `newState` property will be set to `open`.\n * - If the element is transitioning from showing to hidden, then the `oldState` property will be set to `open` and the\n * `newState` will be `closed`.\n *\n * 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.\n */\n toggle?: CallbackEventListener;\n /**\n * A callback fired when the element state changes, after any toggle animations have finished.\n *\n * - If the element transitioned from hidden to showing, the `oldState` property will be set to `closed` and the\n * `newState` property will be set to `open`.\n * - If the element transitioned from showing to hidden, the `oldState` property will be set to `open` and the\n * `newState` will be `closed`.\n *\n * Learn more about 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.\n */\n aftertoggle?: CallbackEventListener;\n}" } }, "DetailsElement": { @@ -54486,7 +54499,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/Details.ts", @@ -56494,7 +56507,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/Details.ts", @@ -56758,7 +56771,7 @@ "syntaxKind": "PropertySignature", "name": "defaultOpen", "value": "boolean", - "description": "Indicates whether the element should be open by default.\n\nThis reflects to the `open` attribute.", + "description": "Whether the element should be open when it first renders. This reflects to the `open` attribute and only takes effect on the initial render.", "isOptional": true, "defaultValue": "false" }, @@ -56767,7 +56780,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -56775,7 +56788,7 @@ "syntaxKind": "PropertySignature", "name": "onAfterToggle", "value": "(event: ToggleEvent$1) => void", - "description": "A callback fired when the element state changes, after any toggle animations have finished.\n\n- If the element transitioned from hidden to showing, the `oldState` property will be set to `closed` and the `newState` property will be set to `open`.\n- If the element transitioned from showing to hidden, the `oldState` property will be set to `open` and the `newState` will be `closed`.\n\nLearn more about [ToggleEvent.newState](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/newState) and [ToggleEvent.oldState](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/oldState).", + "description": "A callback fired when the element state changes, after any toggle animations have finished.\n\n- If the element transitioned from hidden to showing, the `oldState` property will be set to `closed` and the `newState` property will be set to `open`.\n- If the element transitioned from showing to hidden, the `oldState` property will be set to `open` and the `newState` will be `closed`.\n\nLearn more about 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.", "isOptional": true }, { @@ -56783,7 +56796,7 @@ "syntaxKind": "PropertySignature", "name": "onToggle", "value": "(event: ToggleEvent$1) => void", - "description": "A callback fired immediately when the element state changes, before any animations.\n\n- If the element is transitioning from hidden to showing, the `oldState` property will be set to `closed` and the `newState` property will be set to `open`.\n- If the element is transitioning from showing to hidden, then `oldState` property will be set to `open` and the `newState` will be `closed`.\n\nLearn more about the [toggle event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/toggle_event), [ToggleEvent.newState](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/newState), and [ToggleEvent.oldState](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/oldState).", + "description": "A callback fired immediately when the element state changes, before any animations.\n\n- If the element is transitioning from hidden to showing, the `oldState` property will be set to `closed` and the `newState` property will be set to `open`.\n- If the element is transitioning from showing to hidden, then the `oldState` property will be set to `open` and the `newState` will be `closed`.\n\nLearn 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.", "isOptional": true }, { @@ -56791,7 +56804,7 @@ "syntaxKind": "PropertySignature", "name": "open", "value": "boolean", - "description": "Whether the element is open.\n\nThis does not reflect to any attribute.", + "description": "Whether the element is currently open. Use this for controlled component patterns where your application manages the open state directly. This does not reflect to any attribute.", "isOptional": true, "defaultValue": "false" }, @@ -56800,7 +56813,7 @@ "syntaxKind": "PropertySignature", "name": "toggleTransition", "value": "'none' | 'auto'", - "description": "Sets the transition between the two states.", + "description": "The transition style used when toggling between open and closed states.\n\n- `none`: Switches states immediately without animation.\n- `auto`: Uses the default animated transition.", "isOptional": true, "defaultValue": "'auto'" } @@ -56812,7 +56825,7 @@ "src/surfaces/checkout/components/Divider.ts": { "filePath": "src/surfaces/checkout/components/Divider.ts", "name": "DividerElementProps", - "description": "The divider component creates clear visual separation between elements in the interface. Use divider to separate distinct content groups in forms, settings panels, lists, or page sections, helping users scan and understand content organization.\n\nDividers support both horizontal and vertical orientations, along with different visual strengths for varying levels of emphasis. For more structured content grouping with headings, use [section](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/layout-and-structure/section).", + "description": "", "isPublicDocs": true, "members": [ { @@ -56820,7 +56833,7 @@ "syntaxKind": "PropertySignature", "name": "direction", "value": "'inline' | 'block'", - "description": "Specify the direction of the divider. This uses [logical properties](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_logical_properties_and_values).", + "description": "Specify the direction of the divider. This uses [logical properties](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_logical_properties_and_values).\n\nVertical dividers (`'block'` direction) require a parent with a defined height to render visibly.", "isOptional": true, "defaultValue": "'inline'" }, @@ -56829,7 +56842,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true } ], @@ -56862,7 +56875,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/Divider.ts", @@ -57492,7 +57505,7 @@ "syntaxKind": "PropertySignature", "name": "direction", "value": "'inline' | 'block'", - "description": "Specify the direction of the divider. This uses [logical properties](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_logical_properties_and_values).", + "description": "Specify the direction of the divider. This uses [logical properties](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_logical_properties_and_values).\n\nVertical dividers (`'block'` direction) require a parent with a defined height to render visibly.", "isOptional": true, "defaultValue": "'inline'" }, @@ -57768,7 +57781,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -58880,7 +58893,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/Divider.ts", @@ -59144,7 +59157,7 @@ "syntaxKind": "PropertySignature", "name": "direction", "value": "'inline' | 'block'", - "description": "Specify the direction of the divider. This uses [logical properties](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_logical_properties_and_values).", + "description": "Specify the direction of the divider. This uses [logical properties](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_logical_properties_and_values).\n\nVertical dividers (`'block'` direction) require a parent with a defined height to render visibly.", "isOptional": true, "defaultValue": "'inline'" }, @@ -59153,7 +59166,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true } ], @@ -59164,7 +59177,7 @@ "src/surfaces/checkout/components/DropZone.ts": { "filePath": "src/surfaces/checkout/components/DropZone.ts", "name": "DropZoneElementProps", - "description": "The drop zone component lets users upload files through drag-and-drop or by clicking to browse. Use for file uploads such as images, documents, or CSV imports.\n\nThe component provides visual feedback during drag operations and supports file type validation through the `accept` property. Rejected files trigger the `droprejected` event for custom error handling.", + "description": "", "isPublicDocs": true, "members": [ { @@ -59189,7 +59202,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -59198,7 +59211,7 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -59206,7 +59219,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -59214,7 +59227,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Content to use as the field label.", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", "isOptional": true }, { @@ -59231,7 +59244,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -59268,7 +59281,7 @@ "syntaxKind": "PropertySignature", "name": "onChange", "value": "(event: Event) => void", - "description": "Callback when the user has **finished selecting** a file or files.", + "description": "A callback fired when the user has finished selecting one or more files.", "isOptional": true }, { @@ -59284,7 +59297,7 @@ "syntaxKind": "PropertySignature", "name": "onInput", "value": "(event: Event) => void", - "description": "Callback when the user makes any changes in the file selection.", + "description": "A callback fired when the user makes any changes to the file selection.", "isOptional": true } ], @@ -59295,7 +59308,7 @@ "src/surfaces/checkout/components/DropZone.ts": { "filePath": "src/surfaces/checkout/components/DropZone.ts", "name": "DropZoneElementEvents", - "description": "Learn more about [registering events](/docs/api/checkout-ui-extensions/latest/using-polaris-components#event-handling).", + "description": "", "isPublicDocs": true, "members": [ { @@ -59303,7 +59316,7 @@ "syntaxKind": "PropertySignature", "name": "change", "value": "CallbackEventListener", - "description": "Callback when the user has finished selecting a file or files.", + "description": "A callback fired when the drop zone value changes.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", "isOptional": true }, { @@ -59311,7 +59324,7 @@ "syntaxKind": "PropertySignature", "name": "droprejected", "value": "CallbackEventListener", - "description": "Callback when rejected files are dropped. Files are rejected based on the `accept` prop.", + "description": "A callback fired when files are rejected based on the `accept` prop.", "isOptional": true }, { @@ -59319,11 +59332,11 @@ "syntaxKind": "PropertySignature", "name": "input", "value": "CallbackEventListener", - "description": "Callback when the user makes any changes in the field.", + "description": "A callback fired when the user inputs data into the drop zone.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).", "isOptional": true } ], - "value": "export interface DropZoneElementEvents {\n /**\n * Callback when rejected files are dropped. Files are rejected based on the `accept` prop.\n */\n droprejected?: CallbackEventListener;\n /**\n * Callback when the user makes any changes in the field.\n */\n input?: CallbackEventListener;\n /**\n * Callback when the user has finished selecting a file or files.\n */\n change?: CallbackEventListener;\n}" + "value": "export interface DropZoneElementEvents {\n /**\n * A callback fired when files are rejected based on the `accept` prop.\n */\n droprejected?: CallbackEventListener;\n /**\n * A callback fired when the user inputs data into the drop zone.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input?: CallbackEventListener;\n /**\n * A callback fired when the drop zone value changes.\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change?: CallbackEventListener;\n}" } }, "DropZoneElement": { @@ -59369,7 +59382,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/DropZone.ts", @@ -59999,7 +60012,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -60113,7 +60126,7 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -60283,7 +60296,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -60382,7 +60395,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Content to use as the field label.", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", "isOptional": true }, { @@ -60448,7 +60461,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -61427,7 +61440,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/DropZone.ts", @@ -61726,7 +61739,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -61735,7 +61748,7 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -61743,7 +61756,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -61751,7 +61764,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Content to use as the field label.", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", "isOptional": true }, { @@ -61768,7 +61781,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -61776,7 +61789,7 @@ "syntaxKind": "PropertySignature", "name": "onChange", "value": "(event: Event) => void", - "description": "Callback when the user has **finished selecting** a file or files.", + "description": "A callback fired when the user has finished selecting one or more files.", "isOptional": true }, { @@ -61792,7 +61805,7 @@ "syntaxKind": "PropertySignature", "name": "onInput", "value": "(event: Event) => void", - "description": "Callback when the user makes any changes in the file selection.", + "description": "A callback fired when the user makes any changes to the file selection.", "isOptional": true }, { @@ -61821,7 +61834,7 @@ "src/surfaces/checkout/components/EmailField.ts": { "filePath": "src/surfaces/checkout/components/EmailField.ts", "name": "EmailFieldElementProps", - "description": "The email field component captures email address input. Use it to collect email information in forms, customer profiles, or contact workflows.\n\nEmail field doesn't perform automatic email validation. Implement your own validation logic, and use the `error` property to display validation results. For general text input, use [text field](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/forms/text-field).", + "description": "", "isPublicDocs": true, "members": [ { @@ -61829,7 +61842,7 @@ "syntaxKind": "PropertySignature", "name": "autocomplete", "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", "isOptional": true, "defaultValue": "'on' for everything else" }, @@ -61838,7 +61851,7 @@ "syntaxKind": "PropertySignature", "name": "defaultValue", "value": "string", - "description": "The default value for the field.", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces this value.", "isOptional": true }, { @@ -61846,7 +61859,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -61855,7 +61868,7 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -61863,7 +61876,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -61871,7 +61884,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Content to use as the field label.", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", "isOptional": true }, { @@ -61879,7 +61892,7 @@ "syntaxKind": "PropertySignature", "name": "labelAccessibilityVisibility", "value": "'visible' | 'exclusive'", - "description": "Changes the visibility of the component's label.\n\n- `visible`: the label is visible to all users.\n- `exclusive`: the label is visually hidden but remains in the accessibility tree.", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone.\n- `exclusive`: The label is visually hidden but still announced by screen readers.", "isOptional": true, "defaultValue": "'visible'" }, @@ -61897,7 +61910,7 @@ "syntaxKind": "PropertySignature", "name": "minLength", "value": "number", - "description": "Specifies the min number of characters allowed.", + "description": "Specifies the minimum number of characters allowed.", "isOptional": true, "defaultValue": "0" }, @@ -61906,7 +61919,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -61924,7 +61937,7 @@ "syntaxKind": "PropertySignature", "name": "readOnly", "value": "boolean", - "description": "The field cannot be edited by the user. It is focusable will be announced by screen readers.", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", "isOptional": true, "defaultValue": "false" }, @@ -61969,7 +61982,7 @@ "syntaxKind": "PropertySignature", "name": "onChange", "value": "(event: Event) => void", - "description": "Callback when the user has **finished editing** a field, for example, once they have blurred the field.", + "description": "A callback fired when the user has **finished editing** a field, such as when they blur the field or press Enter.", "isOptional": true }, { @@ -61985,7 +61998,7 @@ "syntaxKind": "PropertySignature", "name": "onInput", "value": "(event: Event) => void", - "description": "Callback when the user makes any changes in the field.", + "description": "A callback fired when the user makes any changes in the field, such as typing a character.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).", "isOptional": true } ], @@ -61996,7 +62009,7 @@ "src/surfaces/checkout/components/EmailField.ts": { "filePath": "src/surfaces/checkout/components/EmailField.ts", "name": "EmailFieldElementEvents", - "description": "Learn more about [registering events](/docs/api/checkout-ui-extensions/latest/using-polaris-components#event-handling).", + "description": "", "isPublicDocs": true, "members": [ { @@ -62004,7 +62017,7 @@ "syntaxKind": "PropertySignature", "name": "blur", "value": "CallbackEventListener", - "description": "A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "description": "<<<<<<< HEAD A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n======= A callback fired when the email field loses focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) \n Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", "isOptional": true }, { @@ -62012,7 +62025,7 @@ "syntaxKind": "PropertySignature", "name": "change", "value": "CallbackEventListener", - "description": "Callback when the user has **finished editing** a field, for example, once they have blurred the field.", + "description": "<<<<<<< HEAD Callback when the user has **finished editing** a field, for example, once they have blurred the field.\n======= A callback fired when the email field value changes.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) \n Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", "isOptional": true }, { @@ -62020,7 +62033,7 @@ "syntaxKind": "PropertySignature", "name": "focus", "value": "CallbackEventListener", - "description": "A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "description": "<<<<<<< HEAD A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n======= A callback fired when the email field receives focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) \n Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", "isOptional": true }, { @@ -62028,18 +62041,18 @@ "syntaxKind": "PropertySignature", "name": "input", "value": "CallbackEventListener", - "description": "Callback when the user makes any changes in the field.", + "description": "A callback fired when the user inputs data into the email field.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).", "isOptional": true } ], - "value": "export interface EmailFieldElementEvents {\n /**\n * A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event\n */\n blur?: CallbackEventListener;\n /**\n * Callback when the user has **finished editing** a field, for example, once they have blurred the field.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event\n */\n change?: CallbackEventListener;\n /**\n * A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event\n */\n focus?: CallbackEventListener;\n /**\n * Callback when the user makes any changes in the field.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event\n */\n input?: CallbackEventListener;\n}" + "value": "export interface EmailFieldElementEvents {\n /**\n<<<<<<< HEAD\n * A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n=======\n * A callback fired when the email field loses focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality)\n *\n * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur?: CallbackEventListener;\n /**\n<<<<<<< HEAD\n * Callback when the user has **finished editing** a field, for example, once they have blurred the field.\n=======\n * A callback fired when the email field value changes.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality)\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change?: CallbackEventListener;\n /**\n<<<<<<< HEAD\n * A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n=======\n * A callback fired when the email field receives focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality)\n *\n * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus?: CallbackEventListener;\n /**\n * A callback fired when the user inputs data into the email field.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input?: CallbackEventListener;\n}" } }, "EmailFieldElementSlots": { "src/surfaces/checkout/components/EmailField.ts": { "filePath": "src/surfaces/checkout/components/EmailField.ts", "name": "EmailFieldElementSlots", - "description": "Learn more about [component slots](/docs/api/checkout-ui-extensions/latest/using-polaris-components#slots).", + "description": "", "isPublicDocs": true, "members": [ { @@ -62047,11 +62060,11 @@ "syntaxKind": "PropertySignature", "name": "accessory", "value": "HTMLElement", - "description": "Additional content to be displayed in the field. Commonly used to display an icon that activates a tooltip providing more information.", + "description": "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.", "isOptional": true } ], - "value": "export interface EmailFieldElementSlots {\n /**\n * Additional content to be displayed in the field.\n * Commonly used to display an icon that activates a tooltip providing more information.\n */\n accessory?: HTMLElement;\n}" + "value": "export interface EmailFieldElementSlots {\n /**\n * 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.\n */\n accessory?: HTMLElement;\n}" } }, "EmailFieldElement": { @@ -62080,7 +62093,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/EmailField.ts", @@ -62521,7 +62534,7 @@ "syntaxKind": "PropertySignature", "name": "autocomplete", "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", "isOptional": true, "defaultValue": "'on' for everything else" }, @@ -62712,7 +62725,7 @@ "syntaxKind": "PropertySignature", "name": "defaultValue", "value": "string", - "description": "The default value for the field.", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces this value.", "isOptional": true }, { @@ -62727,7 +62740,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -62841,7 +62854,7 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -63011,7 +63024,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -63110,7 +63123,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Content to use as the field label.", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", "isOptional": true }, { @@ -63118,7 +63131,7 @@ "syntaxKind": "PropertySignature", "name": "labelAccessibilityVisibility", "value": "'visible' | 'exclusive'", - "description": "Changes the visibility of the component's label.\n\n- `visible`: the label is visible to all users.\n- `exclusive`: the label is visually hidden but remains in the accessibility tree.", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone.\n- `exclusive`: The label is visually hidden but still announced by screen readers.", "isOptional": true, "defaultValue": "'visible'" }, @@ -63185,7 +63198,7 @@ "syntaxKind": "PropertySignature", "name": "minLength", "value": "number", - "description": "Specifies the min number of characters allowed.", + "description": "Specifies the minimum number of characters allowed.", "isOptional": true, "defaultValue": "0" }, @@ -63194,7 +63207,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -64127,7 +64140,7 @@ "syntaxKind": "PropertySignature", "name": "readOnly", "value": "boolean", - "description": "The field cannot be edited by the user. It is focusable will be announced by screen readers.", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", "isOptional": true, "defaultValue": "false" }, @@ -64178,7 +64191,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/EmailField.ts", @@ -64459,7 +64472,7 @@ "syntaxKind": "PropertySignature", "name": "autocomplete", "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", "isOptional": true, "defaultValue": "'on' for everything else" }, @@ -64468,7 +64481,7 @@ "syntaxKind": "PropertySignature", "name": "defaultValue", "value": "string", - "description": "The default value for the field.", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces this value.", "isOptional": true }, { @@ -64476,7 +64489,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -64485,7 +64498,7 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -64493,7 +64506,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -64501,7 +64514,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Content to use as the field label.", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", "isOptional": true }, { @@ -64509,7 +64522,7 @@ "syntaxKind": "PropertySignature", "name": "labelAccessibilityVisibility", "value": "'visible' | 'exclusive'", - "description": "Changes the visibility of the component's label.\n\n- `visible`: the label is visible to all users.\n- `exclusive`: the label is visually hidden but remains in the accessibility tree.", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone.\n- `exclusive`: The label is visually hidden but still announced by screen readers.", "isOptional": true, "defaultValue": "'visible'" }, @@ -64527,7 +64540,7 @@ "syntaxKind": "PropertySignature", "name": "minLength", "value": "number", - "description": "Specifies the min number of characters allowed.", + "description": "Specifies the minimum number of characters allowed.", "isOptional": true, "defaultValue": "0" }, @@ -64536,7 +64549,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -64552,7 +64565,7 @@ "syntaxKind": "PropertySignature", "name": "onChange", "value": "(event: Event) => void", - "description": "Callback when the user has **finished editing** a field, for example, once they have blurred the field.", + "description": "A callback fired when the user has **finished editing** a field, such as when they blur the field or press Enter.", "isOptional": true }, { @@ -64568,7 +64581,7 @@ "syntaxKind": "PropertySignature", "name": "onInput", "value": "(event: Event) => void", - "description": "Callback when the user makes any changes in the field.", + "description": "A callback fired when the user makes any changes in the field, such as typing a character.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).", "isOptional": true }, { @@ -64586,7 +64599,7 @@ "syntaxKind": "PropertySignature", "name": "readOnly", "value": "boolean", - "description": "The field cannot be edited by the user. It is focusable will be announced by screen readers.", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", "isOptional": true, "defaultValue": "false" }, @@ -64615,7 +64628,7 @@ "src/surfaces/checkout/components/Form.ts": { "filePath": "src/surfaces/checkout/components/Form.ts", "name": "FormElementProps", - "description": "The form component wraps form controls and enables implicit submission, allowing users to submit from any input by pressing **Enter**. Use form to group related input fields and handle form submission through JavaScript event handlers.\n\nUnlike HTML forms, form doesn't automatically submit data using HTTP—you must register a `submit` event to process form data programmatically. For Shopify Functions configuration forms, use [function settings](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/forms/function-settings).", + "description": "", "isPublicDocs": true, "members": [ { @@ -64634,7 +64647,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true } ], @@ -64653,18 +64666,18 @@ "syntaxKind": "PropertySignature", "name": "onSubmit", "value": "() => void", - "description": "A callback that is run when the form is submitted.", + "description": "A callback fired when the form is submitted.", "isOptional": true } ], - "value": "export interface FormEvents extends Pick {\n /**\n * A callback that is run when the form is submitted.\n */\n onSubmit?: () => void;\n}" + "value": "export interface FormEvents extends Pick {\n /**\n * A callback fired when the form is submitted.\n */\n onSubmit?: () => void;\n}" } }, "FormElementEvents": { "src/surfaces/checkout/components/Form.ts": { "filePath": "src/surfaces/checkout/components/Form.ts", "name": "FormElementEvents", - "description": "Learn more about [registering events](/docs/api/checkout-ui-extensions/latest/using-polaris-components#event-handling).", + "description": "", "isPublicDocs": true, "members": [ { @@ -64672,11 +64685,11 @@ "syntaxKind": "PropertySignature", "name": "submit", "value": "CallbackEventListener", - "description": "A callback that is run when the form is submitted.", + "description": "A callback fired when the form is submitted.", "isOptional": true } ], - "value": "export interface FormElementEvents {\n /**\n * A callback that is run when the form is submitted.\n */\n submit?: CallbackEventListener;\n}" + "value": "export interface FormElementEvents {\n /**\n * A callback fired when the form is submitted.\n */\n submit?: CallbackEventListener;\n}" } }, "FormElement": { @@ -64705,7 +64718,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/Form.ts", @@ -65613,7 +65626,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -66725,7 +66738,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/Form.ts", @@ -67000,7 +67013,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -67008,7 +67021,7 @@ "syntaxKind": "PropertySignature", "name": "onSubmit", "value": "() => void", - "description": "A callback that is run when the form is submitted.", + "description": "A callback fired when the form is submitted.", "isOptional": true } ], @@ -67021,7 +67034,7 @@ "syntaxKind": "TypeAliasDeclaration", "name": "ReducedAlignContentKeyword", "value": "'center' | 'start' | 'end' | 'normal' | 'space-between' | 'space-around' | 'space-evenly' | 'stretch'", - "description": "", + "description": "The subset of `align-content` values available for the grid component.\n\n- `center`: Packs rows toward the center of the grid.\n- `start`: Packs rows toward the start of the block axis.\n- `end`: Packs rows toward the end of the block axis.\n- `normal`: Default browser behavior.\n- `space-between`: Distributes rows evenly with no space at the edges.\n- `space-around`: Distributes rows evenly with equal space around each.\n- `space-evenly`: Distributes rows with equal space between and at the edges.\n- `stretch`: Stretches rows to fill the available space.", "isPublicDocs": true } }, @@ -67031,7 +67044,7 @@ "syntaxKind": "TypeAliasDeclaration", "name": "ReducedAlignItemsKeyword", "value": "'center' | 'start' | 'end' | 'normal' | 'baseline' | 'stretch'", - "description": "", + "description": "The subset of `align-items` values available for the grid component.\n\n- `center`: Centers items along the block axis.\n- `start`: Aligns items to the start of the block axis.\n- `end`: Aligns items to the end of the block axis.\n- `normal`: Default browser behavior.\n- `baseline`: Aligns items along their text baseline.\n- `stretch`: Stretches items to fill the cell along the block axis.", "isPublicDocs": true } }, @@ -67041,7 +67054,7 @@ "syntaxKind": "TypeAliasDeclaration", "name": "ReducedJustifyContentKeyword", "value": "'center' | 'start' | 'end' | 'normal' | 'space-between' | 'space-around' | 'space-evenly' | 'stretch'", - "description": "", + "description": "The subset of `justify-content` values available for the grid component.\n\n- `center`: Packs columns toward the center of the grid.\n- `start`: Packs columns toward the start of the inline axis.\n- `end`: Packs columns toward the end of the inline axis.\n- `normal`: Default browser behavior.\n- `space-between`: Distributes columns evenly with no space at the edges.\n- `space-around`: Distributes columns evenly with equal space around each.\n- `space-evenly`: Distributes columns with equal space between and at the edges.\n- `stretch`: Stretches columns to fill the available space.", "isPublicDocs": true } }, @@ -67051,7 +67064,7 @@ "syntaxKind": "TypeAliasDeclaration", "name": "ReducedJustifyItemsKeyword", "value": "'center' | 'start' | 'end' | 'normal' | 'baseline' | 'stretch'", - "description": "", + "description": "The subset of `justify-items` values available for the grid component.\n\n- `center`: Centers items along the inline axis.\n- `start`: Aligns items to the start of the inline axis.\n- `end`: Aligns items to the end of the inline axis.\n- `normal`: Default browser behavior.\n- `baseline`: Aligns items along their text baseline.\n- `stretch`: Stretches items to fill the cell along the inline axis.", "isPublicDocs": true } }, @@ -67059,7 +67072,7 @@ "src/surfaces/checkout/components/Grid.ts": { "filePath": "src/surfaces/checkout/components/Grid.ts", "name": "GridElementProps", - "description": "The grid component organizes content in a matrix of rows and columns to create responsive page layouts. Use grid to build complex, multi-column layouts that adapt to different screen sizes and maintain consistent alignment.\n\nGrid follows the CSS grid layout pattern and supports flexible column configurations, gap spacing, and alignment properties for precise layout control. For simpler linear layouts (horizontal or vertical), use [stack](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/layout-and-structure/stack).", + "description": "", "isPublicDocs": true, "members": [ { @@ -67084,7 +67097,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityVisibility", "value": "'visible' | 'hidden' | 'exclusive'", - "description": "Changes the visibility of the element.\n\n- `visible`: the element is visible to all users.\n- `hidden`: the element is removed from the accessibility tree but remains visible.\n- `exclusive`: the element is visually hidden but remains in the accessibility tree.", + "description": "Controls how the element is exposed to sighted users and to assistive technologies such as screen readers.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", "isOptional": true, "defaultValue": "'visible'" }, @@ -67093,7 +67106,7 @@ "syntaxKind": "PropertySignature", "name": "alignContent", "value": "MaybeResponsive", - "description": "Aligns the grid along the block (column) axis.\n\nThis overrides the block value of `placeContent`.", + "description": "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.", "isOptional": true, "defaultValue": "'' - meaning no override" }, @@ -67102,7 +67115,7 @@ "syntaxKind": "PropertySignature", "name": "alignItems", "value": "MaybeResponsive", - "description": "Aligns the grid items along the block (column) axis.\n\nThis overrides the block value of `placeItems`.", + "description": "Aligns grid items along the block (column) axis. Set to an empty string to use the default.", "isOptional": true, "defaultValue": "'' - meaning no override" }, @@ -67111,7 +67124,7 @@ "syntaxKind": "PropertySignature", "name": "background", "value": "'base' | 'subdued' | 'transparent'", - "description": "Adjust the background of the element.\n\n- `'transparent'`: No visible background.\n- `'subdued'`: A subtle, low-emphasis background.\n- `'base'`: The standard background color.\n- `'strong'`: A high-emphasis background for prominence.", + "description": "The background color of the grid.\n\n- `base`: The standard background color for general content areas.\n- `subdued`: A muted background for secondary or supporting content.\n- `transparent`: No background color (the default).", "isOptional": true, "defaultValue": "'transparent'" }, @@ -67129,9 +67142,9 @@ "syntaxKind": "PropertySignature", "name": "border", "value": "BorderShorthand", - "description": "Applies a border using shorthand syntax to specify width, color, and style in a single property.\n\nAccepts a size value, optionally followed by a color, optionally followed by a style. Omitted values use defaults: color defaults to `base`, style defaults to `auto`.\n\nIndividual properties (`borderWidth`, `borderStyle`, `borderColor`) can override values set here.", + "description": "A shorthand for setting the border width, color, and style in a single property. Individual border properties (`borderWidth`, `borderStyle`, `borderColor`) can override values set here.", "isOptional": true, - "defaultValue": "'none' - equivalent to `none base auto`.", + "defaultValue": "'none'", "examples": [ { "title": "Example", @@ -67150,7 +67163,7 @@ "syntaxKind": "PropertySignature", "name": "borderColor", "value": "'' | 'base'", - "description": "Controls the color of the border using the design system's color scale.\n\nWhen set, this overrides the color value specified in the `border` property. Choose from `subdued`, `base`, or `strong` to match the visual emphasis needed.", + "description": "The color of the border using the design system's color scale. Overrides the color value set by `border`.", "isOptional": true, "defaultValue": "'' - meaning no override" }, @@ -67159,7 +67172,7 @@ "syntaxKind": "PropertySignature", "name": "borderRadius", "value": "MaybeAllValuesShorthandProperty>", - "description": "Controls the roundedness of the element's corners using the design system's radius scale.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) using flow-relative values:\n- One value: applies to all corners\n- Two values: applies to start corners (top-left & bottom-right) and end corners (top-right & bottom-left) respectively\n- Three values: applies to start-start (top-left), end corners (top-right & bottom-left), and end-end (bottom-right) respectively\n- Four values: applies to start-start (top-left), start-end (top-right), end-end (bottom-right), and end-start (bottom-left) respectively\n\nExamples:\n- `small-100`: All corners have `small-100` radius\n- `small-100 none`: Top-left and bottom-right are `small-100`, top-right and bottom-left are `none`\n- `small-100 none large-100`: Top-left is `small-100`, top-right and bottom-left are `none`, bottom-right is `large-100`\n- `small-100 none large-100 base`: Each corner has its specified radius value", + "description": "The roundedness of the grid's corners.\n\n- `none`: Sharp corners with no rounding.\n- `small-100` / `small`: Subtle rounding for compact elements.\n- `base`: Standard rounding for most use cases.\n- `large` / `large-100`: More pronounced rounding for prominent containers.\n- `max`: Maximum rounding, creating a pill or circular shape.\n\nSupports 1-to-4-value shorthand syntax for specifying different radii per corner.", "isOptional": true, "defaultValue": "'none'" }, @@ -67177,7 +67190,7 @@ "syntaxKind": "PropertySignature", "name": "borderWidth", "value": "MaybeAllValuesShorthandProperty | ''", - "description": "Controls the thickness of the border on all sides. When set, this overrides the width value specified in the `border` property.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) for specifying different widths per side:\n- One value: applies to all sides\n- Two values: applies to block sides (top/bottom) and inline sides (left/right) respectively\n- Three values: applies to block-start (top), inline sides (left/right), and block-end (bottom) respectively\n- Four values: applies to block-start (top), inline-end (right), block-end (bottom), and inline-start (left) respectively", + "description": "The thickness of the border on all sides. Supports 1-to-4-value shorthand syntax for specifying different widths per side. Overrides the width value set by `border`.", "isOptional": true, "defaultValue": "'' - meaning no override" }, @@ -67195,7 +67208,7 @@ "syntaxKind": "PropertySignature", "name": "display", "value": "MaybeResponsive<\"auto\" | \"none\">", - "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.", + "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.\n\nLearn more about the [display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display).", "isOptional": true, "defaultValue": "'auto'" }, @@ -67231,7 +67244,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -67248,7 +67261,7 @@ "syntaxKind": "PropertySignature", "name": "justifyContent", "value": "MaybeResponsive", - "description": "Aligns the grid along the inline (row) axis.\n\nThis overrides the inline value of `placeContent`.", + "description": "Controls how the grid's columns are distributed along the inline (row) axis when there is extra space. Set to an empty string to use the default.", "isOptional": true, "defaultValue": "'' - meaning no override" }, @@ -67257,7 +67270,7 @@ "syntaxKind": "PropertySignature", "name": "justifyItems", "value": "MaybeResponsive", - "description": "Aligns the grid items along the inline (row) axis.\n\nThis overrides the inline value of `placeItems`.", + "description": "Aligns grid items along the inline (row) axis. Set to an empty string to use the default.", "isOptional": true, "defaultValue": "'' - meaning no override" }, @@ -67374,7 +67387,7 @@ "syntaxKind": "PropertySignature", "name": "placeContent", "value": "MaybeResponsive<`${ReducedAlignContentKeyword} ${ReducedJustifyContentKeyword}` | ReducedAlignContentKeyword>", - "description": "A shorthand property for `justify-content` and `align-content`.", + "description": "A shorthand for `justifyContent` and `alignContent` that sets both distribution axes at once.", "isOptional": true, "defaultValue": "'normal normal'" }, @@ -67383,7 +67396,7 @@ "syntaxKind": "PropertySignature", "name": "placeItems", "value": "MaybeResponsive<`${ReducedAlignItemsKeyword} ${ReducedJustifyItemsKeyword}` | ReducedAlignItemsKeyword>", - "description": "A shorthand property for `justify-items` and `align-items`.", + "description": "A shorthand for `justifyItems` and `alignItems` that sets both alignment axes at once.", "isOptional": true, "defaultValue": "'normal normal'" }, @@ -67397,7 +67410,7 @@ "defaultValue": "'' - meaning no override" } ], - "value": "export interface GridElementProps extends Pick {\n alignContent?: MaybeResponsive;\n alignItems?: MaybeResponsive;\n background?: Extract;\n border?: BorderShorthand;\n borderColor?: ReducedColorKeyword | '';\n borderWidth?: MaybeAllValuesShorthandProperty | '';\n borderRadius?: MaybeAllValuesShorthandProperty>;\n justifyContent?: MaybeResponsive;\n justifyItems?: MaybeResponsive;\n placeContent?: MaybeResponsive<`${ReducedAlignContentKeyword} ${ReducedJustifyContentKeyword}` | ReducedAlignContentKeyword>;\n placeItems?: MaybeResponsive<`${ReducedAlignItemsKeyword} ${ReducedJustifyItemsKeyword}` | ReducedAlignItemsKeyword>;\n}" + "value": "export interface GridElementProps extends Pick {\n /**\n * 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.\n *\n * @default '' - meaning no override\n */\n alignContent?: MaybeResponsive;\n /**\n * Aligns grid items along the block (column) axis. Set to an empty string to use the default.\n *\n * @default '' - meaning no override\n */\n alignItems?: MaybeResponsive;\n /**\n * The background color of the grid.\n *\n * - `base`: The standard background color for general content areas.\n * - `subdued`: A muted background for secondary or supporting content.\n * - `transparent`: No background color (the default).\n *\n * @default 'transparent'\n */\n background?: Extract;\n /**\n * A shorthand for setting the border width, color, and style in a single property. Individual border properties (`borderWidth`, `borderStyle`, `borderColor`) can override values set here.\n *\n * @default 'none'\n */\n border?: BorderShorthand;\n /**\n * The color of the border using the design system's color scale. Overrides the color value set by `border`.\n *\n * @default '' - meaning no override\n */\n borderColor?: ReducedColorKeyword | '';\n /**\n * The thickness of the border on all sides. Supports 1-to-4-value shorthand syntax for specifying different widths per side. Overrides the width value set by `border`.\n *\n * @default '' - meaning no override\n */\n borderWidth?: MaybeAllValuesShorthandProperty | '';\n /**\n * The roundedness of the grid's corners.\n *\n * - `none`: Sharp corners with no rounding.\n * - `small-100` / `small`: Subtle rounding for compact elements.\n * - `base`: Standard rounding for most use cases.\n * - `large` / `large-100`: More pronounced rounding for prominent containers.\n * - `max`: Maximum rounding, creating a pill or circular shape.\n *\n * Supports 1-to-4-value shorthand syntax for specifying different radii per corner.\n *\n * @default 'none'\n */\n borderRadius?: MaybeAllValuesShorthandProperty>;\n /**\n * Controls how the grid's columns are distributed along the inline (row) axis when there is extra space. Set to an empty string to use the default.\n *\n * @default '' - meaning no override\n */\n justifyContent?: MaybeResponsive;\n /**\n * Aligns grid items along the inline (row) axis. Set to an empty string to use the default.\n *\n * @default '' - meaning no override\n */\n justifyItems?: MaybeResponsive;\n /**\n * A shorthand for `justifyContent` and `alignContent` that sets both distribution axes at once.\n *\n * @default 'normal normal'\n */\n placeContent?: MaybeResponsive<`${ReducedAlignContentKeyword} ${ReducedJustifyContentKeyword}` | ReducedAlignContentKeyword>;\n /**\n * A shorthand for `justifyItems` and `alignItems` that sets both alignment axes at once.\n *\n * @default 'normal normal'\n */\n placeItems?: MaybeResponsive<`${ReducedAlignItemsKeyword} ${ReducedJustifyItemsKeyword}` | ReducedAlignItemsKeyword>;\n}" } }, "GridProps": { @@ -67429,7 +67442,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityVisibility", "value": "'visible' | 'hidden' | 'exclusive'", - "description": "Changes the visibility of the element.\n\n- `visible`: the element is visible to all users.\n- `hidden`: the element is removed from the accessibility tree but remains visible.\n- `exclusive`: the element is visually hidden but remains in the accessibility tree.", + "description": "Controls how the element is exposed to sighted users and to assistive technologies such as screen readers.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", "isOptional": true, "defaultValue": "'visible'" }, @@ -67438,23 +67451,25 @@ "syntaxKind": "PropertySignature", "name": "alignContent", "value": "MaybeResponsive", - "description": "Aligns the grid along the block (column) axis.\n\nThis overrides the block value of `placeContent`.", - "isOptional": true + "description": "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.", + "isOptional": true, + "defaultValue": "'' - meaning no override" }, { "filePath": "src/surfaces/checkout/components/Grid.ts", "syntaxKind": "PropertySignature", "name": "alignItems", "value": "MaybeResponsive", - "description": "Aligns the grid items along the block (column) axis.\n\nThis overrides the block value of `placeItems`.", - "isOptional": true + "description": "Aligns grid items along the block (column) axis. Set to an empty string to use the default.", + "isOptional": true, + "defaultValue": "'' - meaning no override" }, { "filePath": "src/surfaces/checkout/components/Grid.ts", "syntaxKind": "PropertySignature", "name": "background", "value": "'base' | 'subdued' | 'transparent'", - "description": "Adjust the background of the element.\n\n- `'transparent'`: No visible background.\n- `'subdued'`: A subtle, low-emphasis background.\n- `'base'`: The standard background color.\n- `'strong'`: A high-emphasis background for prominence.", + "description": "The background color of the grid.\n\n- `base`: The standard background color for general content areas.\n- `subdued`: A muted background for secondary or supporting content.\n- `transparent`: No background color (the default).", "isOptional": true, "defaultValue": "'transparent'" }, @@ -67472,23 +67487,25 @@ "syntaxKind": "PropertySignature", "name": "border", "value": "BorderShorthand", - "description": "Applies a border using shorthand syntax to specify width, color, and style in a single property.\n\nAccepts a size value, optionally followed by a color, optionally followed by a style. Omitted values use defaults: color defaults to `base`, style defaults to `auto`.\n\nIndividual properties (`borderWidth`, `borderStyle`, `borderColor`) can override values set here.", - "isOptional": true + "description": "A shorthand for setting the border width, color, and style in a single property. Individual border properties (`borderWidth`, `borderStyle`, `borderColor`) can override values set here.", + "isOptional": true, + "defaultValue": "'none'" }, { "filePath": "src/surfaces/checkout/components/Grid.ts", "syntaxKind": "PropertySignature", "name": "borderColor", "value": "'' | 'base'", - "description": "Controls the color of the border using the design system's color scale.\n\nWhen set, this overrides the color value specified in the `border` property. Choose from `subdued`, `base`, or `strong` to match the visual emphasis needed.", - "isOptional": true + "description": "The color of the border using the design system's color scale. Overrides the color value set by `border`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" }, { "filePath": "src/surfaces/checkout/components/Grid.ts", "syntaxKind": "PropertySignature", "name": "borderRadius", "value": "MaybeAllValuesShorthandProperty>", - "description": "Controls the roundedness of the element's corners using the design system's radius scale.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) using flow-relative values:\n- One value: applies to all corners\n- Two values: applies to start corners (top-left & bottom-right) and end corners (top-right & bottom-left) respectively\n- Three values: applies to start-start (top-left), end corners (top-right & bottom-left), and end-end (bottom-right) respectively\n- Four values: applies to start-start (top-left), start-end (top-right), end-end (bottom-right), and end-start (bottom-left) respectively\n\nExamples:\n- `small-100`: All corners have `small-100` radius\n- `small-100 none`: Top-left and bottom-right are `small-100`, top-right and bottom-left are `none`\n- `small-100 none large-100`: Top-left is `small-100`, top-right and bottom-left are `none`, bottom-right is `large-100`\n- `small-100 none large-100 base`: Each corner has its specified radius value", + "description": "The roundedness of the grid's corners.\n\n- `none`: Sharp corners with no rounding.\n- `small-100` / `small`: Subtle rounding for compact elements.\n- `base`: Standard rounding for most use cases.\n- `large` / `large-100`: More pronounced rounding for prominent containers.\n- `max`: Maximum rounding, creating a pill or circular shape.\n\nSupports 1-to-4-value shorthand syntax for specifying different radii per corner.", "isOptional": true, "defaultValue": "'none'" }, @@ -67506,8 +67523,9 @@ "syntaxKind": "PropertySignature", "name": "borderWidth", "value": "MaybeAllValuesShorthandProperty | ''", - "description": "Controls the thickness of the border on all sides. When set, this overrides the width value specified in the `border` property.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) for specifying different widths per side:\n- One value: applies to all sides\n- Two values: applies to block sides (top/bottom) and inline sides (left/right) respectively\n- Three values: applies to block-start (top), inline sides (left/right), and block-end (bottom) respectively\n- Four values: applies to block-start (top), inline-end (right), block-end (bottom), and inline-start (left) respectively", - "isOptional": true + "description": "The thickness of the border on all sides. Supports 1-to-4-value shorthand syntax for specifying different widths per side. Overrides the width value set by `border`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" }, { "filePath": "src/surfaces/checkout/components/Grid.ts", @@ -67523,7 +67541,7 @@ "syntaxKind": "PropertySignature", "name": "display", "value": "MaybeResponsive<\"auto\" | \"none\">", - "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.", + "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.\n\nLearn more about the [display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display).", "isOptional": true, "defaultValue": "'auto'" }, @@ -67559,7 +67577,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -67576,16 +67594,18 @@ "syntaxKind": "PropertySignature", "name": "justifyContent", "value": "MaybeResponsive", - "description": "Aligns the grid along the inline (row) axis.\n\nThis overrides the inline value of `placeContent`.", - "isOptional": true + "description": "Controls how the grid's columns are distributed along the inline (row) axis when there is extra space. Set to an empty string to use the default.", + "isOptional": true, + "defaultValue": "'' - meaning no override" }, { "filePath": "src/surfaces/checkout/components/Grid.ts", "syntaxKind": "PropertySignature", "name": "justifyItems", "value": "MaybeResponsive", - "description": "Aligns the grid items along the inline (row) axis.\n\nThis overrides the inline value of `placeItems`.", - "isOptional": true + "description": "Aligns grid items along the inline (row) axis. Set to an empty string to use the default.", + "isOptional": true, + "defaultValue": "'' - meaning no override" }, { "filePath": "src/surfaces/checkout/components/Grid.ts", @@ -67700,16 +67720,18 @@ "syntaxKind": "PropertySignature", "name": "placeContent", "value": "MaybeResponsive<`${ReducedAlignContentKeyword} ${ReducedJustifyContentKeyword}` | ReducedAlignContentKeyword>", - "description": "A shorthand property for `justify-content` and `align-content`.", - "isOptional": true + "description": "A shorthand for `justifyContent` and `alignContent` that sets both distribution axes at once.", + "isOptional": true, + "defaultValue": "'normal normal'" }, { "filePath": "src/surfaces/checkout/components/Grid.ts", "syntaxKind": "PropertySignature", "name": "placeItems", "value": "MaybeResponsive<`${ReducedAlignItemsKeyword} ${ReducedJustifyItemsKeyword}` | ReducedAlignItemsKeyword>", - "description": "A shorthand property for `justify-items` and `align-items`.", - "isOptional": true + "description": "A shorthand for `justifyItems` and `alignItems` that sets both alignment axes at once.", + "isOptional": true, + "defaultValue": "'normal normal'" }, { "filePath": "src/surfaces/checkout/components/Grid.ts", @@ -67763,7 +67785,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityVisibility", "value": "'visible' | 'hidden' | 'exclusive'", - "description": "Changes the visibility of the element.\n\n- `visible`: the element is visible to all users.\n- `hidden`: the element is removed from the accessibility tree but remains visible.\n- `exclusive`: the element is visually hidden but remains in the accessibility tree.", + "description": "Controls how the element is exposed to sighted users and to assistive technologies such as screen readers.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", "isOptional": true, "defaultValue": "'visible'" }, @@ -67786,7 +67808,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/Grid.ts", @@ -67800,16 +67822,18 @@ "syntaxKind": "PropertySignature", "name": "alignContent", "value": "MaybeResponsive", - "description": "Aligns the grid along the block (column) axis.\n\nThis overrides the block value of `placeContent`.", - "isOptional": true + "description": "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.", + "isOptional": true, + "defaultValue": "'' - meaning no override" }, { "filePath": "src/surfaces/checkout/components/Grid.ts", "syntaxKind": "PropertySignature", "name": "alignItems", "value": "MaybeResponsive", - "description": "Aligns the grid items along the block (column) axis.\n\nThis overrides the block value of `placeItems`.", - "isOptional": true + "description": "Aligns grid items along the block (column) axis. Set to an empty string to use the default.", + "isOptional": true, + "defaultValue": "'' - meaning no override" }, { "filePath": "src/surfaces/checkout/components/Grid.ts", @@ -68257,7 +68281,7 @@ "syntaxKind": "PropertySignature", "name": "background", "value": "'base' | 'subdued' | 'transparent'", - "description": "Adjust the background of the element.\n\n- `'transparent'`: No visible background.\n- `'subdued'`: A subtle, low-emphasis background.\n- `'base'`: The standard background color.\n- `'strong'`: A high-emphasis background for prominence.", + "description": "The background color of the grid.\n\n- `base`: The standard background color for general content areas.\n- `subdued`: A muted background for secondary or supporting content.\n- `transparent`: No background color (the default).", "isOptional": true, "defaultValue": "'transparent'" }, @@ -68296,23 +68320,25 @@ "syntaxKind": "PropertySignature", "name": "border", "value": "BorderShorthand", - "description": "Applies a border using shorthand syntax to specify width, color, and style in a single property.\n\nAccepts a size value, optionally followed by a color, optionally followed by a style. Omitted values use defaults: color defaults to `base`, style defaults to `auto`.\n\nIndividual properties (`borderWidth`, `borderStyle`, `borderColor`) can override values set here.", - "isOptional": true + "description": "A shorthand for setting the border width, color, and style in a single property. Individual border properties (`borderWidth`, `borderStyle`, `borderColor`) can override values set here.", + "isOptional": true, + "defaultValue": "'none'" }, { "filePath": "src/surfaces/checkout/components/Grid.ts", "syntaxKind": "PropertySignature", "name": "borderColor", "value": "'' | 'base'", - "description": "Controls the color of the border using the design system's color scale.\n\nWhen set, this overrides the color value specified in the `border` property. Choose from `subdued`, `base`, or `strong` to match the visual emphasis needed.", - "isOptional": true + "description": "The color of the border using the design system's color scale. Overrides the color value set by `border`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" }, { "filePath": "src/surfaces/checkout/components/Grid.ts", "syntaxKind": "PropertySignature", "name": "borderRadius", "value": "MaybeAllValuesShorthandProperty>", - "description": "Controls the roundedness of the element's corners using the design system's radius scale.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) using flow-relative values:\n- One value: applies to all corners\n- Two values: applies to start corners (top-left & bottom-right) and end corners (top-right & bottom-left) respectively\n- Three values: applies to start-start (top-left), end corners (top-right & bottom-left), and end-end (bottom-right) respectively\n- Four values: applies to start-start (top-left), start-end (top-right), end-end (bottom-right), and end-start (bottom-left) respectively\n\nExamples:\n- `small-100`: All corners have `small-100` radius\n- `small-100 none`: Top-left and bottom-right are `small-100`, top-right and bottom-left are `none`\n- `small-100 none large-100`: Top-left is `small-100`, top-right and bottom-left are `none`, bottom-right is `large-100`\n- `small-100 none large-100 base`: Each corner has its specified radius value", + "description": "The roundedness of the grid's corners.\n\n- `none`: Sharp corners with no rounding.\n- `small-100` / `small`: Subtle rounding for compact elements.\n- `base`: Standard rounding for most use cases.\n- `large` / `large-100`: More pronounced rounding for prominent containers.\n- `max`: Maximum rounding, creating a pill or circular shape.\n\nSupports 1-to-4-value shorthand syntax for specifying different radii per corner.", "isOptional": true, "defaultValue": "'none'" }, @@ -68330,8 +68356,9 @@ "syntaxKind": "PropertySignature", "name": "borderWidth", "value": "MaybeAllValuesShorthandProperty | ''", - "description": "Controls the thickness of the border on all sides. When set, this overrides the width value specified in the `border` property.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) for specifying different widths per side:\n- One value: applies to all sides\n- Two values: applies to block sides (top/bottom) and inline sides (left/right) respectively\n- Three values: applies to block-start (top), inline sides (left/right), and block-end (bottom) respectively\n- Four values: applies to block-start (top), inline-end (right), block-end (bottom), and inline-start (left) respectively", - "isOptional": true + "description": "The thickness of the border on all sides. Supports 1-to-4-value shorthand syntax for specifying different widths per side. Overrides the width value set by `border`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" }, { "filePath": "src/surfaces/checkout/components/Grid.ts", @@ -68508,7 +68535,7 @@ "syntaxKind": "PropertySignature", "name": "display", "value": "MaybeResponsive<\"auto\" | \"none\">", - "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.", + "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.\n\nLearn more about the [display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display).", "isOptional": true, "defaultValue": "'auto'" }, @@ -68804,7 +68831,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -68912,16 +68939,18 @@ "syntaxKind": "PropertySignature", "name": "justifyContent", "value": "MaybeResponsive", - "description": "Aligns the grid along the inline (row) axis.\n\nThis overrides the inline value of `placeContent`.", - "isOptional": true + "description": "Controls how the grid's columns are distributed along the inline (row) axis when there is extra space. Set to an empty string to use the default.", + "isOptional": true, + "defaultValue": "'' - meaning no override" }, { "filePath": "src/surfaces/checkout/components/Grid.ts", "syntaxKind": "PropertySignature", "name": "justifyItems", "value": "MaybeResponsive", - "description": "Aligns the grid items along the inline (row) axis.\n\nThis overrides the inline value of `placeItems`.", - "isOptional": true + "description": "Aligns grid items along the inline (row) axis. Set to an empty string to use the default.", + "isOptional": true, + "defaultValue": "'' - meaning no override" }, { "filePath": "src/surfaces/checkout/components/Grid.ts", @@ -69949,16 +69978,18 @@ "syntaxKind": "PropertySignature", "name": "placeContent", "value": "MaybeResponsive<`${ReducedAlignContentKeyword} ${ReducedJustifyContentKeyword}` | ReducedAlignContentKeyword>", - "description": "A shorthand property for `justify-content` and `align-content`.", - "isOptional": true + "description": "A shorthand for `justifyContent` and `alignContent` that sets both distribution axes at once.", + "isOptional": true, + "defaultValue": "'normal normal'" }, { "filePath": "src/surfaces/checkout/components/Grid.ts", "syntaxKind": "PropertySignature", "name": "placeItems", "value": "MaybeResponsive<`${ReducedAlignItemsKeyword} ${ReducedJustifyItemsKeyword}` | ReducedAlignItemsKeyword>", - "description": "A shorthand property for `justify-items` and `align-items`.", - "isOptional": true + "description": "A shorthand for `justifyItems` and `alignItems` that sets both alignment axes at once.", + "isOptional": true, + "defaultValue": "'normal normal'" }, { "filePath": "src/surfaces/checkout/components/Grid.ts", @@ -70065,7 +70096,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/Grid.ts", @@ -70330,7 +70361,7 @@ "src/surfaces/checkout/components/GridItem.ts": { "filePath": "src/surfaces/checkout/components/GridItem.ts", "name": "GridItemElementProps", - "description": "The grid item component represents a single cell within a grid layout, allowing you to control how content is positioned and sized within the grid. Use grid item as a child of grid to specify column span, row span, and positioning for individual content areas.\n\nGrid item supports precise placement control through column and row properties, enabling you to create complex layouts where different items occupy varying amounts of space or appear in specific grid positions.", + "description": "", "isPublicDocs": true, "members": [ { @@ -70355,7 +70386,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityVisibility", "value": "'visible' | 'hidden' | 'exclusive'", - "description": "Changes the visibility of the element.\n\n- `visible`: the element is visible to all users.\n- `hidden`: the element is removed from the accessibility tree but remains visible.\n- `exclusive`: the element is visually hidden but remains in the accessibility tree.", + "description": "Controls how the element is exposed to sighted users and to assistive technologies such as screen readers.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", "isOptional": true, "defaultValue": "'visible'" }, @@ -70364,7 +70395,7 @@ "syntaxKind": "PropertySignature", "name": "background", "value": "'base' | 'subdued' | 'transparent'", - "description": "Adjust the background of the element.\n\n- `'transparent'`: No visible background.\n- `'subdued'`: A subtle, low-emphasis background.\n- `'base'`: The standard background color.\n- `'strong'`: A high-emphasis background for prominence.", + "description": "The background color of the grid item.\n\n- `base`: The standard background color for general content areas.\n- `subdued`: A muted background for secondary or supporting content.\n- `transparent`: No background color (the default).", "isOptional": true, "defaultValue": "'transparent'" }, @@ -70382,9 +70413,9 @@ "syntaxKind": "PropertySignature", "name": "border", "value": "BorderShorthand", - "description": "Applies a border using shorthand syntax to specify width, color, and style in a single property.\n\nAccepts a size value, optionally followed by a color, optionally followed by a style. Omitted values use defaults: color defaults to `base`, style defaults to `auto`.\n\nIndividual properties (`borderWidth`, `borderStyle`, `borderColor`) can override values set here.", + "description": "A shorthand for setting the border width, color, and style in a single property. Individual border properties (`borderWidth`, `borderStyle`, `borderColor`) can override values set here.", "isOptional": true, - "defaultValue": "'none' - equivalent to `none base auto`.", + "defaultValue": "'none'", "examples": [ { "title": "Example", @@ -70403,7 +70434,7 @@ "syntaxKind": "PropertySignature", "name": "borderColor", "value": "'' | 'base'", - "description": "Controls the color of the border using the design system's color scale.\n\nWhen set, this overrides the color value specified in the `border` property. Choose from `subdued`, `base`, or `strong` to match the visual emphasis needed.", + "description": "The color of the border using the design system's color scale. Overrides the color value set by `border`.", "isOptional": true, "defaultValue": "'' - meaning no override" }, @@ -70412,7 +70443,7 @@ "syntaxKind": "PropertySignature", "name": "borderRadius", "value": "MaybeAllValuesShorthandProperty>", - "description": "Controls the roundedness of the element's corners using the design system's radius scale.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) using flow-relative values:\n- One value: applies to all corners\n- Two values: applies to start corners (top-left & bottom-right) and end corners (top-right & bottom-left) respectively\n- Three values: applies to start-start (top-left), end corners (top-right & bottom-left), and end-end (bottom-right) respectively\n- Four values: applies to start-start (top-left), start-end (top-right), end-end (bottom-right), and end-start (bottom-left) respectively\n\nExamples:\n- `small-100`: All corners have `small-100` radius\n- `small-100 none`: Top-left and bottom-right are `small-100`, top-right and bottom-left are `none`\n- `small-100 none large-100`: Top-left is `small-100`, top-right and bottom-left are `none`, bottom-right is `large-100`\n- `small-100 none large-100 base`: Each corner has its specified radius value", + "description": "The roundedness of the grid item's corners.\n\n- `none`: Sharp corners with no rounding.\n- `small-100` / `small`: Subtle rounding for compact elements.\n- `base`: Standard rounding for most use cases.\n- `large` / `large-100`: More pronounced rounding for prominent containers.\n- `max`: Maximum rounding, creating a pill or circular shape.\n\nSupports 1-to-4-value shorthand syntax for specifying different radii per corner.", "isOptional": true, "defaultValue": "'none'" }, @@ -70430,7 +70461,7 @@ "syntaxKind": "PropertySignature", "name": "borderWidth", "value": "MaybeAllValuesShorthandProperty | ''", - "description": "Controls the thickness of the border on all sides. When set, this overrides the width value specified in the `border` property.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) for specifying different widths per side:\n- One value: applies to all sides\n- Two values: applies to block sides (top/bottom) and inline sides (left/right) respectively\n- Three values: applies to block-start (top), inline sides (left/right), and block-end (bottom) respectively\n- Four values: applies to block-start (top), inline-end (right), block-end (bottom), and inline-start (left) respectively", + "description": "The thickness of the border on all sides. Supports 1-to-4-value shorthand syntax for specifying different widths per side. Overrides the width value set by `border`.", "isOptional": true, "defaultValue": "'' - meaning no override" }, @@ -70439,7 +70470,7 @@ "syntaxKind": "PropertySignature", "name": "display", "value": "MaybeResponsive<\"auto\" | \"none\">", - "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.", + "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.\n\nLearn more about the [display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display).", "isOptional": true, "defaultValue": "'auto'" }, @@ -70466,7 +70497,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -70587,7 +70618,7 @@ "defaultValue": "'' - meaning no override" } ], - "value": "export interface GridItemElementProps extends Pick {\n background?: Extract;\n border?: BorderShorthand;\n borderColor?: ReducedColorKeyword | '';\n borderWidth?: MaybeAllValuesShorthandProperty | '';\n borderRadius?: MaybeAllValuesShorthandProperty>;\n}" + "value": "export interface GridItemElementProps extends Pick {\n /**\n * The background color of the grid item.\n *\n * - `base`: The standard background color for general content areas.\n * - `subdued`: A muted background for secondary or supporting content.\n * - `transparent`: No background color (the default).\n *\n * @default 'transparent'\n */\n background?: Extract;\n /**\n * A shorthand for setting the border width, color, and style in a single property. Individual border properties (`borderWidth`, `borderStyle`, `borderColor`) can override values set here.\n *\n * @default 'none'\n */\n border?: BorderShorthand;\n /**\n * The color of the border using the design system's color scale. Overrides the color value set by `border`.\n *\n * @default '' - meaning no override\n */\n borderColor?: ReducedColorKeyword | '';\n /**\n * The thickness of the border on all sides. Supports 1-to-4-value shorthand syntax for specifying different widths per side. Overrides the width value set by `border`.\n *\n * @default '' - meaning no override\n */\n borderWidth?: MaybeAllValuesShorthandProperty | '';\n /**\n * The roundedness of the grid item's corners.\n *\n * - `none`: Sharp corners with no rounding.\n * - `small-100` / `small`: Subtle rounding for compact elements.\n * - `base`: Standard rounding for most use cases.\n * - `large` / `large-100`: More pronounced rounding for prominent containers.\n * - `max`: Maximum rounding, creating a pill or circular shape.\n *\n * Supports 1-to-4-value shorthand syntax for specifying different radii per corner.\n *\n * @default 'none'\n */\n borderRadius?: MaybeAllValuesShorthandProperty>;\n}" } }, "GridItemProps": { @@ -70619,7 +70650,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityVisibility", "value": "'visible' | 'hidden' | 'exclusive'", - "description": "Changes the visibility of the element.\n\n- `visible`: the element is visible to all users.\n- `hidden`: the element is removed from the accessibility tree but remains visible.\n- `exclusive`: the element is visually hidden but remains in the accessibility tree.", + "description": "Controls how the element is exposed to sighted users and to assistive technologies such as screen readers.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", "isOptional": true, "defaultValue": "'visible'" }, @@ -70628,7 +70659,7 @@ "syntaxKind": "PropertySignature", "name": "background", "value": "'base' | 'subdued' | 'transparent'", - "description": "Adjust the background of the element.\n\n- `'transparent'`: No visible background.\n- `'subdued'`: A subtle, low-emphasis background.\n- `'base'`: The standard background color.\n- `'strong'`: A high-emphasis background for prominence.", + "description": "The background color of the grid item.\n\n- `base`: The standard background color for general content areas.\n- `subdued`: A muted background for secondary or supporting content.\n- `transparent`: No background color (the default).", "isOptional": true, "defaultValue": "'transparent'" }, @@ -70646,23 +70677,25 @@ "syntaxKind": "PropertySignature", "name": "border", "value": "BorderShorthand", - "description": "Applies a border using shorthand syntax to specify width, color, and style in a single property.\n\nAccepts a size value, optionally followed by a color, optionally followed by a style. Omitted values use defaults: color defaults to `base`, style defaults to `auto`.\n\nIndividual properties (`borderWidth`, `borderStyle`, `borderColor`) can override values set here.", - "isOptional": true + "description": "A shorthand for setting the border width, color, and style in a single property. Individual border properties (`borderWidth`, `borderStyle`, `borderColor`) can override values set here.", + "isOptional": true, + "defaultValue": "'none'" }, { "filePath": "src/surfaces/checkout/components/GridItem.ts", "syntaxKind": "PropertySignature", "name": "borderColor", "value": "'' | 'base'", - "description": "Controls the color of the border using the design system's color scale.\n\nWhen set, this overrides the color value specified in the `border` property. Choose from `subdued`, `base`, or `strong` to match the visual emphasis needed.", - "isOptional": true + "description": "The color of the border using the design system's color scale. Overrides the color value set by `border`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" }, { "filePath": "src/surfaces/checkout/components/GridItem.ts", "syntaxKind": "PropertySignature", "name": "borderRadius", "value": "MaybeAllValuesShorthandProperty>", - "description": "Controls the roundedness of the element's corners using the design system's radius scale.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) using flow-relative values:\n- One value: applies to all corners\n- Two values: applies to start corners (top-left & bottom-right) and end corners (top-right & bottom-left) respectively\n- Three values: applies to start-start (top-left), end corners (top-right & bottom-left), and end-end (bottom-right) respectively\n- Four values: applies to start-start (top-left), start-end (top-right), end-end (bottom-right), and end-start (bottom-left) respectively\n\nExamples:\n- `small-100`: All corners have `small-100` radius\n- `small-100 none`: Top-left and bottom-right are `small-100`, top-right and bottom-left are `none`\n- `small-100 none large-100`: Top-left is `small-100`, top-right and bottom-left are `none`, bottom-right is `large-100`\n- `small-100 none large-100 base`: Each corner has its specified radius value", + "description": "The roundedness of the grid item's corners.\n\n- `none`: Sharp corners with no rounding.\n- `small-100` / `small`: Subtle rounding for compact elements.\n- `base`: Standard rounding for most use cases.\n- `large` / `large-100`: More pronounced rounding for prominent containers.\n- `max`: Maximum rounding, creating a pill or circular shape.\n\nSupports 1-to-4-value shorthand syntax for specifying different radii per corner.", "isOptional": true, "defaultValue": "'none'" }, @@ -70680,15 +70713,16 @@ "syntaxKind": "PropertySignature", "name": "borderWidth", "value": "MaybeAllValuesShorthandProperty | ''", - "description": "Controls the thickness of the border on all sides. When set, this overrides the width value specified in the `border` property.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) for specifying different widths per side:\n- One value: applies to all sides\n- Two values: applies to block sides (top/bottom) and inline sides (left/right) respectively\n- Three values: applies to block-start (top), inline sides (left/right), and block-end (bottom) respectively\n- Four values: applies to block-start (top), inline-end (right), block-end (bottom), and inline-start (left) respectively", - "isOptional": true + "description": "The thickness of the border on all sides. Supports 1-to-4-value shorthand syntax for specifying different widths per side. Overrides the width value set by `border`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" }, { "filePath": "src/surfaces/checkout/components/GridItem.ts", "syntaxKind": "PropertySignature", "name": "display", "value": "MaybeResponsive<\"auto\" | \"none\">", - "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.", + "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.\n\nLearn more about the [display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display).", "isOptional": true, "defaultValue": "'auto'" }, @@ -70715,7 +70749,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -70868,7 +70902,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityVisibility", "value": "'visible' | 'hidden' | 'exclusive'", - "description": "Changes the visibility of the element.\n\n- `visible`: the element is visible to all users.\n- `hidden`: the element is removed from the accessibility tree but remains visible.\n- `exclusive`: the element is visually hidden but remains in the accessibility tree.", + "description": "Controls how the element is exposed to sighted users and to assistive technologies such as screen readers.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", "isOptional": true, "defaultValue": "'visible'" }, @@ -70891,7 +70925,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/GridItem.ts", @@ -71346,7 +71380,7 @@ "syntaxKind": "PropertySignature", "name": "background", "value": "'base' | 'subdued' | 'transparent'", - "description": "Adjust the background of the element.\n\n- `'transparent'`: No visible background.\n- `'subdued'`: A subtle, low-emphasis background.\n- `'base'`: The standard background color.\n- `'strong'`: A high-emphasis background for prominence.", + "description": "The background color of the grid item.\n\n- `base`: The standard background color for general content areas.\n- `subdued`: A muted background for secondary or supporting content.\n- `transparent`: No background color (the default).", "isOptional": true, "defaultValue": "'transparent'" }, @@ -71385,23 +71419,25 @@ "syntaxKind": "PropertySignature", "name": "border", "value": "BorderShorthand", - "description": "Applies a border using shorthand syntax to specify width, color, and style in a single property.\n\nAccepts a size value, optionally followed by a color, optionally followed by a style. Omitted values use defaults: color defaults to `base`, style defaults to `auto`.\n\nIndividual properties (`borderWidth`, `borderStyle`, `borderColor`) can override values set here.", - "isOptional": true + "description": "A shorthand for setting the border width, color, and style in a single property. Individual border properties (`borderWidth`, `borderStyle`, `borderColor`) can override values set here.", + "isOptional": true, + "defaultValue": "'none'" }, { "filePath": "src/surfaces/checkout/components/GridItem.ts", "syntaxKind": "PropertySignature", "name": "borderColor", "value": "'' | 'base'", - "description": "Controls the color of the border using the design system's color scale.\n\nWhen set, this overrides the color value specified in the `border` property. Choose from `subdued`, `base`, or `strong` to match the visual emphasis needed.", - "isOptional": true + "description": "The color of the border using the design system's color scale. Overrides the color value set by `border`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" }, { "filePath": "src/surfaces/checkout/components/GridItem.ts", "syntaxKind": "PropertySignature", "name": "borderRadius", "value": "MaybeAllValuesShorthandProperty>", - "description": "Controls the roundedness of the element's corners using the design system's radius scale.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) using flow-relative values:\n- One value: applies to all corners\n- Two values: applies to start corners (top-left & bottom-right) and end corners (top-right & bottom-left) respectively\n- Three values: applies to start-start (top-left), end corners (top-right & bottom-left), and end-end (bottom-right) respectively\n- Four values: applies to start-start (top-left), start-end (top-right), end-end (bottom-right), and end-start (bottom-left) respectively\n\nExamples:\n- `small-100`: All corners have `small-100` radius\n- `small-100 none`: Top-left and bottom-right are `small-100`, top-right and bottom-left are `none`\n- `small-100 none large-100`: Top-left is `small-100`, top-right and bottom-left are `none`, bottom-right is `large-100`\n- `small-100 none large-100 base`: Each corner has its specified radius value", + "description": "The roundedness of the grid item's corners.\n\n- `none`: Sharp corners with no rounding.\n- `small-100` / `small`: Subtle rounding for compact elements.\n- `base`: Standard rounding for most use cases.\n- `large` / `large-100`: More pronounced rounding for prominent containers.\n- `max`: Maximum rounding, creating a pill or circular shape.\n\nSupports 1-to-4-value shorthand syntax for specifying different radii per corner.", "isOptional": true, "defaultValue": "'none'" }, @@ -71419,8 +71455,9 @@ "syntaxKind": "PropertySignature", "name": "borderWidth", "value": "MaybeAllValuesShorthandProperty | ''", - "description": "Controls the thickness of the border on all sides. When set, this overrides the width value specified in the `border` property.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) for specifying different widths per side:\n- One value: applies to all sides\n- Two values: applies to block sides (top/bottom) and inline sides (left/right) respectively\n- Three values: applies to block-start (top), inline sides (left/right), and block-end (bottom) respectively\n- Four values: applies to block-start (top), inline-end (right), block-end (bottom), and inline-start (left) respectively", - "isOptional": true + "description": "The thickness of the border on all sides. Supports 1-to-4-value shorthand syntax for specifying different widths per side. Overrides the width value set by `border`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" }, { "filePath": "src/surfaces/checkout/components/GridItem.ts", @@ -71588,7 +71625,7 @@ "syntaxKind": "PropertySignature", "name": "display", "value": "MaybeResponsive<\"auto\" | \"none\">", - "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.", + "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.\n\nLearn more about the [display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display).", "isOptional": true, "defaultValue": "'auto'" }, @@ -71875,7 +71912,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -73104,7 +73141,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/GridItem.ts", @@ -73360,7 +73397,7 @@ "src/surfaces/checkout/components/Heading.ts": { "filePath": "src/surfaces/checkout/components/Heading.ts", "name": "HeadingElementProps", - "description": "The heading component renders hierarchical titles to communicate the structure and organization of page content. Use heading to create section titles and content headers that help users understand information hierarchy and navigate content.\n\nHeading levels adjust automatically based on nesting within parent [section](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/layout-and-structure/section) components, ensuring meaningful and accessible page outlines without manual level management.", + "description": "", "isPublicDocs": true, "members": [ { @@ -73377,7 +73414,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true } ], @@ -73419,7 +73456,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/Heading.ts", @@ -74316,7 +74353,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -75428,7 +75465,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/Heading.ts", @@ -75701,7 +75738,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true } ], @@ -75720,7 +75757,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -75779,7 +75816,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/Icon.ts", @@ -76676,7 +76713,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -77788,7 +77825,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/Icon.ts", @@ -78070,7 +78107,7 @@ "src/surfaces/checkout/components/Icon.ts": { "filePath": "src/surfaces/checkout/components/Icon.ts", "name": "IconProps", - "description": "The properties for the icon component when it's used in JSX.", + "description": "", "isPublicDocs": true, "members": [ { @@ -78078,7 +78115,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -78115,7 +78152,7 @@ "src/surfaces/checkout/components/Image.ts": { "filePath": "src/surfaces/checkout/components/Image.ts", "name": "ImageElementProps", - "description": "The image component embeds images within the interface with control over presentation and loading behavior. Use image to visually illustrate concepts, showcase products, display user content, or support tasks and interactions with visual context.\n\nImages support responsive sizing, alt text for accessibility, aspect ratio control, and loading states for progressive enhancement. For small preview images in lists or tables, use [thumbnail](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/media-and-visuals/thumbnail). For profile images, use [avatar](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/media-and-visuals/avatar).", + "description": "", "isPublicDocs": true, "members": [ { @@ -78198,7 +78235,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -78260,7 +78297,7 @@ "src/surfaces/checkout/components/Image.ts": { "filePath": "src/surfaces/checkout/components/Image.ts", "name": "ImageProps", - "description": "The properties for the image component when it's used in JSX.", + "description": "", "isPublicDocs": true, "members": [ { @@ -78329,7 +78366,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -78422,7 +78459,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/Image.ts", @@ -79371,7 +79408,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -80510,7 +80547,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/Image.ts", @@ -80790,7 +80827,7 @@ "src/surfaces/checkout/components/Link.ts": { "filePath": "src/surfaces/checkout/components/Link.ts", "name": "LinkElementProps", - "description": "The link component makes text interactive, allowing users to navigate to other pages or perform specific actions. Use link for navigation, external references, or triggering actions while maintaining standard link semantics and accessibility.\n\nLinks support standard URLs, custom protocols, navigation within Shopify admin pages, and can open in new windows for external destinations. For prominent actions or form submissions, use [button](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/actions/button) instead.", + "description": "", "isPublicDocs": true, "members": [ { @@ -80806,7 +80843,7 @@ "syntaxKind": "PropertySignature", "name": "command", "value": "'--auto' | '--show' | '--hide' | '--toggle' | '--copy'", - "description": "Sets the action the `commandFor` should take when this clickable is activated.\n\nSee the documentation of particular components for the actions they support.\n\n- `--auto`: Performs the default action for the target component.\n- `--show`: Displays the target component.\n- `--hide`: Conceals the target component.\n- `--toggle`: Alternates the target component.\n- `--copy`: Copies the target ClipboardItem.", + "description": "Sets the action the `commandFor` target should take when this component is activated.\n\n- `--auto`: Performs the default action for the target component.\n- `--show`: Displays the target component.\n- `--hide`: Conceals the target component.\n- `--toggle`: Alternates the target component.\n- `--copy`: Copies the target ClipboardItem.\n\nLearn more about the [`command` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).", "isOptional": true, "defaultValue": "'--auto'" }, @@ -80815,7 +80852,7 @@ "syntaxKind": "PropertySignature", "name": "commandFor", "value": "string", - "description": "ID of a component that should respond to activations (such as clicks) on this component.\n\nSee `command` for how to control the behavior of the target.", + "description": "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).\n\nWhen both `commandFor` and `href` are set, `commandFor` takes precedence. The command runs and the link doesn't navigate.", "isOptional": true }, { @@ -80831,7 +80868,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -80895,7 +80932,7 @@ "src/surfaces/checkout/components/Link.ts": { "filePath": "src/surfaces/checkout/components/Link.ts", "name": "LinkElementEvents", - "description": "The link component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", + "description": "", "isPublicDocs": true, "members": [ { @@ -80944,7 +80981,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/Link.ts", @@ -81518,7 +81555,7 @@ "syntaxKind": "PropertySignature", "name": "command", "value": "'--auto' | '--show' | '--hide' | '--toggle' | '--copy'", - "description": "Sets the action the `commandFor` should take when this clickable is activated.\n\nSee the documentation of particular components for the actions they support.\n\n- `--auto`: Performs the default action for the target component.\n- `--show`: Displays the target component.\n- `--hide`: Conceals the target component.\n- `--toggle`: Alternates the target component.\n- `--copy`: Copies the target ClipboardItem.", + "description": "Sets the action the `commandFor` target should take when this component is activated.\n\n- `--auto`: Performs the default action for the target component.\n- `--show`: Displays the target component.\n- `--hide`: Conceals the target component.\n- `--toggle`: Alternates the target component.\n- `--copy`: Copies the target ClipboardItem.\n\nLearn more about the [`command` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).", "isOptional": true, "defaultValue": "'--auto'" }, @@ -81527,7 +81564,7 @@ "syntaxKind": "PropertySignature", "name": "commandFor", "value": "string", - "description": "ID of a component that should respond to activations (such as clicks) on this component.\n\nSee `command` for how to control the behavior of the target.", + "description": "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).\n\nWhen both `commandFor` and `href` are set, `commandFor` takes precedence. The command runs and the link doesn't navigate.", "isOptional": true }, { @@ -81866,7 +81903,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -82987,7 +83024,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/Link.ts", @@ -83277,7 +83314,7 @@ "syntaxKind": "PropertySignature", "name": "command", "value": "'--auto' | '--show' | '--hide' | '--toggle' | '--copy'", - "description": "Sets the action the `commandFor` should take when this clickable is activated.\n\nSee the documentation of particular components for the actions they support.\n\n- `--auto`: Performs the default action for the target component.\n- `--show`: Displays the target component.\n- `--hide`: Conceals the target component.\n- `--toggle`: Alternates the target component.\n- `--copy`: Copies the target ClipboardItem.", + "description": "Sets the action the `commandFor` target should take when this component is activated.\n\n- `--auto`: Performs the default action for the target component.\n- `--show`: Displays the target component.\n- `--hide`: Conceals the target component.\n- `--toggle`: Alternates the target component.\n- `--copy`: Copies the target ClipboardItem.\n\nLearn more about the [`command` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).", "isOptional": true, "defaultValue": "'--auto'" }, @@ -83286,7 +83323,7 @@ "syntaxKind": "PropertySignature", "name": "commandFor", "value": "string", - "description": "ID of a component that should respond to activations (such as clicks) on this component.\n\nSee `command` for how to control the behavior of the target.", + "description": "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).\n\nWhen both `commandFor` and `href` are set, `commandFor` takes precedence. The command runs and the link doesn't navigate.", "isOptional": true }, { @@ -83302,7 +83339,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -83355,7 +83392,7 @@ "src/surfaces/checkout/components/ListItem.ts": { "filePath": "src/surfaces/checkout/components/ListItem.ts", "name": "ListItemElementProps", - "description": "The list item component represents a single entry within an ordered list or unordered list. Use list item to structure individual points, steps, or items within a list, with each item automatically receiving appropriate list markers (bullets or numbers) from its parent list.\n\nList item must be used as a direct child of ordered list or unordered list components. Each list item can contain text, inline formatting, or other components to create rich list content.", + "description": "", "isPublicDocs": true, "members": [ { @@ -83363,7 +83400,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true } ], @@ -83396,7 +83433,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/ListItem.ts", @@ -84293,7 +84330,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -85405,7 +85442,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/ListItem.ts", @@ -85669,7 +85706,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true } ], @@ -85680,7 +85717,7 @@ "src/surfaces/checkout/components/Map.ts": { "filePath": "src/surfaces/checkout/components/Map.ts", "name": "MapElementProps", - "description": "Use Map to display a map on a page. This component is useful for displaying a map of a location, such as a store or a customer’s address.", + "description": "", "isPublicDocs": true, "members": [ { @@ -85713,7 +85750,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -85814,7 +85851,7 @@ "src/surfaces/checkout/components/Map.ts": { "filePath": "src/surfaces/checkout/components/Map.ts", "name": "MapEvents", - "description": "The event handlers for the map component.", + "description": "", "isPublicDocs": true, "members": [ { @@ -86507,7 +86544,7 @@ "src/surfaces/checkout/components/Map.ts": { "filePath": "src/surfaces/checkout/components/Map.ts", "name": "MapElementEvents", - "description": "Learn more about [registering events](/docs/api/checkout-ui-extensions/latest/using-polaris-components#event-handling).", + "description": "", "isPublicDocs": true, "members": [ { @@ -86580,7 +86617,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/Map.ts", @@ -87494,7 +87531,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -88701,7 +88738,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/Map.ts", @@ -88966,7 +89003,7 @@ "src/surfaces/checkout/components/Map.ts": { "filePath": "src/surfaces/checkout/components/Map.ts", "name": "MapProps", - "description": "The properties for the map component when it's used in JSX.", + "description": "", "isPublicDocs": true, "members": [ { @@ -88999,7 +89036,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -89166,7 +89203,7 @@ "syntaxKind": "PropertySignature", "name": "command", "value": "'--auto' | '--show' | '--hide' | '--toggle'", - "description": "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).\n\n- `--auto`: a default action for the target component.\n- `--show`: shows the target component.\n- `--hide`: hides the target component.\n- `--toggle`: toggles the target component.", + "description": "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).\n\n- `--auto`: a default action for the target component.\n- `--show`: shows the target component.\n- `--hide`: hides the target component.\n- `--toggle`: toggles the target component.", "isOptional": true, "defaultValue": "'--auto'" }, @@ -89175,7 +89212,7 @@ "syntaxKind": "PropertySignature", "name": "commandFor", "value": "string", - "description": "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).", + "description": "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).", "isOptional": true }, { @@ -89206,14 +89243,14 @@ "defaultValue": "0" } ], - "value": "export interface MapMarkerElementProps extends Pick {\n /**\n * 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).\n *\n * - `--auto`: a default action for the target component.\n * - `--show`: shows the target component.\n * - `--hide`: hides the target component.\n * - `--toggle`: toggles the target component.\n *\n * @default '--auto'\n */\n command?: Extract;\n /**\n * 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).\n */\n commandFor?: MapMarkerProps$1['commandFor'];\n}" + "value": "export interface MapMarkerElementProps extends Pick {\n /**\n * 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).\n *\n * - `--auto`: a default action for the target component.\n * - `--show`: shows the target component.\n * - `--hide`: hides the target component.\n * - `--toggle`: toggles the target component.\n *\n * @default '--auto'\n */\n command?: Extract;\n /**\n * 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).\n */\n commandFor?: MapMarkerProps$1['commandFor'];\n}" } }, "MapMarkerEvents": { "src/surfaces/checkout/components/MapMarker.ts": { "filePath": "src/surfaces/checkout/components/MapMarker.ts", "name": "MapMarkerEvents", - "description": "The event handlers for the map marker component.", + "description": "", "isPublicDocs": true, "members": [ { @@ -89251,7 +89288,7 @@ "src/surfaces/checkout/components/MapMarker.ts": { "filePath": "src/surfaces/checkout/components/MapMarker.ts", "name": "MapMarkerElementSlots", - "description": "The named slots for the map marker component. Slots allow you to insert custom content into specific areas of the marker.", + "description": "", "isPublicDocs": true, "members": [ { @@ -89300,7 +89337,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/MapMarker.ts", @@ -89892,7 +89929,7 @@ "syntaxKind": "PropertySignature", "name": "command", "value": "'--auto' | '--show' | '--hide' | '--toggle'", - "description": "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).\n\n- `--auto`: a default action for the target component.\n- `--show`: shows the target component.\n- `--hide`: hides the target component.\n- `--toggle`: toggles the target component.", + "description": "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).\n\n- `--auto`: a default action for the target component.\n- `--show`: shows the target component.\n- `--hide`: hides the target component.\n- `--toggle`: toggles the target component.", "isOptional": true, "defaultValue": "'--auto'" }, @@ -89901,7 +89938,7 @@ "syntaxKind": "PropertySignature", "name": "commandFor", "value": "string", - "description": "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).", + "description": "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).", "isOptional": true }, { @@ -91363,7 +91400,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/MapMarker.ts", @@ -91619,7 +91656,7 @@ "src/surfaces/checkout/components/MapMarker.ts": { "filePath": "src/surfaces/checkout/components/MapMarker.ts", "name": "MapMarkerProps", - "description": "The properties for the map marker component when it's used in JSX.", + "description": "", "isPublicDocs": true, "members": [ { @@ -91653,7 +91690,7 @@ "syntaxKind": "PropertySignature", "name": "command", "value": "'--auto' | '--show' | '--hide' | '--toggle'", - "description": "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).\n\n- `--auto`: a default action for the target component.\n- `--show`: shows the target component.\n- `--hide`: hides the target component.\n- `--toggle`: toggles the target component.", + "description": "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).\n\n- `--auto`: a default action for the target component.\n- `--show`: shows the target component.\n- `--hide`: hides the target component.\n- `--toggle`: toggles the target component.", "isOptional": true, "defaultValue": "'--auto'" }, @@ -91662,7 +91699,7 @@ "syntaxKind": "PropertySignature", "name": "commandFor", "value": "string", - "description": "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).", + "description": "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).", "isOptional": true }, { @@ -91708,7 +91745,7 @@ "src/surfaces/checkout/components/Modal.ts": { "filePath": "src/surfaces/checkout/components/Modal.ts", "name": "ModalElementProps", - "description": "The modal component displays content in an overlay. Use to create a distraction-free experience such as a confirmation dialog or a settings panel.\n\nA button triggers the modal using the `commandFor` attribute. Content within the modal scrolls if it exceeds available height.", + "description": "", "isPublicDocs": true, "members": [ { @@ -91732,7 +91769,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -91761,7 +91798,7 @@ "src/surfaces/checkout/components/Modal.ts": { "filePath": "src/surfaces/checkout/components/Modal.ts", "name": "ModalElementSlots", - "description": "Learn more about [component slots](/docs/api/checkout-ui-extensions/latest/using-polaris-components#slots).", + "description": "", "isPublicDocs": true, "members": [ { @@ -91788,7 +91825,7 @@ "src/surfaces/checkout/components/Modal.ts": { "filePath": "src/surfaces/checkout/components/Modal.ts", "name": "ModalEvents", - "description": "The event callbacks for monitoring modal visibility changes.", + "description": "", "isPublicDocs": true, "members": [ { @@ -91831,7 +91868,7 @@ "src/surfaces/checkout/components/Modal.ts": { "filePath": "src/surfaces/checkout/components/Modal.ts", "name": "ModalElementMethods", - "description": "Learn more about [component methods](/docs/api/checkout-ui-extensions/latest/using-polaris-components#methods).", + "description": "", "isPublicDocs": true, "members": [ { @@ -91849,7 +91886,7 @@ "src/surfaces/checkout/components/Modal.ts": { "filePath": "src/surfaces/checkout/components/Modal.ts", "name": "ModalElementEvents", - "description": "Learn more about [registering events](/docs/api/checkout-ui-extensions/latest/using-polaris-components#event-handling).", + "description": "", "isPublicDocs": true, "members": [ { @@ -91922,7 +91959,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/Modal.ts", @@ -92834,7 +92871,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -93983,7 +94020,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/Modal.ts", @@ -94248,7 +94285,7 @@ "src/surfaces/checkout/components/Modal.ts": { "filePath": "src/surfaces/checkout/components/Modal.ts", "name": "ModalProps", - "description": "The properties for the modal component when it's used in JSX.", + "description": "", "isPublicDocs": true, "members": [ { @@ -94272,7 +94309,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -94333,7 +94370,7 @@ "src/surfaces/checkout/components/MoneyField.ts": { "filePath": "src/surfaces/checkout/components/MoneyField.ts", "name": "MoneyFieldElementProps", - "description": "The money field component collects monetary values from users with built-in currency formatting and validation. Use money field for prices, costs, or financial amounts to provide proper currency symbols, decimal handling, and numeric validation.\n\nMoney fields support currency codes, automatic formatting, and min/max constraints to ensure users enter valid monetary values. For non-currency numeric input, use [number field](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/forms/number-field).", + "description": "", "isPublicDocs": true, "members": [ { @@ -94341,7 +94378,7 @@ "syntaxKind": "PropertySignature", "name": "autocomplete", "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", "isOptional": true, "defaultValue": "'on' for everything else" }, @@ -94350,7 +94387,7 @@ "syntaxKind": "PropertySignature", "name": "defaultValue", "value": "string", - "description": "The default value for the field.", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces this value.", "isOptional": true }, { @@ -94358,7 +94395,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -94367,7 +94404,7 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -94375,7 +94412,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -94383,7 +94420,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Content to use as the field label.", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", "isOptional": true }, { @@ -94391,7 +94428,7 @@ "syntaxKind": "PropertySignature", "name": "labelAccessibilityVisibility", "value": "'visible' | 'exclusive'", - "description": "Changes the visibility of the component's label.\n\n- `visible`: the label is visible to all users.\n- `exclusive`: the label is visually hidden but remains in the accessibility tree.", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone.\n- `exclusive`: The label is visually hidden but still announced by screen readers.", "isOptional": true, "defaultValue": "'visible'" }, @@ -94418,7 +94455,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -94426,7 +94463,7 @@ "syntaxKind": "PropertySignature", "name": "readOnly", "value": "boolean", - "description": "The field cannot be edited by the user. It is focusable will be announced by screen readers.", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", "isOptional": true, "defaultValue": "false" }, @@ -94480,7 +94517,7 @@ "syntaxKind": "PropertySignature", "name": "onChange", "value": "(event: Event) => void", - "description": "Callback when the user has **finished editing** a field, for example, once they have blurred the field.", + "description": "A callback fired when the user has **finished editing** a field, such as when they blur the field or press Enter.", "isOptional": true }, { @@ -94496,7 +94533,7 @@ "syntaxKind": "PropertySignature", "name": "onInput", "value": "(event: Event) => void", - "description": "Callback when the user makes any changes in the field.", + "description": "A callback fired when the user makes any changes in the field, such as typing a character.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).", "isOptional": true } ], @@ -94507,7 +94544,7 @@ "src/surfaces/checkout/components/MoneyField.ts": { "filePath": "src/surfaces/checkout/components/MoneyField.ts", "name": "MoneyFieldElementEvents", - "description": "Learn more about [registering events](/docs/api/checkout-ui-extensions/latest/using-polaris-components#event-handling).", + "description": "", "isPublicDocs": true, "members": [ { @@ -94515,7 +94552,7 @@ "syntaxKind": "PropertySignature", "name": "blur", "value": "CallbackEventListener", - "description": "A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "description": "<<<<<<< HEAD A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n======= A callback fired when the money field loses focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) \n Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", "isOptional": true }, { @@ -94523,7 +94560,7 @@ "syntaxKind": "PropertySignature", "name": "change", "value": "CallbackEventListener", - "description": "Callback when the user has **finished editing** a field, for example, once they have blurred the field.", + "description": "<<<<<<< HEAD Callback when the user has **finished editing** a field, for example, once they have blurred the field.\n======= A callback fired when the money field value changes.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) \n Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", "isOptional": true }, { @@ -94531,7 +94568,7 @@ "syntaxKind": "PropertySignature", "name": "focus", "value": "CallbackEventListener", - "description": "A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "description": "<<<<<<< HEAD A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n======= A callback fired when the money field receives focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) \n Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", "isOptional": true }, { @@ -94539,11 +94576,11 @@ "syntaxKind": "PropertySignature", "name": "input", "value": "CallbackEventListener", - "description": "Callback when the user makes any changes in the field.", + "description": "A callback fired when the user inputs data into the money field.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).", "isOptional": true } ], - "value": "export interface MoneyFieldElementEvents {\n /**\n * A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event\n */\n blur?: CallbackEventListener;\n /**\n * Callback when the user has **finished editing** a field, for example, once they have blurred the field.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event\n */\n change?: CallbackEventListener;\n /**\n * A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event\n */\n focus?: CallbackEventListener;\n /**\n * Callback when the user makes any changes in the field.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event\n */\n input?: CallbackEventListener;\n}" + "value": "export interface MoneyFieldElementEvents {\n /**\n<<<<<<< HEAD\n * A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n=======\n * A callback fired when the money field loses focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality)\n *\n * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur?: CallbackEventListener;\n /**\n<<<<<<< HEAD\n * Callback when the user has **finished editing** a field, for example, once they have blurred the field.\n=======\n * A callback fired when the money field value changes.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality)\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change?: CallbackEventListener;\n /**\n<<<<<<< HEAD\n * A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n=======\n * A callback fired when the money field receives focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality)\n *\n * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus?: CallbackEventListener;\n /**\n * A callback fired when the user inputs data into the money field.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input?: CallbackEventListener;\n}" } }, "MoneyFieldElement": { @@ -94558,7 +94595,7 @@ "syntaxKind": "PropertySignature", "name": "autocomplete", "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", "isOptional": true, "defaultValue": "'on' for everything else" }, @@ -94567,7 +94604,7 @@ "syntaxKind": "PropertySignature", "name": "defaultValue", "value": "string", - "description": "The default value for the field.", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces this value.", "isOptional": true }, { @@ -94575,7 +94612,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -94584,7 +94621,7 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -94592,7 +94629,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -94600,7 +94637,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Content to use as the field label.", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", "isOptional": true }, { @@ -94608,7 +94645,7 @@ "syntaxKind": "PropertySignature", "name": "labelAccessibilityVisibility", "value": "'visible' | 'exclusive'", - "description": "Changes the visibility of the component's label.\n\n- `visible`: the label is visible to all users.\n- `exclusive`: the label is visually hidden but remains in the accessibility tree.", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone.\n- `exclusive`: The label is visually hidden but still announced by screen readers.", "isOptional": true, "defaultValue": "'visible'" }, @@ -94635,7 +94672,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -94671,7 +94708,7 @@ "syntaxKind": "PropertySignature", "name": "readOnly", "value": "boolean", - "description": "The field cannot be edited by the user. It is focusable will be announced by screen readers.", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", "isOptional": true, "defaultValue": "false" }, @@ -94717,7 +94754,7 @@ "syntaxKind": "PropertySignature", "name": "autocomplete", "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", "isOptional": true, "defaultValue": "'on' for everything else" }, @@ -94726,7 +94763,7 @@ "syntaxKind": "PropertySignature", "name": "defaultValue", "value": "string", - "description": "The default value for the field.", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces this value.", "isOptional": true }, { @@ -94734,7 +94771,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -94743,7 +94780,7 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -94751,7 +94788,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -94759,7 +94796,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Content to use as the field label.", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", "isOptional": true }, { @@ -94767,7 +94804,7 @@ "syntaxKind": "PropertySignature", "name": "labelAccessibilityVisibility", "value": "'visible' | 'exclusive'", - "description": "Changes the visibility of the component's label.\n\n- `visible`: the label is visible to all users.\n- `exclusive`: the label is visually hidden but remains in the accessibility tree.", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone.\n- `exclusive`: The label is visually hidden but still announced by screen readers.", "isOptional": true, "defaultValue": "'visible'" }, @@ -94794,7 +94831,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -94810,7 +94847,7 @@ "syntaxKind": "PropertySignature", "name": "onChange", "value": "(event: Event) => void", - "description": "Callback when the user has **finished editing** a field, for example, once they have blurred the field.", + "description": "A callback fired when the user has **finished editing** a field, such as when they blur the field or press Enter.", "isOptional": true }, { @@ -94826,7 +94863,7 @@ "syntaxKind": "PropertySignature", "name": "onInput", "value": "(event: Event) => void", - "description": "Callback when the user makes any changes in the field.", + "description": "A callback fired when the user makes any changes in the field, such as typing a character.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).", "isOptional": true }, { @@ -94834,7 +94871,7 @@ "syntaxKind": "PropertySignature", "name": "readOnly", "value": "boolean", - "description": "The field cannot be edited by the user. It is focusable will be announced by screen readers.", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", "isOptional": true, "defaultValue": "false" }, @@ -94872,7 +94909,7 @@ "src/surfaces/checkout/components/NumberField.ts": { "filePath": "src/surfaces/checkout/components/NumberField.ts", "name": "NumberFieldElementProps", - "description": "The number field component captures numeric input with built-in number validation. Use it to collect quantities, prices, or other numeric information.\n\nThe component supports min/max constraints and step increments for guided numeric entry. For monetary values with currency formatting, use [money field](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/forms/money-field).", + "description": "", "isPublicDocs": true, "members": [ { @@ -94880,7 +94917,7 @@ "syntaxKind": "PropertySignature", "name": "autocomplete", "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", "isOptional": true, "defaultValue": "'on' for everything else" }, @@ -94898,7 +94935,7 @@ "syntaxKind": "PropertySignature", "name": "defaultValue", "value": "string", - "description": "The default value for the field.", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces this value.", "isOptional": true }, { @@ -94906,7 +94943,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -94915,7 +94952,7 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -94932,7 +94969,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -94949,7 +94986,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Content to use as the field label.", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", "isOptional": true }, { @@ -94957,7 +94994,7 @@ "syntaxKind": "PropertySignature", "name": "labelAccessibilityVisibility", "value": "'visible' | 'exclusive'", - "description": "Changes the visibility of the component's label.\n\n- `visible`: the label is visible to all users.\n- `exclusive`: the label is visually hidden but remains in the accessibility tree.", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone.\n- `exclusive`: The label is visually hidden but still announced by screen readers.", "isOptional": true, "defaultValue": "'visible'" }, @@ -94984,7 +95021,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -95002,7 +95039,7 @@ "syntaxKind": "PropertySignature", "name": "prefix", "value": "string", - "description": "A value to be displayed immediately before the editable portion of the field.\n\nThis is useful for displaying an implied part of the value, such as \"https://\" or \"+353\".\n\nThis cannot be edited by the user, and it isn't included in the value of the field.\n\nIt may not be displayed until the user has interacted with the input. For example, an inline label may take the place of the prefix until the user focuses the input.", + "description": "A value to be displayed immediately before the editable portion of the field.\n\nThis is useful for displaying an implied part of the value, such as \"https://\" or \"+353\".\n\nThis can't be edited by the user, and it isn't included in the value of the field.\n\nIt may not be displayed until the user has interacted with the input. For example, an inline label may take the place of the prefix until the user focuses the input.", "isOptional": true, "defaultValue": "''" }, @@ -95011,7 +95048,7 @@ "syntaxKind": "PropertySignature", "name": "readOnly", "value": "boolean", - "description": "The field cannot be edited by the user. It is focusable will be announced by screen readers.", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", "isOptional": true, "defaultValue": "false" }, @@ -95038,7 +95075,7 @@ "syntaxKind": "PropertySignature", "name": "suffix", "value": "string", - "description": "A value to be displayed immediately after the editable portion of the field.\n\nThis is useful for displaying an implied part of the value, such as \"@shopify.com\", or \"%\".\n\nThis cannot be edited by the user, and it isn't included in the value of the field.\n\nIt may not be displayed until the user has interacted with the input. For example, an inline label may take the place of the suffix until the user focuses the input.", + "description": "A value to be displayed immediately after the editable portion of the field.\n\nThis is useful for displaying an implied part of the value, such as \"@shopify.com\", or \"%\".\n\nThis can't be edited by the user, and it isn't included in the value of the field.\n\nIt may not be displayed until the user has interacted with the input. For example, an inline label may take the place of the suffix until the user focuses the input.", "isOptional": true, "defaultValue": "''" }, @@ -95074,7 +95111,7 @@ "syntaxKind": "PropertySignature", "name": "onChange", "value": "(event: Event) => void", - "description": "Callback when the user has **finished editing** a field, for example, once they have blurred the field.", + "description": "A callback fired when the user has **finished editing** a field, such as when they blur the field or press Enter.", "isOptional": true }, { @@ -95090,7 +95127,7 @@ "syntaxKind": "PropertySignature", "name": "onInput", "value": "(event: Event) => void", - "description": "Callback when the user makes any changes in the field.", + "description": "A callback fired when the user makes any changes in the field, such as typing a character.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).", "isOptional": true } ], @@ -95101,7 +95138,7 @@ "src/surfaces/checkout/components/NumberField.ts": { "filePath": "src/surfaces/checkout/components/NumberField.ts", "name": "NumberFieldElementEvents", - "description": "Learn more about [registering events](/docs/api/checkout-ui-extensions/latest/using-polaris-components#event-handling).", + "description": "", "isPublicDocs": true, "members": [ { @@ -95109,7 +95146,7 @@ "syntaxKind": "PropertySignature", "name": "blur", "value": "CallbackEventListener", - "description": "A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "description": "<<<<<<< HEAD A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n======= A callback fired when the number field loses focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) \n Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", "isOptional": true }, { @@ -95117,7 +95154,7 @@ "syntaxKind": "PropertySignature", "name": "change", "value": "CallbackEventListener", - "description": "Callback when the user has **finished editing** a field, for example, once they have blurred the field.", + "description": "<<<<<<< HEAD Callback when the user has **finished editing** a field, for example, once they have blurred the field.\n======= A callback fired when the number field value changes.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) \n Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", "isOptional": true }, { @@ -95125,7 +95162,7 @@ "syntaxKind": "PropertySignature", "name": "focus", "value": "CallbackEventListener", - "description": "A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "description": "<<<<<<< HEAD A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n======= A callback fired when the number field receives focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) \n Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", "isOptional": true }, { @@ -95133,18 +95170,18 @@ "syntaxKind": "PropertySignature", "name": "input", "value": "CallbackEventListener", - "description": "Callback when the user makes any changes in the field.", + "description": "A callback fired when the user inputs data into the number field.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).", "isOptional": true } ], - "value": "export interface NumberFieldElementEvents {\n /**\n * A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event\n */\n blur?: CallbackEventListener;\n /**\n * Callback when the user has **finished editing** a field, for example, once they have blurred the field.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event\n */\n change?: CallbackEventListener;\n /**\n * A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event\n */\n focus?: CallbackEventListener;\n /**\n * Callback when the user makes any changes in the field.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event\n */\n input?: CallbackEventListener;\n}" + "value": "export interface NumberFieldElementEvents {\n /**\n<<<<<<< HEAD\n * A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n=======\n * A callback fired when the number field loses focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality)\n *\n * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur?: CallbackEventListener;\n /**\n<<<<<<< HEAD\n * Callback when the user has **finished editing** a field, for example, once they have blurred the field.\n=======\n * A callback fired when the number field value changes.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality)\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change?: CallbackEventListener;\n /**\n<<<<<<< HEAD\n * A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n=======\n * A callback fired when the number field receives focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality)\n *\n * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus?: CallbackEventListener;\n /**\n * A callback fired when the user inputs data into the number field.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input?: CallbackEventListener;\n}" } }, "NumberFieldElementSlots": { "src/surfaces/checkout/components/NumberField.ts": { "filePath": "src/surfaces/checkout/components/NumberField.ts", "name": "NumberFieldElementSlots", - "description": "Learn more about [component slots](/docs/api/checkout-ui-extensions/latest/using-polaris-components#slots).", + "description": "", "isPublicDocs": true, "members": [ { @@ -95152,11 +95189,11 @@ "syntaxKind": "PropertySignature", "name": "accessory", "value": "HTMLElement", - "description": "Additional content to be displayed in the field. Commonly used to display an icon that activates a tooltip providing more information.", + "description": "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.", "isOptional": true } ], - "value": "export interface NumberFieldElementSlots {\n /**\n * Additional content to be displayed in the field.\n * Commonly used to display an icon that activates a tooltip providing more information.\n */\n accessory?: HTMLElement;\n}" + "value": "export interface NumberFieldElementSlots {\n /**\n * 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.\n */\n accessory?: HTMLElement;\n}" } }, "NumberFieldElement": { @@ -95185,7 +95222,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/NumberField.ts", @@ -95626,7 +95663,7 @@ "syntaxKind": "PropertySignature", "name": "autocomplete", "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", "isOptional": true, "defaultValue": "'on' for everything else" }, @@ -95826,7 +95863,7 @@ "syntaxKind": "PropertySignature", "name": "defaultValue", "value": "string", - "description": "The default value for the field.", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces this value.", "isOptional": true }, { @@ -95841,7 +95878,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -95955,7 +95992,7 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -96133,7 +96170,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -96234,7 +96271,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Content to use as the field label.", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", "isOptional": true }, { @@ -96242,7 +96279,7 @@ "syntaxKind": "PropertySignature", "name": "labelAccessibilityVisibility", "value": "'visible' | 'exclusive'", - "description": "Changes the visibility of the component's label.\n\n- `visible`: the label is visible to all users.\n- `exclusive`: the label is visually hidden but remains in the accessibility tree.", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone.\n- `exclusive`: The label is visually hidden but still announced by screen readers.", "isOptional": true, "defaultValue": "'visible'" }, @@ -96318,7 +96355,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -97207,7 +97244,7 @@ "syntaxKind": "PropertySignature", "name": "prefix", "value": "string", - "description": "A value to be displayed immediately before the editable portion of the field.\n\nThis is useful for displaying an implied part of the value, such as \"https://\" or \"+353\".\n\nThis cannot be edited by the user, and it isn't included in the value of the field.\n\nIt may not be displayed until the user has interacted with the input. For example, an inline label may take the place of the prefix until the user focuses the input.", + "description": "A value to be displayed immediately before the editable portion of the field.\n\nThis is useful for displaying an implied part of the value, such as \"https://\" or \"+353\".\n\nThis can't be edited by the user, and it isn't included in the value of the field.\n\nIt may not be displayed until the user has interacted with the input. For example, an inline label may take the place of the prefix until the user focuses the input.", "isOptional": true, "defaultValue": "''" }, @@ -97260,7 +97297,7 @@ "syntaxKind": "PropertySignature", "name": "readOnly", "value": "boolean", - "description": "The field cannot be edited by the user. It is focusable will be announced by screen readers.", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", "isOptional": true, "defaultValue": "false" }, @@ -97311,7 +97348,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/NumberField.ts", @@ -97511,7 +97548,7 @@ "syntaxKind": "PropertySignature", "name": "suffix", "value": "string", - "description": "A value to be displayed immediately after the editable portion of the field.\n\nThis is useful for displaying an implied part of the value, such as \"@shopify.com\", or \"%\".\n\nThis cannot be edited by the user, and it isn't included in the value of the field.\n\nIt may not be displayed until the user has interacted with the input. For example, an inline label may take the place of the suffix until the user focuses the input.", + "description": "A value to be displayed immediately after the editable portion of the field.\n\nThis is useful for displaying an implied part of the value, such as \"@shopify.com\", or \"%\".\n\nThis can't be edited by the user, and it isn't included in the value of the field.\n\nIt may not be displayed until the user has interacted with the input. For example, an inline label may take the place of the suffix until the user focuses the input.", "isOptional": true, "defaultValue": "''" }, @@ -97610,7 +97647,7 @@ "syntaxKind": "PropertySignature", "name": "autocomplete", "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", "isOptional": true, "defaultValue": "'on' for everything else" }, @@ -97628,7 +97665,7 @@ "syntaxKind": "PropertySignature", "name": "defaultValue", "value": "string", - "description": "The default value for the field.", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces this value.", "isOptional": true }, { @@ -97636,7 +97673,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -97645,7 +97682,7 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -97661,7 +97698,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -97678,7 +97715,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Content to use as the field label.", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", "isOptional": true }, { @@ -97686,7 +97723,7 @@ "syntaxKind": "PropertySignature", "name": "labelAccessibilityVisibility", "value": "'visible' | 'exclusive'", - "description": "Changes the visibility of the component's label.\n\n- `visible`: the label is visible to all users.\n- `exclusive`: the label is visually hidden but remains in the accessibility tree.", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone.\n- `exclusive`: The label is visually hidden but still announced by screen readers.", "isOptional": true, "defaultValue": "'visible'" }, @@ -97713,7 +97750,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -97729,7 +97766,7 @@ "syntaxKind": "PropertySignature", "name": "onChange", "value": "(event: Event) => void", - "description": "Callback when the user has **finished editing** a field, for example, once they have blurred the field.", + "description": "A callback fired when the user has **finished editing** a field, such as when they blur the field or press Enter.", "isOptional": true }, { @@ -97745,7 +97782,7 @@ "syntaxKind": "PropertySignature", "name": "onInput", "value": "(event: Event) => void", - "description": "Callback when the user makes any changes in the field.", + "description": "A callback fired when the user makes any changes in the field, such as typing a character.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).", "isOptional": true }, { @@ -97763,7 +97800,7 @@ "syntaxKind": "PropertySignature", "name": "prefix", "value": "string", - "description": "A value to be displayed immediately before the editable portion of the field.\n\nThis is useful for displaying an implied part of the value, such as \"https://\" or \"+353\".\n\nThis cannot be edited by the user, and it isn't included in the value of the field.\n\nIt may not be displayed until the user has interacted with the input. For example, an inline label may take the place of the prefix until the user focuses the input.", + "description": "A value to be displayed immediately before the editable portion of the field.\n\nThis is useful for displaying an implied part of the value, such as \"https://\" or \"+353\".\n\nThis can't be edited by the user, and it isn't included in the value of the field.\n\nIt may not be displayed until the user has interacted with the input. For example, an inline label may take the place of the prefix until the user focuses the input.", "isOptional": true, "defaultValue": "''" }, @@ -97772,7 +97809,7 @@ "syntaxKind": "PropertySignature", "name": "readOnly", "value": "boolean", - "description": "The field cannot be edited by the user. It is focusable will be announced by screen readers.", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", "isOptional": true, "defaultValue": "false" }, @@ -97799,7 +97836,7 @@ "syntaxKind": "PropertySignature", "name": "suffix", "value": "string", - "description": "A value to be displayed immediately after the editable portion of the field.\n\nThis is useful for displaying an implied part of the value, such as \"@shopify.com\", or \"%\".\n\nThis cannot be edited by the user, and it isn't included in the value of the field.\n\nIt may not be displayed until the user has interacted with the input. For example, an inline label may take the place of the suffix until the user focuses the input.", + "description": "A value to be displayed immediately after the editable portion of the field.\n\nThis is useful for displaying an implied part of the value, such as \"@shopify.com\", or \"%\".\n\nThis can't be edited by the user, and it isn't included in the value of the field.\n\nIt may not be displayed until the user has interacted with the input. For example, an inline label may take the place of the suffix until the user focuses the input.", "isOptional": true, "defaultValue": "''" }, @@ -97819,7 +97856,7 @@ "src/surfaces/checkout/components/Option.ts": { "filePath": "src/surfaces/checkout/components/Option.ts", "name": "OptionElementProps", - "description": "Represents a single option within a select component. Use only as a child of `s-select` components.", + "description": "", "isPublicDocs": true, "members": [ { @@ -97835,7 +97872,7 @@ "syntaxKind": "PropertySignature", "name": "defaultSelected", "value": "boolean", - "description": "Whether the control is active by default.", + "description": "Whether the control is selected by default.", "isOptional": true, "defaultValue": "false" }, @@ -97844,7 +97881,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the control, disallowing any interaction.", + "description": "Whether the control is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -97853,7 +97890,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -97861,7 +97898,7 @@ "syntaxKind": "PropertySignature", "name": "selected", "value": "boolean", - "description": "Whether the control is active.", + "description": "Whether the control is currently selected.", "isOptional": true, "defaultValue": "false" }, @@ -97911,7 +97948,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/Option.ts", @@ -98534,7 +98571,7 @@ "syntaxKind": "PropertySignature", "name": "defaultSelected", "value": "boolean", - "description": "Whether the control is active by default.", + "description": "Whether the control is selected by default.", "isOptional": true, "defaultValue": "false" }, @@ -98550,7 +98587,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the control, disallowing any interaction.", + "description": "Whether the control is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -98826,7 +98863,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -99938,7 +99975,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/Option.ts", @@ -100043,7 +100080,7 @@ "syntaxKind": "PropertySignature", "name": "selected", "value": "boolean", - "description": "Whether the control is active.", + "description": "Whether the control is currently selected.", "isOptional": true, "defaultValue": "false" }, @@ -100227,7 +100264,7 @@ "syntaxKind": "PropertySignature", "name": "defaultSelected", "value": "boolean", - "description": "Whether the control is active by default.", + "description": "Whether the control is selected by default.", "isOptional": true, "defaultValue": "false" }, @@ -100236,7 +100273,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the control, disallowing any interaction.", + "description": "Whether the control is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -100245,7 +100282,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -100253,7 +100290,7 @@ "syntaxKind": "PropertySignature", "name": "selected", "value": "boolean", - "description": "Whether the control is active.", + "description": "Whether the control is currently selected.", "isOptional": true, "defaultValue": "false" }, @@ -100273,7 +100310,7 @@ "src/surfaces/checkout/components/OrderedList.ts": { "filePath": "src/surfaces/checkout/components/OrderedList.ts", "name": "OrderedListElementProps", - "description": "Properties for the OrderedList component element.", + "description": "", "isPublicDocs": true, "members": [ { @@ -100281,7 +100318,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true } ], @@ -100314,7 +100351,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/OrderedList.ts", @@ -101211,7 +101248,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -102323,7 +102360,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/OrderedList.ts", @@ -102587,7 +102624,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true } ], @@ -102598,7 +102635,7 @@ "src/surfaces/checkout/components/Paragraph.ts": { "filePath": "src/surfaces/checkout/components/Paragraph.ts", "name": "ParagraphElementProps", - "description": "The paragraph component displays blocks of text content and can contain inline elements like buttons, links, or emphasized text. Use paragraph to present standalone blocks of readable content, descriptions, or explanatory text.\n\nParagraphs support alignment options and can wrap inline components to create rich, formatted content blocks. For inline text styling, use [text](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/typography-and-content/text).", + "description": "", "isPublicDocs": true, "members": [ { @@ -102606,7 +102643,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityVisibility", "value": "'visible' | 'hidden' | 'exclusive'", - "description": "Changes the visibility of the element.\n\n- `visible`: the element is visible to all users.\n- `hidden`: the element is removed from the accessibility tree but remains visible.\n- `exclusive`: the element is visually hidden but remains in the accessibility tree.", + "description": "Controls how the element is exposed to sighted users and to assistive technologies such as screen readers.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", "isOptional": true, "defaultValue": "'visible'" }, @@ -102615,7 +102652,7 @@ "syntaxKind": "PropertySignature", "name": "color", "value": "'base' | 'subdued'", - "description": "Modify the color to be more or less intense.", + "description": "The color emphasis level that controls visual intensity.\n\n- `subdued`: Deemphasized color for secondary text, supporting labels, and less critical interface elements.\n- `base`: Primary color for body text, standard UI elements, and general content with good readability.\n- `strong`: Emphasized color for headings, key labels, and interactive elements that need prominence.", "isOptional": true, "defaultValue": "'base'" }, @@ -102624,7 +102661,7 @@ "syntaxKind": "PropertySignature", "name": "dir", "value": "'ltr' | 'rtl' | 'auto' | ''", - "description": "Indicates the directionality of the element’s text.\n\n- `ltr`: languages written from left to right (such as English)\n- `rtl`: languages written from right to left (such as Arabic)\n- `auto`: the user agent determines the direction based on the content\n- `''`: direction is inherited from parent elements (equivalent to not setting the attribute)", + "description": "Indicates the directionality of the element’s text.\n\n- `ltr`: The languages written from left to right (such as English).\n- `rtl`: The languages written from right to left (such as Arabic).\n- `auto`: The user agent determines the direction based on the content.\n- `\"\"`: The direction is inherited from parent elements (equivalent to not setting the attribute).\n\nLearn more about the [dir attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/dir).", "isOptional": true, "defaultValue": "''" }, @@ -102633,7 +102670,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -102641,16 +102678,25 @@ "syntaxKind": "PropertySignature", "name": "lang", "value": "string", - "description": "The language of the button's text content. Use this when the button text is in a different language than the rest of the page, so assistive technologies can invoke the correct pronunciation. [Reference of values](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry) (`Subtag` label)\n\nIt is recommended to combine it with the `dir` attribute to ensure the text is rendered correctly if the surrounding content’s direction is different.", + "description": "Indicate the text language. Useful when the text is in a different language than the rest of the page. It will allow assistive technologies such as screen readers to invoke the correct pronunciation. [Reference of values](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry) (\"subtag\" label)\n\nIt is recommended to combine it with the `dir` attribute to ensure the text is rendered correctly if the surrounding content’s direction is different.", "isOptional": true, "defaultValue": "''" }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "textAlign", + "value": "'start' | 'end' | 'center' | 'auto'", + "description": "Sets the alignment of the text.", + "isOptional": true, + "defaultValue": "'auto'" + }, { "filePath": "src/surfaces/checkout/components/Paragraph.ts", "syntaxKind": "PropertySignature", "name": "tone", "value": "'custom' | 'success' | 'info' | 'auto' | 'neutral' | 'warning' | 'critical'", - "description": "Sets the tone of the component, based on the intention of the information being conveyed.", + "description": "The semantic meaning and color treatment of the component.\n\n- `auto`: Automatically determined based on context.\n- `neutral`: General information without specific intent.\n- `info`: Informational content or helpful tips.\n- `success`: Positive outcomes or successful states.\n- `warning`: Important warnings about potential issues.\n- `critical`: Urgent problems or destructive actions.\n- `custom`: Custom styling controlled by your theme.", "isOptional": true, "defaultValue": "'auto'" }, @@ -102659,12 +102705,12 @@ "syntaxKind": "PropertySignature", "name": "type", "value": "ParagraphType", - "description": "Provide semantic meaning and default styling to the paragraph.\n\nOther presentation properties on `s-paragraph` override the default styling.", + "description": "The semantic type and styling treatment for the paragraph content.\n\nOther presentation properties on `s-paragraph` override the default styling.", "isOptional": true, "defaultValue": "'paragraph'" } ], - "value": "export interface ParagraphElementProps extends Pick {\n color?: Extract;\n tone?: Extract;\n}" + "value": "export interface ParagraphElementProps extends Pick {\n color?: Extract;\n tone?: Extract;\n /**\n * Sets the alignment of the text.\n * @see https://developer.mozilla.org/en-US/docs/Web/CSS/text-align\n *\n * @default 'auto'\n */\n textAlign?: 'start' | 'end' | 'center' | 'auto';\n}" } }, "ParagraphType": { @@ -102689,7 +102735,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityVisibility", "value": "'visible' | 'hidden' | 'exclusive'", - "description": "Changes the visibility of the element.\n\n- `visible`: the element is visible to all users.\n- `hidden`: the element is removed from the accessibility tree but remains visible.\n- `exclusive`: the element is visually hidden but remains in the accessibility tree.", + "description": "Controls how the element is exposed to sighted users and to assistive technologies such as screen readers.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", "isOptional": true, "defaultValue": "'visible'" }, @@ -102712,7 +102758,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/Paragraph.ts", @@ -103286,7 +103332,7 @@ "syntaxKind": "PropertySignature", "name": "color", "value": "'base' | 'subdued'", - "description": "Modify the color to be more or less intense.", + "description": "The color emphasis level that controls visual intensity.\n\n- `subdued`: Deemphasized color for secondary text, supporting labels, and less critical interface elements.\n- `base`: Primary color for body text, standard UI elements, and general content with good readability.\n- `strong`: Emphasized color for headings, key labels, and interactive elements that need prominence.", "isOptional": true, "defaultValue": "'base'" }, @@ -103344,7 +103390,7 @@ "syntaxKind": "PropertySignature", "name": "dir", "value": "'ltr' | 'rtl' | 'auto' | ''", - "description": "Indicates the directionality of the element’s text.\n\n- `ltr`: languages written from left to right (such as English)\n- `rtl`: languages written from right to left (such as Arabic)\n- `auto`: the user agent determines the direction based on the content\n- `''`: direction is inherited from parent elements (equivalent to not setting the attribute)", + "description": "Indicates the directionality of the element’s text.\n\n- `ltr`: The languages written from left to right (such as English).\n- `rtl`: The languages written from right to left (such as Arabic).\n- `auto`: The user agent determines the direction based on the content.\n- `\"\"`: The direction is inherited from parent elements (equivalent to not setting the attribute).\n\nLearn more about the [dir attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/dir).", "isOptional": true, "defaultValue": "''" }, @@ -103620,7 +103666,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -103719,7 +103765,7 @@ "syntaxKind": "PropertySignature", "name": "lang", "value": "string", - "description": "The language of the button's text content. Use this when the button text is in a different language than the rest of the page, so assistive technologies can invoke the correct pronunciation. [Reference of values](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry) (`Subtag` label)\n\nIt is recommended to combine it with the `dir` attribute to ensure the text is rendered correctly if the surrounding content’s direction is different.", + "description": "Indicate the text language. Useful when the text is in a different language than the rest of the page. It will allow assistive technologies such as screen readers to invoke the correct pronunciation. [Reference of values](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry) (\"subtag\" label)\n\nIt is recommended to combine it with the `dir` attribute to ensure the text is rendered correctly if the surrounding content’s direction is different.", "isOptional": true, "defaultValue": "''" }, @@ -104734,7 +104780,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/Paragraph.ts", @@ -104932,6 +104978,15 @@ "value": "3", "description": "node is a Text node." }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "textAlign", + "value": "'start' | 'end' | 'center' | 'auto'", + "description": "Sets the alignment of the text.", + "isOptional": true, + "defaultValue": "'auto'" + }, { "filePath": "src/surfaces/checkout/components/Paragraph.ts", "syntaxKind": "GetAccessor", @@ -104965,7 +105020,7 @@ "syntaxKind": "PropertySignature", "name": "tone", "value": "'custom' | 'success' | 'info' | 'auto' | 'neutral' | 'warning' | 'critical'", - "description": "Sets the tone of the component, based on the intention of the information being conveyed.", + "description": "The semantic meaning and color treatment of the component.\n\n- `auto`: Automatically determined based on context.\n- `neutral`: General information without specific intent.\n- `info`: Informational content or helpful tips.\n- `success`: Positive outcomes or successful states.\n- `warning`: Important warnings about potential issues.\n- `critical`: Urgent problems or destructive actions.\n- `custom`: Custom styling controlled by your theme.", "isOptional": true, "defaultValue": "'auto'" }, @@ -104981,7 +105036,7 @@ "syntaxKind": "PropertySignature", "name": "type", "value": "ParagraphType", - "description": "Provide semantic meaning and default styling to the paragraph.\n\nOther presentation properties on `s-paragraph` override the default styling.", + "description": "The semantic type and styling treatment for the paragraph content.\n\nOther presentation properties on `s-paragraph` override the default styling.", "isOptional": true, "defaultValue": "'paragraph'" }, @@ -105016,7 +105071,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityVisibility", "value": "'visible' | 'hidden' | 'exclusive'", - "description": "Changes the visibility of the element.\n\n- `visible`: the element is visible to all users.\n- `hidden`: the element is removed from the accessibility tree but remains visible.\n- `exclusive`: the element is visually hidden but remains in the accessibility tree.", + "description": "Controls how the element is exposed to sighted users and to assistive technologies such as screen readers.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", "isOptional": true, "defaultValue": "'visible'" }, @@ -105025,7 +105080,7 @@ "syntaxKind": "PropertySignature", "name": "color", "value": "'base' | 'subdued'", - "description": "Modify the color to be more or less intense.", + "description": "The color emphasis level that controls visual intensity.\n\n- `subdued`: Deemphasized color for secondary text, supporting labels, and less critical interface elements.\n- `base`: Primary color for body text, standard UI elements, and general content with good readability.\n- `strong`: Emphasized color for headings, key labels, and interactive elements that need prominence.", "isOptional": true, "defaultValue": "'base'" }, @@ -105034,7 +105089,7 @@ "syntaxKind": "PropertySignature", "name": "dir", "value": "'ltr' | 'rtl' | 'auto' | ''", - "description": "Indicates the directionality of the element’s text.\n\n- `ltr`: languages written from left to right (such as English)\n- `rtl`: languages written from right to left (such as Arabic)\n- `auto`: the user agent determines the direction based on the content\n- `''`: direction is inherited from parent elements (equivalent to not setting the attribute)", + "description": "Indicates the directionality of the element’s text.\n\n- `ltr`: The languages written from left to right (such as English).\n- `rtl`: The languages written from right to left (such as Arabic).\n- `auto`: The user agent determines the direction based on the content.\n- `\"\"`: The direction is inherited from parent elements (equivalent to not setting the attribute).\n\nLearn more about the [dir attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/dir).", "isOptional": true, "defaultValue": "''" }, @@ -105043,7 +105098,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -105051,16 +105106,25 @@ "syntaxKind": "PropertySignature", "name": "lang", "value": "string", - "description": "The language of the button's text content. Use this when the button text is in a different language than the rest of the page, so assistive technologies can invoke the correct pronunciation. [Reference of values](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry) (`Subtag` label)\n\nIt is recommended to combine it with the `dir` attribute to ensure the text is rendered correctly if the surrounding content’s direction is different.", + "description": "Indicate the text language. Useful when the text is in a different language than the rest of the page. It will allow assistive technologies such as screen readers to invoke the correct pronunciation. [Reference of values](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry) (\"subtag\" label)\n\nIt is recommended to combine it with the `dir` attribute to ensure the text is rendered correctly if the surrounding content’s direction is different.", "isOptional": true, "defaultValue": "''" }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "textAlign", + "value": "'start' | 'end' | 'center' | 'auto'", + "description": "Sets the alignment of the text.", + "isOptional": true, + "defaultValue": "'auto'" + }, { "filePath": "src/surfaces/checkout/components/Paragraph.ts", "syntaxKind": "PropertySignature", "name": "tone", "value": "'custom' | 'success' | 'info' | 'auto' | 'neutral' | 'warning' | 'critical'", - "description": "Sets the tone of the component, based on the intention of the information being conveyed.", + "description": "The semantic meaning and color treatment of the component.\n\n- `auto`: Automatically determined based on context.\n- `neutral`: General information without specific intent.\n- `info`: Informational content or helpful tips.\n- `success`: Positive outcomes or successful states.\n- `warning`: Important warnings about potential issues.\n- `critical`: Urgent problems or destructive actions.\n- `custom`: Custom styling controlled by your theme.", "isOptional": true, "defaultValue": "'auto'" }, @@ -105069,7 +105133,7 @@ "syntaxKind": "PropertySignature", "name": "type", "value": "ParagraphType", - "description": "Provide semantic meaning and default styling to the paragraph.\n\nOther presentation properties on `s-paragraph` override the default styling.", + "description": "The semantic type and styling treatment for the paragraph content.\n\nOther presentation properties on `s-paragraph` override the default styling.", "isOptional": true, "defaultValue": "'paragraph'" } @@ -105081,7 +105145,7 @@ "src/surfaces/checkout/components/PasswordField.ts": { "filePath": "src/surfaces/checkout/components/PasswordField.ts", "name": "PasswordFieldElementProps", - "description": "The password field component securely collects sensitive information from users. Use password field for password entry, where input characters are automatically masked for privacy.\n\nPassword fields support validation, help text, and accessibility features to create secure and user-friendly authentication experiences. For general text input, use [text field](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/forms/text-field).", + "description": "", "isPublicDocs": true, "members": [ { @@ -105089,7 +105153,7 @@ "syntaxKind": "PropertySignature", "name": "autocomplete", "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", "isOptional": true, "defaultValue": "'on' for everything else" }, @@ -105098,7 +105162,7 @@ "syntaxKind": "PropertySignature", "name": "defaultValue", "value": "string", - "description": "The default value for the field.", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces this value.", "isOptional": true }, { @@ -105106,7 +105170,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -105115,7 +105179,7 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -105123,7 +105187,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -105131,7 +105195,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Content to use as the field label.", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", "isOptional": true }, { @@ -105139,7 +105203,7 @@ "syntaxKind": "PropertySignature", "name": "labelAccessibilityVisibility", "value": "'visible' | 'exclusive'", - "description": "Changes the visibility of the component's label.\n\n- `visible`: the label is visible to all users.\n- `exclusive`: the label is visually hidden but remains in the accessibility tree.", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone.\n- `exclusive`: The label is visually hidden but still announced by screen readers.", "isOptional": true, "defaultValue": "'visible'" }, @@ -105157,7 +105221,7 @@ "syntaxKind": "PropertySignature", "name": "minLength", "value": "number", - "description": "Specifies the min number of characters allowed.", + "description": "Specifies the minimum number of characters allowed.", "isOptional": true, "defaultValue": "0" }, @@ -105166,7 +105230,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -105174,7 +105238,7 @@ "syntaxKind": "PropertySignature", "name": "readOnly", "value": "boolean", - "description": "The field cannot be edited by the user. It is focusable will be announced by screen readers.", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", "isOptional": true, "defaultValue": "false" }, @@ -105219,7 +105283,7 @@ "syntaxKind": "PropertySignature", "name": "onChange", "value": "(event: Event) => void", - "description": "Callback when the user has **finished editing** a field, for example, once they have blurred the field.", + "description": "A callback fired when the user has **finished editing** a field, such as when they blur the field or press Enter.", "isOptional": true }, { @@ -105235,7 +105299,7 @@ "syntaxKind": "PropertySignature", "name": "onInput", "value": "(event: Event) => void", - "description": "Callback when the user makes any changes in the field.", + "description": "A callback fired when the user makes any changes in the field, such as typing a character.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).", "isOptional": true } ], @@ -105246,7 +105310,7 @@ "src/surfaces/checkout/components/PasswordField.ts": { "filePath": "src/surfaces/checkout/components/PasswordField.ts", "name": "PasswordFieldElementEvents", - "description": "Learn more about [registering events](/docs/api/checkout-ui-extensions/latest/using-polaris-components#event-handling).", + "description": "", "isPublicDocs": true, "members": [ { @@ -105254,7 +105318,7 @@ "syntaxKind": "PropertySignature", "name": "blur", "value": "CallbackEventListener", - "description": "A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "description": "<<<<<<< HEAD A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n======= A callback fired when the password field loses focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) \n Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", "isOptional": true }, { @@ -105262,7 +105326,7 @@ "syntaxKind": "PropertySignature", "name": "change", "value": "CallbackEventListener", - "description": "Callback when the user has **finished editing** a field, for example, once they have blurred the field.", + "description": "<<<<<<< HEAD Callback when the user has **finished editing** a field, for example, once they have blurred the field.\n======= A callback fired when the password field value changes.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) \n Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", "isOptional": true }, { @@ -105270,7 +105334,7 @@ "syntaxKind": "PropertySignature", "name": "focus", "value": "CallbackEventListener", - "description": "A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "description": "<<<<<<< HEAD A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n======= A callback fired when the password field receives focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) \n Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", "isOptional": true }, { @@ -105278,18 +105342,18 @@ "syntaxKind": "PropertySignature", "name": "input", "value": "CallbackEventListener", - "description": "Callback when the user makes any changes in the field.", + "description": "A callback fired when the user inputs data into the password field.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).", "isOptional": true } ], - "value": "export interface PasswordFieldElementEvents {\n /**\n * A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event\n */\n blur?: CallbackEventListener;\n /**\n * Callback when the user has **finished editing** a field, for example, once they have blurred the field.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event\n */\n change?: CallbackEventListener;\n /**\n * A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event\n */\n focus?: CallbackEventListener;\n /**\n * Callback when the user makes any changes in the field.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event\n */\n input?: CallbackEventListener;\n}" + "value": "export interface PasswordFieldElementEvents {\n /**\n<<<<<<< HEAD\n * A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n=======\n * A callback fired when the password field loses focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality)\n *\n * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur?: CallbackEventListener;\n /**\n<<<<<<< HEAD\n * Callback when the user has **finished editing** a field, for example, once they have blurred the field.\n=======\n * A callback fired when the password field value changes.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality)\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change?: CallbackEventListener;\n /**\n<<<<<<< HEAD\n * A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n=======\n * A callback fired when the password field receives focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality)\n *\n * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus?: CallbackEventListener;\n /**\n * A callback fired when the user inputs data into the password field.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input?: CallbackEventListener;\n}" } }, "PasswordFieldElementSlots": { "src/surfaces/checkout/components/PasswordField.ts": { "filePath": "src/surfaces/checkout/components/PasswordField.ts", "name": "PasswordFieldElementSlots", - "description": "Learn more about [component slots](/docs/api/checkout-ui-extensions/latest/using-polaris-components#slots).", + "description": "", "isPublicDocs": true, "members": [ { @@ -105297,11 +105361,11 @@ "syntaxKind": "PropertySignature", "name": "accessory", "value": "HTMLElement", - "description": "Additional content to be displayed in the field. Commonly used to display an icon that activates a tooltip providing more information.", + "description": "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.", "isOptional": true } ], - "value": "export interface PasswordFieldElementSlots {\n /**\n * Additional content to be displayed in the field.\n * Commonly used to display an icon that activates a tooltip providing more information.\n */\n accessory?: HTMLElement;\n}" + "value": "export interface PasswordFieldElementSlots {\n /**\n * 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.\n */\n accessory?: HTMLElement;\n}" } }, "PasswordFieldElement": { @@ -105330,7 +105394,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/PasswordField.ts", @@ -105771,7 +105835,7 @@ "syntaxKind": "PropertySignature", "name": "autocomplete", "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", "isOptional": true, "defaultValue": "'on' for everything else" }, @@ -105962,7 +106026,7 @@ "syntaxKind": "PropertySignature", "name": "defaultValue", "value": "string", - "description": "The default value for the field.", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces this value.", "isOptional": true }, { @@ -105977,7 +106041,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -106091,7 +106155,7 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -106261,7 +106325,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -106353,7 +106417,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Content to use as the field label.", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", "isOptional": true }, { @@ -106361,7 +106425,7 @@ "syntaxKind": "PropertySignature", "name": "labelAccessibilityVisibility", "value": "'visible' | 'exclusive'", - "description": "Changes the visibility of the component's label.\n\n- `visible`: the label is visible to all users.\n- `exclusive`: the label is visually hidden but remains in the accessibility tree.", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone.\n- `exclusive`: The label is visually hidden but still announced by screen readers.", "isOptional": true, "defaultValue": "'visible'" }, @@ -106428,7 +106492,7 @@ "syntaxKind": "PropertySignature", "name": "minLength", "value": "number", - "description": "Specifies the min number of characters allowed.", + "description": "Specifies the minimum number of characters allowed.", "isOptional": true, "defaultValue": "0" }, @@ -106437,7 +106501,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -106650,7 +106714,7 @@ "syntaxKind": "PropertySignature", "name": "onChange", "value": "(event: Event) => void", - "description": "Callback when the user has **finished editing** a field, for example, once they have blurred the field.", + "description": "A callback fired when the user has **finished editing** a field, such as when they blur the field or press Enter.", "isOptional": true }, { @@ -106848,7 +106912,7 @@ "syntaxKind": "PropertySignature", "name": "onInput", "value": "(event: Event) => void", - "description": "Callback when the user makes any changes in the field.", + "description": "A callback fired when the user makes any changes in the field, such as typing a character.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).", "isOptional": true }, { @@ -107392,7 +107456,7 @@ "syntaxKind": "PropertySignature", "name": "readOnly", "value": "boolean", - "description": "The field cannot be edited by the user. It is focusable will be announced by screen readers.", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", "isOptional": true, "defaultValue": "false" }, @@ -107443,7 +107507,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/PasswordField.ts", @@ -107724,7 +107788,7 @@ "syntaxKind": "PropertySignature", "name": "autocomplete", "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", "isOptional": true, "defaultValue": "'on' for everything else" }, @@ -107733,7 +107797,7 @@ "syntaxKind": "PropertySignature", "name": "defaultValue", "value": "string", - "description": "The default value for the field.", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces this value.", "isOptional": true }, { @@ -107741,7 +107805,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -107750,7 +107814,7 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -107758,7 +107822,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -107766,7 +107830,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Content to use as the field label.", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", "isOptional": true }, { @@ -107774,7 +107838,7 @@ "syntaxKind": "PropertySignature", "name": "labelAccessibilityVisibility", "value": "'visible' | 'exclusive'", - "description": "Changes the visibility of the component's label.\n\n- `visible`: the label is visible to all users.\n- `exclusive`: the label is visually hidden but remains in the accessibility tree.", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone.\n- `exclusive`: The label is visually hidden but still announced by screen readers.", "isOptional": true, "defaultValue": "'visible'" }, @@ -107792,7 +107856,7 @@ "syntaxKind": "PropertySignature", "name": "minLength", "value": "number", - "description": "Specifies the min number of characters allowed.", + "description": "Specifies the minimum number of characters allowed.", "isOptional": true, "defaultValue": "0" }, @@ -107801,7 +107865,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -107817,7 +107881,7 @@ "syntaxKind": "PropertySignature", "name": "onChange", "value": "(event: Event) => void", - "description": "Callback when the user has **finished editing** a field, for example, once they have blurred the field.", + "description": "A callback fired when the user has **finished editing** a field, such as when they blur the field or press Enter.", "isOptional": true }, { @@ -107833,7 +107897,7 @@ "syntaxKind": "PropertySignature", "name": "onInput", "value": "(event: Event) => void", - "description": "Callback when the user makes any changes in the field.", + "description": "A callback fired when the user makes any changes in the field, such as typing a character.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).", "isOptional": true }, { @@ -107841,7 +107905,7 @@ "syntaxKind": "PropertySignature", "name": "readOnly", "value": "boolean", - "description": "The field cannot be edited by the user. It is focusable will be announced by screen readers.", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", "isOptional": true, "defaultValue": "false" }, @@ -107870,7 +107934,7 @@ "src/surfaces/checkout/components/PaymentIcon.ts": { "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", "name": "PaymentIconElementProps", - "description": "Displays icons representing payment methods. Use to visually communicate available or saved payment options clearly", + "description": "", "isPublicDocs": true, "members": [ { @@ -107886,7 +107950,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -107956,7 +108020,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", @@ -108853,7 +108917,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -109965,7 +110029,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", @@ -110230,7 +110294,7 @@ "src/surfaces/checkout/components/PaymentIcon.ts": { "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", "name": "PaymentIconProps", - "description": "The properties for the payment icon component when it's used in JSX.", + "description": "", "isPublicDocs": true, "members": [ { @@ -110246,7 +110310,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -110266,7 +110330,7 @@ "src/surfaces/checkout/components/PhoneField.ts": { "filePath": "src/surfaces/checkout/components/PhoneField.ts", "name": "PhoneFieldElementEvents", - "description": "Learn more about [registering events](/docs/api/checkout-ui-extensions/latest/using-polaris-components#event-handling).", + "description": "", "isPublicDocs": true, "members": [ { @@ -110274,7 +110338,7 @@ "syntaxKind": "PropertySignature", "name": "blur", "value": "CallbackEventListener", - "description": "A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "description": "<<<<<<< HEAD A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n======= A callback fired when the phone field loses focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) \n Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", "isOptional": true }, { @@ -110282,7 +110346,7 @@ "syntaxKind": "PropertySignature", "name": "change", "value": "CallbackEventListener", - "description": "Callback when the user has **finished editing** a field, for example, once they have blurred the field.", + "description": "<<<<<<< HEAD Callback when the user has **finished editing** a field, for example, once they have blurred the field.\n======= A callback fired when the phone field value changes.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) \n Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", "isOptional": true }, { @@ -110290,7 +110354,7 @@ "syntaxKind": "PropertySignature", "name": "focus", "value": "CallbackEventListener", - "description": "A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "description": "<<<<<<< HEAD A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n======= A callback fired when the phone field receives focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) \n Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", "isOptional": true }, { @@ -110298,18 +110362,18 @@ "syntaxKind": "PropertySignature", "name": "input", "value": "CallbackEventListener", - "description": "Callback when the user makes any changes in the field.", + "description": "A callback fired when the user inputs data into the phone field.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).", "isOptional": true } ], - "value": "export interface PhoneFieldElementEvents {\n /**\n * A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event\n */\n blur?: CallbackEventListener;\n /**\n * Callback when the user has **finished editing** a field, for example, once they have blurred the field.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event\n */\n change?: CallbackEventListener;\n /**\n * A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event\n */\n focus?: CallbackEventListener;\n /**\n * Callback when the user makes any changes in the field.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event\n */\n input?: CallbackEventListener;\n}" + "value": "export interface PhoneFieldElementEvents {\n /**\n<<<<<<< HEAD\n * A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n=======\n * A callback fired when the phone field loses focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality)\n *\n * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur?: CallbackEventListener;\n /**\n<<<<<<< HEAD\n * Callback when the user has **finished editing** a field, for example, once they have blurred the field.\n=======\n * A callback fired when the phone field value changes.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality)\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change?: CallbackEventListener;\n /**\n<<<<<<< HEAD\n * A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n=======\n * A callback fired when the phone field receives focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality)\n *\n * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus?: CallbackEventListener;\n /**\n * A callback fired when the user inputs data into the phone field.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input?: CallbackEventListener;\n}" } }, "PhoneFieldElementSlots": { "src/surfaces/checkout/components/PhoneField.ts": { "filePath": "src/surfaces/checkout/components/PhoneField.ts", "name": "PhoneFieldElementSlots", - "description": "Learn more about [component slots](/docs/api/checkout-ui-extensions/latest/using-polaris-components#slots).", + "description": "", "isPublicDocs": true, "members": [ { @@ -110317,18 +110381,18 @@ "syntaxKind": "PropertySignature", "name": "accessory", "value": "HTMLElement", - "description": "Additional content to be displayed in the field. Commonly used to display an icon that activates a tooltip providing more information.", + "description": "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.", "isOptional": true } ], - "value": "export interface PhoneFieldElementSlots {\n /**\n * Additional content to be displayed in the field.\n * Commonly used to display an icon that activates a tooltip providing more information.\n */\n accessory?: HTMLElement;\n}" + "value": "export interface PhoneFieldElementSlots {\n /**\n * 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.\n */\n accessory?: HTMLElement;\n}" } }, "PopoverElementProps": { "src/surfaces/checkout/components/Popover.ts": { "filePath": "src/surfaces/checkout/components/Popover.ts", "name": "PopoverElementProps", - "description": "The popover component displays contextual content in an overlay triggered by a button using the [`commandFor`](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/button#commandfor) attribute. Use for secondary actions, settings, or information that doesn't require a full modal.\n\nFor interactions that need more space or user focus, such as confirmations or complex forms, use [modal](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/overlays/modal) instead.", + "description": "", "isPublicDocs": true, "members": [ { @@ -110345,7 +110409,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -110401,7 +110465,7 @@ "src/surfaces/checkout/components/Popover.ts": { "filePath": "src/surfaces/checkout/components/Popover.ts", "name": "PopoverEvents", - "description": "The event callbacks for monitoring popover visibility changes.", + "description": "", "isPublicDocs": true, "members": [ { @@ -110428,7 +110492,7 @@ "src/surfaces/checkout/components/Popover.ts": { "filePath": "src/surfaces/checkout/components/Popover.ts", "name": "PopoverElementEvents", - "description": "Learn more about [registering events](/docs/api/checkout-ui-extensions/latest/using-polaris-components#event-handling).", + "description": "", "isPublicDocs": true, "members": [ { @@ -110477,7 +110541,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/Popover.ts", @@ -111383,7 +111447,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -112554,7 +112618,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/Popover.ts", @@ -112810,7 +112874,7 @@ "src/surfaces/checkout/components/Popover.ts": { "filePath": "src/surfaces/checkout/components/Popover.ts", "name": "PopoverProps", - "description": "The properties for the popover component when it's used in JSX.", + "description": "", "isPublicDocs": true, "members": [ { @@ -112827,7 +112891,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -112899,7 +112963,7 @@ "src/surfaces/checkout/components/PressButton.ts": { "filePath": "src/surfaces/checkout/components/PressButton.ts", "name": "PressButtonElementProps", - "description": "Allows users to toggle between active/inactive states. Use to represent a persistent on/off or selected/unselected status.", + "description": "", "isPublicDocs": true, "members": [ { @@ -112933,7 +112997,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -113014,7 +113078,7 @@ "src/surfaces/checkout/components/PressButton.ts": { "filePath": "src/surfaces/checkout/components/PressButton.ts", "name": "PressButtonElementEvents", - "description": "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).", + "description": "", "isPublicDocs": true, "members": [ { @@ -113079,7 +113143,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/PressButton.ts", @@ -113987,7 +114051,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -115127,7 +115191,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/PressButton.ts", @@ -115417,7 +115481,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -115487,7 +115551,7 @@ "src/surfaces/checkout/components/ProductThumbnail.ts": { "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", "name": "ProductThumbnailElementProps", - "description": "Use ProductThumbnail to display a product thumbnail", + "description": "", "isPublicDocs": true, "members": [ { @@ -115570,7 +115634,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", @@ -117580,7 +117644,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", @@ -117877,7 +117941,7 @@ "src/surfaces/checkout/components/ProductThumbnail.ts": { "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", "name": "ProductThumbnailProps", - "description": "The properties for the product thumbnail component when it's used in JSX.", + "description": "", "isPublicDocs": true, "members": [ { @@ -117938,7 +118002,7 @@ "src/surfaces/checkout/components/Progress.ts": { "filePath": "src/surfaces/checkout/components/Progress.ts", "name": "ProgressElementProps", - "description": "Displays an indicator showing the completion status of a task. Use to visually communicate progress in either determinate (known percentage) or indeterminate (unknown duration) states.", + "description": "", "isPublicDocs": true, "members": [ { @@ -117946,7 +118010,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityLabel", "value": "string", - "description": "A label that describes the purpose of the progress. When set, it will be announced to users using assistive technologies and will provide them with more context.\n\nUse it to provide context of what is progressing.", + "description": "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\".", "isOptional": true }, { @@ -117954,7 +118018,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -117962,7 +118026,7 @@ "syntaxKind": "PropertySignature", "name": "max", "value": "number", - "description": "This attribute describes how much work the task indicated by the progress element requires.\n\nThe `max` attribute, if present, must have a value greater than 0 and be a valid floating point number.", + "description": "The total amount of work the task requires. Must be a value greater than `0` and a valid floating point number.\n\nLearn more about the [max attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/progress#max).", "isOptional": true, "defaultValue": "1" }, @@ -117971,7 +118035,7 @@ "syntaxKind": "PropertySignature", "name": "tone", "value": "'auto' | 'critical'", - "description": "Sets the tone of the progress, based on the intention of the information being conveyed.", + "description": "The semantic meaning and color treatment of the progress indicator.\n\n- `auto`: Automatically determined based on context.\n- `critical`: Indicates an urgent or error state requiring immediate attention.", "isOptional": true, "defaultValue": "'auto'" }, @@ -117980,11 +118044,11 @@ "syntaxKind": "PropertySignature", "name": "value", "value": "number", - "description": "Specifies how much of the task has been completed.\n\nIt must be a valid floating point number between 0 and `max`, or between 0 and 1 if `max` is omitted. If there is no value attribute, the progress bar is indeterminate; this indicates that an activity is ongoing with no indication of how long it is expected to take.", + "description": "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.\n\nLearn more about the [value attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/progress#value).", "isOptional": true } ], - "value": "export interface ProgressElementProps extends Pick {\n tone?: Extract;\n}" + "value": "export interface ProgressElementProps extends Pick {\n /**\n * 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\".\n */\n accessibilityLabel?: ProgressProps$1['accessibilityLabel'];\n /**\n * The total amount of work the task requires. Must be a value greater than `0` and a valid floating point number.\n *\n * Learn more about the [max attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/progress#max).\n *\n * @default 1\n */\n max?: ProgressProps$1['max'];\n /**\n * The semantic meaning and color treatment of the progress indicator.\n *\n * - `auto`: Automatically determined based on context.\n * - `critical`: Indicates an urgent or error state requiring immediate attention.\n *\n * @default 'auto'\n */\n tone?: Extract;\n /**\n * 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.\n *\n * Learn more about the [value attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/progress#value).\n */\n value?: ProgressProps$1['value'];\n}" } }, "ProgressElement": { @@ -117999,7 +118063,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityLabel", "value": "string", - "description": "A label that describes the purpose of the progress. When set, it will be announced to users using assistive technologies and will provide them with more context.\n\nUse it to provide context of what is progressing.", + "description": "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\".", "isOptional": true }, { @@ -118021,7 +118085,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/Progress.ts", @@ -118918,7 +118982,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -119066,7 +119130,7 @@ "syntaxKind": "PropertySignature", "name": "max", "value": "number", - "description": "This attribute describes how much work the task indicated by the progress element requires.\n\nThe `max` attribute, if present, must have a value greater than 0 and be a valid floating point number.", + "description": "The total amount of work the task requires. Must be a value greater than `0` and a valid floating point number.\n\nLearn more about the [max attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/progress#max).", "isOptional": true, "defaultValue": "1" }, @@ -120039,7 +120103,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/Progress.ts", @@ -120270,7 +120334,7 @@ "syntaxKind": "PropertySignature", "name": "tone", "value": "'auto' | 'critical'", - "description": "Sets the tone of the progress, based on the intention of the information being conveyed.", + "description": "The semantic meaning and color treatment of the progress indicator.\n\n- `auto`: Automatically determined based on context.\n- `critical`: Indicates an urgent or error state requiring immediate attention.", "isOptional": true, "defaultValue": "'auto'" }, @@ -120286,7 +120350,7 @@ "syntaxKind": "PropertySignature", "name": "value", "value": "number", - "description": "Specifies how much of the task has been completed.\n\nIt must be a valid floating point number between 0 and `max`, or between 0 and 1 if `max` is omitted. If there is no value attribute, the progress bar is indeterminate; this indicates that an activity is ongoing with no indication of how long it is expected to take.", + "description": "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.\n\nLearn more about the [value attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/progress#value).", "isOptional": true }, { @@ -120320,7 +120384,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityLabel", "value": "string", - "description": "A label that describes the purpose of the progress. When set, it will be announced to users using assistive technologies and will provide them with more context.\n\nUse it to provide context of what is progressing.", + "description": "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\".", "isOptional": true }, { @@ -120328,7 +120392,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -120336,7 +120400,7 @@ "syntaxKind": "PropertySignature", "name": "max", "value": "number", - "description": "This attribute describes how much work the task indicated by the progress element requires.\n\nThe `max` attribute, if present, must have a value greater than 0 and be a valid floating point number.", + "description": "The total amount of work the task requires. Must be a value greater than `0` and a valid floating point number.\n\nLearn more about the [max attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/progress#max).", "isOptional": true, "defaultValue": "1" }, @@ -120345,7 +120409,7 @@ "syntaxKind": "PropertySignature", "name": "tone", "value": "'auto' | 'critical'", - "description": "Sets the tone of the progress, based on the intention of the information being conveyed.", + "description": "The semantic meaning and color treatment of the progress indicator.\n\n- `auto`: Automatically determined based on context.\n- `critical`: Indicates an urgent or error state requiring immediate attention.", "isOptional": true, "defaultValue": "'auto'" }, @@ -120354,7 +120418,7 @@ "syntaxKind": "PropertySignature", "name": "value", "value": "number", - "description": "Specifies how much of the task has been completed.\n\nIt must be a valid floating point number between 0 and `max`, or between 0 and 1 if `max` is omitted. If there is no value attribute, the progress bar is indeterminate; this indicates that an activity is ongoing with no indication of how long it is expected to take.", + "description": "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.\n\nLearn more about the [value attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/progress#value).", "isOptional": true } ], @@ -120365,7 +120429,7 @@ "src/surfaces/checkout/components/QRCode.ts": { "filePath": "src/surfaces/checkout/components/QRCode.ts", "name": "QRCodeElementProps", - "description": "Displays a scannable QR code representing data such as URLs or text. Use to let users quickly access information by scanning with a smartphone or other device.", + "description": "", "isPublicDocs": true, "members": [ { @@ -120399,7 +120463,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -120435,7 +120499,7 @@ "src/surfaces/checkout/components/QRCode.ts": { "filePath": "src/surfaces/checkout/components/QRCode.ts", "name": "QRCodeEvents", - "description": "The event handlers for the QR code component.", + "description": "", "isPublicDocs": true, "members": [ { @@ -120454,7 +120518,7 @@ "src/surfaces/checkout/components/QRCode.ts": { "filePath": "src/surfaces/checkout/components/QRCode.ts", "name": "QRCodeElementEvents", - "description": "Learn more about [registering events](/docs/api/checkout-ui-extensions/latest/using-polaris-components#event-handling).", + "description": "", "isPublicDocs": true, "members": [ { @@ -120504,7 +120568,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/QRCode.ts", @@ -121418,7 +121482,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -122546,7 +122610,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/QRCode.ts", @@ -122811,7 +122875,7 @@ "src/surfaces/checkout/components/QRCode.ts": { "filePath": "src/surfaces/checkout/components/QRCode.ts", "name": "QRCodeProps", - "description": "The properties for the QR code component when it's used in JSX.", + "description": "", "isPublicDocs": true, "members": [ { @@ -122845,7 +122909,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -122881,7 +122945,7 @@ "src/surfaces/checkout/components/QueryContainer.ts": { "filePath": "src/surfaces/checkout/components/QueryContainer.ts", "name": "QueryContainerElementProps", - "description": "The query container component establishes a container query context for responsive design. Use query container to define an element as a containment context, enabling child components or styles to adapt based on the container's size rather than viewport width.\n\nQuery containers support modern responsive patterns where components respond to their container dimensions, creating more flexible and reusable layouts.", + "description": "", "isPublicDocs": true, "members": [ { @@ -122898,7 +122962,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true } ], @@ -122931,7 +122995,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/QueryContainer.ts", @@ -123837,7 +123901,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -124949,7 +125013,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/QueryContainer.ts", @@ -125222,7 +125286,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true } ], @@ -125233,7 +125297,7 @@ "src/surfaces/checkout/components/ScrollBox.ts": { "filePath": "src/surfaces/checkout/components/ScrollBox.ts", "name": "ScrollBoxElementProps", - "description": "Provides a scrollable container for long content that exceeds the available space. Use to display lists, order summaries, or other lengthy content while maintaining a constrained layout.", + "description": "", "isPublicDocs": true, "members": [ { @@ -125258,7 +125322,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityVisibility", "value": "'visible' | 'hidden' | 'exclusive'", - "description": "Changes the visibility of the element.\n\n- `visible`: the element is visible to all users.\n- `hidden`: the element is removed from the accessibility tree but remains visible.\n- `exclusive`: the element is visually hidden but remains in the accessibility tree.", + "description": "Controls how the element is exposed to sighted users and to assistive technologies such as screen readers.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", "isOptional": true, "defaultValue": "'visible'" }, @@ -125267,7 +125331,7 @@ "syntaxKind": "PropertySignature", "name": "background", "value": "'base' | 'subdued' | 'transparent'", - "description": "Adjust the background of the element.\n\n- `'transparent'`: No visible background.\n- `'subdued'`: A subtle, low-emphasis background.\n- `'base'`: The standard background color.\n- `'strong'`: A high-emphasis background for prominence.", + "description": "The background color of the scroll box.\n\n- `base`: The standard background color for general content areas.\n- `subdued`: A muted background for secondary or supporting content.\n- `transparent`: No background color (the default).", "isOptional": true, "defaultValue": "'transparent'" }, @@ -125285,9 +125349,9 @@ "syntaxKind": "PropertySignature", "name": "border", "value": "BorderShorthand", - "description": "Applies a border using shorthand syntax to specify width, color, and style in a single property.\n\nAccepts a size value, optionally followed by a color, optionally followed by a style. Omitted values use defaults: color defaults to `base`, style defaults to `auto`.\n\nIndividual properties (`borderWidth`, `borderStyle`, `borderColor`) can override values set here.", + "description": "A shorthand for setting the border width, color, and style in a single property. Individual border properties (`borderWidth`, `borderStyle`, `borderColor`) can override values set here.", "isOptional": true, - "defaultValue": "'none' - equivalent to `none base auto`.", + "defaultValue": "'none'", "examples": [ { "title": "Example", @@ -125306,7 +125370,7 @@ "syntaxKind": "PropertySignature", "name": "borderColor", "value": "'' | 'base'", - "description": "Controls the color of the border using the design system's color scale.\n\nWhen set, this overrides the color value specified in the `border` property. Choose from `subdued`, `base`, or `strong` to match the visual emphasis needed.", + "description": "The color of the border using the design system's color scale. Overrides the color value set by `border`.", "isOptional": true, "defaultValue": "'' - meaning no override" }, @@ -125315,7 +125379,7 @@ "syntaxKind": "PropertySignature", "name": "borderRadius", "value": "MaybeAllValuesShorthandProperty>", - "description": "Controls the roundedness of the element's corners using the design system's radius scale.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) using flow-relative values:\n- One value: applies to all corners\n- Two values: applies to start corners (top-left & bottom-right) and end corners (top-right & bottom-left) respectively\n- Three values: applies to start-start (top-left), end corners (top-right & bottom-left), and end-end (bottom-right) respectively\n- Four values: applies to start-start (top-left), start-end (top-right), end-end (bottom-right), and end-start (bottom-left) respectively\n\nExamples:\n- `small-100`: All corners have `small-100` radius\n- `small-100 none`: Top-left and bottom-right are `small-100`, top-right and bottom-left are `none`\n- `small-100 none large-100`: Top-left is `small-100`, top-right and bottom-left are `none`, bottom-right is `large-100`\n- `small-100 none large-100 base`: Each corner has its specified radius value", + "description": "The roundedness of the scroll box's corners.\n\n- `none`: Sharp corners with no rounding.\n- `small-100` / `small`: Subtle rounding for compact elements.\n- `base`: Standard rounding for most use cases.\n- `large` / `large-100`: More pronounced rounding for prominent containers.\n- `max`: Maximum rounding, creating a pill or circular shape.\n\nSupports 1-to-4-value shorthand syntax for specifying different radii per corner.", "isOptional": true, "defaultValue": "'none'" }, @@ -125333,7 +125397,7 @@ "syntaxKind": "PropertySignature", "name": "borderWidth", "value": "MaybeAllValuesShorthandProperty | ''", - "description": "Controls the thickness of the border on all sides. When set, this overrides the width value specified in the `border` property.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) for specifying different widths per side:\n- One value: applies to all sides\n- Two values: applies to block sides (top/bottom) and inline sides (left/right) respectively\n- Three values: applies to block-start (top), inline sides (left/right), and block-end (bottom) respectively\n- Four values: applies to block-start (top), inline-end (right), block-end (bottom), and inline-start (left) respectively", + "description": "The thickness of the border on all sides. Supports 1-to-4-value shorthand syntax for specifying different widths per side. Overrides the width value set by `border`.", "isOptional": true, "defaultValue": "'' - meaning no override" }, @@ -125342,7 +125406,7 @@ "syntaxKind": "PropertySignature", "name": "display", "value": "MaybeResponsive<\"auto\" | \"none\">", - "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.", + "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.\n\nLearn more about the [display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display).", "isOptional": true, "defaultValue": "'auto'" }, @@ -125351,7 +125415,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -125472,7 +125536,7 @@ "defaultValue": "'' - meaning no override" } ], - "value": "export interface ScrollBoxElementProps extends Pick {\n background?: Extract;\n border?: BorderShorthand;\n borderColor?: ReducedColorKeyword | '';\n borderRadius?: MaybeAllValuesShorthandProperty>;\n borderWidth?: MaybeAllValuesShorthandProperty | '';\n}" + "value": "export interface ScrollBoxElementProps extends Pick {\n /**\n * The background color of the scroll box.\n *\n * - `base`: The standard background color for general content areas.\n * - `subdued`: A muted background for secondary or supporting content.\n * - `transparent`: No background color (the default).\n *\n * @default 'transparent'\n */\n background?: Extract;\n /**\n * A shorthand for setting the border width, color, and style in a single property. Individual border properties (`borderWidth`, `borderStyle`, `borderColor`) can override values set here.\n *\n * @default 'none'\n */\n border?: BorderShorthand;\n /**\n * The color of the border using the design system's color scale. Overrides the color value set by `border`.\n *\n * @default '' - meaning no override\n */\n borderColor?: ReducedColorKeyword | '';\n /**\n * The roundedness of the scroll box's corners.\n *\n * - `none`: Sharp corners with no rounding.\n * - `small-100` / `small`: Subtle rounding for compact elements.\n * - `base`: Standard rounding for most use cases.\n * - `large` / `large-100`: More pronounced rounding for prominent containers.\n * - `max`: Maximum rounding, creating a pill or circular shape.\n *\n * Supports 1-to-4-value shorthand syntax for specifying different radii per corner.\n *\n * @default 'none'\n */\n borderRadius?: MaybeAllValuesShorthandProperty>;\n /**\n * The thickness of the border on all sides. Supports 1-to-4-value shorthand syntax for specifying different widths per side. Overrides the width value set by `border`.\n *\n * @default '' - meaning no override\n */\n borderWidth?: MaybeAllValuesShorthandProperty | '';\n}" } }, "ScrollBoxProps": { @@ -125504,7 +125568,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityVisibility", "value": "'visible' | 'hidden' | 'exclusive'", - "description": "Changes the visibility of the element.\n\n- `visible`: the element is visible to all users.\n- `hidden`: the element is removed from the accessibility tree but remains visible.\n- `exclusive`: the element is visually hidden but remains in the accessibility tree.", + "description": "Controls how the element is exposed to sighted users and to assistive technologies such as screen readers.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", "isOptional": true, "defaultValue": "'visible'" }, @@ -125513,7 +125577,7 @@ "syntaxKind": "PropertySignature", "name": "background", "value": "'base' | 'subdued' | 'transparent'", - "description": "Adjust the background of the element.\n\n- `'transparent'`: No visible background.\n- `'subdued'`: A subtle, low-emphasis background.\n- `'base'`: The standard background color.\n- `'strong'`: A high-emphasis background for prominence.", + "description": "The background color of the scroll box.\n\n- `base`: The standard background color for general content areas.\n- `subdued`: A muted background for secondary or supporting content.\n- `transparent`: No background color (the default).", "isOptional": true, "defaultValue": "'transparent'" }, @@ -125531,23 +125595,25 @@ "syntaxKind": "PropertySignature", "name": "border", "value": "BorderShorthand", - "description": "Applies a border using shorthand syntax to specify width, color, and style in a single property.\n\nAccepts a size value, optionally followed by a color, optionally followed by a style. Omitted values use defaults: color defaults to `base`, style defaults to `auto`.\n\nIndividual properties (`borderWidth`, `borderStyle`, `borderColor`) can override values set here.", - "isOptional": true + "description": "A shorthand for setting the border width, color, and style in a single property. Individual border properties (`borderWidth`, `borderStyle`, `borderColor`) can override values set here.", + "isOptional": true, + "defaultValue": "'none'" }, { "filePath": "src/surfaces/checkout/components/ScrollBox.ts", "syntaxKind": "PropertySignature", "name": "borderColor", "value": "'' | 'base'", - "description": "Controls the color of the border using the design system's color scale.\n\nWhen set, this overrides the color value specified in the `border` property. Choose from `subdued`, `base`, or `strong` to match the visual emphasis needed.", - "isOptional": true + "description": "The color of the border using the design system's color scale. Overrides the color value set by `border`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" }, { "filePath": "src/surfaces/checkout/components/ScrollBox.ts", "syntaxKind": "PropertySignature", "name": "borderRadius", "value": "MaybeAllValuesShorthandProperty>", - "description": "Controls the roundedness of the element's corners using the design system's radius scale.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) using flow-relative values:\n- One value: applies to all corners\n- Two values: applies to start corners (top-left & bottom-right) and end corners (top-right & bottom-left) respectively\n- Three values: applies to start-start (top-left), end corners (top-right & bottom-left), and end-end (bottom-right) respectively\n- Four values: applies to start-start (top-left), start-end (top-right), end-end (bottom-right), and end-start (bottom-left) respectively\n\nExamples:\n- `small-100`: All corners have `small-100` radius\n- `small-100 none`: Top-left and bottom-right are `small-100`, top-right and bottom-left are `none`\n- `small-100 none large-100`: Top-left is `small-100`, top-right and bottom-left are `none`, bottom-right is `large-100`\n- `small-100 none large-100 base`: Each corner has its specified radius value", + "description": "The roundedness of the scroll box's corners.\n\n- `none`: Sharp corners with no rounding.\n- `small-100` / `small`: Subtle rounding for compact elements.\n- `base`: Standard rounding for most use cases.\n- `large` / `large-100`: More pronounced rounding for prominent containers.\n- `max`: Maximum rounding, creating a pill or circular shape.\n\nSupports 1-to-4-value shorthand syntax for specifying different radii per corner.", "isOptional": true, "defaultValue": "'none'" }, @@ -125565,15 +125631,16 @@ "syntaxKind": "PropertySignature", "name": "borderWidth", "value": "MaybeAllValuesShorthandProperty | ''", - "description": "Controls the thickness of the border on all sides. When set, this overrides the width value specified in the `border` property.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) for specifying different widths per side:\n- One value: applies to all sides\n- Two values: applies to block sides (top/bottom) and inline sides (left/right) respectively\n- Three values: applies to block-start (top), inline sides (left/right), and block-end (bottom) respectively\n- Four values: applies to block-start (top), inline-end (right), block-end (bottom), and inline-start (left) respectively", - "isOptional": true + "description": "The thickness of the border on all sides. Supports 1-to-4-value shorthand syntax for specifying different widths per side. Overrides the width value set by `border`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" }, { "filePath": "src/surfaces/checkout/components/ScrollBox.ts", "syntaxKind": "PropertySignature", "name": "display", "value": "MaybeResponsive<\"auto\" | \"none\">", - "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.", + "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.\n\nLearn more about the [display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display).", "isOptional": true, "defaultValue": "'auto'" }, @@ -125582,7 +125649,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -125745,7 +125812,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityVisibility", "value": "'visible' | 'hidden' | 'exclusive'", - "description": "Changes the visibility of the element.\n\n- `visible`: the element is visible to all users.\n- `hidden`: the element is removed from the accessibility tree but remains visible.\n- `exclusive`: the element is visually hidden but remains in the accessibility tree.", + "description": "Controls how the element is exposed to sighted users and to assistive technologies such as screen readers.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", "isOptional": true, "defaultValue": "'visible'" }, @@ -125768,7 +125835,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/ScrollBox.ts", @@ -126223,7 +126290,7 @@ "syntaxKind": "PropertySignature", "name": "background", "value": "'base' | 'subdued' | 'transparent'", - "description": "Adjust the background of the element.\n\n- `'transparent'`: No visible background.\n- `'subdued'`: A subtle, low-emphasis background.\n- `'base'`: The standard background color.\n- `'strong'`: A high-emphasis background for prominence.", + "description": "The background color of the scroll box.\n\n- `base`: The standard background color for general content areas.\n- `subdued`: A muted background for secondary or supporting content.\n- `transparent`: No background color (the default).", "isOptional": true, "defaultValue": "'transparent'" }, @@ -126262,23 +126329,25 @@ "syntaxKind": "PropertySignature", "name": "border", "value": "BorderShorthand", - "description": "Applies a border using shorthand syntax to specify width, color, and style in a single property.\n\nAccepts a size value, optionally followed by a color, optionally followed by a style. Omitted values use defaults: color defaults to `base`, style defaults to `auto`.\n\nIndividual properties (`borderWidth`, `borderStyle`, `borderColor`) can override values set here.", - "isOptional": true + "description": "A shorthand for setting the border width, color, and style in a single property. Individual border properties (`borderWidth`, `borderStyle`, `borderColor`) can override values set here.", + "isOptional": true, + "defaultValue": "'none'" }, { "filePath": "src/surfaces/checkout/components/ScrollBox.ts", "syntaxKind": "PropertySignature", "name": "borderColor", "value": "'' | 'base'", - "description": "Controls the color of the border using the design system's color scale.\n\nWhen set, this overrides the color value specified in the `border` property. Choose from `subdued`, `base`, or `strong` to match the visual emphasis needed.", - "isOptional": true + "description": "The color of the border using the design system's color scale. Overrides the color value set by `border`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" }, { "filePath": "src/surfaces/checkout/components/ScrollBox.ts", "syntaxKind": "PropertySignature", "name": "borderRadius", "value": "MaybeAllValuesShorthandProperty>", - "description": "Controls the roundedness of the element's corners using the design system's radius scale.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) using flow-relative values:\n- One value: applies to all corners\n- Two values: applies to start corners (top-left & bottom-right) and end corners (top-right & bottom-left) respectively\n- Three values: applies to start-start (top-left), end corners (top-right & bottom-left), and end-end (bottom-right) respectively\n- Four values: applies to start-start (top-left), start-end (top-right), end-end (bottom-right), and end-start (bottom-left) respectively\n\nExamples:\n- `small-100`: All corners have `small-100` radius\n- `small-100 none`: Top-left and bottom-right are `small-100`, top-right and bottom-left are `none`\n- `small-100 none large-100`: Top-left is `small-100`, top-right and bottom-left are `none`, bottom-right is `large-100`\n- `small-100 none large-100 base`: Each corner has its specified radius value", + "description": "The roundedness of the scroll box's corners.\n\n- `none`: Sharp corners with no rounding.\n- `small-100` / `small`: Subtle rounding for compact elements.\n- `base`: Standard rounding for most use cases.\n- `large` / `large-100`: More pronounced rounding for prominent containers.\n- `max`: Maximum rounding, creating a pill or circular shape.\n\nSupports 1-to-4-value shorthand syntax for specifying different radii per corner.", "isOptional": true, "defaultValue": "'none'" }, @@ -126296,8 +126365,9 @@ "syntaxKind": "PropertySignature", "name": "borderWidth", "value": "MaybeAllValuesShorthandProperty | ''", - "description": "Controls the thickness of the border on all sides. When set, this overrides the width value specified in the `border` property.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) for specifying different widths per side:\n- One value: applies to all sides\n- Two values: applies to block sides (top/bottom) and inline sides (left/right) respectively\n- Three values: applies to block-start (top), inline sides (left/right), and block-end (bottom) respectively\n- Four values: applies to block-start (top), inline-end (right), block-end (bottom), and inline-start (left) respectively", - "isOptional": true + "description": "The thickness of the border on all sides. Supports 1-to-4-value shorthand syntax for specifying different widths per side. Overrides the width value set by `border`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" }, { "filePath": "src/surfaces/checkout/components/ScrollBox.ts", @@ -126465,7 +126535,7 @@ "syntaxKind": "PropertySignature", "name": "display", "value": "MaybeResponsive<\"auto\" | \"none\">", - "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.", + "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.\n\nLearn more about the [display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display).", "isOptional": true, "defaultValue": "'auto'" }, @@ -126734,7 +126804,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -127963,7 +128033,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/ScrollBox.ts", @@ -128243,7 +128313,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true } ], @@ -128284,7 +128354,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/Section.ts", @@ -129189,7 +129259,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -130301,7 +130371,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/Section.ts", @@ -130581,7 +130651,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true } ], @@ -130592,7 +130662,7 @@ "src/surfaces/checkout/components/Select.ts": { "filePath": "src/surfaces/checkout/components/Select.ts", "name": "SelectElementProps", - "description": "Properties for the Select component element.", + "description": "", "isPublicDocs": true, "members": [ { @@ -130600,7 +130670,7 @@ "syntaxKind": "PropertySignature", "name": "autocomplete", "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", "isOptional": true, "defaultValue": "'on' for everything else" }, @@ -130609,7 +130679,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -130618,7 +130688,7 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -130626,7 +130696,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -130634,7 +130704,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Content to use as the field label.", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", "isOptional": true }, { @@ -130642,7 +130712,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -130650,7 +130720,7 @@ "syntaxKind": "PropertySignature", "name": "placeholder", "value": "string", - "description": "A short hint that describes the expected value of the field.", + "description": "The placeholder text displayed in the field when it's empty, providing a hint about the expected input format or value.", "isOptional": true }, { @@ -130694,7 +130764,7 @@ "syntaxKind": "PropertySignature", "name": "onChange", "value": "(event: Event) => void", - "description": "Callback when the user has **finished editing** a field, for example, once they have blurred the field.", + "description": "A callback fired when the user has **finished editing** a field, such as when they blur the field or press Enter.", "isOptional": true }, { @@ -130713,7 +130783,7 @@ "src/surfaces/checkout/components/Select.ts": { "filePath": "src/surfaces/checkout/components/Select.ts", "name": "SelectElementEvents", - "description": "Events for the Select component element.", + "description": "", "isPublicDocs": true, "members": [ { @@ -130721,7 +130791,7 @@ "syntaxKind": "PropertySignature", "name": "blur", "value": "CallbackEventListener", - "description": "A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "description": "<<<<<<< HEAD A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n======= A callback fired when the select loses focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) \n Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", "isOptional": true }, { @@ -130729,7 +130799,7 @@ "syntaxKind": "PropertySignature", "name": "change", "value": "CallbackEventListener", - "description": "Callback when the user has **finished editing** a field, for example, once they have blurred the field.", + "description": "<<<<<<< HEAD Callback when the user has **finished editing** a field, for example, once they have blurred the field.\n======= A callback fired when the select value changes.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) \n Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", "isOptional": true }, { @@ -130737,11 +130807,11 @@ "syntaxKind": "PropertySignature", "name": "focus", "value": "CallbackEventListener", - "description": "A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "description": "<<<<<<< HEAD A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n======= A callback fired when the select receives focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) \n Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", "isOptional": true } ], - "value": "export interface SelectElementEvents {\n /**\n * A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event\n */\n blur?: CallbackEventListener;\n /**\n * Callback when the user has **finished editing** a field, for example, once they have blurred the field.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event\n */\n change?: CallbackEventListener;\n /**\n * A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event\n */\n focus?: CallbackEventListener;\n}" + "value": "export interface SelectElementEvents {\n /**\n<<<<<<< HEAD\n * A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n=======\n * A callback fired when the select loses focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality)\n *\n * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur?: CallbackEventListener;\n /**\n<<<<<<< HEAD\n * Callback when the user has **finished editing** a field, for example, once they have blurred the field.\n=======\n * A callback fired when the select value changes.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality)\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change?: CallbackEventListener;\n /**\n<<<<<<< HEAD\n * A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n=======\n * A callback fired when the select receives focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality)\n *\n * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus?: CallbackEventListener;\n}" } }, "SelectElement": { @@ -130770,7 +130840,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/Select.ts", @@ -131211,7 +131281,7 @@ "syntaxKind": "PropertySignature", "name": "autocomplete", "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", "isOptional": true, "defaultValue": "'on' for everything else" }, @@ -131409,7 +131479,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -131523,7 +131593,7 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -131693,7 +131763,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -131792,7 +131862,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Content to use as the field label.", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", "isOptional": true }, { @@ -131849,7 +131919,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -132721,7 +132791,7 @@ "syntaxKind": "PropertySignature", "name": "placeholder", "value": "string", - "description": "A short hint that describes the expected value of the field.", + "description": "The placeholder text displayed in the field when it's empty, providing a hint about the expected input format or value.", "isOptional": true }, { @@ -132829,7 +132899,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/Select.ts", @@ -133110,7 +133180,7 @@ "syntaxKind": "PropertySignature", "name": "autocomplete", "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", "isOptional": true, "defaultValue": "'on' for everything else" }, @@ -133119,7 +133189,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -133128,7 +133198,7 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -133136,7 +133206,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -133144,7 +133214,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Content to use as the field label.", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", "isOptional": true }, { @@ -133152,7 +133222,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -133168,7 +133238,7 @@ "syntaxKind": "PropertySignature", "name": "onChange", "value": "(event: Event) => void", - "description": "Callback when the user has **finished editing** a field, for example, once they have blurred the field.", + "description": "A callback fired when the user has **finished editing** a field, such as when they blur the field or press Enter.", "isOptional": true }, { @@ -133184,7 +133254,7 @@ "syntaxKind": "PropertySignature", "name": "placeholder", "value": "string", - "description": "A short hint that describes the expected value of the field.", + "description": "The placeholder text displayed in the field when it's empty, providing a hint about the expected input format or value.", "isOptional": true }, { @@ -133212,7 +133282,7 @@ "src/surfaces/checkout/components/Sheet.ts": { "filePath": "src/surfaces/checkout/components/Sheet.ts", "name": "SheetElementProps", - "description": "The Sheet component displays essential information for customers at the bottom of the screen, appearing above other elements. Use it sparingly to avoid distracting customers during checkout. This component requires access to [Customer Privacy API](/docs/api/checkout-ui-extensions/latest/configuration#collect-buyer-consent) to be rendered.\n\nThe library automatically applies the [WAI-ARIA Dialog pattern](https://www.w3.org/WAI/ARIA/apg/patterns/dialog-modal/) to both the activator and the sheet content.", + "description": "", "isPublicDocs": true, "members": [ { @@ -133245,7 +133315,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true } ], @@ -133256,7 +133326,7 @@ "src/surfaces/checkout/components/Sheet.ts": { "filePath": "src/surfaces/checkout/components/Sheet.ts", "name": "SheetEvents", - "description": "The event callbacks for monitoring sheet visibility changes.", + "description": "", "isPublicDocs": true, "members": [ { @@ -133299,7 +133369,7 @@ "src/surfaces/checkout/components/Sheet.ts": { "filePath": "src/surfaces/checkout/components/Sheet.ts", "name": "SheetElementEvents", - "description": "Learn more about [registering events](/docs/api/checkout-ui-extensions/latest/using-polaris-components#event-handling).", + "description": "", "isPublicDocs": true, "members": [ { @@ -133342,7 +133412,7 @@ "src/surfaces/checkout/components/Sheet.ts": { "filePath": "src/surfaces/checkout/components/Sheet.ts", "name": "SheetElementSlots", - "description": "Learn more about [component slots](/docs/api/checkout-ui-extensions/latest/using-polaris-components#slots).", + "description": "", "isPublicDocs": true, "members": [ { @@ -133369,7 +133439,7 @@ "src/surfaces/checkout/components/Sheet.ts": { "filePath": "src/surfaces/checkout/components/Sheet.ts", "name": "SheetElementMethods", - "description": "Learn more about [component methods](/docs/api/checkout-ui-extensions/latest/using-polaris-components#methods).", + "description": "", "isPublicDocs": true, "members": [ { @@ -133417,7 +133487,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/Sheet.ts", @@ -134352,7 +134422,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -135492,7 +135562,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/Sheet.ts", @@ -135748,7 +135818,7 @@ "src/surfaces/checkout/components/Sheet.ts": { "filePath": "src/surfaces/checkout/components/Sheet.ts", "name": "SheetProps", - "description": "The properties for the sheet component when it's used in JSX.", + "description": "", "isPublicDocs": true, "members": [ { @@ -135781,7 +135851,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -135824,7 +135894,7 @@ "src/surfaces/checkout/components/SkeletonParagraph.ts": { "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", "name": "SkeletonParagraphElementProps", - "description": "Displays a placeholder representation of text content while it loads. Use to improve perceived performance by showing users where text will appear.", + "description": "", "isPublicDocs": true, "members": [ { @@ -135841,7 +135911,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true } ], @@ -135874,7 +135944,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", @@ -136780,7 +136850,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -137892,7 +137962,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", @@ -138165,7 +138235,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true } ], @@ -138176,7 +138246,7 @@ "src/surfaces/checkout/components/Spinner.ts": { "filePath": "src/surfaces/checkout/components/Spinner.ts", "name": "SpinnerElementProps", - "description": "Properties for the Spinner component element.", + "description": "", "isPublicDocs": true, "members": [ { @@ -138184,7 +138254,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityLabel", "value": "string", - "description": "A label that describes the purpose of the progress. When set, it will be announced to users using assistive technologies and will provide them with more context. Providing an `accessibilityLabel` is recommended if there is no accompanying text describing that something is loading.", + "description": "A label that describes the purpose of the spinner for assistive technologies like screen readers. Provide an `accessibilityLabel` when there is no visible text that conveys a loading state.", "isOptional": true }, { @@ -138192,7 +138262,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -138200,12 +138270,12 @@ "syntaxKind": "PropertySignature", "name": "size", "value": "'small' | 'large' | 'base' | 'small-100' | 'large-100'", - "description": "Adjusts the size of the spinner icon.", + "description": "The size of the spinner icon.\n\n- `base`: The default size, suitable for most use cases.\n- `small`: A compact size for secondary loading states.\n- `small-100`: The smallest size for tight spaces or inline indicators.\n- `large`: A larger size for more prominent loading states.\n- `large-100`: The largest size for full-page or section-level loading indicators.", "isOptional": true, "defaultValue": "'base'" } ], - "value": "export interface SpinnerElementProps extends SpinnerProps$1 {\n size?: Extract;\n}" + "value": "export interface SpinnerElementProps extends SpinnerProps$1 {\n /**\n * A label that describes the purpose of the spinner for assistive technologies like screen readers. Provide an `accessibilityLabel` when there is no visible text that conveys a loading state.\n */\n accessibilityLabel?: SpinnerProps$1['accessibilityLabel'];\n /**\n * The size of the spinner icon.\n *\n * - `base`: The default size, suitable for most use cases.\n * - `small`: A compact size for secondary loading states.\n * - `small-100`: The smallest size for tight spaces or inline indicators.\n * - `large`: A larger size for more prominent loading states.\n * - `large-100`: The largest size for full-page or section-level loading indicators.\n *\n * @default 'base'\n */\n size?: Extract;\n}" } }, "SpinnerElement": { @@ -138220,7 +138290,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityLabel", "value": "string", - "description": "A label that describes the purpose of the progress. When set, it will be announced to users using assistive technologies and will provide them with more context. Providing an `accessibilityLabel` is recommended if there is no accompanying text describing that something is loading.", + "description": "A label that describes the purpose of the spinner for assistive technologies like screen readers. Provide an `accessibilityLabel` when there is no visible text that conveys a loading state.", "isOptional": true }, { @@ -138242,7 +138312,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/Spinner.ts", @@ -139139,7 +139209,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -140251,7 +140321,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/Spinner.ts", @@ -140412,7 +140482,7 @@ "syntaxKind": "PropertySignature", "name": "size", "value": "'small' | 'large' | 'base' | 'small-100' | 'large-100'", - "description": "Adjusts the size of the spinner icon.", + "description": "The size of the spinner icon.\n\n- `base`: The default size, suitable for most use cases.\n- `small`: A compact size for secondary loading states.\n- `small-100`: The smallest size for tight spaces or inline indicators.\n- `large`: A larger size for more prominent loading states.\n- `large-100`: The largest size for full-page or section-level loading indicators.", "isOptional": true, "defaultValue": "'base'" }, @@ -140524,7 +140594,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityLabel", "value": "string", - "description": "A label that describes the purpose of the progress. When set, it will be announced to users using assistive technologies and will provide them with more context. Providing an `accessibilityLabel` is recommended if there is no accompanying text describing that something is loading.", + "description": "A label that describes the purpose of the spinner for assistive technologies like screen readers. Provide an `accessibilityLabel` when there is no visible text that conveys a loading state.", "isOptional": true }, { @@ -140532,7 +140602,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -140540,7 +140610,7 @@ "syntaxKind": "PropertySignature", "name": "size", "value": "'small' | 'large' | 'base' | 'small-100' | 'large-100'", - "description": "Adjusts the size of the spinner icon.", + "description": "The size of the spinner icon.\n\n- `base`: The default size, suitable for most use cases.\n- `small`: A compact size for secondary loading states.\n- `small-100`: The smallest size for tight spaces or inline indicators.\n- `large`: A larger size for more prominent loading states.\n- `large-100`: The largest size for full-page or section-level loading indicators.", "isOptional": true, "defaultValue": "'base'" } @@ -140552,7 +140622,7 @@ "src/surfaces/checkout/components/Stack.ts": { "filePath": "src/surfaces/checkout/components/Stack.ts", "name": "StackElementProps", - "description": "The stack component organizes elements horizontally or vertically along the block or inline axis. Use stack to structure layouts, group related components, control spacing between elements, or create flexible arrangements that adapt to content.\n\nStacks support gap spacing, alignment, wrapping, and distribution properties to create consistent, responsive layouts without custom CSS. For complex multi-column layouts with precise grid positioning, use [grid](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/layout-and-structure/grid).", + "description": "", "isPublicDocs": true, "members": [ { @@ -140568,7 +140638,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityRole", "value": "'aside' | 'footer' | 'header' | 'main' | 'section' | 'status' | 'none' | 'navigation' | 'ordered-list' | 'list-item' | 'list-item-separator' | 'unordered-list' | 'separator' | 'alert' | 'generic'", - "description": "Sets the semantic meaning of the component’s content. When set, the role will be used by assistive technologies to help users navigate the page.", + "description": "The semantic meaning of the stack's content, used by assistive technologies.\n\n- `aside`: Supporting content related to the main content.\n- `footer`: Information such as copyright, navigation links, and privacy statements.\n- `header`: A page or section header.\n- `main`: The primary content of the page.\n- `section`: A generic section that should have a heading or `accessibilityLabel`.\n- `status`: A live region with advisory information that is not urgent.\n- `none`: Strips semantic meaning while keeping visual styling.\n- `navigation`: A major group of navigation links.\n- `ordered-list`: A list of ordered items.\n- `list-item`: An item inside a list.\n- `list-item-separator`: A divider between list items.\n- `unordered-list`: A list of unordered items.\n- `separator`: A divider that separates sections of content.\n- `alert`: Important, usually time-sensitive information.\n- `generic`: A nameless container with no semantic meaning (renders a `
`).", "isOptional": true, "defaultValue": "'generic'" }, @@ -140577,7 +140647,7 @@ "syntaxKind": "PropertySignature", "name": "alignContent", "value": "MaybeResponsive>", - "description": "Aligns the Stack along the cross axis.", + "description": "Controls how lines of content are distributed along the cross axis when there is extra space.\n\n- `normal`: Default browser behavior.\n- `space-between`: Distributes lines evenly with no space at the edges.\n- `space-around`: Distributes lines evenly with equal space around each.\n- `space-evenly`: Distributes lines with equal space between and at the edges.\n- `stretch`: Stretches lines to fill the available space.\n- `center`: Packs lines toward the center.\n- `start`: Packs lines toward the start of the cross axis.\n- `end`: Packs lines toward the end of the cross axis.", "isOptional": true, "defaultValue": "'normal'" }, @@ -140586,7 +140656,7 @@ "syntaxKind": "PropertySignature", "name": "alignItems", "value": "MaybeResponsive>", - "description": "Aligns the Stack's children along the cross axis.", + "description": "Controls how child elements are aligned along the cross axis.\n\n- `normal`: Default browser behavior.\n- `stretch`: Stretches children to fill the cross axis.\n- `center`: Centers children along the cross axis.\n- `start`: Aligns children to the start of the cross axis.\n- `end`: Aligns children to the end of the cross axis.", "isOptional": true, "defaultValue": "'normal'" }, @@ -140595,7 +140665,7 @@ "syntaxKind": "PropertySignature", "name": "background", "value": "'base' | 'subdued' | 'transparent'", - "description": "Adjust the background of the element.\n\n- `'transparent'`: No visible background.\n- `'subdued'`: A subtle, low-emphasis background.\n- `'base'`: The standard background color.\n- `'strong'`: A high-emphasis background for prominence.", + "description": "The background color of the stack.\n\n- `base`: The standard background color for general content areas.\n- `subdued`: A muted background for secondary or supporting content.\n- `transparent`: No background color (the default).", "isOptional": true, "defaultValue": "'transparent'" }, @@ -140613,9 +140683,9 @@ "syntaxKind": "PropertySignature", "name": "border", "value": "BorderShorthand", - "description": "Applies a border using shorthand syntax to specify width, color, and style in a single property.\n\nAccepts a size value, optionally followed by a color, optionally followed by a style. Omitted values use defaults: color defaults to `base`, style defaults to `auto`.\n\nIndividual properties (`borderWidth`, `borderStyle`, `borderColor`) can override values set here.", + "description": "A shorthand for setting the border width, color, and style in a single property. Individual border properties (`borderWidth`, `borderStyle`) can override values set here.", "isOptional": true, - "defaultValue": "'none' - equivalent to `none base auto`.", + "defaultValue": "'none'", "examples": [ { "title": "Example", @@ -140634,7 +140704,7 @@ "syntaxKind": "PropertySignature", "name": "borderRadius", "value": "MaybeAllValuesShorthandProperty>", - "description": "Controls the roundedness of the element's corners using the design system's radius scale.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) using flow-relative values:\n- One value: applies to all corners\n- Two values: applies to start corners (top-left & bottom-right) and end corners (top-right & bottom-left) respectively\n- Three values: applies to start-start (top-left), end corners (top-right & bottom-left), and end-end (bottom-right) respectively\n- Four values: applies to start-start (top-left), start-end (top-right), end-end (bottom-right), and end-start (bottom-left) respectively\n\nExamples:\n- `small-100`: All corners have `small-100` radius\n- `small-100 none`: Top-left and bottom-right are `small-100`, top-right and bottom-left are `none`\n- `small-100 none large-100`: Top-left is `small-100`, top-right and bottom-left are `none`, bottom-right is `large-100`\n- `small-100 none large-100 base`: Each corner has its specified radius value", + "description": "The roundedness of the stack's corners.\n\n- `none`: Sharp corners with no rounding.\n- `small-100` / `small`: Subtle rounding for compact elements.\n- `base`: Standard rounding for most use cases.\n- `large` / `large-100`: More pronounced rounding for prominent containers.\n- `max`: Maximum rounding, creating a pill or circular shape.\n\nSupports 1-to-4-value shorthand syntax for specifying different radii per corner.", "isOptional": true, "defaultValue": "'none'" }, @@ -140652,7 +140722,7 @@ "syntaxKind": "PropertySignature", "name": "borderWidth", "value": "MaybeAllValuesShorthandProperty | ''", - "description": "Controls the thickness of the border on all sides. When set, this overrides the width value specified in the `border` property.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) for specifying different widths per side:\n- One value: applies to all sides\n- Two values: applies to block sides (top/bottom) and inline sides (left/right) respectively\n- Three values: applies to block-start (top), inline sides (left/right), and block-end (bottom) respectively\n- Four values: applies to block-start (top), inline-end (right), block-end (bottom), and inline-start (left) respectively", + "description": "The thickness of the border on all sides. Supports 1-to-4-value shorthand syntax for specifying different widths per side. Overrides the width value set by `border`.", "isOptional": true, "defaultValue": "'' - meaning no override" }, @@ -140679,7 +140749,7 @@ "syntaxKind": "PropertySignature", "name": "display", "value": "MaybeResponsive<\"auto\" | \"none\">", - "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.", + "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.\n\nLearn more about the [display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display).", "isOptional": true, "defaultValue": "'auto'" }, @@ -140697,7 +140767,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -140714,7 +140784,7 @@ "syntaxKind": "PropertySignature", "name": "justifyContent", "value": "MaybeResponsive>", - "description": "Aligns the Stack along the main axis.", + "description": "Controls how child elements are distributed along the main axis.\n\n- `normal`: Default browser behavior.\n- `space-between`: Distributes children evenly with no space at the edges.\n- `space-around`: Distributes children evenly with equal space around each.\n- `space-evenly`: Distributes children with equal space between and at the edges.\n- `stretch`: Stretches children to fill the available space.\n- `center`: Packs children toward the center.\n- `start`: Packs children toward the start of the main axis.\n- `end`: Packs children toward the end of the main axis.", "isOptional": true, "defaultValue": "'normal'" }, @@ -140836,7 +140906,7 @@ "defaultValue": "'' - meaning no override" } ], - "value": "export interface StackElementProps extends Pick {\n accessibilityRole?: Extract;\n background?: Extract;\n border?: BorderShorthand;\n borderWidth?: MaybeAllValuesShorthandProperty | '';\n borderRadius?: MaybeAllValuesShorthandProperty>;\n alignContent?: MaybeResponsive>;\n alignItems?: MaybeResponsive>;\n justifyContent?: MaybeResponsive>;\n}" + "value": "export interface StackElementProps extends Pick {\n /**\n * The semantic meaning of the stack's content, used by assistive technologies.\n *\n * - `aside`: Supporting content related to the main content.\n * - `footer`: Information such as copyright, navigation links, and privacy statements.\n * - `header`: A page or section header.\n * - `main`: The primary content of the page.\n * - `section`: A generic section that should have a heading or `accessibilityLabel`.\n * - `status`: A live region with advisory information that is not urgent.\n * - `none`: Strips semantic meaning while keeping visual styling.\n * - `navigation`: A major group of navigation links.\n * - `ordered-list`: A list of ordered items.\n * - `list-item`: An item inside a list.\n * - `list-item-separator`: A divider between list items.\n * - `unordered-list`: A list of unordered items.\n * - `separator`: A divider that separates sections of content.\n * - `alert`: Important, usually time-sensitive information.\n * - `generic`: A nameless container with no semantic meaning (renders a `
`).\n *\n * @default 'generic'\n */\n accessibilityRole?: Extract;\n /**\n * The background color of the stack.\n *\n * - `base`: The standard background color for general content areas.\n * - `subdued`: A muted background for secondary or supporting content.\n * - `transparent`: No background color (the default).\n *\n * @default 'transparent'\n */\n background?: Extract;\n /**\n * A shorthand for setting the border width, color, and style in a single property. Individual border properties (`borderWidth`, `borderStyle`) can override values set here.\n *\n * @default 'none'\n */\n border?: BorderShorthand;\n /**\n * The thickness of the border on all sides. Supports 1-to-4-value shorthand syntax for specifying different widths per side. Overrides the width value set by `border`.\n *\n * @default '' - meaning no override\n */\n borderWidth?: MaybeAllValuesShorthandProperty | '';\n /**\n * The roundedness of the stack's corners.\n *\n * - `none`: Sharp corners with no rounding.\n * - `small-100` / `small`: Subtle rounding for compact elements.\n * - `base`: Standard rounding for most use cases.\n * - `large` / `large-100`: More pronounced rounding for prominent containers.\n * - `max`: Maximum rounding, creating a pill or circular shape.\n *\n * Supports 1-to-4-value shorthand syntax for specifying different radii per corner.\n *\n * @default 'none'\n */\n borderRadius?: MaybeAllValuesShorthandProperty>;\n /**\n * Controls how lines of content are distributed along the cross axis when there is extra space.\n *\n * - `normal`: Default browser behavior.\n * - `space-between`: Distributes lines evenly with no space at the edges.\n * - `space-around`: Distributes lines evenly with equal space around each.\n * - `space-evenly`: Distributes lines with equal space between and at the edges.\n * - `stretch`: Stretches lines to fill the available space.\n * - `center`: Packs lines toward the center.\n * - `start`: Packs lines toward the start of the cross axis.\n * - `end`: Packs lines toward the end of the cross axis.\n *\n * @default 'normal'\n */\n alignContent?: MaybeResponsive>;\n /**\n * Controls how child elements are aligned along the cross axis.\n *\n * - `normal`: Default browser behavior.\n * - `stretch`: Stretches children to fill the cross axis.\n * - `center`: Centers children along the cross axis.\n * - `start`: Aligns children to the start of the cross axis.\n * - `end`: Aligns children to the end of the cross axis.\n *\n * @default 'normal'\n */\n alignItems?: MaybeResponsive>;\n /**\n * Controls how child elements are distributed along the main axis.\n *\n * - `normal`: Default browser behavior.\n * - `space-between`: Distributes children evenly with no space at the edges.\n * - `space-around`: Distributes children evenly with equal space around each.\n * - `space-evenly`: Distributes children with equal space between and at the edges.\n * - `stretch`: Stretches children to fill the available space.\n * - `center`: Packs children toward the center.\n * - `start`: Packs children toward the start of the main axis.\n * - `end`: Packs children toward the end of the main axis.\n *\n * @default 'normal'\n */\n justifyContent?: MaybeResponsive>;\n}" } }, "StackProps": { @@ -140859,7 +140929,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityRole", "value": "'aside' | 'footer' | 'header' | 'main' | 'section' | 'status' | 'none' | 'navigation' | 'ordered-list' | 'list-item' | 'list-item-separator' | 'unordered-list' | 'separator' | 'alert' | 'generic'", - "description": "Sets the semantic meaning of the component’s content. When set, the role will be used by assistive technologies to help users navigate the page.", + "description": "The semantic meaning of the stack's content, used by assistive technologies.\n\n- `aside`: Supporting content related to the main content.\n- `footer`: Information such as copyright, navigation links, and privacy statements.\n- `header`: A page or section header.\n- `main`: The primary content of the page.\n- `section`: A generic section that should have a heading or `accessibilityLabel`.\n- `status`: A live region with advisory information that is not urgent.\n- `none`: Strips semantic meaning while keeping visual styling.\n- `navigation`: A major group of navigation links.\n- `ordered-list`: A list of ordered items.\n- `list-item`: An item inside a list.\n- `list-item-separator`: A divider between list items.\n- `unordered-list`: A list of unordered items.\n- `separator`: A divider that separates sections of content.\n- `alert`: Important, usually time-sensitive information.\n- `generic`: A nameless container with no semantic meaning (renders a `
`).", "isOptional": true, "defaultValue": "'generic'" }, @@ -140868,7 +140938,7 @@ "syntaxKind": "PropertySignature", "name": "alignContent", "value": "MaybeResponsive>", - "description": "Aligns the Stack along the cross axis.", + "description": "Controls how lines of content are distributed along the cross axis when there is extra space.\n\n- `normal`: Default browser behavior.\n- `space-between`: Distributes lines evenly with no space at the edges.\n- `space-around`: Distributes lines evenly with equal space around each.\n- `space-evenly`: Distributes lines with equal space between and at the edges.\n- `stretch`: Stretches lines to fill the available space.\n- `center`: Packs lines toward the center.\n- `start`: Packs lines toward the start of the cross axis.\n- `end`: Packs lines toward the end of the cross axis.", "isOptional": true, "defaultValue": "'normal'" }, @@ -140877,7 +140947,7 @@ "syntaxKind": "PropertySignature", "name": "alignItems", "value": "MaybeResponsive>", - "description": "Aligns the Stack's children along the cross axis.", + "description": "Controls how child elements are aligned along the cross axis.\n\n- `normal`: Default browser behavior.\n- `stretch`: Stretches children to fill the cross axis.\n- `center`: Centers children along the cross axis.\n- `start`: Aligns children to the start of the cross axis.\n- `end`: Aligns children to the end of the cross axis.", "isOptional": true, "defaultValue": "'normal'" }, @@ -140886,7 +140956,7 @@ "syntaxKind": "PropertySignature", "name": "background", "value": "'base' | 'subdued' | 'transparent'", - "description": "Adjust the background of the element.\n\n- `'transparent'`: No visible background.\n- `'subdued'`: A subtle, low-emphasis background.\n- `'base'`: The standard background color.\n- `'strong'`: A high-emphasis background for prominence.", + "description": "The background color of the stack.\n\n- `base`: The standard background color for general content areas.\n- `subdued`: A muted background for secondary or supporting content.\n- `transparent`: No background color (the default).", "isOptional": true, "defaultValue": "'transparent'" }, @@ -140904,15 +140974,16 @@ "syntaxKind": "PropertySignature", "name": "border", "value": "BorderShorthand", - "description": "Applies a border using shorthand syntax to specify width, color, and style in a single property.\n\nAccepts a size value, optionally followed by a color, optionally followed by a style. Omitted values use defaults: color defaults to `base`, style defaults to `auto`.\n\nIndividual properties (`borderWidth`, `borderStyle`, `borderColor`) can override values set here.", - "isOptional": true + "description": "A shorthand for setting the border width, color, and style in a single property. Individual border properties (`borderWidth`, `borderStyle`) can override values set here.", + "isOptional": true, + "defaultValue": "'none'" }, { "filePath": "src/surfaces/checkout/components/Stack.ts", "syntaxKind": "PropertySignature", "name": "borderRadius", "value": "MaybeAllValuesShorthandProperty>", - "description": "Controls the roundedness of the element's corners using the design system's radius scale.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) using flow-relative values:\n- One value: applies to all corners\n- Two values: applies to start corners (top-left & bottom-right) and end corners (top-right & bottom-left) respectively\n- Three values: applies to start-start (top-left), end corners (top-right & bottom-left), and end-end (bottom-right) respectively\n- Four values: applies to start-start (top-left), start-end (top-right), end-end (bottom-right), and end-start (bottom-left) respectively\n\nExamples:\n- `small-100`: All corners have `small-100` radius\n- `small-100 none`: Top-left and bottom-right are `small-100`, top-right and bottom-left are `none`\n- `small-100 none large-100`: Top-left is `small-100`, top-right and bottom-left are `none`, bottom-right is `large-100`\n- `small-100 none large-100 base`: Each corner has its specified radius value", + "description": "The roundedness of the stack's corners.\n\n- `none`: Sharp corners with no rounding.\n- `small-100` / `small`: Subtle rounding for compact elements.\n- `base`: Standard rounding for most use cases.\n- `large` / `large-100`: More pronounced rounding for prominent containers.\n- `max`: Maximum rounding, creating a pill or circular shape.\n\nSupports 1-to-4-value shorthand syntax for specifying different radii per corner.", "isOptional": true, "defaultValue": "'none'" }, @@ -140930,8 +141001,9 @@ "syntaxKind": "PropertySignature", "name": "borderWidth", "value": "MaybeAllValuesShorthandProperty | ''", - "description": "Controls the thickness of the border on all sides. When set, this overrides the width value specified in the `border` property.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) for specifying different widths per side:\n- One value: applies to all sides\n- Two values: applies to block sides (top/bottom) and inline sides (left/right) respectively\n- Three values: applies to block-start (top), inline sides (left/right), and block-end (bottom) respectively\n- Four values: applies to block-start (top), inline-end (right), block-end (bottom), and inline-start (left) respectively", - "isOptional": true + "description": "The thickness of the border on all sides. Supports 1-to-4-value shorthand syntax for specifying different widths per side. Overrides the width value set by `border`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" }, { "filePath": "src/surfaces/checkout/components/Stack.ts", @@ -140956,7 +141028,7 @@ "syntaxKind": "PropertySignature", "name": "display", "value": "MaybeResponsive<\"auto\" | \"none\">", - "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.", + "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.\n\nLearn more about the [display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display).", "isOptional": true, "defaultValue": "'auto'" }, @@ -140974,7 +141046,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -140991,7 +141063,7 @@ "syntaxKind": "PropertySignature", "name": "justifyContent", "value": "MaybeResponsive>", - "description": "Aligns the Stack along the main axis.", + "description": "Controls how child elements are distributed along the main axis.\n\n- `normal`: Default browser behavior.\n- `space-between`: Distributes children evenly with no space at the edges.\n- `space-around`: Distributes children evenly with equal space around each.\n- `space-evenly`: Distributes children with equal space between and at the edges.\n- `stretch`: Stretches children to fill the available space.\n- `center`: Packs children toward the center.\n- `start`: Packs children toward the start of the main axis.\n- `end`: Packs children toward the end of the main axis.", "isOptional": true, "defaultValue": "'normal'" }, @@ -141136,7 +141208,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityRole", "value": "'aside' | 'footer' | 'header' | 'main' | 'section' | 'status' | 'none' | 'navigation' | 'ordered-list' | 'list-item' | 'list-item-separator' | 'unordered-list' | 'separator' | 'alert' | 'generic'", - "description": "Sets the semantic meaning of the component’s content. When set, the role will be used by assistive technologies to help users navigate the page.", + "description": "The semantic meaning of the stack's content, used by assistive technologies.\n\n- `aside`: Supporting content related to the main content.\n- `footer`: Information such as copyright, navigation links, and privacy statements.\n- `header`: A page or section header.\n- `main`: The primary content of the page.\n- `section`: A generic section that should have a heading or `accessibilityLabel`.\n- `status`: A live region with advisory information that is not urgent.\n- `none`: Strips semantic meaning while keeping visual styling.\n- `navigation`: A major group of navigation links.\n- `ordered-list`: A list of ordered items.\n- `list-item`: An item inside a list.\n- `list-item-separator`: A divider between list items.\n- `unordered-list`: A list of unordered items.\n- `separator`: A divider that separates sections of content.\n- `alert`: Important, usually time-sensitive information.\n- `generic`: A nameless container with no semantic meaning (renders a `
`).", "isOptional": true, "defaultValue": "'generic'" }, @@ -141159,7 +141231,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/Stack.ts", @@ -141173,7 +141245,7 @@ "syntaxKind": "PropertySignature", "name": "alignContent", "value": "MaybeResponsive>", - "description": "Aligns the Stack along the cross axis.", + "description": "Controls how lines of content are distributed along the cross axis when there is extra space.\n\n- `normal`: Default browser behavior.\n- `space-between`: Distributes lines evenly with no space at the edges.\n- `space-around`: Distributes lines evenly with equal space around each.\n- `space-evenly`: Distributes lines with equal space between and at the edges.\n- `stretch`: Stretches lines to fill the available space.\n- `center`: Packs lines toward the center.\n- `start`: Packs lines toward the start of the cross axis.\n- `end`: Packs lines toward the end of the cross axis.", "isOptional": true, "defaultValue": "'normal'" }, @@ -141182,7 +141254,7 @@ "syntaxKind": "PropertySignature", "name": "alignItems", "value": "MaybeResponsive>", - "description": "Aligns the Stack's children along the cross axis.", + "description": "Controls how child elements are aligned along the cross axis.\n\n- `normal`: Default browser behavior.\n- `stretch`: Stretches children to fill the cross axis.\n- `center`: Centers children along the cross axis.\n- `start`: Aligns children to the start of the cross axis.\n- `end`: Aligns children to the end of the cross axis.", "isOptional": true, "defaultValue": "'normal'" }, @@ -141632,7 +141704,7 @@ "syntaxKind": "PropertySignature", "name": "background", "value": "'base' | 'subdued' | 'transparent'", - "description": "Adjust the background of the element.\n\n- `'transparent'`: No visible background.\n- `'subdued'`: A subtle, low-emphasis background.\n- `'base'`: The standard background color.\n- `'strong'`: A high-emphasis background for prominence.", + "description": "The background color of the stack.\n\n- `base`: The standard background color for general content areas.\n- `subdued`: A muted background for secondary or supporting content.\n- `transparent`: No background color (the default).", "isOptional": true, "defaultValue": "'transparent'" }, @@ -141671,15 +141743,16 @@ "syntaxKind": "PropertySignature", "name": "border", "value": "BorderShorthand", - "description": "Applies a border using shorthand syntax to specify width, color, and style in a single property.\n\nAccepts a size value, optionally followed by a color, optionally followed by a style. Omitted values use defaults: color defaults to `base`, style defaults to `auto`.\n\nIndividual properties (`borderWidth`, `borderStyle`, `borderColor`) can override values set here.", - "isOptional": true + "description": "A shorthand for setting the border width, color, and style in a single property. Individual border properties (`borderWidth`, `borderStyle`) can override values set here.", + "isOptional": true, + "defaultValue": "'none'" }, { "filePath": "src/surfaces/checkout/components/Stack.ts", "syntaxKind": "PropertySignature", "name": "borderRadius", "value": "MaybeAllValuesShorthandProperty>", - "description": "Controls the roundedness of the element's corners using the design system's radius scale.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) using flow-relative values:\n- One value: applies to all corners\n- Two values: applies to start corners (top-left & bottom-right) and end corners (top-right & bottom-left) respectively\n- Three values: applies to start-start (top-left), end corners (top-right & bottom-left), and end-end (bottom-right) respectively\n- Four values: applies to start-start (top-left), start-end (top-right), end-end (bottom-right), and end-start (bottom-left) respectively\n\nExamples:\n- `small-100`: All corners have `small-100` radius\n- `small-100 none`: Top-left and bottom-right are `small-100`, top-right and bottom-left are `none`\n- `small-100 none large-100`: Top-left is `small-100`, top-right and bottom-left are `none`, bottom-right is `large-100`\n- `small-100 none large-100 base`: Each corner has its specified radius value", + "description": "The roundedness of the stack's corners.\n\n- `none`: Sharp corners with no rounding.\n- `small-100` / `small`: Subtle rounding for compact elements.\n- `base`: Standard rounding for most use cases.\n- `large` / `large-100`: More pronounced rounding for prominent containers.\n- `max`: Maximum rounding, creating a pill or circular shape.\n\nSupports 1-to-4-value shorthand syntax for specifying different radii per corner.", "isOptional": true, "defaultValue": "'none'" }, @@ -141697,8 +141770,9 @@ "syntaxKind": "PropertySignature", "name": "borderWidth", "value": "MaybeAllValuesShorthandProperty | ''", - "description": "Controls the thickness of the border on all sides. When set, this overrides the width value specified in the `border` property.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) for specifying different widths per side:\n- One value: applies to all sides\n- Two values: applies to block sides (top/bottom) and inline sides (left/right) respectively\n- Three values: applies to block-start (top), inline sides (left/right), and block-end (bottom) respectively\n- Four values: applies to block-start (top), inline-end (right), block-end (bottom), and inline-start (left) respectively", - "isOptional": true + "description": "The thickness of the border on all sides. Supports 1-to-4-value shorthand syntax for specifying different widths per side. Overrides the width value set by `border`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" }, { "filePath": "src/surfaces/checkout/components/Stack.ts", @@ -141884,7 +141958,7 @@ "syntaxKind": "PropertySignature", "name": "display", "value": "MaybeResponsive<\"auto\" | \"none\">", - "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.", + "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.\n\nLearn more about the [display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display).", "isOptional": true, "defaultValue": "'auto'" }, @@ -142162,7 +142236,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -142270,7 +142344,7 @@ "syntaxKind": "PropertySignature", "name": "justifyContent", "value": "MaybeResponsive>", - "description": "Aligns the Stack along the main axis.", + "description": "Controls how child elements are distributed along the main axis.\n\n- `normal`: Default browser behavior.\n- `space-between`: Distributes children evenly with no space at the edges.\n- `space-around`: Distributes children evenly with equal space around each.\n- `space-evenly`: Distributes children with equal space between and at the edges.\n- `stretch`: Stretches children to fill the available space.\n- `center`: Packs children toward the center.\n- `start`: Packs children toward the start of the main axis.\n- `end`: Packs children toward the end of the main axis.", "isOptional": true, "defaultValue": "'normal'" }, @@ -143400,7 +143474,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/Stack.ts", @@ -143665,7 +143739,7 @@ "src/surfaces/checkout/components/Summary.ts": { "filePath": "src/surfaces/checkout/components/Summary.ts", "name": "SummaryElementProps", - "description": "Provides a clickable label for collapsible Details content. Use to create clear, accessible disclosure controls that show or hide additional information.", + "description": "", "isPublicDocs": true, "members": [ { @@ -143673,7 +143747,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true } ], @@ -143706,7 +143780,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/Summary.ts", @@ -144603,7 +144677,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -145715,7 +145789,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/Summary.ts", @@ -145979,7 +146053,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true } ], @@ -145990,7 +146064,7 @@ "src/surfaces/checkout/components/Switch.ts": { "filePath": "src/surfaces/checkout/components/Switch.ts", "name": "SwitchElementProps", - "description": "The switch component provides a clear way for users to toggle options or settings on and off. Use switch for binary controls that take effect immediately, like enabling features, activating settings, or controlling visibility.\n\nSwitches provide instant visual feedback and are ideal for settings that don't require a save action to apply changes. For selections that require explicit submission, use [checkbox](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/forms/checkbox) instead.", + "description": "", "isPublicDocs": true, "members": [ { @@ -146006,7 +146080,7 @@ "syntaxKind": "PropertySignature", "name": "checked", "value": "boolean", - "description": "Whether the control is active.", + "description": "Whether the control is currently checked.", "isOptional": true, "defaultValue": "false" }, @@ -146015,7 +146089,7 @@ "syntaxKind": "PropertySignature", "name": "command", "value": "'--auto' | '--show' | '--hide' | '--toggle'", - "description": "Sets the action the `commandFor` should take when this clickable is activated.\n\nSee the documentation of particular components for the actions they support.\n\n- `--auto`: Performs the default action for the target component.\n- `--show`: Displays the target component.\n- `--hide`: Conceals the target component.\n- `--toggle`: Alternates the target component.\n- `--copy`: Copies the target ClipboardItem.", + "description": "Sets the action the `commandFor` target should take when this component is activated.\n\n- `--auto`: Performs the default action for the target component.\n- `--show`: Displays the target component.\n- `--hide`: Conceals the target component.\n- `--toggle`: Alternates the target component.\n- `--copy`: Copies the target ClipboardItem.\n\nLearn more about the [`command` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).", "isOptional": true, "defaultValue": "'--auto'" }, @@ -146024,7 +146098,7 @@ "syntaxKind": "PropertySignature", "name": "commandFor", "value": "string", - "description": "ID of a component that should respond to activations (such as clicks) on this component.\n\nSee `command` for how to control the behavior of the target.", + "description": "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).\n\nWhen both `commandFor` and `href` are set, `commandFor` takes precedence. The command runs and the link doesn't navigate.", "isOptional": true }, { @@ -146032,7 +146106,7 @@ "syntaxKind": "PropertySignature", "name": "defaultChecked", "value": "boolean", - "description": "Whether the control is active by default.", + "description": "Whether the control is checked by default.", "isOptional": true, "defaultValue": "false" }, @@ -146041,7 +146115,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the control, disallowing any interaction.", + "description": "Whether the control is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -146050,7 +146124,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -146058,7 +146132,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Visual content to use as the control label.", + "description": "The text displayed as the control label, which identifies the purpose of the control to users. This label is associated with the control for accessibility.", "isOptional": true }, { @@ -146066,7 +146140,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the control that is unique within the nearest containing `Form` component.", + "description": "The name attribute for the control, used to identify its value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -146104,7 +146178,7 @@ "src/surfaces/checkout/components/Switch.ts": { "filePath": "src/surfaces/checkout/components/Switch.ts", "name": "SwitchElementEvents", - "description": "Learn more about [registering events](/docs/api/checkout-ui-extensions/latest/using-polaris-components#event-handling).", + "description": "", "isPublicDocs": true, "members": [ { @@ -146112,11 +146186,11 @@ "syntaxKind": "PropertySignature", "name": "change", "value": "CallbackEventListener", - "description": "A callback that is run whenever the control is changed.", + "description": "A callback fired when the switch value changes.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", "isOptional": true } ], - "value": "export interface SwitchElementEvents {\n /**\n * A callback that is run whenever the control is changed.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event\n */\n change?: CallbackEventListener;\n}" + "value": "export interface SwitchElementEvents {\n /**\n * A callback fired when the switch value changes.\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change?: CallbackEventListener;\n}" } }, "SwitchElement": { @@ -146153,7 +146227,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/Switch.ts", @@ -146636,7 +146710,7 @@ "syntaxKind": "PropertySignature", "name": "checked", "value": "boolean", - "description": "Whether the control is active.", + "description": "Whether the control is currently checked.", "isOptional": true, "defaultValue": "false" }, @@ -146736,7 +146810,7 @@ "syntaxKind": "PropertySignature", "name": "command", "value": "'--auto' | '--show' | '--hide' | '--toggle'", - "description": "Sets the action the `commandFor` should take when this clickable is activated.\n\nSee the documentation of particular components for the actions they support.\n\n- `--auto`: Performs the default action for the target component.\n- `--show`: Displays the target component.\n- `--hide`: Conceals the target component.\n- `--toggle`: Alternates the target component.\n- `--copy`: Copies the target ClipboardItem.", + "description": "Sets the action the `commandFor` target should take when this component is activated.\n\n- `--auto`: Performs the default action for the target component.\n- `--show`: Displays the target component.\n- `--hide`: Conceals the target component.\n- `--toggle`: Alternates the target component.\n- `--copy`: Copies the target ClipboardItem.\n\nLearn more about the [`command` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).", "isOptional": true, "defaultValue": "'--auto'" }, @@ -146745,7 +146819,7 @@ "syntaxKind": "PropertySignature", "name": "commandFor", "value": "string", - "description": "ID of a component that should respond to activations (such as clicks) on this component.\n\nSee `command` for how to control the behavior of the target.", + "description": "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).\n\nWhen both `commandFor` and `href` are set, `commandFor` takes precedence. The command runs and the link doesn't navigate.", "isOptional": true }, { @@ -146802,7 +146876,7 @@ "syntaxKind": "PropertySignature", "name": "defaultChecked", "value": "boolean", - "description": "Whether the control is active by default.", + "description": "Whether the control is checked by default.", "isOptional": true, "defaultValue": "false" }, @@ -146818,7 +146892,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the control, disallowing any interaction.", + "description": "Whether the control is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -147094,7 +147168,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -147193,7 +147267,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Visual content to use as the control label.", + "description": "The text displayed as the control label, which identifies the purpose of the control to users. This label is associated with the control for accessibility.", "isOptional": true }, { @@ -147250,7 +147324,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the control that is unique within the nearest containing `Form` component.", + "description": "The name attribute for the control, used to identify its value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -148222,7 +148296,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/Switch.ts", @@ -148502,7 +148576,7 @@ "syntaxKind": "PropertySignature", "name": "checked", "value": "boolean", - "description": "Whether the control is active.", + "description": "Whether the control is currently checked.", "isOptional": true, "defaultValue": "false" }, @@ -148511,7 +148585,7 @@ "syntaxKind": "PropertySignature", "name": "command", "value": "'--auto' | '--show' | '--hide' | '--toggle'", - "description": "Sets the action the `commandFor` should take when this clickable is activated.\n\nSee the documentation of particular components for the actions they support.\n\n- `--auto`: Performs the default action for the target component.\n- `--show`: Displays the target component.\n- `--hide`: Conceals the target component.\n- `--toggle`: Alternates the target component.\n- `--copy`: Copies the target ClipboardItem.", + "description": "Sets the action the `commandFor` target should take when this component is activated.\n\n- `--auto`: Performs the default action for the target component.\n- `--show`: Displays the target component.\n- `--hide`: Conceals the target component.\n- `--toggle`: Alternates the target component.\n- `--copy`: Copies the target ClipboardItem.\n\nLearn more about the [`command` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).", "isOptional": true, "defaultValue": "'--auto'" }, @@ -148520,7 +148594,7 @@ "syntaxKind": "PropertySignature", "name": "commandFor", "value": "string", - "description": "ID of a component that should respond to activations (such as clicks) on this component.\n\nSee `command` for how to control the behavior of the target.", + "description": "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).\n\nWhen both `commandFor` and `href` are set, `commandFor` takes precedence. The command runs and the link doesn't navigate.", "isOptional": true }, { @@ -148528,7 +148602,7 @@ "syntaxKind": "PropertySignature", "name": "defaultChecked", "value": "boolean", - "description": "Whether the control is active by default.", + "description": "Whether the control is checked by default.", "isOptional": true, "defaultValue": "false" }, @@ -148537,7 +148611,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the control, disallowing any interaction.", + "description": "Whether the control is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -148546,7 +148620,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -148554,7 +148628,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Visual content to use as the control label.", + "description": "The text displayed as the control label, which identifies the purpose of the control to users. This label is associated with the control for accessibility.", "isOptional": true }, { @@ -148562,7 +148636,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the control that is unique within the nearest containing `Form` component.", + "description": "The name attribute for the control, used to identify its value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -148589,7 +148663,7 @@ "src/surfaces/checkout/components/Text.ts": { "filePath": "src/surfaces/checkout/components/Text.ts", "name": "TextElementProps", - "description": "The text component displays inline text with specific visual styles or tones. Use text to emphasize or differentiate words or phrases within paragraphs or other block-level components, applying weight, color, or semantic styling.\n\nText supports multiple visual variants, alignment options, and line clamping for flexible inline typography control. For block-level text content, use [paragraph](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/typography-and-content/paragraph).", + "description": "", "isPublicDocs": true, "members": [ { @@ -148597,7 +148671,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityVisibility", "value": "'visible' | 'hidden' | 'exclusive'", - "description": "Changes the visibility of the element.\n\n- `visible`: the element is visible to all users.\n- `hidden`: the element is removed from the accessibility tree but remains visible.\n- `exclusive`: the element is visually hidden but remains in the accessibility tree.", + "description": "Controls how the element is exposed to sighted users and to assistive technologies such as screen readers.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", "isOptional": true, "defaultValue": "'visible'" }, @@ -148606,7 +148680,7 @@ "syntaxKind": "PropertySignature", "name": "color", "value": "'base' | 'subdued'", - "description": "Modify the color to be more or less intense.", + "description": "The color emphasis level that controls visual intensity.\n\n- `subdued`: Deemphasized color for secondary text, supporting labels, and less critical interface elements.\n- `base`: Primary color for body text, standard UI elements, and general content with good readability.\n- `strong`: Emphasized color for headings, key labels, and interactive elements that need prominence.", "isOptional": true, "defaultValue": "'base'" }, @@ -148615,7 +148689,7 @@ "syntaxKind": "PropertySignature", "name": "dir", "value": "'ltr' | 'rtl' | 'auto' | ''", - "description": "Indicates the directionality of the element’s text.\n\n- `ltr`: languages written from left to right (such as English)\n- `rtl`: languages written from right to left (such as Arabic)\n- `auto`: the user agent determines the direction based on the content\n- `''`: direction is inherited from parent elements (equivalent to not setting the attribute)", + "description": "Indicates the directionality of the element’s text.\n\n- `ltr`: The languages written from left to right (such as English).\n- `rtl`: The languages written from right to left (such as Arabic).\n- `auto`: The user agent determines the direction based on the content.\n- `\"\"`: The direction is inherited from parent elements (equivalent to not setting the attribute).\n\nLearn more about the [dir attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/dir).", "isOptional": true, "defaultValue": "''" }, @@ -148624,7 +148698,7 @@ "syntaxKind": "PropertySignature", "name": "display", "value": "MaybeResponsive<\"auto\" | \"none\">", - "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.", + "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.\n\nLearn more about the [display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display).", "isOptional": true, "defaultValue": "'auto'" }, @@ -148633,7 +148707,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -148641,7 +148715,7 @@ "syntaxKind": "PropertySignature", "name": "lang", "value": "string", - "description": "The language of the button's text content. Use this when the button text is in a different language than the rest of the page, so assistive technologies can invoke the correct pronunciation. [Reference of values](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry) (`Subtag` label)\n\nIt is recommended to combine it with the `dir` attribute to ensure the text is rendered correctly if the surrounding content’s direction is different.", + "description": "Indicate the text language. Useful when the text is in a different language than the rest of the page. It will allow assistive technologies such as screen readers to invoke the correct pronunciation. [Reference of values](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry) (\"subtag\" label)\n\nIt is recommended to combine it with the `dir` attribute to ensure the text is rendered correctly if the surrounding content’s direction is different.", "isOptional": true, "defaultValue": "''" }, @@ -148650,7 +148724,7 @@ "syntaxKind": "PropertySignature", "name": "tone", "value": "'custom' | 'success' | 'info' | 'auto' | 'neutral' | 'warning' | 'critical'", - "description": "Sets the tone of the component, based on the intention of the information being conveyed.", + "description": "The semantic meaning and color treatment of the component.\n\n- `auto`: Automatically determined based on context.\n- `neutral`: General information without specific intent.\n- `info`: Informational content or helpful tips.\n- `success`: Positive outcomes or successful states.\n- `warning`: Important warnings about potential issues.\n- `critical`: Urgent problems or destructive actions.\n- `custom`: Custom styling controlled by your theme.", "isOptional": true, "defaultValue": "'auto'" }, @@ -148659,12 +148733,12 @@ "syntaxKind": "PropertySignature", "name": "type", "value": "'small' | 'address' | 'mark' | 'strong' | 'generic' | 'redundant' | 'emphasis' | 'offset'", - "description": "Provide semantic meaning and default styling to the text.\n\nOther presentation properties on Text override the default styling.", + "description": "The semantic type and styling treatment for the text content.\n\nOther presentation properties on `s-text` override the default styling.\n\n- `address`: A semantic type that indicates the text is contact information. Typically used for addresses.\n- `redundant`: A semantic type that indicates the text is no longer accurate or no longer relevant.\n- `mark`: A semantic type that indicates the text is marked or highlighted.\n- `emphasis`: A semantic type that indicates emphatic stress.\n- `offset`: A semantic type that indicates an offset from the normal prose.\n- `strong`: A semantic type that indicates strong importance, seriousness, or urgency.\n- `small`: A semantic type that indicates less important text.\n- `generic`: No additional semantics or styling is applied.", "isOptional": true, "defaultValue": "'generic'" } ], - "value": "export interface TextElementProps extends Pick {\n color?: Extract;\n tone?: Extract;\n type?: Extract;\n}" + "value": "export interface TextElementProps extends Pick {\n color?: Extract;\n tone?: Extract;\n /**\n * The semantic type and styling treatment for the text content.\n *\n * Other presentation properties on `s-text` override the default styling.\n *\n * - `address`: A semantic type that indicates the text is contact information. Typically used for addresses.\n * - `redundant`: A semantic type that indicates the text is no longer accurate or no longer relevant.\n * - `mark`: A semantic type that indicates the text is marked or highlighted.\n * - `emphasis`: A semantic type that indicates emphatic stress.\n * - `offset`: A semantic type that indicates an offset from the normal prose.\n * - `strong`: A semantic type that indicates strong importance, seriousness, or urgency.\n * - `small`: A semantic type that indicates less important text.\n * - `generic`: No additional semantics or styling is applied.\n *\n * @default 'generic'\n */\n type?: Extract;\n}" } }, "TextElement": { @@ -148679,7 +148753,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityVisibility", "value": "'visible' | 'hidden' | 'exclusive'", - "description": "Changes the visibility of the element.\n\n- `visible`: the element is visible to all users.\n- `hidden`: the element is removed from the accessibility tree but remains visible.\n- `exclusive`: the element is visually hidden but remains in the accessibility tree.", + "description": "Controls how the element is exposed to sighted users and to assistive technologies such as screen readers.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", "isOptional": true, "defaultValue": "'visible'" }, @@ -148702,7 +148776,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/Text.ts", @@ -149276,7 +149350,7 @@ "syntaxKind": "PropertySignature", "name": "color", "value": "'base' | 'subdued'", - "description": "Modify the color to be more or less intense.", + "description": "The color emphasis level that controls visual intensity.\n\n- `subdued`: Deemphasized color for secondary text, supporting labels, and less critical interface elements.\n- `base`: Primary color for body text, standard UI elements, and general content with good readability.\n- `strong`: Emphasized color for headings, key labels, and interactive elements that need prominence.", "isOptional": true, "defaultValue": "'base'" }, @@ -149334,7 +149408,7 @@ "syntaxKind": "PropertySignature", "name": "dir", "value": "'ltr' | 'rtl' | 'auto' | ''", - "description": "Indicates the directionality of the element’s text.\n\n- `ltr`: languages written from left to right (such as English)\n- `rtl`: languages written from right to left (such as Arabic)\n- `auto`: the user agent determines the direction based on the content\n- `''`: direction is inherited from parent elements (equivalent to not setting the attribute)", + "description": "Indicates the directionality of the element’s text.\n\n- `ltr`: The languages written from left to right (such as English).\n- `rtl`: The languages written from right to left (such as Arabic).\n- `auto`: The user agent determines the direction based on the content.\n- `\"\"`: The direction is inherited from parent elements (equivalent to not setting the attribute).\n\nLearn more about the [dir attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/dir).", "isOptional": true, "defaultValue": "''" }, @@ -149350,7 +149424,7 @@ "syntaxKind": "PropertySignature", "name": "display", "value": "MaybeResponsive<\"auto\" | \"none\">", - "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.", + "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.\n\nLearn more about the [display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display).", "isOptional": true, "defaultValue": "'auto'" }, @@ -149619,7 +149693,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -149718,7 +149792,7 @@ "syntaxKind": "PropertySignature", "name": "lang", "value": "string", - "description": "The language of the button's text content. Use this when the button text is in a different language than the rest of the page, so assistive technologies can invoke the correct pronunciation. [Reference of values](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry) (`Subtag` label)\n\nIt is recommended to combine it with the `dir` attribute to ensure the text is rendered correctly if the surrounding content’s direction is different.", + "description": "Indicate the text language. Useful when the text is in a different language than the rest of the page. It will allow assistive technologies such as screen readers to invoke the correct pronunciation. [Reference of values](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry) (\"subtag\" label)\n\nIt is recommended to combine it with the `dir` attribute to ensure the text is rendered correctly if the surrounding content’s direction is different.", "isOptional": true, "defaultValue": "''" }, @@ -150733,7 +150807,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/Text.ts", @@ -150964,7 +151038,7 @@ "syntaxKind": "PropertySignature", "name": "tone", "value": "'custom' | 'success' | 'info' | 'auto' | 'neutral' | 'warning' | 'critical'", - "description": "Sets the tone of the component, based on the intention of the information being conveyed.", + "description": "The semantic meaning and color treatment of the component.\n\n- `auto`: Automatically determined based on context.\n- `neutral`: General information without specific intent.\n- `info`: Informational content or helpful tips.\n- `success`: Positive outcomes or successful states.\n- `warning`: Important warnings about potential issues.\n- `critical`: Urgent problems or destructive actions.\n- `custom`: Custom styling controlled by your theme.", "isOptional": true, "defaultValue": "'auto'" }, @@ -150980,7 +151054,7 @@ "syntaxKind": "PropertySignature", "name": "type", "value": "'small' | 'address' | 'mark' | 'strong' | 'generic' | 'redundant' | 'emphasis' | 'offset'", - "description": "Provide semantic meaning and default styling to the text.\n\nOther presentation properties on Text override the default styling.", + "description": "The semantic type and styling treatment for the text content.\n\nOther presentation properties on `s-text` override the default styling.\n\n- `address`: A semantic type that indicates the text is contact information. Typically used for addresses.\n- `redundant`: A semantic type that indicates the text is no longer accurate or no longer relevant.\n- `mark`: A semantic type that indicates the text is marked or highlighted.\n- `emphasis`: A semantic type that indicates emphatic stress.\n- `offset`: A semantic type that indicates an offset from the normal prose.\n- `strong`: A semantic type that indicates strong importance, seriousness, or urgency.\n- `small`: A semantic type that indicates less important text.\n- `generic`: No additional semantics or styling is applied.", "isOptional": true, "defaultValue": "'generic'" }, @@ -151015,7 +151089,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityVisibility", "value": "'visible' | 'hidden' | 'exclusive'", - "description": "Changes the visibility of the element.\n\n- `visible`: the element is visible to all users.\n- `hidden`: the element is removed from the accessibility tree but remains visible.\n- `exclusive`: the element is visually hidden but remains in the accessibility tree.", + "description": "Controls how the element is exposed to sighted users and to assistive technologies such as screen readers.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", "isOptional": true, "defaultValue": "'visible'" }, @@ -151024,7 +151098,7 @@ "syntaxKind": "PropertySignature", "name": "color", "value": "'base' | 'subdued'", - "description": "Modify the color to be more or less intense.", + "description": "The color emphasis level that controls visual intensity.\n\n- `subdued`: Deemphasized color for secondary text, supporting labels, and less critical interface elements.\n- `base`: Primary color for body text, standard UI elements, and general content with good readability.\n- `strong`: Emphasized color for headings, key labels, and interactive elements that need prominence.", "isOptional": true, "defaultValue": "'base'" }, @@ -151033,7 +151107,7 @@ "syntaxKind": "PropertySignature", "name": "dir", "value": "'ltr' | 'rtl' | 'auto' | ''", - "description": "Indicates the directionality of the element’s text.\n\n- `ltr`: languages written from left to right (such as English)\n- `rtl`: languages written from right to left (such as Arabic)\n- `auto`: the user agent determines the direction based on the content\n- `''`: direction is inherited from parent elements (equivalent to not setting the attribute)", + "description": "Indicates the directionality of the element’s text.\n\n- `ltr`: The languages written from left to right (such as English).\n- `rtl`: The languages written from right to left (such as Arabic).\n- `auto`: The user agent determines the direction based on the content.\n- `\"\"`: The direction is inherited from parent elements (equivalent to not setting the attribute).\n\nLearn more about the [dir attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/dir).", "isOptional": true, "defaultValue": "''" }, @@ -151042,7 +151116,7 @@ "syntaxKind": "PropertySignature", "name": "display", "value": "MaybeResponsive<\"auto\" | \"none\">", - "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.", + "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.\n\nLearn more about the [display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display).", "isOptional": true, "defaultValue": "'auto'" }, @@ -151051,7 +151125,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -151059,7 +151133,7 @@ "syntaxKind": "PropertySignature", "name": "lang", "value": "string", - "description": "The language of the button's text content. Use this when the button text is in a different language than the rest of the page, so assistive technologies can invoke the correct pronunciation. [Reference of values](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry) (`Subtag` label)\n\nIt is recommended to combine it with the `dir` attribute to ensure the text is rendered correctly if the surrounding content’s direction is different.", + "description": "Indicate the text language. Useful when the text is in a different language than the rest of the page. It will allow assistive technologies such as screen readers to invoke the correct pronunciation. [Reference of values](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry) (\"subtag\" label)\n\nIt is recommended to combine it with the `dir` attribute to ensure the text is rendered correctly if the surrounding content’s direction is different.", "isOptional": true, "defaultValue": "''" }, @@ -151068,7 +151142,7 @@ "syntaxKind": "PropertySignature", "name": "tone", "value": "'custom' | 'success' | 'info' | 'auto' | 'neutral' | 'warning' | 'critical'", - "description": "Sets the tone of the component, based on the intention of the information being conveyed.", + "description": "The semantic meaning and color treatment of the component.\n\n- `auto`: Automatically determined based on context.\n- `neutral`: General information without specific intent.\n- `info`: Informational content or helpful tips.\n- `success`: Positive outcomes or successful states.\n- `warning`: Important warnings about potential issues.\n- `critical`: Urgent problems or destructive actions.\n- `custom`: Custom styling controlled by your theme.", "isOptional": true, "defaultValue": "'auto'" }, @@ -151077,7 +151151,7 @@ "syntaxKind": "PropertySignature", "name": "type", "value": "'small' | 'address' | 'mark' | 'strong' | 'generic' | 'redundant' | 'emphasis' | 'offset'", - "description": "Provide semantic meaning and default styling to the text.\n\nOther presentation properties on Text override the default styling.", + "description": "The semantic type and styling treatment for the text content.\n\nOther presentation properties on `s-text` override the default styling.\n\n- `address`: A semantic type that indicates the text is contact information. Typically used for addresses.\n- `redundant`: A semantic type that indicates the text is no longer accurate or no longer relevant.\n- `mark`: A semantic type that indicates the text is marked or highlighted.\n- `emphasis`: A semantic type that indicates emphatic stress.\n- `offset`: A semantic type that indicates an offset from the normal prose.\n- `strong`: A semantic type that indicates strong importance, seriousness, or urgency.\n- `small`: A semantic type that indicates less important text.\n- `generic`: No additional semantics or styling is applied.", "isOptional": true, "defaultValue": "'generic'" } @@ -151089,7 +151163,7 @@ "src/surfaces/checkout/components/TextArea.ts": { "filePath": "src/surfaces/checkout/components/TextArea.ts", "name": "TextAreaElementProps", - "description": "The text area component captures multi-line text input. Use it to collect descriptions, notes, comments, or other extended text content.\n\nThe component supports configurable height, character limits, and validation. For single-line text input, use [text field](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/forms/text-field).", + "description": "", "isPublicDocs": true, "members": [ { @@ -151097,7 +151171,7 @@ "syntaxKind": "PropertySignature", "name": "autocomplete", "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", "isOptional": true, "defaultValue": "'on' for everything else" }, @@ -151106,7 +151180,7 @@ "syntaxKind": "PropertySignature", "name": "defaultValue", "value": "string", - "description": "The default value for the field.", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces this value.", "isOptional": true }, { @@ -151114,7 +151188,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -151123,7 +151197,7 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -151131,7 +151205,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -151139,7 +151213,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Content to use as the field label.", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", "isOptional": true }, { @@ -151147,7 +151221,7 @@ "syntaxKind": "PropertySignature", "name": "labelAccessibilityVisibility", "value": "'visible' | 'exclusive'", - "description": "Changes the visibility of the component's label.\n\n- `visible`: the label is visible to all users.\n- `exclusive`: the label is visually hidden but remains in the accessibility tree.", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone.\n- `exclusive`: The label is visually hidden but still announced by screen readers.", "isOptional": true, "defaultValue": "'visible'" }, @@ -151165,7 +151239,7 @@ "syntaxKind": "PropertySignature", "name": "minLength", "value": "number", - "description": "Specifies the min number of characters allowed.", + "description": "Specifies the minimum number of characters allowed.", "isOptional": true, "defaultValue": "0" }, @@ -151174,7 +151248,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -151192,7 +151266,7 @@ "syntaxKind": "PropertySignature", "name": "readOnly", "value": "boolean", - "description": "The field cannot be edited by the user. It is focusable will be announced by screen readers.", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", "isOptional": true, "defaultValue": "false" }, @@ -151246,7 +151320,7 @@ "syntaxKind": "PropertySignature", "name": "onChange", "value": "(event: Event) => void", - "description": "Callback when the user has **finished editing** a field, for example, once they have blurred the field.", + "description": "A callback fired when the user has **finished editing** a field, such as when they blur the field or press Enter.", "isOptional": true }, { @@ -151262,7 +151336,7 @@ "syntaxKind": "PropertySignature", "name": "onInput", "value": "(event: Event) => void", - "description": "Callback when the user makes any changes in the field.", + "description": "A callback fired when the user makes any changes in the field, such as typing a character.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).", "isOptional": true } ], @@ -151273,7 +151347,7 @@ "src/surfaces/checkout/components/TextArea.ts": { "filePath": "src/surfaces/checkout/components/TextArea.ts", "name": "TextAreaElementEvents", - "description": "Learn more about [registering events](/docs/api/checkout-ui-extensions/latest/using-polaris-components#event-handling).", + "description": "", "isPublicDocs": true, "members": [ { @@ -151281,7 +151355,7 @@ "syntaxKind": "PropertySignature", "name": "blur", "value": "CallbackEventListener", - "description": "A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "description": "<<<<<<< HEAD A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n======= A callback fired when the text area loses focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) \n Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", "isOptional": true }, { @@ -151289,7 +151363,7 @@ "syntaxKind": "PropertySignature", "name": "change", "value": "CallbackEventListener", - "description": "Callback when the user has **finished editing** a field, for example, once they have blurred the field.", + "description": "<<<<<<< HEAD Callback when the user has **finished editing** a field, for example, once they have blurred the field.\n======= A callback fired when the text area value changes.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) \n Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", "isOptional": true }, { @@ -151297,7 +151371,7 @@ "syntaxKind": "PropertySignature", "name": "focus", "value": "CallbackEventListener", - "description": "A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "description": "<<<<<<< HEAD A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n======= A callback fired when the text area receives focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) \n Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", "isOptional": true }, { @@ -151305,11 +151379,11 @@ "syntaxKind": "PropertySignature", "name": "input", "value": "CallbackEventListener", - "description": "Callback when the user makes any changes in the field.", + "description": "A callback fired when the user inputs data into the text area.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).", "isOptional": true } ], - "value": "export interface TextAreaElementEvents {\n /**\n * A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event\n */\n blur?: CallbackEventListener;\n /**\n * Callback when the user has **finished editing** a field, for example, once they have blurred the field.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event\n */\n change?: CallbackEventListener;\n /**\n * A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event\n */\n focus?: CallbackEventListener;\n /**\n * Callback when the user makes any changes in the field.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event\n */\n input?: CallbackEventListener;\n}" + "value": "export interface TextAreaElementEvents {\n /**\n<<<<<<< HEAD\n * A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n=======\n * A callback fired when the text area loses focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality)\n *\n * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur?: CallbackEventListener;\n /**\n<<<<<<< HEAD\n * Callback when the user has **finished editing** a field, for example, once they have blurred the field.\n=======\n * A callback fired when the text area value changes.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality)\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change?: CallbackEventListener;\n /**\n<<<<<<< HEAD\n * A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n=======\n * A callback fired when the text area receives focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality)\n *\n * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus?: CallbackEventListener;\n /**\n * A callback fired when the user inputs data into the text area.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input?: CallbackEventListener;\n}" } }, "TextAreaElement": { @@ -151338,7 +151412,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/TextArea.ts", @@ -151779,7 +151853,7 @@ "syntaxKind": "PropertySignature", "name": "autocomplete", "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", "isOptional": true, "defaultValue": "'on' for everything else" }, @@ -151970,7 +152044,7 @@ "syntaxKind": "PropertySignature", "name": "defaultValue", "value": "string", - "description": "The default value for the field.", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces this value.", "isOptional": true }, { @@ -151985,7 +152059,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -152099,7 +152173,7 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -152269,7 +152343,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -152368,7 +152442,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Content to use as the field label.", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", "isOptional": true }, { @@ -152376,7 +152450,7 @@ "syntaxKind": "PropertySignature", "name": "labelAccessibilityVisibility", "value": "'visible' | 'exclusive'", - "description": "Changes the visibility of the component's label.\n\n- `visible`: the label is visible to all users.\n- `exclusive`: the label is visually hidden but remains in the accessibility tree.", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone.\n- `exclusive`: The label is visually hidden but still announced by screen readers.", "isOptional": true, "defaultValue": "'visible'" }, @@ -152443,7 +152517,7 @@ "syntaxKind": "PropertySignature", "name": "minLength", "value": "number", - "description": "Specifies the min number of characters allowed.", + "description": "Specifies the minimum number of characters allowed.", "isOptional": true, "defaultValue": "0" }, @@ -152452,7 +152526,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -153392,7 +153466,7 @@ "syntaxKind": "PropertySignature", "name": "readOnly", "value": "boolean", - "description": "The field cannot be edited by the user. It is focusable will be announced by screen readers.", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", "isOptional": true, "defaultValue": "false" }, @@ -153443,7 +153517,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/TextArea.ts", @@ -153733,7 +153807,7 @@ "syntaxKind": "PropertySignature", "name": "autocomplete", "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", "isOptional": true, "defaultValue": "'on' for everything else" }, @@ -153742,7 +153816,7 @@ "syntaxKind": "PropertySignature", "name": "defaultValue", "value": "string", - "description": "The default value for the field.", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces this value.", "isOptional": true }, { @@ -153750,7 +153824,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -153759,7 +153833,7 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -153767,7 +153841,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -153775,7 +153849,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Content to use as the field label.", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", "isOptional": true }, { @@ -153783,7 +153857,7 @@ "syntaxKind": "PropertySignature", "name": "labelAccessibilityVisibility", "value": "'visible' | 'exclusive'", - "description": "Changes the visibility of the component's label.\n\n- `visible`: the label is visible to all users.\n- `exclusive`: the label is visually hidden but remains in the accessibility tree.", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone.\n- `exclusive`: The label is visually hidden but still announced by screen readers.", "isOptional": true, "defaultValue": "'visible'" }, @@ -153801,7 +153875,7 @@ "syntaxKind": "PropertySignature", "name": "minLength", "value": "number", - "description": "Specifies the min number of characters allowed.", + "description": "Specifies the minimum number of characters allowed.", "isOptional": true, "defaultValue": "0" }, @@ -153810,7 +153884,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -153826,7 +153900,7 @@ "syntaxKind": "PropertySignature", "name": "onChange", "value": "(event: Event) => void", - "description": "Callback when the user has **finished editing** a field, for example, once they have blurred the field.", + "description": "A callback fired when the user has **finished editing** a field, such as when they blur the field or press Enter.", "isOptional": true }, { @@ -153842,7 +153916,7 @@ "syntaxKind": "PropertySignature", "name": "onInput", "value": "(event: Event) => void", - "description": "Callback when the user makes any changes in the field.", + "description": "A callback fired when the user makes any changes in the field, such as typing a character.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).", "isOptional": true }, { @@ -153860,7 +153934,7 @@ "syntaxKind": "PropertySignature", "name": "readOnly", "value": "boolean", - "description": "The field cannot be edited by the user. It is focusable will be announced by screen readers.", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", "isOptional": true, "defaultValue": "false" }, @@ -153898,7 +153972,7 @@ "src/surfaces/checkout/components/TextField.ts": { "filePath": "src/surfaces/checkout/components/TextField.ts", "name": "TextFieldElementProps", - "description": "Properties for the TextField component element.", + "description": "", "isPublicDocs": true, "members": [ { @@ -153906,7 +153980,7 @@ "syntaxKind": "PropertySignature", "name": "autocomplete", "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", "isOptional": true, "defaultValue": "'on' for everything else" }, @@ -153915,7 +153989,7 @@ "syntaxKind": "PropertySignature", "name": "defaultValue", "value": "string", - "description": "The default value for the field.", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces this value.", "isOptional": true }, { @@ -153923,7 +153997,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -153932,7 +154006,7 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -153949,7 +154023,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -153957,7 +154031,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Content to use as the field label.", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", "isOptional": true }, { @@ -153965,7 +154039,7 @@ "syntaxKind": "PropertySignature", "name": "labelAccessibilityVisibility", "value": "'visible' | 'exclusive'", - "description": "Changes the visibility of the component's label.\n\n- `visible`: the label is visible to all users.\n- `exclusive`: the label is visually hidden but remains in the accessibility tree.", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone.\n- `exclusive`: The label is visually hidden but still announced by screen readers.", "isOptional": true, "defaultValue": "'visible'" }, @@ -153983,7 +154057,7 @@ "syntaxKind": "PropertySignature", "name": "minLength", "value": "number", - "description": "Specifies the min number of characters allowed.", + "description": "Specifies the minimum number of characters allowed.", "isOptional": true, "defaultValue": "0" }, @@ -153992,7 +154066,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -154010,7 +154084,7 @@ "syntaxKind": "PropertySignature", "name": "prefix", "value": "string", - "description": "A value to be displayed immediately before the editable portion of the field.\n\nThis is useful for displaying an implied part of the value, such as \"https://\" or \"+353\".\n\nThis cannot be edited by the user, and it isn't included in the value of the field.\n\nIt may not be displayed until the user has interacted with the input. For example, an inline label may take the place of the prefix until the user focuses the input.", + "description": "A value to be displayed immediately before the editable portion of the field.\n\nThis is useful for displaying an implied part of the value, such as \"https://\" or \"+353\".\n\nThis can't be edited by the user, and it isn't included in the value of the field.\n\nIt may not be displayed until the user has interacted with the input. For example, an inline label may take the place of the prefix until the user focuses the input.", "isOptional": true, "defaultValue": "''" }, @@ -154019,7 +154093,7 @@ "syntaxKind": "PropertySignature", "name": "readOnly", "value": "boolean", - "description": "The field cannot be edited by the user. It is focusable will be announced by screen readers.", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", "isOptional": true, "defaultValue": "false" }, @@ -154037,7 +154111,7 @@ "syntaxKind": "PropertySignature", "name": "suffix", "value": "string", - "description": "A value to be displayed immediately after the editable portion of the field.\n\nThis is useful for displaying an implied part of the value, such as \"@shopify.com\", or \"%\".\n\nThis cannot be edited by the user, and it isn't included in the value of the field.\n\nIt may not be displayed until the user has interacted with the input. For example, an inline label may take the place of the suffix until the user focuses the input.", + "description": "A value to be displayed immediately after the editable portion of the field.\n\nThis is useful for displaying an implied part of the value, such as \"@shopify.com\", or \"%\".\n\nThis can't be edited by the user, and it isn't included in the value of the field.\n\nIt may not be displayed until the user has interacted with the input. For example, an inline label may take the place of the suffix until the user focuses the input.", "isOptional": true, "defaultValue": "''" }, @@ -154073,7 +154147,7 @@ "syntaxKind": "PropertySignature", "name": "onChange", "value": "(event: Event) => void", - "description": "Callback when the user has **finished editing** a field, for example, once they have blurred the field.", + "description": "A callback fired when the user has **finished editing** a field, such as when they blur the field or press Enter.", "isOptional": true }, { @@ -154089,7 +154163,7 @@ "syntaxKind": "PropertySignature", "name": "onInput", "value": "(event: Event) => void", - "description": "Callback when the user makes any changes in the field.", + "description": "A callback fired when the user makes any changes in the field, such as typing a character.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).", "isOptional": true } ], @@ -154100,7 +154174,7 @@ "src/surfaces/checkout/components/TextField.ts": { "filePath": "src/surfaces/checkout/components/TextField.ts", "name": "TextFieldElementEvents", - "description": "Events for the TextField component element.", + "description": "", "isPublicDocs": true, "members": [ { @@ -154108,7 +154182,7 @@ "syntaxKind": "PropertySignature", "name": "blur", "value": "CallbackEventListener", - "description": "A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "description": "<<<<<<< HEAD A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n======= A callback fired when the text field loses focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) \n Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", "isOptional": true }, { @@ -154116,7 +154190,7 @@ "syntaxKind": "PropertySignature", "name": "change", "value": "CallbackEventListener", - "description": "Callback when the user has **finished editing** a field, for example, once they have blurred the field.", + "description": "<<<<<<< HEAD Callback when the user has **finished editing** a field, for example, once they have blurred the field.\n======= A callback fired when the text field value changes.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) \n Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", "isOptional": true }, { @@ -154124,7 +154198,7 @@ "syntaxKind": "PropertySignature", "name": "focus", "value": "CallbackEventListener", - "description": "A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "description": "<<<<<<< HEAD A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n======= A callback fired when the text field receives focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) \n Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", "isOptional": true }, { @@ -154132,18 +154206,18 @@ "syntaxKind": "PropertySignature", "name": "input", "value": "CallbackEventListener", - "description": "Callback when the user makes any changes in the field.", + "description": "A callback fired when the user inputs data into the text field.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).", "isOptional": true } ], - "value": "export interface TextFieldElementEvents {\n /**\n * A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event\n */\n blur?: CallbackEventListener;\n /**\n * Callback when the user has **finished editing** a field, for example, once they have blurred the field.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event\n */\n change?: CallbackEventListener;\n /**\n * A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event\n */\n focus?: CallbackEventListener;\n /**\n * Callback when the user makes any changes in the field.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event\n */\n input?: CallbackEventListener;\n}" + "value": "export interface TextFieldElementEvents {\n /**\n<<<<<<< HEAD\n * A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n=======\n * A callback fired when the text field loses focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality)\n *\n * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur?: CallbackEventListener;\n /**\n<<<<<<< HEAD\n * Callback when the user has **finished editing** a field, for example, once they have blurred the field.\n=======\n * A callback fired when the text field value changes.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality)\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change?: CallbackEventListener;\n /**\n<<<<<<< HEAD\n * A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n=======\n * A callback fired when the text field receives focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality)\n *\n * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus?: CallbackEventListener;\n /**\n * A callback fired when the user inputs data into the text field.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input?: CallbackEventListener;\n}" } }, "TextFieldElementSlots": { "src/surfaces/checkout/components/TextField.ts": { "filePath": "src/surfaces/checkout/components/TextField.ts", "name": "TextFieldElementSlots", - "description": "Slots for the TextField component element.", + "description": "", "isPublicDocs": true, "members": [ { @@ -154151,11 +154225,11 @@ "syntaxKind": "PropertySignature", "name": "accessory", "value": "HTMLElement", - "description": "Additional content to be displayed in the field. Commonly used to display an icon that activates a tooltip providing more information.", + "description": "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.", "isOptional": true } ], - "value": "export interface TextFieldElementSlots {\n /**\n * Additional content to be displayed in the field.\n * Commonly used to display an icon that activates a tooltip providing more information.\n */\n accessory?: HTMLElement;\n}" + "value": "export interface TextFieldElementSlots {\n /**\n * 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.\n */\n accessory?: HTMLElement;\n}" } }, "TextFieldElement": { @@ -154184,7 +154258,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/TextField.ts", @@ -154625,7 +154699,7 @@ "syntaxKind": "PropertySignature", "name": "autocomplete", "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", "isOptional": true, "defaultValue": "'on' for everything else" }, @@ -154816,7 +154890,7 @@ "syntaxKind": "PropertySignature", "name": "defaultValue", "value": "string", - "description": "The default value for the field.", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces this value.", "isOptional": true }, { @@ -154831,7 +154905,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -154945,7 +155019,7 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -155123,7 +155197,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -155222,7 +155296,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Content to use as the field label.", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", "isOptional": true }, { @@ -155230,7 +155304,7 @@ "syntaxKind": "PropertySignature", "name": "labelAccessibilityVisibility", "value": "'visible' | 'exclusive'", - "description": "Changes the visibility of the component's label.\n\n- `visible`: the label is visible to all users.\n- `exclusive`: the label is visually hidden but remains in the accessibility tree.", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone.\n- `exclusive`: The label is visually hidden but still announced by screen readers.", "isOptional": true, "defaultValue": "'visible'" }, @@ -155297,7 +155371,7 @@ "syntaxKind": "PropertySignature", "name": "minLength", "value": "number", - "description": "Specifies the min number of characters allowed.", + "description": "Specifies the minimum number of characters allowed.", "isOptional": true, "defaultValue": "0" }, @@ -155306,7 +155380,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -156195,7 +156269,7 @@ "syntaxKind": "PropertySignature", "name": "prefix", "value": "string", - "description": "A value to be displayed immediately before the editable portion of the field.\n\nThis is useful for displaying an implied part of the value, such as \"https://\" or \"+353\".\n\nThis cannot be edited by the user, and it isn't included in the value of the field.\n\nIt may not be displayed until the user has interacted with the input. For example, an inline label may take the place of the prefix until the user focuses the input.", + "description": "A value to be displayed immediately before the editable portion of the field.\n\nThis is useful for displaying an implied part of the value, such as \"https://\" or \"+353\".\n\nThis can't be edited by the user, and it isn't included in the value of the field.\n\nIt may not be displayed until the user has interacted with the input. For example, an inline label may take the place of the prefix until the user focuses the input.", "isOptional": true, "defaultValue": "''" }, @@ -156248,7 +156322,7 @@ "syntaxKind": "PropertySignature", "name": "readOnly", "value": "boolean", - "description": "The field cannot be edited by the user. It is focusable will be announced by screen readers.", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", "isOptional": true, "defaultValue": "false" }, @@ -156299,7 +156373,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/TextField.ts", @@ -156490,7 +156564,7 @@ "syntaxKind": "PropertySignature", "name": "suffix", "value": "string", - "description": "A value to be displayed immediately after the editable portion of the field.\n\nThis is useful for displaying an implied part of the value, such as \"@shopify.com\", or \"%\".\n\nThis cannot be edited by the user, and it isn't included in the value of the field.\n\nIt may not be displayed until the user has interacted with the input. For example, an inline label may take the place of the suffix until the user focuses the input.", + "description": "A value to be displayed immediately after the editable portion of the field.\n\nThis is useful for displaying an implied part of the value, such as \"@shopify.com\", or \"%\".\n\nThis can't be edited by the user, and it isn't included in the value of the field.\n\nIt may not be displayed until the user has interacted with the input. For example, an inline label may take the place of the suffix until the user focuses the input.", "isOptional": true, "defaultValue": "''" }, @@ -156589,7 +156663,7 @@ "syntaxKind": "PropertySignature", "name": "autocomplete", "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", "isOptional": true, "defaultValue": "'on' for everything else" }, @@ -156598,7 +156672,7 @@ "syntaxKind": "PropertySignature", "name": "defaultValue", "value": "string", - "description": "The default value for the field.", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces this value.", "isOptional": true }, { @@ -156606,7 +156680,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -156615,7 +156689,7 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -156631,7 +156705,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -156639,7 +156713,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Content to use as the field label.", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", "isOptional": true }, { @@ -156647,7 +156721,7 @@ "syntaxKind": "PropertySignature", "name": "labelAccessibilityVisibility", "value": "'visible' | 'exclusive'", - "description": "Changes the visibility of the component's label.\n\n- `visible`: the label is visible to all users.\n- `exclusive`: the label is visually hidden but remains in the accessibility tree.", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone.\n- `exclusive`: The label is visually hidden but still announced by screen readers.", "isOptional": true, "defaultValue": "'visible'" }, @@ -156665,7 +156739,7 @@ "syntaxKind": "PropertySignature", "name": "minLength", "value": "number", - "description": "Specifies the min number of characters allowed.", + "description": "Specifies the minimum number of characters allowed.", "isOptional": true, "defaultValue": "0" }, @@ -156674,7 +156748,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -156690,7 +156764,7 @@ "syntaxKind": "PropertySignature", "name": "onChange", "value": "(event: Event) => void", - "description": "Callback when the user has **finished editing** a field, for example, once they have blurred the field.", + "description": "A callback fired when the user has **finished editing** a field, such as when they blur the field or press Enter.", "isOptional": true }, { @@ -156706,7 +156780,7 @@ "syntaxKind": "PropertySignature", "name": "onInput", "value": "(event: Event) => void", - "description": "Callback when the user makes any changes in the field.", + "description": "A callback fired when the user makes any changes in the field, such as typing a character.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).", "isOptional": true }, { @@ -156724,7 +156798,7 @@ "syntaxKind": "PropertySignature", "name": "prefix", "value": "string", - "description": "A value to be displayed immediately before the editable portion of the field.\n\nThis is useful for displaying an implied part of the value, such as \"https://\" or \"+353\".\n\nThis cannot be edited by the user, and it isn't included in the value of the field.\n\nIt may not be displayed until the user has interacted with the input. For example, an inline label may take the place of the prefix until the user focuses the input.", + "description": "A value to be displayed immediately before the editable portion of the field.\n\nThis is useful for displaying an implied part of the value, such as \"https://\" or \"+353\".\n\nThis can't be edited by the user, and it isn't included in the value of the field.\n\nIt may not be displayed until the user has interacted with the input. For example, an inline label may take the place of the prefix until the user focuses the input.", "isOptional": true, "defaultValue": "''" }, @@ -156733,7 +156807,7 @@ "syntaxKind": "PropertySignature", "name": "readOnly", "value": "boolean", - "description": "The field cannot be edited by the user. It is focusable will be announced by screen readers.", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", "isOptional": true, "defaultValue": "false" }, @@ -156751,7 +156825,7 @@ "syntaxKind": "PropertySignature", "name": "suffix", "value": "string", - "description": "A value to be displayed immediately after the editable portion of the field.\n\nThis is useful for displaying an implied part of the value, such as \"@shopify.com\", or \"%\".\n\nThis cannot be edited by the user, and it isn't included in the value of the field.\n\nIt may not be displayed until the user has interacted with the input. For example, an inline label may take the place of the suffix until the user focuses the input.", + "description": "A value to be displayed immediately after the editable portion of the field.\n\nThis is useful for displaying an implied part of the value, such as \"@shopify.com\", or \"%\".\n\nThis can't be edited by the user, and it isn't included in the value of the field.\n\nIt may not be displayed until the user has interacted with the input. For example, an inline label may take the place of the suffix until the user focuses the input.", "isOptional": true, "defaultValue": "''" }, @@ -156771,7 +156845,7 @@ "src/surfaces/checkout/components/Time.ts": { "filePath": "src/surfaces/checkout/components/Time.ts", "name": "TimeElementProps", - "description": "Represents a specific point or duration in time. Use to display dates, times, or durations clearly and consistently. May include a machine-readable `datetime` attribute for improved accessibility and functionality.", + "description": "", "isPublicDocs": true, "members": [ { @@ -156779,7 +156853,7 @@ "syntaxKind": "PropertySignature", "name": "dateTime", "value": "string", - "description": "Set the time and/or date of the element.\n\nIt must be a [valid date string](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/time#valid_datetime_values).", + "description": "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.\n\nThe 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`.", "isOptional": true, "defaultValue": "''" }, @@ -156788,7 +156862,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true } ], @@ -156821,7 +156895,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/Time.ts", @@ -157444,7 +157518,7 @@ "syntaxKind": "PropertySignature", "name": "dateTime", "value": "string", - "description": "Set the time and/or date of the element.\n\nIt must be a [valid date string](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/time#valid_datetime_values).", + "description": "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.\n\nThe 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`.", "isOptional": true, "defaultValue": "''" }, @@ -157727,7 +157801,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -158839,7 +158913,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/Time.ts", @@ -159103,7 +159177,7 @@ "syntaxKind": "PropertySignature", "name": "dateTime", "value": "string", - "description": "Set the time and/or date of the element.\n\nIt must be a [valid date string](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/time#valid_datetime_values).", + "description": "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.\n\nThe 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`.", "isOptional": true, "defaultValue": "''" }, @@ -159112,7 +159186,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true } ], @@ -159123,7 +159197,7 @@ "src/surfaces/checkout/components/Tooltip.ts": { "filePath": "src/surfaces/checkout/components/Tooltip.ts", "name": "TooltipElementProps", - "description": "Properties for the Tooltip component element.", + "description": "", "isPublicDocs": true, "members": [ { @@ -159131,7 +159205,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true } ], @@ -159150,7 +159224,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true } ], @@ -159161,7 +159235,7 @@ "src/surfaces/checkout/components/Tooltip.ts": { "filePath": "src/surfaces/checkout/components/Tooltip.ts", "name": "TooltipProps", - "description": "The properties for the tooltip component when it's used in JSX.", + "description": "", "isPublicDocs": true, "members": [ { @@ -159169,7 +159243,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true } ], @@ -159180,7 +159254,7 @@ "src/surfaces/checkout/components/UnorderedList.ts": { "filePath": "src/surfaces/checkout/components/UnorderedList.ts", "name": "UnorderedListElementProps", - "description": "Properties for the UnorderedList component element.", + "description": "", "isPublicDocs": true, "members": [ { @@ -159188,7 +159262,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true } ], @@ -159221,7 +159295,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/UnorderedList.ts", @@ -160118,7 +160192,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -161230,7 +161304,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/UnorderedList.ts", @@ -161494,7 +161568,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true } ], @@ -161505,7 +161579,7 @@ "src/surfaces/checkout/components/UrlField.ts": { "filePath": "src/surfaces/checkout/components/UrlField.ts", "name": "URLFieldElementProps", - "description": "The URL field component collects URLs from users with built-in formatting and validation. Use URL field for website addresses, link destinations, or any URL input to provide URL-specific keyboard layouts and automatic validation.\n\nURL fields support protocol prefixing, validation, and help text to guide users toward entering properly formatted web addresses. For general text input, use [text field](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/forms/text-field).", + "description": "", "isPublicDocs": true, "members": [ { @@ -161513,7 +161587,7 @@ "syntaxKind": "PropertySignature", "name": "autocomplete", "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", "isOptional": true, "defaultValue": "'on' for everything else" }, @@ -161522,7 +161596,7 @@ "syntaxKind": "PropertySignature", "name": "defaultValue", "value": "string", - "description": "The default value for the field.", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces this value.", "isOptional": true }, { @@ -161530,7 +161604,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -161539,7 +161613,7 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -161547,7 +161621,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -161555,7 +161629,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Content to use as the field label.", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", "isOptional": true }, { @@ -161563,7 +161637,7 @@ "syntaxKind": "PropertySignature", "name": "labelAccessibilityVisibility", "value": "'visible' | 'exclusive'", - "description": "Changes the visibility of the component's label.\n\n- `visible`: the label is visible to all users.\n- `exclusive`: the label is visually hidden but remains in the accessibility tree.", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone.\n- `exclusive`: The label is visually hidden but still announced by screen readers.", "isOptional": true, "defaultValue": "'visible'" }, @@ -161581,7 +161655,7 @@ "syntaxKind": "PropertySignature", "name": "minLength", "value": "number", - "description": "Specifies the min number of characters allowed.", + "description": "Specifies the minimum number of characters allowed.", "isOptional": true, "defaultValue": "0" }, @@ -161590,7 +161664,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -161598,7 +161672,7 @@ "syntaxKind": "PropertySignature", "name": "readOnly", "value": "boolean", - "description": "The field cannot be edited by the user. It is focusable will be announced by screen readers.", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", "isOptional": true, "defaultValue": "false" }, @@ -161643,7 +161717,7 @@ "syntaxKind": "PropertySignature", "name": "onChange", "value": "(event: Event) => void", - "description": "Callback when the user has **finished editing** a field, for example, once they have blurred the field.", + "description": "A callback fired when the user has **finished editing** a field, such as when they blur the field or press Enter.", "isOptional": true }, { @@ -161659,7 +161733,7 @@ "syntaxKind": "PropertySignature", "name": "onInput", "value": "(event: Event) => void", - "description": "Callback when the user makes any changes in the field.", + "description": "A callback fired when the user makes any changes in the field, such as typing a character.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).", "isOptional": true } ], @@ -161670,7 +161744,7 @@ "src/surfaces/checkout/components/UrlField.ts": { "filePath": "src/surfaces/checkout/components/UrlField.ts", "name": "URLFieldElementEvents", - "description": "Learn more about [registering events](/docs/api/checkout-ui-extensions/latest/using-polaris-components#event-handling).", + "description": "", "isPublicDocs": true, "members": [ { @@ -161678,7 +161752,7 @@ "syntaxKind": "PropertySignature", "name": "blur", "value": "CallbackEventListener", - "description": "A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "description": "A callback fired when the URL field loses focus.\n\nLearn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", "isOptional": true }, { @@ -161686,7 +161760,7 @@ "syntaxKind": "PropertySignature", "name": "change", "value": "CallbackEventListener", - "description": "Callback when the user has **finished editing** a field, for example, once they have blurred the field.", + "description": "A callback fired when the URL field value changes.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", "isOptional": true }, { @@ -161694,7 +161768,7 @@ "syntaxKind": "PropertySignature", "name": "focus", "value": "CallbackEventListener", - "description": "A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "description": "A callback fired when the URL field receives focus.\n\nLearn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", "isOptional": true }, { @@ -161702,18 +161776,18 @@ "syntaxKind": "PropertySignature", "name": "input", "value": "CallbackEventListener", - "description": "Callback when the user makes any changes in the field.", + "description": "A callback fired when the user inputs data into the URL field.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).", "isOptional": true } ], - "value": "export interface URLFieldElementEvents {\n /**\n * A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event\n */\n blur?: CallbackEventListener;\n /**\n * Callback when the user has **finished editing** a field, for example, once they have blurred the field.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event\n */\n change?: CallbackEventListener;\n /**\n * A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event\n */\n focus?: CallbackEventListener;\n /**\n * Callback when the user makes any changes in the field.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event\n */\n input?: CallbackEventListener;\n}" + "value": "export interface URLFieldElementEvents {\n /**\n * A callback fired when the URL field loses focus.\n *\n * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur?: CallbackEventListener;\n /**\n * A callback fired when the URL field value changes.\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change?: CallbackEventListener;\n /**\n * A callback fired when the URL field receives focus.\n *\n * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus?: CallbackEventListener;\n /**\n * A callback fired when the user inputs data into the URL field.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input?: CallbackEventListener;\n}" } }, "URLFieldElementSlots": { "src/surfaces/checkout/components/UrlField.ts": { "filePath": "src/surfaces/checkout/components/UrlField.ts", "name": "URLFieldElementSlots", - "description": "Learn more about [component slots](/docs/api/checkout-ui-extensions/latest/using-polaris-components#slots).", + "description": "", "isPublicDocs": true, "members": [ { @@ -161721,11 +161795,11 @@ "syntaxKind": "PropertySignature", "name": "accessory", "value": "HTMLElement", - "description": "Additional content to be displayed in the field. Commonly used to display an icon that activates a tooltip providing more information.", + "description": "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.", "isOptional": true } ], - "value": "export interface URLFieldElementSlots {\n /**\n * Additional content to be displayed in the field.\n * Commonly used to display an icon that activates a tooltip providing more information.\n */\n accessory?: HTMLElement;\n}" + "value": "export interface URLFieldElementSlots {\n /**\n * 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.\n */\n accessory?: HTMLElement;\n}" } }, "UrlFieldElement": { @@ -161754,7 +161828,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/UrlField.ts", @@ -162195,7 +162269,7 @@ "syntaxKind": "PropertySignature", "name": "autocomplete", "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", "isOptional": true, "defaultValue": "'on' for everything else" }, @@ -162386,7 +162460,7 @@ "syntaxKind": "PropertySignature", "name": "defaultValue", "value": "string", - "description": "The default value for the field.", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces this value.", "isOptional": true }, { @@ -162401,7 +162475,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -162515,7 +162589,7 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -162685,7 +162759,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -162784,7 +162858,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Content to use as the field label.", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", "isOptional": true }, { @@ -162792,7 +162866,7 @@ "syntaxKind": "PropertySignature", "name": "labelAccessibilityVisibility", "value": "'visible' | 'exclusive'", - "description": "Changes the visibility of the component's label.\n\n- `visible`: the label is visible to all users.\n- `exclusive`: the label is visually hidden but remains in the accessibility tree.", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone.\n- `exclusive`: The label is visually hidden but still announced by screen readers.", "isOptional": true, "defaultValue": "'visible'" }, @@ -162859,7 +162933,7 @@ "syntaxKind": "PropertySignature", "name": "minLength", "value": "number", - "description": "Specifies the min number of characters allowed.", + "description": "Specifies the minimum number of characters allowed.", "isOptional": true, "defaultValue": "0" }, @@ -162868,7 +162942,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -163791,7 +163865,7 @@ "syntaxKind": "PropertySignature", "name": "readOnly", "value": "boolean", - "description": "The field cannot be edited by the user. It is focusable will be announced by screen readers.", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", "isOptional": true, "defaultValue": "false" }, @@ -163842,7 +163916,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/UrlField.ts", @@ -164123,7 +164197,7 @@ "syntaxKind": "PropertySignature", "name": "autocomplete", "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", "isOptional": true, "defaultValue": "'on' for everything else" }, @@ -164132,7 +164206,7 @@ "syntaxKind": "PropertySignature", "name": "defaultValue", "value": "string", - "description": "The default value for the field.", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces this value.", "isOptional": true }, { @@ -164140,7 +164214,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -164149,7 +164223,7 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -164157,7 +164231,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -164165,7 +164239,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Content to use as the field label.", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", "isOptional": true }, { @@ -164173,7 +164247,7 @@ "syntaxKind": "PropertySignature", "name": "labelAccessibilityVisibility", "value": "'visible' | 'exclusive'", - "description": "Changes the visibility of the component's label.\n\n- `visible`: the label is visible to all users.\n- `exclusive`: the label is visually hidden but remains in the accessibility tree.", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone.\n- `exclusive`: The label is visually hidden but still announced by screen readers.", "isOptional": true, "defaultValue": "'visible'" }, @@ -164191,7 +164265,7 @@ "syntaxKind": "PropertySignature", "name": "minLength", "value": "number", - "description": "Specifies the min number of characters allowed.", + "description": "Specifies the minimum number of characters allowed.", "isOptional": true, "defaultValue": "0" }, @@ -164200,7 +164274,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -164216,7 +164290,7 @@ "syntaxKind": "PropertySignature", "name": "onChange", "value": "(event: Event) => void", - "description": "Callback when the user has **finished editing** a field, for example, once they have blurred the field.", + "description": "A callback fired when the user has **finished editing** a field, such as when they blur the field or press Enter.", "isOptional": true }, { @@ -164232,7 +164306,7 @@ "syntaxKind": "PropertySignature", "name": "onInput", "value": "(event: Event) => void", - "description": "Callback when the user makes any changes in the field.", + "description": "A callback fired when the user makes any changes in the field, such as typing a character.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).", "isOptional": true }, { @@ -164240,7 +164314,7 @@ "syntaxKind": "PropertySignature", "name": "readOnly", "value": "boolean", - "description": "The field cannot be edited by the user. It is focusable will be announced by screen readers.", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", "isOptional": true, "defaultValue": "false" }, @@ -164435,7 +164509,7 @@ "syntaxKind": "PropertySignature", "name": "onAfterToggle", "value": "(event: ToggleEvent$1) => void", - "description": "A callback fired when the element state changes, after any toggle animations have finished.\n\n- If the element transitioned from hidden to showing, the `oldState` property will be set to `closed` and the `newState` property will be set to `open`.\n- If the element transitioned from showing to hidden, the `oldState` property will be set to `open` and the `newState` will be `closed`.\n\nLearn more about [ToggleEvent.newState](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/newState) and [ToggleEvent.oldState](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/oldState).", + "description": "A callback fired when the element state changes, after any toggle animations have finished.\n\n- If the element transitioned from hidden to showing, the `oldState` property will be set to `closed` and the `newState` property will be set to `open`.\n- If the element transitioned from showing to hidden, the `oldState` property will be set to `open` and the `newState` will be `closed`.\n\nLearn more about [`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).", "isOptional": true }, { @@ -164443,11 +164517,11 @@ "syntaxKind": "PropertySignature", "name": "onToggle", "value": "(event: ToggleEvent$1) => void", - "description": "A callback fired immediately when the element state changes, before any animations.\n\n- If the element is transitioning from hidden to showing, the `oldState` property will be set to `closed` and the `newState` property will be set to `open`.\n- If the element is transitioning from showing to hidden, then `oldState` property will be set to `open` and the `newState` will be `closed`.\n\nLearn more about the [toggle event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/toggle_event), [ToggleEvent.newState](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/newState), and [ToggleEvent.oldState](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/oldState).", + "description": "A callback fired immediately when the element state changes, before any animations.\n\n- If the element is transitioning from hidden to showing, the `oldState` property will be set to `closed` and the `newState` property will be set to `open`.\n- If the element is transitioning from showing to hidden, then the `oldState` property will be set to `open` and the `newState` will be `closed`.\n\nLearn more about the [`toggle` event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/toggle_event), [`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).", "isOptional": true } ], - "value": "export interface ToggleEventProps {\n\t/**\n\t * A callback fired when the element state changes, after any toggle animations have finished.\n\t *\n\t * - If the element transitioned from hidden to showing, the `oldState` property will be set to `closed` and the\n\t * `newState` property will be set to `open`.\n\t * - If the element transitioned from showing to hidden, the `oldState` property will be set to `open` and the\n\t * `newState` will be `closed`.\n\t *\n\t * Learn more about [ToggleEvent.newState](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/newState) and [ToggleEvent.oldState](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/oldState).\n\t */\n\tonAfterToggle?: (event: ToggleEvent$1) => void;\n\t/**\n\t * A callback fired immediately when the element state changes, before any animations.\n\t *\n\t * - If the element is transitioning from hidden to showing, the `oldState` property will be set to `closed` and the\n\t * `newState` property will be set to `open`.\n\t * - If the element is transitioning from showing to hidden, then `oldState` property will be set to `open` and the\n\t * `newState` will be `closed`.\n\t *\n\t * Learn more about the [toggle event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/toggle_event), [ToggleEvent.newState](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/newState), and [ToggleEvent.oldState](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/oldState).\n\t */\n\tonToggle?: (event: ToggleEvent$1) => void;\n}" + "value": "export interface ToggleEventProps {\n\t/**\n\t * A callback fired when the element state changes, after any toggle animations have finished.\n\t *\n\t * - If the element transitioned from hidden to showing, the `oldState` property will be set to `closed` and the\n\t * `newState` property will be set to `open`.\n\t * - If the element transitioned from showing to hidden, the `oldState` property will be set to `open` and the\n\t * `newState` will be `closed`.\n\t *\n\t * Learn more about [`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).\n\t */\n\tonAfterToggle?: (event: ToggleEvent$1) => void;\n\t/**\n\t * A callback fired immediately when the element state changes, before any animations.\n\t *\n\t * - If the element is transitioning from hidden to showing, the `oldState` property will be set to `closed` and the\n\t * `newState` property will be set to `open`.\n\t * - If the element is transitioning from showing to hidden, then the `oldState` property will be set to `open` and the\n\t * `newState` will be `closed`.\n\t *\n\t * Learn more about the [`toggle` event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/toggle_event), [`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).\n\t */\n\tonToggle?: (event: ToggleEvent$1) => void;\n}" } }, "ExtendableEvent": { @@ -164739,12 +164813,12 @@ "syntaxKind": "PropertySignature", "name": "accessibilityRole", "value": "AccessibilityRole", - "description": "Sets the semantic meaning of the component’s content. When set, the role will be used by assistive technologies to help users navigate the page.", + "description": "The semantic meaning of the component’s content. When set, assistive technologies use this role to help users navigate the page.", "isOptional": true, "defaultValue": "'generic'" } ], - "value": "export interface AccessibilityRoleProps {\n\t/**\n\t * Sets the semantic meaning of the component’s content. When set,\n\t * the role will be used by assistive technologies to help users\n\t * navigate the page.\n\t *\n\t * @implementation Although, in HTML hosts, this property changes the element used,\n\t * changing this property must not impact the visual styling of inside or outside of the box.\n\t *\n\t * @default 'generic'\n\t */\n\taccessibilityRole?: AccessibilityRole;\n}" + "value": "export interface AccessibilityRoleProps {\n\t/**\n\t * The semantic meaning of the component’s content. When set, assistive technologies use this role to help users navigate the page.\n\t *\n\t * @default 'generic'\n\t */\n\taccessibilityRole?: AccessibilityRole;\n}" } }, "AccessibilityVisibilityProps": { @@ -165026,12 +165100,12 @@ "syntaxKind": "PropertySignature", "name": "overflow", "value": "'hidden' | 'visible'", - "description": "Sets the overflow behavior of the element.\n\n- `hidden`: clips the content when it is larger than the element’s container. The element will not be scrollable and the users will not be able to access the clipped content by dragging or using a scroll wheel on a mouse.\n- `visible`: the content that extends beyond the element’s container is visible.", + "description": "The overflow behavior of the element.\n\n- `visible`: Content that extends beyond the container is visible.\n- `hidden`: Content that extends beyond the container is clipped and not scrollable.", "isOptional": true, "defaultValue": "'visible'" } ], - "value": "export interface OverflowProps {\n\t/**\n\t * Sets the overflow behavior of the element.\n\t *\n\t * - `hidden`: clips the content when it is larger than the element’s container.\n\t * The element will not be scrollable and the users will not be able\n\t * to access the clipped content by dragging or using a scroll wheel on a mouse.\n\t * - `visible`: the content that extends beyond the element’s container is visible.\n\t *\n\t * @default 'visible'\n\t */\n\toverflow?: \"hidden\" | \"visible\";\n}" + "value": "export interface OverflowProps {\n\t/**\n\t * The overflow behavior of the element.\n\t *\n\t * - `visible`: Content that extends beyond the container is visible.\n\t * - `hidden`: Content that extends beyond the container is clipped and not scrollable.\n\t *\n\t * @default 'visible'\n\t */\n\toverflow?: \"hidden\" | \"visible\";\n}" } }, "BaseBoxProps": { @@ -165200,7 +165274,7 @@ "syntaxKind": "PropertySignature", "name": "overflow", "value": "'hidden' | 'visible'", - "description": "Sets the overflow behavior of the element.\n\n- `hidden`: clips the content when it is larger than the element’s container. The element will not be scrollable and the users will not be able to access the clipped content by dragging or using a scroll wheel on a mouse.\n- `visible`: the content that extends beyond the element’s container is visible.", + "description": "The overflow behavior of the element.\n\n- `visible`: Content that extends beyond the container is visible.\n- `hidden`: Content that extends beyond the container is clipped and not scrollable.", "isOptional": true, "defaultValue": "'visible'" }, @@ -165291,7 +165365,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityRole", "value": "AccessibilityRole", - "description": "Sets the semantic meaning of the component’s content. When set, the role will be used by assistive technologies to help users navigate the page.", + "description": "The semantic meaning of the component’s content. When set, assistive technologies use this role to help users navigate the page.", "isOptional": true, "defaultValue": "'generic'" }, @@ -165446,7 +165520,7 @@ "syntaxKind": "PropertySignature", "name": "overflow", "value": "'hidden' | 'visible'", - "description": "Sets the overflow behavior of the element.\n\n- `hidden`: clips the content when it is larger than the element’s container. The element will not be scrollable and the users will not be able to access the clipped content by dragging or using a scroll wheel on a mouse.\n- `visible`: the content that extends beyond the element’s container is visible.", + "description": "The overflow behavior of the element.\n\n- `visible`: Content that extends beyond the container is visible.\n- `hidden`: Content that extends beyond the container is clipped and not scrollable.", "isOptional": true, "defaultValue": "'visible'" }, @@ -165529,7 +165603,7 @@ "syntaxKind": "PropertySignature", "name": "command", "value": "'--auto' | '--show' | '--hide' | '--toggle' | '--copy'", - "description": "Sets the action the `commandFor` should take when this clickable is activated.\n\nSee the documentation of particular components for the actions they support.\n\n- `--auto`: a default action for the target component.\n- `--show`: shows the target component.\n- `--hide`: hides the target component.\n- `--toggle`: toggles the target component.\n- `--copy`: copies the target ClipboardItem.", + "description": "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).\n\nSee the documentation of particular components for the actions they support.\n\n- `--auto`: a default action for the target component.\n- `--show`: shows the target component.\n- `--hide`: hides the target component.\n- `--toggle`: toggles the target component.\n- `--copy`: copies the target ClipboardItem.", "isOptional": true, "defaultValue": "'--auto'" }, @@ -165538,7 +165612,7 @@ "syntaxKind": "PropertySignature", "name": "commandFor", "value": "string", - "description": "ID of a component that should respond to activations (such as clicks) on this component.\n\nSee `command` for how to control the behavior of the target.", + "description": "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).", "isOptional": true }, { @@ -165555,7 +165629,7 @@ "syntaxKind": "PropertySignature", "name": "interestFor", "value": "string", - "description": "The ID of the component to show when users hover over or focus on this component. Pair with a target component that supports interest-based interactions. Learn more about the [interestFor attribute](https://open-ui.org/components/interest-invokers.explainer/#the-pitch-in-code).", + "description": "The ID of the component to show when users hover over or focus on this component. Use this to connect interactive components to popovers or tooltips that provide additional context or information.", "isOptional": true }, { @@ -165616,7 +165690,7 @@ "syntaxKind": "PropertySignature", "name": "command", "value": "'--auto' | '--show' | '--hide' | '--toggle' | '--copy'", - "description": "Sets the action the `commandFor` should take when this clickable is activated.\n\nSee the documentation of particular components for the actions they support.\n\n- `--auto`: a default action for the target component.\n- `--show`: shows the target component.\n- `--hide`: hides the target component.\n- `--toggle`: toggles the target component.\n- `--copy`: copies the target ClipboardItem.", + "description": "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).\n\nSee the documentation of particular components for the actions they support.\n\n- `--auto`: a default action for the target component.\n- `--show`: shows the target component.\n- `--hide`: hides the target component.\n- `--toggle`: toggles the target component.\n- `--copy`: copies the target ClipboardItem.", "isOptional": true, "defaultValue": "'--auto'" }, @@ -165625,7 +165699,7 @@ "syntaxKind": "PropertySignature", "name": "commandFor", "value": "string", - "description": "ID of a component that should respond to activations (such as clicks) on this component.\n\nSee `command` for how to control the behavior of the target.", + "description": "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).", "isOptional": true }, { @@ -165649,7 +165723,7 @@ "syntaxKind": "PropertySignature", "name": "interestFor", "value": "string", - "description": "The ID of the component to show when users hover over or focus on this component. Pair with a target component that supports interest-based interactions. Learn more about the [interestFor attribute](https://open-ui.org/components/interest-invokers.explainer/#the-pitch-in-code).", + "description": "The ID of the component to show when users hover over or focus on this component. Use this to connect interactive components to popovers or tooltips that provide additional context or information.", "isOptional": true }, { @@ -165701,7 +165775,7 @@ "syntaxKind": "PropertySignature", "name": "command", "value": "'--auto' | '--show' | '--hide' | '--toggle' | '--copy'", - "description": "Sets the action the `commandFor` should take when this clickable is activated.\n\nSee the documentation of particular components for the actions they support.\n\n- `--auto`: a default action for the target component.\n- `--show`: shows the target component.\n- `--hide`: hides the target component.\n- `--toggle`: toggles the target component.\n- `--copy`: copies the target ClipboardItem.", + "description": "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).\n\nSee the documentation of particular components for the actions they support.\n\n- `--auto`: a default action for the target component.\n- `--show`: shows the target component.\n- `--hide`: hides the target component.\n- `--toggle`: toggles the target component.\n- `--copy`: copies the target ClipboardItem.", "isOptional": true, "defaultValue": "'--auto'" }, @@ -165710,7 +165784,7 @@ "syntaxKind": "PropertySignature", "name": "commandFor", "value": "string", - "description": "ID of a component that should respond to activations (such as clicks) on this component.\n\nSee `command` for how to control the behavior of the target.", + "description": "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).", "isOptional": true }, { @@ -165718,11 +165792,11 @@ "syntaxKind": "PropertySignature", "name": "interestFor", "value": "string", - "description": "The ID of the component to show when users hover over or focus on this component. Pair with a target component that supports interest-based interactions. Learn more about the [interestFor attribute](https://open-ui.org/components/interest-invokers.explainer/#the-pitch-in-code).", + "description": "The ID of the component to show when users hover over or focus on this component. Use this to connect interactive components to popovers or tooltips that provide additional context or information.", "isOptional": true } ], - "value": "export interface InteractionProps {\n\t/**\n\t * ID of a component that should respond to activations (such as clicks) on this component.\n\t *\n\t * See `command` for how to control the behavior of the target.\n\t *\n\t * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#commandfor\n\t */\n\tcommandFor?: string;\n\t/**\n\t * Sets the action the `commandFor` should take when this clickable is activated.\n\t *\n\t * See the documentation of particular components for the actions they support.\n\t *\n\t * - `--auto`: a default action for the target component.\n\t * - `--show`: shows the target component.\n\t * - `--hide`: hides the target component.\n\t * - `--toggle`: toggles the target component.\n\t * - `--copy`: copies the target ClipboardItem.\n\t *\n\t * @default '--auto'\n\t *\n\t * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command\n\t */\n\tcommand?: \"--auto\" | \"--show\" | \"--hide\" | \"--toggle\" | \"--copy\";\n\t/**\n\t * The ID of the component to show when users hover over or focus on this component. Pair with a target component that supports interest-based interactions. Learn more about the [interestFor attribute](https://open-ui.org/components/interest-invokers.explainer/#the-pitch-in-code).\n\t */\n\tinterestFor?: string;\n}" + "value": "export interface InteractionProps {\n\t/**\n\t * 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).\n\t */\n\tcommandFor?: string;\n\t/**\n\t * 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).\n\t *\n\t * See the documentation of particular components for the actions they support.\n\t *\n\t * - `--auto`: a default action for the target component.\n\t * - `--show`: shows the target component.\n\t * - `--hide`: hides the target component.\n\t * - `--toggle`: toggles the target component.\n\t * - `--copy`: copies the target ClipboardItem.\n\t *\n\t * @default '--auto'\n\t */\n\tcommand?: \"--auto\" | \"--show\" | \"--hide\" | \"--toggle\" | \"--copy\";\n\t/**\n\t * The ID of the component to show when users hover over or focus on this component. Use this to connect interactive components to popovers or tooltips that provide additional context or information.\n\t */\n\tinterestFor?: string;\n}" } }, "BaseClickableProps": { @@ -165737,7 +165811,7 @@ "syntaxKind": "PropertySignature", "name": "command", "value": "'--auto' | '--show' | '--hide' | '--toggle' | '--copy'", - "description": "Sets the action the `commandFor` should take when this clickable is activated.\n\nSee the documentation of particular components for the actions they support.\n\n- `--auto`: a default action for the target component.\n- `--show`: shows the target component.\n- `--hide`: hides the target component.\n- `--toggle`: toggles the target component.\n- `--copy`: copies the target ClipboardItem.", + "description": "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).\n\nSee the documentation of particular components for the actions they support.\n\n- `--auto`: a default action for the target component.\n- `--show`: shows the target component.\n- `--hide`: hides the target component.\n- `--toggle`: toggles the target component.\n- `--copy`: copies the target ClipboardItem.", "isOptional": true, "defaultValue": "'--auto'" }, @@ -165746,7 +165820,7 @@ "syntaxKind": "PropertySignature", "name": "commandFor", "value": "string", - "description": "ID of a component that should respond to activations (such as clicks) on this component.\n\nSee `command` for how to control the behavior of the target.", + "description": "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).", "isOptional": true }, { @@ -165779,7 +165853,7 @@ "syntaxKind": "PropertySignature", "name": "interestFor", "value": "string", - "description": "The ID of the component to show when users hover over or focus on this component. Pair with a target component that supports interest-based interactions. Learn more about the [interestFor attribute](https://open-ui.org/components/interest-invokers.explainer/#the-pitch-in-code).", + "description": "The ID of the component to show when users hover over or focus on this component. Use this to connect interactive components to popovers or tooltips that provide additional context or information.", "isOptional": true }, { @@ -165970,11 +166044,11 @@ "syntaxKind": "PropertySignature", "name": "values", "value": "string[]", - "description": "An array of the `value`s of the selected options.\n\nThis is a convenience prop for setting the `selected` prop on child options.", + "description": "An array of `value` attributes for the currently selected options.\n\nThis is a convenience prop for setting the `selected` prop on child options.", "isOptional": true } ], - "value": "export interface MultipleInputProps extends BaseInputProps {\n\t/**\n\t * Callback when the user has selected option(s).\n\t *\n\t * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event\n\t */\n\tonChange?: (event: Event) => void;\n\t/**\n\t * Callback when the user has selected option(s).\n\t *\n\t * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event\n\t */\n\tonInput?: (event: Event) => void;\n\t/**\n\t * An array of the `value`s of the selected options.\n\t *\n\t * This is a convenience prop for setting the `selected` prop on child options.\n\t */\n\tvalues?: string[];\n}" + "value": "export interface MultipleInputProps extends BaseInputProps {\n\t/**\n\t * Callback when the user has selected option(s).\n\t *\n\t * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event\n\t */\n\tonChange?: (event: Event) => void;\n\t/**\n\t * Callback when the user has selected option(s).\n\t *\n\t * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event\n\t */\n\tonInput?: (event: Event) => void;\n\t/**\n\t * An array of `value` attributes for the currently selected options.\n\t *\n\t * This is a convenience prop for setting the `selected` prop on child options.\n\t */\n\tvalues?: string[];\n}" } }, "FileInputProps": { @@ -166624,7 +166698,7 @@ "syntaxKind": "PropertySignature", "name": "command", "value": "'--auto' | '--show' | '--hide' | '--toggle' | '--copy'", - "description": "Sets the action the `commandFor` should take when this clickable is activated.\n\nSee the documentation of particular components for the actions they support.\n\n- `--auto`: a default action for the target component.\n- `--show`: shows the target component.\n- `--hide`: hides the target component.\n- `--toggle`: toggles the target component.\n- `--copy`: copies the target ClipboardItem.", + "description": "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).\n\nSee the documentation of particular components for the actions they support.\n\n- `--auto`: a default action for the target component.\n- `--show`: shows the target component.\n- `--hide`: hides the target component.\n- `--toggle`: toggles the target component.\n- `--copy`: copies the target ClipboardItem.", "isOptional": true, "defaultValue": "'--auto'" }, @@ -166633,7 +166707,7 @@ "syntaxKind": "PropertySignature", "name": "commandFor", "value": "string", - "description": "ID of a component that should respond to activations (such as clicks) on this component.\n\nSee `command` for how to control the behavior of the target.", + "description": "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).", "isOptional": true }, { @@ -166659,7 +166733,7 @@ "syntaxKind": "PropertySignature", "name": "interestFor", "value": "string", - "description": "The ID of the component to show when users hover over or focus on this component. Pair with a target component that supports interest-based interactions. Learn more about the [interestFor attribute](https://open-ui.org/components/interest-invokers.explainer/#the-pitch-in-code).", + "description": "The ID of the component to show when users hover over or focus on this component. Use this to connect interactive components to popovers or tooltips that provide additional context or information.", "isOptional": true }, { @@ -166775,6 +166849,16 @@ "isPublicDocs": true } }, + "ConsentPolicy": { + "src/surfaces/checkout/components/components.ts": { + "filePath": "src/surfaces/checkout/components/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "ConsentPolicy", + "value": "\"sms-marketing\"", + "description": "", + "isPublicDocs": true + } + }, "PhoneAutocompleteField": { "src/surfaces/checkout/components/components.ts": { "filePath": "src/surfaces/checkout/components/components.ts", @@ -167267,7 +167351,7 @@ "src/surfaces/checkout/preact/api.ts": { "filePath": "src/surfaces/checkout/preact/api.ts", "name": "UseApiGeneratedType", - "description": "Returns the full API object that was passed in to your extension when it was created. Depending on the extension target, this object can contain different properties.\n\nFor example, the `purchase.checkout.cart-line-item.render-after` extension target will return the [CartLineDetailsApi](https://shopify.dev/docs/api/checkout-ui-extensions/apis/cartlinedetailsapi) object. Other targets may only have access to the [StandardApi](https://shopify.dev/docs/api/checkout-ui-extensions/apis/standardapi) object, which contains a basic set of properties about the checkout.\n\nFor a full list of the API available to each extension target, see the [ExtensionTargets type](https://shopify.dev/docs/api/checkout-ui-extensions/apis/extensiontargets).\n\n> Note: > As of version 2025-10, you no longer need this hook. The full API object is accessible via > the global `shopify` object.", + "description": "Returns the full API object that was passed in to your extension when it was created. Depending on the extension target, this object can contain different properties.\n\nFor example, the `purchase.checkout.cart-line-item.render-after` extension target will return the [CartLineDetailsApi](/docs/api/checkout-ui-extensions/apis/cartlinedetailsapi) object. Other targets may only have access to the [StandardApi](/docs/api/checkout-ui-extensions/apis/standardapi) object, which contains a basic set of properties about the checkout.\n\nFor a full list of the API available to each extension target, see the [ExtensionTargets type](/docs/api/checkout-ui-extensions/apis/extensiontargets).\n\n> Note: > As of version 2025-10, you no longer need this hook. The full API object is accessible via > the global `shopify` object.", "isPublicDocs": true, "params": [ { @@ -167291,7 +167375,7 @@ "src/surfaces/checkout/preact/api.ts": { "filePath": "src/surfaces/checkout/preact/api.ts", "name": "UseExtensionApiGeneratedType", - "description": "Returns the full API object that was passed in to your extension when it was created. Depending on the extension target, this object can contain different properties.\n\nFor example, the `purchase.checkout.cart-line-item.render-after` extension target will return the [CartLineDetailsApi](https://shopify.dev/docs/api/checkout-ui-extensions/apis/cartlinedetailsapi) object. Other targets may only have access to the [StandardApi](https://shopify.dev/docs/api/checkout-ui-extensions/apis/standardapi) object, which contains a basic set of properties about the checkout.\n\nFor a full list of the API available to each extension target, see the [ExtensionTargets type](https://shopify.dev/docs/api/checkout-ui-extensions/apis/extensiontargets).\n\n> Caution: This is deprecated, use `useApi` instead.", + "description": "Returns the full API object that was passed in to your extension when it was created. Depending on the extension target, this object can contain different properties.\n\nFor example, the `purchase.checkout.cart-line-item.render-after` extension target will return the [CartLineDetailsApi](/docs/api/checkout-ui-extensions/apis/cartlinedetailsapi) object. Other targets may only have access to the [StandardApi](/docs/api/checkout-ui-extensions/apis/standardapi) object, which contains a basic set of properties about the checkout.\n\nFor a full list of the API available to each extension target, see the [ExtensionTargets type](/docs/api/checkout-ui-extensions/apis/extensiontargets).\n\n> Caution: This is deprecated, use `useApi` instead.", "isPublicDocs": true, "params": [], "returns": { @@ -167548,7 +167632,7 @@ "src/surfaces/checkout/preact/buyer-journey.ts": { "filePath": "src/surfaces/checkout/preact/buyer-journey.ts", "name": "UseBuyerJourneyInterceptGeneratedType", - "description": "Installs a function for intercepting and preventing progress on checkout.\n\nTo block checkout progress, you must set the [block_progress](https://shopify.dev/docs/api/checkout-ui-extensions/configuration#block-progress) capability in your extension's configuration.\n\nIf you do, then you're expected to inform the buyer why navigation was blocked, either by passing validation errors to the checkout UI or rendering the errors in your extension.\n\n`useBuyerJourneyIntercept()` should be called at the top level of the extension, not within an embedded or child component, to avoid errors should the child component get destroyed.\n\nIt is good practice to show a warning in the checkout editor when the merchant has not given permission for your extension to block checkout progress.", + "description": "Installs a function for intercepting and preventing progress on checkout.\n\nTo block checkout progress, you must set the [block_progress](/docs/api/checkout-ui-extensions/configuration#block-progress) capability in your extension's configuration.\n\nIf you do, then you're expected to inform the buyer why navigation was blocked, either by passing validation errors to the checkout UI or rendering the errors in your extension.\n\n`useBuyerJourneyIntercept()` should be called at the top level of the extension, not within an embedded or child component, to avoid errors should the child component get destroyed.\n\nIt is good practice to show a warning in the checkout editor when the merchant has not given permission for your extension to block checkout progress.", "isPublicDocs": true, "params": [ { @@ -167706,7 +167790,7 @@ "src/surfaces/checkout/preact/checkout-token.ts": { "filePath": "src/surfaces/checkout/preact/checkout-token.ts", "name": "UseCheckoutTokenGeneratedType", - "description": "A stable id that represents the current checkout.\n\nMatches the `token` field in the [WebPixel checkout payload](https://shopify.dev/docs/api/pixels/customer-events#checkout) and the `checkout_token` field in the [Admin REST API Order resource](https://shopify.dev/docs/api/admin-rest/unstable/resources/order#resource-object).", + "description": "A stable id that represents the current checkout.\n\nMatches the `token` field in the [WebPixel checkout payload](/docs/api/pixels/customer-events#checkout) and the `checkout_token` field in the [Admin REST API Order resource](/docs/api/admin-rest/unstable/resources/order#resource-object).", "isPublicDocs": true, "params": [], "returns": { @@ -168007,7 +168091,7 @@ "src/surfaces/checkout/preact/discounts.ts": { "filePath": "src/surfaces/checkout/preact/discounts.ts", "name": "UseApplyDiscountCodeChangeGeneratedType", - "description": "Returns a function to add or remove discount codes.\n\n> Caution: > See [security considerations](https://shopify.dev/docs/api/checkout-ui-extensions/configuration#network-access) if your extension retrieves discount codes through a network call.", + "description": "Returns a function to add or remove discount codes.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/configuration#network-access) if your extension retrieves discount codes through a network call.", "isPublicDocs": true, "params": [], "returns": { @@ -168103,7 +168187,7 @@ "src/surfaces/checkout/preact/gift-cards.ts": { "filePath": "src/surfaces/checkout/preact/gift-cards.ts", "name": "UseApplyGiftCardChangeGeneratedType", - "description": "Returns a function to add or remove gift cards.\n\n> Caution: > See [security considerations](https://shopify.dev/docs/api/checkout-ui-extensions/configuration#network-access) if your extension retrieves gift card codes through a network call.", + "description": "Returns a function to add or remove gift cards.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/configuration#network-access) if your extension retrieves gift card codes through a network call.", "isPublicDocs": true, "params": [], "returns": { @@ -168175,7 +168259,7 @@ "src/surfaces/checkout/preact/localized-fields.ts": { "filePath": "src/surfaces/checkout/preact/localized-fields.ts", "name": "UseLocalizedFieldGeneratedType", - "description": "Returns the current localized field or undefined for the specified localized field key and re-renders your component if the value changes.", + "description": "Returns the current localized field or undefined for the specified localized field key and re-renders your component if the value changes.\n\nReturns `undefined` when no field is configured for the buyer's country.", "isPublicDocs": true, "params": [ { diff --git a/packages/ui-extensions/docs/surfaces/checkout/generated/targets.json b/packages/ui-extensions/docs/surfaces/checkout/generated/targets.json index 2893eb299b..a6615ef517 100644 --- a/packages/ui-extensions/docs/surfaces/checkout/generated/targets.json +++ b/packages/ui-extensions/docs/surfaces/checkout/generated/targets.json @@ -71,7 +71,6 @@ "BuyerJourneyApi", "CartInstructionsApi", "CartLinesApi", - "CheckoutSettingsApi", "CheckoutTokenApi", "CostApi", "CustomerPrivacyApi", @@ -84,11 +83,11 @@ "MetafieldsApi", "NoteApi", "PaymentsApi", - "QueryApi", "SessionTokenApi", "SettingsApi", "ShopApi", - "StorageApi" + "StorageApi", + "StorefrontApi" ] }, "purchase.checkout.cart-line-list.render-after": { @@ -163,7 +162,6 @@ "BuyerJourneyApi", "CartInstructionsApi", "CartLinesApi", - "CheckoutSettingsApi", "CheckoutTokenApi", "CostApi", "CustomerPrivacyApi", @@ -176,11 +174,11 @@ "MetafieldsApi", "NoteApi", "PaymentsApi", - "QueryApi", "SessionTokenApi", "SettingsApi", "ShopApi", - "StorageApi" + "StorageApi", + "StorefrontApi" ] }, "purchase.checkout.cart-line-item.render-after": { @@ -256,7 +254,6 @@ "CartInstructionsApi", "CartLineItemApi", "CartLinesApi", - "CheckoutSettingsApi", "CheckoutTokenApi", "CostApi", "CustomerPrivacyApi", @@ -269,11 +266,11 @@ "MetafieldsApi", "NoteApi", "PaymentsApi", - "QueryApi", "SessionTokenApi", "SettingsApi", "ShopApi", - "StorageApi" + "StorageApi", + "StorefrontApi" ] }, "purchase.checkout.contact.render-after": { @@ -348,7 +345,6 @@ "BuyerJourneyApi", "CartInstructionsApi", "CartLinesApi", - "CheckoutSettingsApi", "CheckoutTokenApi", "CostApi", "CustomerPrivacyApi", @@ -361,11 +357,11 @@ "MetafieldsApi", "NoteApi", "PaymentsApi", - "QueryApi", "SessionTokenApi", "SettingsApi", "ShopApi", - "StorageApi" + "StorageApi", + "StorefrontApi" ] }, "purchase.checkout.delivery-address.render-before": { @@ -440,7 +436,6 @@ "BuyerJourneyApi", "CartInstructionsApi", "CartLinesApi", - "CheckoutSettingsApi", "CheckoutTokenApi", "CostApi", "CustomerPrivacyApi", @@ -453,11 +448,11 @@ "MetafieldsApi", "NoteApi", "PaymentsApi", - "QueryApi", "SessionTokenApi", "SettingsApi", "ShopApi", - "StorageApi" + "StorageApi", + "StorefrontApi" ] }, "purchase.checkout.delivery-address.render-after": { @@ -532,7 +527,6 @@ "BuyerJourneyApi", "CartInstructionsApi", "CartLinesApi", - "CheckoutSettingsApi", "CheckoutTokenApi", "CostApi", "CustomerPrivacyApi", @@ -545,11 +539,11 @@ "MetafieldsApi", "NoteApi", "PaymentsApi", - "QueryApi", "SessionTokenApi", "SettingsApi", "ShopApi", - "StorageApi" + "StorageApi", + "StorefrontApi" ] }, "purchase.checkout.block.render": { @@ -624,7 +618,6 @@ "BuyerJourneyApi", "CartInstructionsApi", "CartLinesApi", - "CheckoutSettingsApi", "CheckoutTokenApi", "CostApi", "CustomerPrivacyApi", @@ -637,11 +630,11 @@ "MetafieldsApi", "NoteApi", "PaymentsApi", - "QueryApi", "SessionTokenApi", "SettingsApi", "ShopApi", - "StorageApi" + "StorageApi", + "StorefrontApi" ] }, "purchase.thank-you.block.render": { @@ -709,25 +702,31 @@ "UrlField" ], "apis": [ + "AddressesApi", "AnalyticsApi", + "AttributesApi", "BuyerIdentityApi", "BuyerJourneyApi", "CartInstructionsApi", - "CheckoutSettingsApi", + "CartLinesApi", "CheckoutTokenApi", "CostApi", "CustomerPrivacyApi", "DeliveryApi", + "DiscountsApi", "ExtensionApi", + "GiftCardsApi", "LocalizationApi", "LocalizedFieldsApi", + "MetafieldsApi", + "NoteApi", "OrderApi", "PaymentsApi", - "QueryApi", "SessionTokenApi", "SettingsApi", "ShopApi", - "StorageApi" + "StorageApi", + "StorefrontApi" ] }, "purchase.thank-you.cart-line-item.render-after": { @@ -795,26 +794,32 @@ "UrlField" ], "apis": [ + "AddressesApi", "AnalyticsApi", + "AttributesApi", "BuyerIdentityApi", "BuyerJourneyApi", "CartInstructionsApi", "CartLineItemApi", - "CheckoutSettingsApi", + "CartLinesApi", "CheckoutTokenApi", "CostApi", "CustomerPrivacyApi", "DeliveryApi", + "DiscountsApi", "ExtensionApi", + "GiftCardsApi", "LocalizationApi", "LocalizedFieldsApi", + "MetafieldsApi", + "NoteApi", "OrderApi", "PaymentsApi", - "QueryApi", "SessionTokenApi", "SettingsApi", "ShopApi", - "StorageApi" + "StorageApi", + "StorefrontApi" ] }, "purchase.thank-you.cart-line-list.render-after": { @@ -882,25 +887,31 @@ "UrlField" ], "apis": [ + "AddressesApi", "AnalyticsApi", + "AttributesApi", "BuyerIdentityApi", "BuyerJourneyApi", "CartInstructionsApi", - "CheckoutSettingsApi", + "CartLinesApi", "CheckoutTokenApi", "CostApi", "CustomerPrivacyApi", "DeliveryApi", + "DiscountsApi", "ExtensionApi", + "GiftCardsApi", "LocalizationApi", "LocalizedFieldsApi", + "MetafieldsApi", + "NoteApi", "OrderApi", "PaymentsApi", - "QueryApi", "SessionTokenApi", "SettingsApi", "ShopApi", - "StorageApi" + "StorageApi", + "StorefrontApi" ] }, "purchase.thank-you.customer-information.render-after": { @@ -968,25 +979,31 @@ "UrlField" ], "apis": [ + "AddressesApi", "AnalyticsApi", + "AttributesApi", "BuyerIdentityApi", "BuyerJourneyApi", "CartInstructionsApi", - "CheckoutSettingsApi", + "CartLinesApi", "CheckoutTokenApi", "CostApi", "CustomerPrivacyApi", "DeliveryApi", + "DiscountsApi", "ExtensionApi", + "GiftCardsApi", "LocalizationApi", "LocalizedFieldsApi", + "MetafieldsApi", + "NoteApi", "OrderApi", "PaymentsApi", - "QueryApi", "SessionTokenApi", "SettingsApi", "ShopApi", - "StorageApi" + "StorageApi", + "StorefrontApi" ] }, "purchase.checkout.payment-method-list.render-before": { @@ -1061,7 +1078,6 @@ "BuyerJourneyApi", "CartInstructionsApi", "CartLinesApi", - "CheckoutSettingsApi", "CheckoutTokenApi", "CostApi", "CustomerPrivacyApi", @@ -1074,11 +1090,11 @@ "MetafieldsApi", "NoteApi", "PaymentsApi", - "QueryApi", "SessionTokenApi", "SettingsApi", "ShopApi", - "StorageApi" + "StorageApi", + "StorefrontApi" ] }, "purchase.checkout.payment-method-list.render-after": { @@ -1153,7 +1169,6 @@ "BuyerJourneyApi", "CartInstructionsApi", "CartLinesApi", - "CheckoutSettingsApi", "CheckoutTokenApi", "CostApi", "CustomerPrivacyApi", @@ -1166,11 +1181,11 @@ "MetafieldsApi", "NoteApi", "PaymentsApi", - "QueryApi", "SessionTokenApi", "SettingsApi", "ShopApi", - "StorageApi" + "StorageApi", + "StorefrontApi" ] }, "purchase.checkout.reductions.render-before": { @@ -1245,7 +1260,6 @@ "BuyerJourneyApi", "CartInstructionsApi", "CartLinesApi", - "CheckoutSettingsApi", "CheckoutTokenApi", "CostApi", "CustomerPrivacyApi", @@ -1258,11 +1272,11 @@ "MetafieldsApi", "NoteApi", "PaymentsApi", - "QueryApi", "SessionTokenApi", "SettingsApi", "ShopApi", - "StorageApi" + "StorageApi", + "StorefrontApi" ] }, "purchase.checkout.reductions.render-after": { @@ -1337,7 +1351,6 @@ "BuyerJourneyApi", "CartInstructionsApi", "CartLinesApi", - "CheckoutSettingsApi", "CheckoutTokenApi", "CostApi", "CustomerPrivacyApi", @@ -1350,11 +1363,11 @@ "MetafieldsApi", "NoteApi", "PaymentsApi", - "QueryApi", "SessionTokenApi", "SettingsApi", "ShopApi", - "StorageApi" + "StorageApi", + "StorefrontApi" ] }, "purchase.checkout.shipping-option-list.render-before": { @@ -1429,7 +1442,6 @@ "BuyerJourneyApi", "CartInstructionsApi", "CartLinesApi", - "CheckoutSettingsApi", "CheckoutTokenApi", "CostApi", "CustomerPrivacyApi", @@ -1442,12 +1454,12 @@ "MetafieldsApi", "NoteApi", "PaymentsApi", - "QueryApi", "SessionTokenApi", "SettingsApi", "ShippingOptionListApi", "ShopApi", - "StorageApi" + "StorageApi", + "StorefrontApi" ] }, "purchase.checkout.shipping-option-list.render-after": { @@ -1522,7 +1534,6 @@ "BuyerJourneyApi", "CartInstructionsApi", "CartLinesApi", - "CheckoutSettingsApi", "CheckoutTokenApi", "CostApi", "CustomerPrivacyApi", @@ -1535,12 +1546,12 @@ "MetafieldsApi", "NoteApi", "PaymentsApi", - "QueryApi", "SessionTokenApi", "SettingsApi", "ShippingOptionListApi", "ShopApi", - "StorageApi" + "StorageApi", + "StorefrontApi" ] }, "purchase.checkout.pickup-location-list.render-before": { @@ -1615,7 +1626,6 @@ "BuyerJourneyApi", "CartInstructionsApi", "CartLinesApi", - "CheckoutSettingsApi", "CheckoutTokenApi", "CostApi", "CustomerPrivacyApi", @@ -1629,11 +1639,11 @@ "NoteApi", "PaymentsApi", "PickupLocationListApi", - "QueryApi", "SessionTokenApi", "SettingsApi", "ShopApi", - "StorageApi" + "StorageApi", + "StorefrontApi" ] }, "purchase.checkout.pickup-location-list.render-after": { @@ -1708,7 +1718,6 @@ "BuyerJourneyApi", "CartInstructionsApi", "CartLinesApi", - "CheckoutSettingsApi", "CheckoutTokenApi", "CostApi", "CustomerPrivacyApi", @@ -1722,11 +1731,11 @@ "NoteApi", "PaymentsApi", "PickupLocationListApi", - "QueryApi", "SessionTokenApi", "SettingsApi", "ShopApi", - "StorageApi" + "StorageApi", + "StorefrontApi" ] }, "purchase.checkout.shipping-option-item.render-after": { @@ -1801,7 +1810,6 @@ "BuyerJourneyApi", "CartInstructionsApi", "CartLinesApi", - "CheckoutSettingsApi", "CheckoutTokenApi", "CostApi", "CustomerPrivacyApi", @@ -1814,12 +1822,12 @@ "MetafieldsApi", "NoteApi", "PaymentsApi", - "QueryApi", "SessionTokenApi", "SettingsApi", "ShippingOptionItemApi", "ShopApi", - "StorageApi" + "StorageApi", + "StorefrontApi" ] }, "purchase.checkout.shipping-option-item.details.render": { @@ -1894,7 +1902,6 @@ "BuyerJourneyApi", "CartInstructionsApi", "CartLinesApi", - "CheckoutSettingsApi", "CheckoutTokenApi", "CostApi", "CustomerPrivacyApi", @@ -1907,12 +1914,12 @@ "MetafieldsApi", "NoteApi", "PaymentsApi", - "QueryApi", "SessionTokenApi", "SettingsApi", "ShippingOptionItemApi", "ShopApi", - "StorageApi" + "StorageApi", + "StorefrontApi" ] }, "purchase.checkout.pickup-point-list.render-before": { @@ -1987,7 +1994,6 @@ "BuyerJourneyApi", "CartInstructionsApi", "CartLinesApi", - "CheckoutSettingsApi", "CheckoutTokenApi", "CostApi", "CustomerPrivacyApi", @@ -2001,11 +2007,11 @@ "NoteApi", "PaymentsApi", "PickupPointListApi", - "QueryApi", "SessionTokenApi", "SettingsApi", "ShopApi", - "StorageApi" + "StorageApi", + "StorefrontApi" ] }, "purchase.checkout.pickup-point-list.render-after": { @@ -2080,7 +2086,6 @@ "BuyerJourneyApi", "CartInstructionsApi", "CartLinesApi", - "CheckoutSettingsApi", "CheckoutTokenApi", "CostApi", "CustomerPrivacyApi", @@ -2094,11 +2099,11 @@ "NoteApi", "PaymentsApi", "PickupPointListApi", - "QueryApi", "SessionTokenApi", "SettingsApi", "ShopApi", - "StorageApi" + "StorageApi", + "StorefrontApi" ] }, "purchase.checkout.pickup-location-option-item.render-after": { @@ -2173,7 +2178,6 @@ "BuyerJourneyApi", "CartInstructionsApi", "CartLinesApi", - "CheckoutSettingsApi", "CheckoutTokenApi", "CostApi", "CustomerPrivacyApi", @@ -2187,11 +2191,11 @@ "NoteApi", "PaymentsApi", "PickupLocationItemApi", - "QueryApi", "SessionTokenApi", "SettingsApi", "ShopApi", - "StorageApi" + "StorageApi", + "StorefrontApi" ] }, "purchase.checkout.header.render-after": { @@ -2266,7 +2270,6 @@ "BuyerJourneyApi", "CartInstructionsApi", "CartLinesApi", - "CheckoutSettingsApi", "CheckoutTokenApi", "CostApi", "CustomerPrivacyApi", @@ -2279,11 +2282,11 @@ "MetafieldsApi", "NoteApi", "PaymentsApi", - "QueryApi", "SessionTokenApi", "SettingsApi", "ShopApi", - "StorageApi" + "StorageApi", + "StorefrontApi" ] }, "purchase.checkout.footer.render-after": { @@ -2358,7 +2361,6 @@ "BuyerJourneyApi", "CartInstructionsApi", "CartLinesApi", - "CheckoutSettingsApi", "CheckoutTokenApi", "CostApi", "CustomerPrivacyApi", @@ -2371,11 +2373,11 @@ "MetafieldsApi", "NoteApi", "PaymentsApi", - "QueryApi", "SessionTokenApi", "SettingsApi", "ShopApi", - "StorageApi" + "StorageApi", + "StorefrontApi" ] }, "purchase.checkout.chat.render": { @@ -2390,7 +2392,6 @@ "BuyerJourneyApi", "CartInstructionsApi", "CartLinesApi", - "CheckoutSettingsApi", "CheckoutTokenApi", "CostApi", "CustomerPrivacyApi", @@ -2403,11 +2404,11 @@ "MetafieldsApi", "NoteApi", "PaymentsApi", - "QueryApi", "SessionTokenApi", "SettingsApi", "ShopApi", - "StorageApi" + "StorageApi", + "StorefrontApi" ] }, "purchase.thank-you.header.render-after": { @@ -2475,25 +2476,31 @@ "UrlField" ], "apis": [ + "AddressesApi", "AnalyticsApi", + "AttributesApi", "BuyerIdentityApi", "BuyerJourneyApi", "CartInstructionsApi", - "CheckoutSettingsApi", + "CartLinesApi", "CheckoutTokenApi", "CostApi", "CustomerPrivacyApi", "DeliveryApi", + "DiscountsApi", "ExtensionApi", + "GiftCardsApi", "LocalizationApi", "LocalizedFieldsApi", + "MetafieldsApi", + "NoteApi", "OrderApi", "PaymentsApi", - "QueryApi", "SessionTokenApi", "SettingsApi", "ShopApi", - "StorageApi" + "StorageApi", + "StorefrontApi" ] }, "purchase.thank-you.footer.render-after": { @@ -2561,25 +2568,31 @@ "UrlField" ], "apis": [ + "AddressesApi", "AnalyticsApi", + "AttributesApi", "BuyerIdentityApi", "BuyerJourneyApi", "CartInstructionsApi", - "CheckoutSettingsApi", + "CartLinesApi", "CheckoutTokenApi", "CostApi", "CustomerPrivacyApi", "DeliveryApi", + "DiscountsApi", "ExtensionApi", + "GiftCardsApi", "LocalizationApi", "LocalizedFieldsApi", + "MetafieldsApi", + "NoteApi", "OrderApi", "PaymentsApi", - "QueryApi", "SessionTokenApi", "SettingsApi", "ShopApi", - "StorageApi" + "StorageApi", + "StorefrontApi" ] }, "purchase.thank-you.chat.render": { @@ -2587,25 +2600,31 @@ "Chat" ], "apis": [ + "AddressesApi", "AnalyticsApi", + "AttributesApi", "BuyerIdentityApi", "BuyerJourneyApi", "CartInstructionsApi", - "CheckoutSettingsApi", + "CartLinesApi", "CheckoutTokenApi", "CostApi", "CustomerPrivacyApi", "DeliveryApi", + "DiscountsApi", "ExtensionApi", + "GiftCardsApi", "LocalizationApi", "LocalizedFieldsApi", + "MetafieldsApi", + "NoteApi", "OrderApi", "PaymentsApi", - "QueryApi", "SessionTokenApi", "SettingsApi", "ShopApi", - "StorageApi" + "StorageApi", + "StorefrontApi" ] }, "purchase.thank-you.announcement.render": { @@ -2674,43 +2693,73 @@ "UrlField" ], "apis": [ + "AddressesApi", "AnalyticsApi", + "AttributesApi", "BuyerIdentityApi", "BuyerJourneyApi", "CartInstructionsApi", - "CheckoutSettingsApi", + "CartLinesApi", "CheckoutTokenApi", "CostApi", "CustomerPrivacyApi", "DeliveryApi", + "DiscountsApi", "ExtensionApi", + "GiftCardsApi", "LocalizationApi", "LocalizedFieldsApi", + "MetafieldsApi", + "NoteApi", "OrderApi", "PaymentsApi", - "QueryApi", "SessionTokenApi", "SettingsApi", "ShopApi", - "StorageApi" + "StorageApi", + "StorefrontApi" ] }, "purchase.address-autocomplete.suggest": { "components": [], "apis": [ - "AddressAutocompleteStandardApi", - "AddressAutocompleteSuggestApi" + "AddressAutocompleteSuggestApi", + "AddressesApi", + "AnalyticsApi", + "AttributesApi", + "CheckoutTokenApi", + "ExtensionApi", + "LocalizationApi", + "MetafieldsApi", + "SessionTokenApi", + "SettingsApi", + "ShopApi", + "StorageApi", + "StorefrontApi" ] }, "purchase.address-autocomplete.format-suggestion": { "components": [], "apis": [ "AddressAutocompleteFormatSuggestionApi", - "AddressAutocompleteStandardApi" + "AddressesApi", + "AnalyticsApi", + "AttributesApi", + "CheckoutTokenApi", + "ExtensionApi", + "LocalizationApi", + "MetafieldsApi", + "SessionTokenApi", + "SettingsApi", + "ShopApi", + "StorageApi", + "StorefrontApi" ] }, "AddressesApi": { "targets": [ + "purchase.address-autocomplete.format-suggestion", + "purchase.address-autocomplete.suggest", "purchase.checkout.actions.render-before", "purchase.checkout.block.render", "purchase.checkout.cart-line-item.render-after", @@ -2733,11 +2782,21 @@ "purchase.checkout.shipping-option-item.details.render", "purchase.checkout.shipping-option-item.render-after", "purchase.checkout.shipping-option-list.render-after", - "purchase.checkout.shipping-option-list.render-before" + "purchase.checkout.shipping-option-list.render-before", + "purchase.thank-you.announcement.render", + "purchase.thank-you.block.render", + "purchase.thank-you.cart-line-item.render-after", + "purchase.thank-you.cart-line-list.render-after", + "purchase.thank-you.chat.render", + "purchase.thank-you.customer-information.render-after", + "purchase.thank-you.footer.render-after", + "purchase.thank-you.header.render-after" ] }, "AnalyticsApi": { "targets": [ + "purchase.address-autocomplete.format-suggestion", + "purchase.address-autocomplete.suggest", "purchase.checkout.actions.render-before", "purchase.checkout.block.render", "purchase.checkout.cart-line-item.render-after", @@ -2773,6 +2832,8 @@ }, "AttributesApi": { "targets": [ + "purchase.address-autocomplete.format-suggestion", + "purchase.address-autocomplete.suggest", "purchase.checkout.actions.render-before", "purchase.checkout.block.render", "purchase.checkout.cart-line-item.render-after", @@ -2795,7 +2856,15 @@ "purchase.checkout.shipping-option-item.details.render", "purchase.checkout.shipping-option-item.render-after", "purchase.checkout.shipping-option-list.render-after", - "purchase.checkout.shipping-option-list.render-before" + "purchase.checkout.shipping-option-list.render-before", + "purchase.thank-you.announcement.render", + "purchase.thank-you.block.render", + "purchase.thank-you.cart-line-item.render-after", + "purchase.thank-you.cart-line-list.render-after", + "purchase.thank-you.chat.render", + "purchase.thank-you.customer-information.render-after", + "purchase.thank-you.footer.render-after", + "purchase.thank-you.header.render-after" ] }, "BuyerIdentityApi": { @@ -2904,33 +2973,6 @@ ] }, "CartLinesApi": { - "targets": [ - "purchase.checkout.actions.render-before", - "purchase.checkout.block.render", - "purchase.checkout.cart-line-item.render-after", - "purchase.checkout.cart-line-list.render-after", - "purchase.checkout.chat.render", - "purchase.checkout.contact.render-after", - "purchase.checkout.delivery-address.render-after", - "purchase.checkout.delivery-address.render-before", - "purchase.checkout.footer.render-after", - "purchase.checkout.header.render-after", - "purchase.checkout.payment-method-list.render-after", - "purchase.checkout.payment-method-list.render-before", - "purchase.checkout.pickup-location-list.render-after", - "purchase.checkout.pickup-location-list.render-before", - "purchase.checkout.pickup-location-option-item.render-after", - "purchase.checkout.pickup-point-list.render-after", - "purchase.checkout.pickup-point-list.render-before", - "purchase.checkout.reductions.render-after", - "purchase.checkout.reductions.render-before", - "purchase.checkout.shipping-option-item.details.render", - "purchase.checkout.shipping-option-item.render-after", - "purchase.checkout.shipping-option-list.render-after", - "purchase.checkout.shipping-option-list.render-before" - ] - }, - "CheckoutSettingsApi": { "targets": [ "purchase.checkout.actions.render-before", "purchase.checkout.block.render", @@ -2967,6 +3009,8 @@ }, "CheckoutTokenApi": { "targets": [ + "purchase.address-autocomplete.format-suggestion", + "purchase.address-autocomplete.suggest", "purchase.checkout.actions.render-before", "purchase.checkout.block.render", "purchase.checkout.cart-line-item.render-after", @@ -3129,11 +3173,21 @@ "purchase.checkout.shipping-option-item.details.render", "purchase.checkout.shipping-option-item.render-after", "purchase.checkout.shipping-option-list.render-after", - "purchase.checkout.shipping-option-list.render-before" + "purchase.checkout.shipping-option-list.render-before", + "purchase.thank-you.announcement.render", + "purchase.thank-you.block.render", + "purchase.thank-you.cart-line-item.render-after", + "purchase.thank-you.cart-line-list.render-after", + "purchase.thank-you.chat.render", + "purchase.thank-you.customer-information.render-after", + "purchase.thank-you.footer.render-after", + "purchase.thank-you.header.render-after" ] }, "ExtensionApi": { "targets": [ + "purchase.address-autocomplete.format-suggestion", + "purchase.address-autocomplete.suggest", "purchase.checkout.actions.render-before", "purchase.checkout.block.render", "purchase.checkout.cart-line-item.render-after", @@ -3191,11 +3245,21 @@ "purchase.checkout.shipping-option-item.details.render", "purchase.checkout.shipping-option-item.render-after", "purchase.checkout.shipping-option-list.render-after", - "purchase.checkout.shipping-option-list.render-before" + "purchase.checkout.shipping-option-list.render-before", + "purchase.thank-you.announcement.render", + "purchase.thank-you.block.render", + "purchase.thank-you.cart-line-item.render-after", + "purchase.thank-you.cart-line-list.render-after", + "purchase.thank-you.chat.render", + "purchase.thank-you.customer-information.render-after", + "purchase.thank-you.footer.render-after", + "purchase.thank-you.header.render-after" ] }, "LocalizationApi": { "targets": [ + "purchase.address-autocomplete.format-suggestion", + "purchase.address-autocomplete.suggest", "purchase.checkout.actions.render-before", "purchase.checkout.block.render", "purchase.checkout.cart-line-item.render-after", @@ -3266,6 +3330,8 @@ }, "MetafieldsApi": { "targets": [ + "purchase.address-autocomplete.format-suggestion", + "purchase.address-autocomplete.suggest", "purchase.checkout.actions.render-before", "purchase.checkout.block.render", "purchase.checkout.cart-line-item.render-after", @@ -3288,7 +3354,15 @@ "purchase.checkout.shipping-option-item.details.render", "purchase.checkout.shipping-option-item.render-after", "purchase.checkout.shipping-option-list.render-after", - "purchase.checkout.shipping-option-list.render-before" + "purchase.checkout.shipping-option-list.render-before", + "purchase.thank-you.announcement.render", + "purchase.thank-you.block.render", + "purchase.thank-you.cart-line-item.render-after", + "purchase.thank-you.cart-line-list.render-after", + "purchase.thank-you.chat.render", + "purchase.thank-you.customer-information.render-after", + "purchase.thank-you.footer.render-after", + "purchase.thank-you.header.render-after" ] }, "NoteApi": { @@ -3315,7 +3389,15 @@ "purchase.checkout.shipping-option-item.details.render", "purchase.checkout.shipping-option-item.render-after", "purchase.checkout.shipping-option-list.render-after", - "purchase.checkout.shipping-option-list.render-before" + "purchase.checkout.shipping-option-list.render-before", + "purchase.thank-you.announcement.render", + "purchase.thank-you.block.render", + "purchase.thank-you.cart-line-item.render-after", + "purchase.thank-you.cart-line-list.render-after", + "purchase.thank-you.chat.render", + "purchase.thank-you.customer-information.render-after", + "purchase.thank-you.footer.render-after", + "purchase.thank-you.header.render-after" ] }, "PaymentsApi": { @@ -3353,8 +3435,10 @@ "purchase.thank-you.header.render-after" ] }, - "QueryApi": { + "SessionTokenApi": { "targets": [ + "purchase.address-autocomplete.format-suggestion", + "purchase.address-autocomplete.suggest", "purchase.checkout.actions.render-before", "purchase.checkout.block.render", "purchase.checkout.cart-line-item.render-after", @@ -3388,8 +3472,10 @@ "purchase.thank-you.header.render-after" ] }, - "SessionTokenApi": { + "SettingsApi": { "targets": [ + "purchase.address-autocomplete.format-suggestion", + "purchase.address-autocomplete.suggest", "purchase.checkout.actions.render-before", "purchase.checkout.block.render", "purchase.checkout.cart-line-item.render-after", @@ -3423,8 +3509,10 @@ "purchase.thank-you.header.render-after" ] }, - "SettingsApi": { + "ShopApi": { "targets": [ + "purchase.address-autocomplete.format-suggestion", + "purchase.address-autocomplete.suggest", "purchase.checkout.actions.render-before", "purchase.checkout.block.render", "purchase.checkout.cart-line-item.render-after", @@ -3458,8 +3546,10 @@ "purchase.thank-you.header.render-after" ] }, - "ShopApi": { + "StorageApi": { "targets": [ + "purchase.address-autocomplete.format-suggestion", + "purchase.address-autocomplete.suggest", "purchase.checkout.actions.render-before", "purchase.checkout.block.render", "purchase.checkout.cart-line-item.render-after", @@ -3493,8 +3583,10 @@ "purchase.thank-you.header.render-after" ] }, - "StorageApi": { + "StorefrontApi": { "targets": [ + "purchase.address-autocomplete.format-suggestion", + "purchase.address-autocomplete.suggest", "purchase.checkout.actions.render-before", "purchase.checkout.block.render", "purchase.checkout.cart-line-item.render-after", @@ -3575,12 +3667,6 @@ "purchase.checkout.pickup-location-option-item.render-after" ] }, - "AddressAutocompleteStandardApi": { - "targets": [ - "purchase.address-autocomplete.format-suggestion", - "purchase.address-autocomplete.suggest" - ] - }, "AddressAutocompleteSuggestApi": { "targets": [ "purchase.address-autocomplete.suggest" diff --git a/packages/ui-extensions/docs/surfaces/customer-account/generated/customer_account_ui_extensions/2026-01/generated_docs_data.json b/packages/ui-extensions/docs/surfaces/customer-account/generated/customer_account_ui_extensions/2026-01/generated_docs_data.json index 7bd4c8b6ec..7a6d67a303 100644 --- a/packages/ui-extensions/docs/surfaces/customer-account/generated/customer_account_ui_extensions/2026-01/generated_docs_data.json +++ b/packages/ui-extensions/docs/surfaces/customer-account/generated/customer_account_ui_extensions/2026-01/generated_docs_data.json @@ -32,10 +32,10 @@ "syntaxKind": "PropertySignature", "name": "target", "value": "SubscribableSignalLike", - "description": "The cart line that this extension is attached to. Use this to read the line item's merchandise, quantity, cost, and attributes.\n\n> Note: Until version `2023-04`, this property was a `ReadonlySignalLike`." + "description": "The cart line that this extension is attached to. Use this to read the line item's merchandise, quantity, cost, and attributes.\n\nAvailable only on the corresponding item target. Shipping option item targets expose shipping option properties; pickup location item targets expose pickup location properties.\n\n> Note: Until version `2023-04`, this property was a `ReadonlySignalLike`." } ], - "value": "export interface CartLineItemApi {\n /**\n * The cart line that this extension is attached to. Use this to read the\n * line item's merchandise, quantity, cost, and attributes.\n *\n * > Note: Until version `2023-04`, this property was a `ReadonlySignalLike`.\n */\n target: SubscribableSignalLike;\n}" + "value": "export interface CartLineItemApi {\n /**\n * The cart line that this extension is attached to. Use this to read the\n * line item's merchandise, quantity, cost, and attributes.\n *\n * Available only on the corresponding item target. Shipping option item\n * targets expose shipping option properties; pickup location item targets\n * expose pickup location properties.\n *\n * > Note: Until version `2023-04`, this property was a `ReadonlySignalLike`.\n */\n target: SubscribableSignalLike;\n}" }, { "filePath": "src/surfaces/checkout/shared.ts", @@ -180,7 +180,7 @@ "syntaxKind": "PropertySignature", "name": "value", "value": "string", - "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.", + "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.\n\nAttribute values are always strings. To store structured data, serialize it to JSON and parse it when reading.", "examples": [ { "title": "Example", @@ -195,7 +195,7 @@ ] } ], - "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" + "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * Attribute values are always strings. To store structured data, serialize\n * it to JSON and parse it when reading.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -686,10 +686,10 @@ "syntaxKind": "PropertySignature", "name": "isLocationFormVisible", "value": "SubscribableSignalLike", - "description": "Whether the location search form is currently visible to the buyer. Use this to conditionally render UI that depends on the buyer actively searching for pickup points." + "description": "Reflects which view was active when the extension loaded. When the buyer moves to the next view, the extension restarts with the current value rather than updating in place." } ], - "value": "export interface PickupPointListApi {\n /**\n * Whether the location search form is currently visible to the buyer.\n * Use this to conditionally render UI that depends on the buyer actively\n * searching for pickup points.\n */\n isLocationFormVisible: SubscribableSignalLike;\n}" + "value": "export interface PickupPointListApi {\n /**\n * Reflects which view was active when the extension loaded. When the\n * buyer moves to the next view, the extension restarts with the\n * current value rather than updating in place.\n */\n isLocationFormVisible: SubscribableSignalLike;\n}" }, { "filePath": "src/surfaces/checkout/api/pickup/pickup-location-item.ts", @@ -702,17 +702,17 @@ "syntaxKind": "PropertySignature", "name": "isTargetSelected", "value": "SubscribableSignalLike", - "description": "Whether the buyer has selected the target pickup location. When `true`, the target location is the buyer's active choice. When `false`, the buyer has chosen a different pickup location." + "description": "Whether the buyer has selected the target pickup location. When `true`, the target location is the buyer's active choice. When `false`, the buyer has chosen a different pickup location.\n\nAvailable only on the corresponding item target. Shipping option item targets expose shipping option properties; pickup location item targets expose pickup location properties." }, { "filePath": "src/surfaces/checkout/api/pickup/pickup-location-item.ts", "syntaxKind": "PropertySignature", "name": "target", "value": "SubscribableSignalLike", - "description": "The pickup location that this extension is attached to. Use this to read the location's name, address, and other details." + "description": "The pickup location that this extension is attached to. Use this to read the location's name, address, and other details.\n\nAvailable only on the corresponding item target. Shipping option item targets expose shipping option properties; pickup location item targets expose pickup location properties." } ], - "value": "export interface PickupLocationItemApi {\n /**\n * The pickup location that this extension is attached to. Use this to read the location's name, address, and other details.\n */\n target: SubscribableSignalLike;\n\n /**\n * Whether the buyer has selected the target pickup location. When `true`, the target location is the buyer's active choice. When `false`, the buyer has chosen a different pickup location.\n */\n isTargetSelected: SubscribableSignalLike;\n}" + "value": "export interface PickupLocationItemApi {\n /**\n * The pickup location that this extension is attached to. Use this to read the location's name, address, and other details.\n *\n * Available only on the corresponding item target. Shipping option item\n * targets expose shipping option properties; pickup location item targets\n * expose pickup location properties.\n */\n target: SubscribableSignalLike;\n\n /**\n * Whether the buyer has selected the target pickup location. When `true`, the target location is the buyer's active choice. When `false`, the buyer has chosen a different pickup location.\n *\n * Available only on the corresponding item target. Shipping option item\n * targets expose shipping option properties; pickup location item targets\n * expose pickup location properties.\n */\n isTargetSelected: SubscribableSignalLike;\n}" }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -1118,7 +1118,7 @@ "syntaxKind": "PropertySignature", "name": "isTargetSelected", "value": "SubscribableSignalLike", - "description": "Whether the buyer has selected the target shipping option. When `true`, the target option is the buyer's active choice. When `false`, the buyer has chosen a different shipping option." + "description": "Whether the buyer has selected the target shipping option. When `true`, the target option is the buyer's active choice. When `false`, the buyer has chosen a different shipping option.\n\nAvailable only on the corresponding item target. Shipping option item targets expose shipping option properties; pickup location item targets expose pickup location properties." }, { "filePath": "src/surfaces/checkout/api/shipping/shipping-option-item.ts", @@ -1132,10 +1132,10 @@ "syntaxKind": "PropertySignature", "name": "target", "value": "SubscribableSignalLike", - "description": "The shipping option that this extension is attached to. Use this to read the option's cost, carrier, delivery estimate, and other details." + "description": "The shipping option that this extension is attached to. Use this to read the option's cost, carrier, delivery estimate, and other details.\n\nAvailable only on the corresponding item target. Shipping option item targets expose shipping option properties; pickup location item targets expose pickup location properties." } ], - "value": "export interface ShippingOptionItemApi {\n /**\n * The shipping option that this extension is attached to. Use this to read the option's cost, carrier, delivery estimate, and other details.\n */\n target: SubscribableSignalLike;\n\n /**\n * Whether the buyer has selected the target shipping option. When `true`, the target option is the buyer's active choice. When `false`, the buyer has chosen a different shipping option.\n */\n isTargetSelected: SubscribableSignalLike;\n\n /**\n * The render mode of this shipping option, indicating how the extension is displayed in the checkout UI.\n */\n renderMode: ShippingOptionItemRenderMode;\n}" + "value": "export interface ShippingOptionItemApi {\n /**\n * The shipping option that this extension is attached to. Use this to read the option's cost, carrier, delivery estimate, and other details.\n *\n * Available only on the corresponding item target. Shipping option item\n * targets expose shipping option properties; pickup location item targets\n * expose pickup location properties.\n */\n target: SubscribableSignalLike;\n\n /**\n * Whether the buyer has selected the target shipping option. When `true`, the target option is the buyer's active choice. When `false`, the buyer has chosen a different shipping option.\n *\n * Available only on the corresponding item target. Shipping option item\n * targets expose shipping option properties; pickup location item targets\n * expose pickup location properties.\n */\n isTargetSelected: SubscribableSignalLike;\n\n /**\n * The render mode of this shipping option, indicating how the extension is displayed in the checkout UI.\n */\n renderMode: ShippingOptionItemRenderMode;\n}" }, { "filePath": "src/surfaces/checkout/api/shipping/shipping-option-item.ts", @@ -2152,7 +2152,7 @@ "syntaxKind": "MethodSignature", "name": "applyAttributeChange", "value": "(change: AttributeChange) => Promise", - "description": "Updates or removes an attribute on the cart and checkout. On success, the [`attributes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/attributes#standardapi-propertydetail-attributes) property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.", + "description": "Updates or removes an attribute on the cart and checkout. On success, the [`attributes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/attributes#properties-propertydetail-attributes) property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.", "deprecationMessage": "Use cart metafields instead." }, { @@ -2160,42 +2160,42 @@ "syntaxKind": "MethodSignature", "name": "applyCartLinesChange", "value": "(change: CartLineChange) => Promise", - "description": "Adds, removes, or updates line items in the cart. The returned promise resolves when the change has been applied by the server, and the [`lines`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-lines#standardapi-propertydetail-lines) property updates with the new state.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Adds, removes, or updates line items in the cart. The returned promise resolves when the change has been applied by the server, and the [`lines`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-lines#properties-propertydetail-lines) property updates with the new state.\n\nAccepts a single change per call. To make multiple changes, call this method separately for each one.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyDiscountCodeChange", "value": "(change: DiscountCodeChange) => Promise", - "description": "Adds or removes a discount code on the checkout. The returned promise resolves when the change has been applied by the server, and the [`discountCodes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/discounts#standardapi-propertydetail-discountcodes) property updates with the new state.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves discount codes through a network call.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Adds or removes a discount code on the checkout. The returned promise resolves when the change has been applied by the server, and the [`discountCodes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/discounts#properties-propertydetail-discountcodes) property updates with the new state.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves discount codes through a network call.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyGiftCardChange", "value": "(change: GiftCardChange) => Promise", - "description": "Adds or removes a gift card from the checkout. The returned promise resolves when the change has been applied by the server, and the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/gift-cards#standardapi-propertydetail-appliedgiftcards) property updates with the new state.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves gift card codes through a network call.\n\n> Note: This method returns an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Adds or removes a gift card from the checkout. The returned promise resolves when the change has been applied by the server, and the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/gift-cards#properties-propertydetail-appliedgiftcards) property updates with the new state.\n\nUnlike other write operations, gift card changes aren't gated by a cart instruction flag.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves gift card codes through a network call.\n\n> Note: This method returns an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyMetafieldChange", "value": "(change: MetafieldChange) => Promise", - "description": "Creates, updates, or removes a cart metafield on the checkout. On success, the [`metafields`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/metafields#standardapi-propertydetail-metafields) property updates to reflect the change.\n\nCart metafields are copied to order metafields at order creation time if there's a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n\n> Caution: `MetafieldRemoveChange` and `MetafieldUpdateChange` are deprecated. Use cart metafields with `MetafieldRemoveCartChange` and `MetafieldUpdateCartChange` instead. If `MetafieldUpdateChange` writes a metafield with the same namespace and key as a cart metafield that's configured to copy, the cart metafield won't be copied.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Creates, updates, or removes a cart metafield on the checkout. On success, the [`metafields`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/metafields#properties-propertydetail-metafields) property updates to reflect the change.\n\nCart metafields are copied to order metafields at order creation time if there's a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n\n> Caution: `MetafieldRemoveChange` and `MetafieldUpdateChange` are deprecated. Use cart metafields with `MetafieldRemoveCartChange` and `MetafieldUpdateCartChange` instead. If `MetafieldUpdateChange` writes a metafield with the same namespace and key as a cart metafield that's configured to copy, the cart metafield won't be copied.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyNoteChange", "value": "(change: NoteChange) => Promise", - "description": "Sets or removes the buyer's note on the checkout. On success, the [`note`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/note#standardapi-propertydetail-note) property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Sets or removes the buyer's note on the checkout. On success, the [`note`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/note#properties-propertydetail-note) property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyShippingAddressChange", "value": "(change: ShippingAddressUpdateChange) => Promise", - "description": "Updates the buyer's shipping address on the checkout. The provided fields are merged into the existing address without prompting the buyer. On success, the `shippingAddress` property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", + "description": "Updates the buyer's shipping address on the checkout. The provided fields are merged into the existing address without prompting the buyer. On success, the `shippingAddress` property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", "isOptional": true }, { @@ -2208,7 +2208,7 @@ "isPrivate": true } ], - "value": "export interface CheckoutApi {\n /**\n * Updates or removes an attribute on the cart and checkout. On success, the\n * [`attributes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/attributes#standardapi-propertydetail-attributes) property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * @deprecated Use cart metafields instead.\n */\n applyAttributeChange(change: AttributeChange): Promise;\n\n /**\n * Adds, removes, or updates line items in the cart. The returned promise resolves when the change has been applied by the server, and the [`lines`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-lines#standardapi-propertydetail-lines) property updates with the new state.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyCartLinesChange(change: CartLineChange): Promise;\n\n /**\n * Adds or removes a discount code on the checkout. The returned promise resolves when the change has been applied by the server, and the [`discountCodes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/discounts#standardapi-propertydetail-discountcodes) property updates with the new state.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves discount codes through a network call.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyDiscountCodeChange(\n change: DiscountCodeChange,\n ): Promise;\n\n /**\n * Adds or removes a gift card from the checkout. The returned promise resolves when the change has been applied by the server, and the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/gift-cards#standardapi-propertydetail-appliedgiftcards) property updates with the new state.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves gift card codes through a network call.\n *\n * > Note: This method returns an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyGiftCardChange(change: GiftCardChange): Promise;\n\n /**\n * Creates, updates, or removes a cart metafield on the checkout. On success, the\n * [`metafields`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/metafields#standardapi-propertydetail-metafields) property updates to reflect the change.\n *\n * Cart metafields are copied to order metafields at order creation time if there's a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n *\n * > Caution: `MetafieldRemoveChange` and `MetafieldUpdateChange` are deprecated. Use cart metafields with `MetafieldRemoveCartChange` and `MetafieldUpdateCartChange` instead. If `MetafieldUpdateChange` writes a metafield with the same namespace and key as a cart metafield that's configured to copy, the cart metafield won't be copied.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyMetafieldChange(change: MetafieldChange): Promise;\n\n /**\n * Sets or removes the buyer's note on the checkout. On success, the\n * [`note`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/note#standardapi-propertydetail-note)\n * property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyNoteChange(change: NoteChange): Promise;\n\n /**\n * @private\n */\n experimentalIsShopAppStyle?: boolean;\n\n /**\n * Updates the buyer's shipping address on the checkout. The provided fields\n * are merged into the existing address without prompting the buyer. On success,\n * the `shippingAddress` property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyShippingAddressChange?(\n change: ShippingAddressChange,\n ): Promise;\n}" + "value": "export interface CheckoutApi {\n /**\n * Updates or removes an attribute on the cart and checkout. On success, the\n * [`attributes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/attributes#properties-propertydetail-attributes) property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * @deprecated Use cart metafields instead.\n */\n applyAttributeChange(change: AttributeChange): Promise;\n\n /**\n * Adds, removes, or updates line items in the cart. The returned promise resolves when the change has been applied by the server, and the [`lines`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-lines#properties-propertydetail-lines) property updates with the new state.\n *\n * Accepts a single change per call. To make multiple changes, call this\n * method separately for each one.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyCartLinesChange(change: CartLineChange): Promise;\n\n /**\n * Adds or removes a discount code on the checkout. The returned promise resolves when the change has been applied by the server, and the [`discountCodes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/discounts#properties-propertydetail-discountcodes) property updates with the new state.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves discount codes through a network call.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyDiscountCodeChange(\n change: DiscountCodeChange,\n ): Promise;\n\n /**\n * Adds or removes a gift card from the checkout. The returned promise resolves when the change has been applied by the server, and the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/gift-cards#properties-propertydetail-appliedgiftcards) property updates with the new state.\n *\n * Unlike other write operations, gift card changes aren't gated by a cart\n * instruction flag.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves gift card codes through a network call.\n *\n * > Note: This method returns an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyGiftCardChange(change: GiftCardChange): Promise;\n\n /**\n * Creates, updates, or removes a cart metafield on the checkout. On success, the\n * [`metafields`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/metafields#properties-propertydetail-metafields) property updates to reflect the change.\n *\n * Cart metafields are copied to order metafields at order creation time if there's a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n *\n * > Caution: `MetafieldRemoveChange` and `MetafieldUpdateChange` are deprecated. Use cart metafields with `MetafieldRemoveCartChange` and `MetafieldUpdateCartChange` instead. If `MetafieldUpdateChange` writes a metafield with the same namespace and key as a cart metafield that's configured to copy, the cart metafield won't be copied.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyMetafieldChange(change: MetafieldChange): Promise;\n\n /**\n * Sets or removes the buyer's note on the checkout. On success, the\n * [`note`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/note#properties-propertydetail-note)\n * property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyNoteChange(change: NoteChange): Promise;\n\n /**\n * @private\n */\n experimentalIsShopAppStyle?: boolean;\n\n /**\n * Updates the buyer's shipping address on the checkout. The provided fields\n * are merged into the existing address without prompting the buyer. On success,\n * the `shippingAddress` property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyShippingAddressChange?(\n change: ShippingAddressChange,\n ): Promise;\n}" }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -2543,7 +2543,7 @@ "syntaxKind": "PropertySignature", "name": "message", "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer." + "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer.\n\nRender your own localized error text rather than displaying this message to the buyer." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -2553,7 +2553,7 @@ "description": "Indicates that the line item wasn't changed successfully. Refer to the `message` property for details about the error." } ], - "value": "export interface CartLineChangeResultError {\n /**\n * Indicates that the line item wasn't changed successfully. Refer to the `message` property for details about the error.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface CartLineChangeResultError {\n /**\n * Indicates that the line item wasn't changed successfully. Refer to the `message` property for details about the error.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n *\n * Render your own localized error text rather than displaying this message\n * to the buyer.\n */\n message: string;\n}" }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -2733,7 +2733,7 @@ "syntaxKind": "PropertySignature", "name": "message", "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer." + "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer.\n\nRender your own localized error text rather than displaying this message to the buyer." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -2743,7 +2743,7 @@ "description": "Indicates that the gift card change couldn't be applied. Check the `message` property for details." } ], - "value": "export interface GiftCardChangeResultError {\n /**\n * Indicates that the gift card change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface GiftCardChangeResultError {\n /**\n * Indicates that the gift card change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n *\n * Render your own localized error text rather than displaying this message\n * to the buyer.\n */\n message: string;\n}" }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -2908,7 +2908,7 @@ "syntaxKind": "PropertySignature", "name": "message", "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer." + "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer.\n\nRender your own localized error text rather than displaying this message to the buyer." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -2918,7 +2918,7 @@ "description": "Indicates that the metafield change couldn't be applied. Check the `message` property for details." } ], - "value": "export interface MetafieldChangeResultError {\n /**\n * Indicates that the metafield change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface MetafieldChangeResultError {\n /**\n * Indicates that the metafield change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n *\n * Render your own localized error text rather than displaying this message\n * to the buyer.\n */\n message: string;\n}" }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -2996,7 +2996,7 @@ "syntaxKind": "PropertySignature", "name": "message", "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer." + "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer.\n\nRender your own localized error text rather than displaying this message to the buyer." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -3006,7 +3006,7 @@ "description": "Indicates that the note change couldn't be applied. Check the `message` property for details." } ], - "value": "export interface NoteChangeResultError {\n /**\n * Indicates that the note change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface NoteChangeResultError {\n /**\n * Indicates that the note change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n *\n * Render your own localized error text rather than displaying this message\n * to the buyer.\n */\n message: string;\n}" }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -3350,7 +3350,7 @@ "syntaxKind": "PropertySignature", "name": "analytics", "value": "Analytics", - "description": "The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event." + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -3364,7 +3364,7 @@ "syntaxKind": "PropertySignature", "name": "applyTrackingConsentChange", "value": "ApplyTrackingConsentChangeType", - "description": "Enables setting and updating customer privacy consent settings and tracking consent metafields.\n\n> Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent) to be set to `true`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." + "description": "Enables setting and updating customer privacy consent settings and tracking consent metafields.\n\n> Note: Requires the [`collect_buyer_consent` capability](/docs/apps/build/customer-accounts/capabilities#collect-buyer-consent) to be set to `true`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -3385,7 +3385,7 @@ "syntaxKind": "PropertySignature", "name": "availablePaymentOptions", "value": "SubscribableSignalLike", - "description": "All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region." + "description": "All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n\nThe set of payment options can change when the buyer updates their address or cart, so subscribe to changes rather than reading once during initialization. Each option exposes `handle` and `type` only. Provider names, logos, fees, and installment terms aren't available." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -3422,7 +3422,7 @@ "syntaxKind": "PropertySignature", "name": "checkoutToken", "value": "SubscribableSignalLike", - "description": "A stable ID that represents the current checkout.\n\nThe value is `undefined` when the checkout hasn't been created on the server yet.\n\nUse this to correlate checkout sessions across your extension, web pixels, and backend systems.\n\nThis matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data) and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object)." + "description": "A stable ID that represents the current checkout.\n\nThe value is `undefined` when the checkout hasn't been created on the server yet.\n\nUse this to correlate checkout sessions across your extension, web pixels, and backend systems.\n\nThis matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data) and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n\nCan be `undefined`. Handle the `undefined` state before using the value." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -3443,7 +3443,7 @@ "syntaxKind": "PropertySignature", "name": "deliveryGroups", "value": "SubscribableSignalLike", - "description": "The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items." + "description": "The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n\nEmpty until the buyer enters enough address information for Shopify to calculate shipping rates." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -3464,7 +3464,7 @@ "syntaxKind": "PropertySignature", "name": "extension", "value": "Extension", - "description": "The meta information about the extension." + "description": "Metadata about the running extension, including the current target, API version, capabilities, and editor context. Use this to conditionally render content based on where the extension is running." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -3472,7 +3472,7 @@ "name": "extensionPoint", "value": "Target", "description": "The identifier that specifies where in Shopify's UI your code is being injected. This is one of the targets you've included in your extension's configuration file.", - "deprecationMessage": "Deprecated as of version `2023-07`, use `extension.target` instead.", + "deprecationMessage": "Use `extension.target` instead.", "examples": [ { "title": "Example", @@ -3491,14 +3491,14 @@ "syntaxKind": "PropertySignature", "name": "i18n", "value": "I18n", - "description": "Utilities for translating content and formatting values according to the current [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) of the checkout.\n\nRefer to [`localization` examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples) for more information." + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use alongside [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) to build fully localized extensions." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "instructions", "value": "SubscribableSignalLike", - "description": "The cart instructions used to create the checkout and possibly limit extension capabilities.\n\nThese instructions should be checked before performing any actions that might be affected by them.\n\nFor example, if you intend to add a discount code via the `applyDiscountCodeChange` method, check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n\n> Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs aren't available. See the [update guide](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples) for more information." + "description": "The cart instructions used to create the checkout and possibly limit extension capabilities.\n\nThese instructions should be checked before performing any actions that might be affected by them.\n\nFor example, if you intend to add a discount code via the `applyDiscountCodeChange` method, check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n\n> Caution: Check cart instructions before calling select APIs, as > some may not be available. See the > [Cart Instructions API](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples) > for more information." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -3512,7 +3512,7 @@ "syntaxKind": "PropertySignature", "name": "localization", "value": "Localization", - "description": "The details about the location, language, and currency of the customer. For utilities to easily format and translate content based on these details, you can use the [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n) object instead." + "description": "The buyer's language, country, currency, and timezone context. For formatting and translation helpers, use the [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#properties-propertydetail-i18n) object instead." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -3542,21 +3542,21 @@ "syntaxKind": "PropertySignature", "name": "query", "value": ">(query: string, options?: { variables?: Variables; version?: StorefrontApiVersion; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>", - "description": "The method used to query the Storefront GraphQL API with a prefetched token.\n\nRefer to [Storefront API access examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/storefront-api) for more information." + "description": "The method used to query the Storefront GraphQL API with a prefetched token." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "selectedPaymentOptions", "value": "SubscribableSignalLike", - "description": "The payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card)." + "description": "The payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\n\nEach option exposes `handle` and `type` only. Provider names, logos, fees, and installment terms aren't available." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "sessionToken", "value": "SessionToken", - "description": "The session token providing a set of claims as a signed JSON Web Token (JWT).\n\nThe token has a TTL of five minutes.\n\nIf the previous token expires, this value reflects a new session token with a new signature and expiry.\n\nRefer to [session token examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/session-token) for more information." + "description": "The session token providing a set of claims as a signed JSON Web Token (JWT).\n\nThe token has a TTL of five minutes.\n\nIf the previous token expires, this value reflects a new session token with a new signature and expiry.\n\nLearn more about [session tokens](/docs/apps/build/authentication-authorization/session-tokens)." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -3578,14 +3578,14 @@ "syntaxKind": "PropertySignature", "name": "shop", "value": "Shop", - "description": "The shop where the checkout is taking place." + "description": "The store where the checkout is taking place, including the shop name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "storage", "value": "Storage", - "description": "The key-value storage for the extension.\n\nIt uses `localStorage` and should persist across the customer's current checkout session.\n\n> Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n\nData is shared across all activated extension targets of this extension. In versions 2023-07 and earlier, each activated extension target had its own storage." + "description": "Key-value storage that persists across page loads within the current checkout session. Data is shared across all activated targets associated with this extension.\n\n> Caution: Data persistence isn't guaranteed and storage is cleared when the buyer starts a new checkout." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -3607,29 +3607,29 @@ ] } ], - "value": "export interface StandardApi {\n /**\n * The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event.\n */\n analytics: Analytics;\n\n /**\n * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\n */\n appliedGiftCards: SubscribableSignalLike;\n\n /**\n * The cart instructions used to create the checkout and possibly limit extension capabilities.\n *\n * These instructions should be checked before performing any actions that might be affected by them.\n *\n * For example, if you intend to add a discount code via the `applyDiscountCodeChange` method,\n * check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n *\n * > Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs aren't available.\n * See the [update guide](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples) for more information.\n *\n */\n instructions: SubscribableSignalLike;\n\n /**\n * The metafields requested in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration)\n * file. These metafields are updated when there's a change in the merchandise items\n * being purchased by the customer.\n *\n * App owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` isn't supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n appMetafields: SubscribableSignalLike;\n\n /**\n * The custom key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n buyerIdentity?: BuyerIdentity;\n\n /**\n * Provides details on the buyer's progression through the checkout and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/buyer-journey#examples)\n * examples for more information.\n */\n buyerJourney: BuyerJourney;\n\n /**\n * Settings applied to the buyer's checkout.\n */\n checkoutSettings: SubscribableSignalLike;\n\n /**\n * A stable ID that represents the current checkout.\n *\n * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\n *\n * This matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data)\n * and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n */\n checkoutToken: SubscribableSignalLike;\n\n /**\n * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * The meta information about the extension.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n *\n * @deprecated Deprecated as of version `2023-07`, use `extension.target` instead.\n */\n extensionPoint: Target;\n\n /**\n * Utilities for translating content and formatting values according to the current\n * [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization)\n * of the checkout.\n *\n * Refer to [`localization` examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples)\n * for more information.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The details about the location, language, and currency of the customer. For utilities to easily\n * format and translate content based on these details, you can use the\n * [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n)\n * object instead.\n */\n localization: Localization;\n\n /**\n * The metafields that apply to the current checkout.\n *\n * Metafields are stored locally on the client and are applied to the order object after the checkout completes.\n *\n * These metafields are shared by all extensions running on checkout, and\n * persist for as long as the customer is working on this checkout.\n *\n * Once the order is created, you can query these metafields using the\n * [GraphQL Admin API](/docs/admin-api/graphql/reference/orders/order#metafield-2021-01)\n *\n * > Caution:\n * `metafields` is deprecated. Use `appMetafields` with cart metafields instead.\n *\n * @deprecated Use `appMetafields` with cart metafields instead.\n */\n metafields: SubscribableSignalLike;\n\n /**\n * A note left by the customer to the merchant, either in their cart or during checkout.\n *\n * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\n */\n note: SubscribableSignalLike;\n\n /**\n * The method used to query the Storefront GraphQL API with a prefetched token.\n *\n * Refer to [Storefront API access examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/storefront-api) for more information.\n */\n query: >(\n query: string,\n options?: {variables?: Variables; version?: StorefrontApiVersion},\n ) => Promise<{data?: Data; errors?: GraphQLError[]}>;\n\n /**\n * The payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\n */\n selectedPaymentOptions: SubscribableSignalLike;\n\n /**\n * The session token providing a set of claims as a signed JSON Web Token (JWT).\n *\n * The token has a TTL of five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/session-token) for more information.\n */\n sessionToken: SessionToken;\n\n /**\n * The settings matching the settings definition written in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates in real time as a merchant fills in the settings.\n */\n settings: SubscribableSignalLike;\n\n /**\n * The proposed customer shipping address. During the information step, the address\n * updates when the field is committed (on change) rather than every keystroke.\n * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n shippingAddress?: SubscribableSignalLike;\n\n /**\n * The proposed customer billing address. The address updates when the field is\n * committed (on change) rather than every keystroke. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided yet.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n billingAddress?: SubscribableSignalLike;\n\n /** The shop where the checkout is taking place. */\n shop: Shop;\n\n /**\n * The key-value storage for the extension.\n *\n * It uses `localStorage` and should persist across the customer's current checkout session.\n *\n * > Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n *\n * Data is shared across all activated extension targets of this extension. In versions 2023-07 and earlier,\n * each activated extension target had its own storage.\n */\n storage: Storage;\n\n /**\n * The renderer version being used for the extension.\n *\n * @example '2025-10'\n */\n version: Version;\n\n /**\n * Customer privacy consent settings and a flag denoting if consent has previously been collected.\n */\n customerPrivacy: SubscribableSignalLike;\n\n /**\n * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent) to be set to `true`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyTrackingConsentChange: ApplyTrackingConsentChangeType;\n\n /**\n * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" + "value": "export interface StandardApi {\n /**\n * Tracks custom events and sends visitor information to\n * [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events\n * and `visitor()` to submit buyer contact details.\n */\n analytics: Analytics;\n\n /**\n * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\n */\n appliedGiftCards: SubscribableSignalLike;\n\n /**\n * The cart instructions used to create the checkout and possibly limit extension capabilities.\n *\n * These instructions should be checked before performing any actions that might be affected by them.\n *\n * For example, if you intend to add a discount code via the `applyDiscountCodeChange` method,\n * check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n *\n * > Caution: Check cart instructions before calling select APIs, as\n * > some may not be available. See the\n * > [Cart Instructions API](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples)\n * > for more information.\n *\n */\n instructions: SubscribableSignalLike;\n\n /**\n * The metafields requested in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration)\n * file. These metafields are updated when there's a change in the merchandise items\n * being purchased by the customer.\n *\n * App owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` isn't supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n appMetafields: SubscribableSignalLike;\n\n /**\n * The custom key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as\n * credit cards, wallets, and local payment methods. The list depends on\n * the shop's payment configuration and the buyer's region.\n *\n * The set of payment options can change when the buyer updates their\n * address or cart, so subscribe to changes rather than reading once\n * during initialization. Each option exposes `handle` and `type` only.\n * Provider names, logos, fees, and installment terms aren't available.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n buyerIdentity?: BuyerIdentity;\n\n /**\n * Provides details on the buyer's progression through the checkout and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/buyer-journey#examples)\n * examples for more information.\n */\n buyerJourney: BuyerJourney;\n\n /**\n * Settings applied to the buyer's checkout.\n */\n checkoutSettings: SubscribableSignalLike;\n\n /**\n * A stable ID that represents the current checkout.\n *\n * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\n *\n * This matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data)\n * and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n *\n * Can be `undefined`. Handle the `undefined` state before using the value.\n */\n checkoutToken: SubscribableSignalLike;\n\n /**\n * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n *\n * Empty until the buyer enters enough address information for Shopify to\n * calculate shipping rates.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * Metadata about the running extension, including the current target, API version,\n * capabilities, and editor context. Use this to conditionally render content\n * based on where the extension is running.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n *\n * @deprecated Use `extension.target` instead.\n */\n extensionPoint: Target;\n\n /**\n * Utilities for translating strings, formatting currencies, numbers, and dates\n * according to the buyer's locale. Use alongside\n * [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization)\n * to build fully localized extensions.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The buyer's language, country, currency, and timezone context. For\n * formatting and translation helpers, use the\n * [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#properties-propertydetail-i18n)\n * object instead.\n */\n localization: Localization;\n\n /**\n * The metafields that apply to the current checkout.\n *\n * Metafields are stored locally on the client and are applied to the order object after the checkout completes.\n *\n * These metafields are shared by all extensions running on checkout, and\n * persist for as long as the customer is working on this checkout.\n *\n * Once the order is created, you can query these metafields using the\n * [GraphQL Admin API](/docs/admin-api/graphql/reference/orders/order#metafield-2021-01)\n *\n * > Caution:\n * `metafields` is deprecated. Use `appMetafields` with cart metafields instead.\n *\n * @deprecated Use `appMetafields` with cart metafields instead.\n */\n metafields: SubscribableSignalLike;\n\n /**\n * A note left by the customer to the merchant, either in their cart or during checkout.\n *\n * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\n */\n note: SubscribableSignalLike;\n\n /**\n * The method used to query the Storefront GraphQL API with a prefetched token.\n *\n */\n query: >(\n query: string,\n options?: {variables?: Variables; version?: StorefrontApiVersion},\n ) => Promise<{data?: Data; errors?: GraphQLError[]}>;\n\n /**\n * The payment options the buyer has currently selected. This updates as\n * the buyer changes their payment method. The array can contain multiple\n * entries when the buyer splits payment across methods (for example, a\n * gift card and a credit card).\n *\n * Each option exposes `handle` and `type` only. Provider names, logos,\n * fees, and installment terms aren't available.\n */\n selectedPaymentOptions: SubscribableSignalLike;\n\n /**\n * The session token providing a set of claims as a signed JSON Web Token (JWT).\n *\n * The token has a TTL of five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Learn more about [session tokens](/docs/apps/build/authentication-authorization/session-tokens).\n */\n sessionToken: SessionToken;\n\n /**\n * The settings matching the settings definition written in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates in real time as a merchant fills in the settings.\n */\n settings: SubscribableSignalLike;\n\n /**\n * The proposed customer shipping address. During the information step, the address\n * updates when the field is committed (on change) rather than every keystroke.\n * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n shippingAddress?: SubscribableSignalLike;\n\n /**\n * The proposed customer billing address. The address updates when the field is\n * committed (on change) rather than every keystroke. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided yet.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n billingAddress?: SubscribableSignalLike;\n\n /**\n * The store where the checkout is taking place, including the shop name,\n * storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.\n */\n shop: Shop;\n\n /**\n * Key-value storage that persists across page loads within the current checkout\n * session. Data is shared across all activated targets associated with\n * this extension.\n *\n * > Caution: Data persistence isn't guaranteed and storage is cleared when the\n * buyer starts a new checkout.\n */\n storage: Storage;\n\n /**\n * The renderer version being used for the extension.\n *\n * @example '2025-10'\n */\n version: Version;\n\n /**\n * Customer privacy consent settings and a flag denoting if consent has previously been collected.\n */\n customerPrivacy: SubscribableSignalLike;\n\n /**\n * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`collect_buyer_consent` capability](/docs/apps/build/customer-accounts/capabilities#collect-buyer-consent) to be set to `true`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyTrackingConsentChange: ApplyTrackingConsentChangeType;\n\n /**\n * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Analytics", - "description": "", + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "publish", "value": "(name: string, data: Record) => Promise", - "description": "Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing)." + "description": "Publishes a custom event to [Web Pixels](/docs/apps/marketing). Returns `true` when the event is successfully dispatched.\n\nThe Promise resolves to `true` when the event was dispatched. The boolean indicates dispatch confirmation only. It doesn't indicate whether any specific web pixel processed the event." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "visitor", "value": "(data: { email?: string; phone?: string; }) => Promise", - "description": "A method for capturing details about a visitor on the online store." + "description": "Submits buyer contact details for attribution and analytics purposes." } ], - "value": "export interface Analytics {\n /**\n * Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing).\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * A method for capturing details about a visitor on the online store.\n */\n visitor(data: {email?: string; phone?: string}): Promise;\n}" + "value": "export interface Analytics {\n /**\n * Publishes a custom event to [Web Pixels](/docs/apps/marketing).\n * Returns `true` when the event is successfully dispatched.\n *\n * The Promise resolves to `true` when the event was dispatched. The boolean\n * indicates dispatch confirmation only. It doesn't indicate whether any\n * specific web pixel processed the event.\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * Submits buyer contact details for attribution and analytics purposes.\n */\n visitor(data: {email?: string; phone?: string}): Promise;\n}" }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -3670,10 +3670,10 @@ "syntaxKind": "PropertySignature", "name": "type", "value": "'error'", - "description": "Indicates that the visitor information is invalid and wasn't submitted. Examples are using the wrong data type or missing a required property." + "description": "Indicates that the visitor information is invalid and wasn't submitted. Common causes include using the wrong data type or omitting a required property." } ], - "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Examples are using the wrong data type or missing a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Common causes include using the wrong data type or omitting a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -3808,10 +3808,10 @@ "syntaxKind": "PropertySignature", "name": "value", "value": "string | null", - "description": "The new value to store in the metafield. Set to `null` to delete the metafield." + "description": "The new value to store in the metafield. Set to `null` to delete the metafield.\n\nConsent metafield values are strings, not booleans. Pass `null` to delete a tracking consent metafield." } ], - "value": "export interface TrackingConsentMetafieldChange {\n /**\n * The identifier for the tracking consent metafield to update.\n */\n key: string;\n /**\n * The new value to store in the metafield. Set to `null` to delete the metafield.\n */\n value: string | null;\n}" + "value": "export interface TrackingConsentMetafieldChange {\n /**\n * The identifier for the tracking consent metafield to update.\n */\n key: string;\n /**\n * The new value to store in the metafield. Set to `null` to delete the metafield.\n *\n * Consent metafield values are strings, not booleans. Pass `null` to delete\n * a tracking consent metafield.\n */\n value: string | null;\n}" }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -4110,7 +4110,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A globally-unique identifier for the customer in the format `gid://shopify/Customer/`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", + "description": "An identifier for the customer in the format `gid://shopify/Customer/`. This value is unique per shop.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", "examples": [ { "title": "Example", @@ -4163,7 +4163,7 @@ "isPrivate": true } ], - "value": "export interface Customer {\n /**\n * A globally-unique identifier for the customer in the format `gid://shopify/Customer/`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'gid://shopify/Customer/123'\n */\n id: string;\n /**\n * The email address associated with the customer's account. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email?: string;\n /**\n * The phone number associated with the customer's account. The value is `undefined` if no phone number is on file or the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone?: string;\n /**\n * The customer's full name, typically a combination of first and last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n fullName?: string;\n /**\n * The customer's first name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n firstName?: string;\n /**\n * The customer's last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n lastName?: string;\n /**\n * The customer's profile image, such as a Gravatar avatar. Use this to personalize the extension UI for the logged-in buyer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n image: ImageDetails;\n /**\n * Whether the customer has opted in to receiving marketing communications from the merchant, such as email campaigns and promotional offers.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * > Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n *\n * @deprecated Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n */\n acceptsMarketing: boolean;\n /**\n * Whether the customer has opted in to email marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsEmailMarketing: boolean;\n /**\n * Whether the customer has opted in to SMS marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsSmsMarketing: boolean;\n /**\n * The store credit accounts owned by this customer that can be used as payment during checkout. Each account has a balance representing available store credit.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @private\n */\n storeCreditAccounts: StoreCreditAccount[];\n /**\n * The number of orders the customer has previously placed with this shop.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n ordersCount: number;\n}" + "value": "export interface Customer {\n /**\n * An identifier for the customer in the format `gid://shopify/Customer/`. This value is unique per shop.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'gid://shopify/Customer/123'\n */\n id: string;\n /**\n * The email address associated with the customer's account. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email?: string;\n /**\n * The phone number associated with the customer's account. The value is `undefined` if no phone number is on file or the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone?: string;\n /**\n * The customer's full name, typically a combination of first and last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n fullName?: string;\n /**\n * The customer's first name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n firstName?: string;\n /**\n * The customer's last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n lastName?: string;\n /**\n * The customer's profile image, such as a Gravatar avatar. Use this to personalize the extension UI for the logged-in buyer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n image: ImageDetails;\n /**\n * Whether the customer has opted in to receiving marketing communications from the merchant, such as email campaigns and promotional offers.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * > Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n *\n * @deprecated Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n */\n acceptsMarketing: boolean;\n /**\n * Whether the customer has opted in to email marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsEmailMarketing: boolean;\n /**\n * Whether the customer has opted in to SMS marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsSmsMarketing: boolean;\n /**\n * The store credit accounts owned by this customer that can be used as payment during checkout. Each account has a balance representing available store credit.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @private\n */\n storeCreditAccounts: StoreCreditAccount[];\n /**\n * The number of orders the customer has previously placed with this shop.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n ordersCount: number;\n}" }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -4422,11 +4422,11 @@ "syntaxKind": "MethodSignature", "name": "perform", "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", + "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.\n\nRuns after all intercept results are collected. Use it for local state updates such as setting an error flag. By the time it runs, the navigation decision is final, so blocking logic belongs in the intercept handler itself, not here.", "isOptional": true } ], - "value": "interface InterceptorRequestAllow {\n /**\n * Indicates that the interceptor allows the buyer's journey to continue.\n */\n behavior: 'allow';\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" + "value": "interface InterceptorRequestAllow {\n /**\n * Indicates that the interceptor allows the buyer's journey to continue.\n */\n behavior: 'allow';\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n *\n * Runs after all intercept results are collected. Use it for local state\n * updates such as setting an error flag. By the time it runs, the navigation\n * decision is final, so blocking logic belongs in the intercept handler\n * itself, not here.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -4490,7 +4490,7 @@ "syntaxKind": "MethodSignature", "name": "perform", "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", + "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.\n\nRuns after all intercept results are collected. Use it for local state updates such as setting an error flag. By the time it runs, the navigation decision is final, so blocking logic belongs in the intercept handler itself, not here.", "isOptional": true }, { @@ -4501,7 +4501,7 @@ "description": "The reason for blocking the interceptor request. This value isn't presented to the buyer, so it doesn't need to be localized. The value is used only for Shopify's own internal debugging and metrics." } ], - "value": "interface InterceptorRequestBlock {\n /**\n * Indicates that the interceptor blocks the buyer's journey from continuing.\n */\n behavior: 'block';\n\n /**\n * The reason for blocking the interceptor request. This value isn't presented to\n * the buyer, so it doesn't need to be localized. The value is used only for Shopify's\n * own internal debugging and metrics.\n */\n reason: string;\n\n /**\n * Used to pass errors to the checkout UI, outside your extension's UI boundaries.\n */\n errors?: ValidationError[];\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" + "value": "interface InterceptorRequestBlock {\n /**\n * Indicates that the interceptor blocks the buyer's journey from continuing.\n */\n behavior: 'block';\n\n /**\n * The reason for blocking the interceptor request. This value isn't presented to\n * the buyer, so it doesn't need to be localized. The value is used only for Shopify's\n * own internal debugging and metrics.\n */\n reason: string;\n\n /**\n * Used to pass errors to the checkout UI, outside your extension's UI boundaries.\n */\n errors?: ValidationError[];\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n *\n * Runs after all intercept results are collected. Use it for local state\n * updates such as setting an error flag. By the time it runs, the navigation\n * decision is final, so blocking logic belongs in the intercept handler\n * itself, not here.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" }, { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -4722,17 +4722,17 @@ "syntaxKind": "PropertySignature", "name": "totalShippingAmount", "value": "SubscribableSignalLike", - "description": "The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step." + "description": "The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step.\n\n`undefined` until the buyer selects a shipping method (typically after the information step)." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "totalTaxAmount", "value": "SubscribableSignalLike", - "description": "The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet." + "description": "The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet.\n\n`undefined` when taxes haven't been calculated or aren't available for the buyer's region." } ], - "value": "export interface CartCost {\n /**\n * The sum of all line item prices at the current step of checkout, before shipping and taxes are applied. Use this value to display the base cost of the items the buyer purchased.\n */\n subtotalAmount: SubscribableSignalLike;\n\n /**\n * The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step.\n */\n totalShippingAmount: SubscribableSignalLike;\n\n /**\n * The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet.\n */\n totalTaxAmount: SubscribableSignalLike;\n\n /**\n * The minimum total at the current step of checkout. Costs not yet calculated, such as shipping on the information step, aren't included. Gift cards and store credits are excluded from this total.\n */\n totalAmount: SubscribableSignalLike;\n}" + "value": "export interface CartCost {\n /**\n * The sum of all line item prices at the current step of checkout, before shipping and taxes are applied. Use this value to display the base cost of the items the buyer purchased.\n */\n subtotalAmount: SubscribableSignalLike;\n\n /**\n * The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step.\n *\n * `undefined` until the buyer selects a shipping method (typically after the\n * information step).\n */\n totalShippingAmount: SubscribableSignalLike;\n\n /**\n * The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet.\n *\n * `undefined` when taxes haven't been calculated or aren't available for the\n * buyer's region.\n */\n totalTaxAmount: SubscribableSignalLike;\n\n /**\n * The minimum total at the current step of checkout. Costs not yet calculated, such as shipping on the information step, aren't included. Gift cards and store credits are excluded from this total.\n */\n totalAmount: SubscribableSignalLike;\n}" }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -4819,31 +4819,31 @@ "syntaxKind": "PropertySignature", "name": "analytics", "value": "boolean", - "description": "Whether analytics data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Analytics data includes how the shop was used and what interactions occurred." + "description": "Whether analytics data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Analytics data includes how the shop was used and what interactions occurred.\n\nWhether analytics data can be collected right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.analytics`, before calling `shopify.analytics.publish()`." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "marketing", "value": "boolean", - "description": "Whether marketing data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Marketing data includes attribution and targeted advertising preferences." + "description": "Whether marketing data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Marketing data includes attribution and targeted advertising preferences.\n\nWhether marketing data can be collected right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.marketing`, before performing marketing-related data collection." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "preferences", "value": "boolean", - "description": "Whether preference data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Preference data includes language, currency, and sizing choices." + "description": "Whether preference data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Preference data includes language, currency, and sizing choices.\n\nWhether preference data can be collected right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.preferences`, before storing or reading buyer preference data." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "saleOfData", "value": "boolean", - "description": "Whether data can be shared with third parties based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. This typically applies to behavioral advertising data." + "description": "Whether data can be shared with third parties based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. This typically applies to behavioral advertising data.\n\nWhether buyer data can be shared with or sold to third parties right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.saleOfData`, before sharing or selling buyer data with third parties." } ], - "value": "export interface AllowedProcessing {\n /**\n * Whether analytics data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Analytics\n * data includes how the shop was used and what interactions occurred.\n */\n analytics: boolean;\n /**\n * Whether marketing data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Marketing\n * data includes attribution and targeted advertising preferences.\n */\n marketing: boolean;\n /**\n * Whether preference data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Preference\n * data includes language, currency, and sizing choices.\n */\n preferences: boolean;\n /**\n * Whether data can be shared with third parties based on the visitor's\n * consent, the merchant's privacy configuration, and the visitor's region.\n * This typically applies to behavioral advertising data.\n */\n saleOfData: boolean;\n}" + "value": "export interface AllowedProcessing {\n /**\n * Whether analytics data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Analytics\n * data includes how the shop was used and what interactions occurred.\n *\n * Whether analytics data can be collected right now. Combines the buyer's\n * consent, the merchant's privacy configuration, and the buyer's region into\n * a single boolean. Check this flag, not `visitorConsent.analytics`, before\n * calling `shopify.analytics.publish()`.\n */\n analytics: boolean;\n /**\n * Whether marketing data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Marketing\n * data includes attribution and targeted advertising preferences.\n *\n * Whether marketing data can be collected right now. Combines the buyer's\n * consent, the merchant's privacy configuration, and the buyer's region into\n * a single boolean. Check this flag, not `visitorConsent.marketing`, before\n * performing marketing-related data collection.\n */\n marketing: boolean;\n /**\n * Whether preference data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Preference\n * data includes language, currency, and sizing choices.\n *\n * Whether preference data can be collected right now. Combines the buyer's\n * consent, the merchant's privacy configuration, and the buyer's region into\n * a single boolean. Check this flag, not `visitorConsent.preferences`,\n * before storing or reading buyer preference data.\n */\n preferences: boolean;\n /**\n * Whether data can be shared with third parties based on the visitor's\n * consent, the merchant's privacy configuration, and the visitor's region.\n * This typically applies to behavioral advertising data.\n *\n * Whether buyer data can be shared with or sold to third parties right now.\n * Combines the buyer's consent, the merchant's privacy configuration, and\n * the buyer's region into a single boolean. Check this flag, not\n * `visitorConsent.saleOfData`, before sharing or selling buyer data with\n * third parties.\n */\n saleOfData: boolean;\n}" }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -4933,7 +4933,7 @@ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Extension", - "description": "The meta information about an extension target.", + "description": "Metadata about the running extension, including its API version, target, capabilities, and editor context. Use this to read configuration details or conditionally render content based on where the extension is running.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -4959,7 +4959,7 @@ "syntaxKind": "PropertySignature", "name": "capabilities", "value": "SubscribableSignalLike", - "description": "The allowed capabilities of the extension, defined in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n\n* [`api_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#api-access): the extension can access the Storefront API.\n\n* [`network_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access): the extension can make external network calls.\n\n* [`block_progress`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n\n* [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n\n* [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can register customer consent decisions that are honored on Shopify-managed services.\n\n* [`iframe.sources`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#iframe): the extension can embed an external URL in an iframe." + "description": "The allowed capabilities of the extension, defined in your [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -5007,7 +5007,7 @@ "syntaxKind": "PropertySignature", "name": "version", "value": "string", - "description": "The published version of the running extension target.\n\nFor unpublished extensions, the value is `undefined`.", + "description": "The published version of the running extension target.\n\nFor unpublished extensions, the value is `undefined`.\n\nDon't use this property as a stable identifier in development environments. It becomes available only after the extension is published.", "isOptional": true, "examples": [ { @@ -5023,7 +5023,7 @@ ] } ], - "value": "export interface Extension {\n /**\n * The API version that was set in the extension config file.\n *\n * @example '2024-10', '2025-01', '2025-04', '2025-07', '2025-10'\n */\n apiVersion: ApiVersion;\n\n /**\n * The allowed capabilities of the extension, defined\n * in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n *\n * * [`api_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#api-access): the extension can access the Storefront API.\n *\n * * [`network_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access): the extension can make external network calls.\n *\n * * [`block_progress`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n *\n * * [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n *\n * * [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can register customer consent decisions that are honored on Shopify-managed services.\n *\n * * [`iframe.sources`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#iframe): the extension can embed an external URL in an iframe.\n */\n capabilities: SubscribableSignalLike;\n\n /**\n * Information about the editor where the extension is being rendered.\n *\n * If the value is undefined, then the extension isn't running in an editor.\n */\n editor?: Editor;\n\n /**\n * A Boolean to show whether your extension is currently rendered to the screen.\n *\n * Shopify might render your extension before it's visible in the UI,\n * typically to pre-render extensions that appear on a later step of the\n * checkout.\n *\n * Your extension might also continue to run after the customer has navigated away\n * from where it was rendered. The extension continues running so that\n * your extension is immediately available to render if the customer navigates back.\n */\n rendered: SubscribableSignalLike;\n\n /**\n * The URL to the script that started the extension target.\n */\n scriptUrl: string;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n */\n target: Target;\n\n /**\n * The published version of the running extension target.\n *\n * For unpublished extensions, the value is `undefined`.\n *\n * @example 3.0.10\n */\n version?: string;\n}" + "value": "export interface Extension {\n /**\n * The API version that was set in the extension config file.\n *\n * @example '2024-10', '2025-01', '2025-04', '2025-07', '2025-10'\n */\n apiVersion: ApiVersion;\n\n /**\n * The allowed capabilities of the extension, defined in your\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n */\n capabilities: SubscribableSignalLike;\n\n /**\n * Information about the editor where the extension is being rendered.\n *\n * If the value is undefined, then the extension isn't running in an editor.\n */\n editor?: Editor;\n\n /**\n * A Boolean to show whether your extension is currently rendered to the screen.\n *\n * Shopify might render your extension before it's visible in the UI,\n * typically to pre-render extensions that appear on a later step of the\n * checkout.\n *\n * Your extension might also continue to run after the customer has navigated away\n * from where it was rendered. The extension continues running so that\n * your extension is immediately available to render if the customer navigates back.\n */\n rendered: SubscribableSignalLike;\n\n /**\n * The URL to the script that started the extension target.\n */\n scriptUrl: string;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n */\n target: Target;\n\n /**\n * The published version of the running extension target.\n *\n * For unpublished extensions, the value is `undefined`.\n *\n * Don't use this property as a stable identifier in development environments.\n * It becomes available only after the extension is published.\n *\n * @example 3.0.10\n */\n version?: string;\n}" }, { "filePath": "src/shared.ts", @@ -5042,7 +5042,7 @@ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Editor", - "description": "", + "description": "Information about the editor environment when an extension is rendered inside the checkout editor. The value is `undefined` when the extension is not rendering in an editor.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -5057,7 +5057,7 @@ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18n", - "description": "", + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use the I18n API alongside the Localization API to build fully localized extensions.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -5093,7 +5093,7 @@ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18nTranslate", - "description": "This returns a translated string matching a key in a locale file.", + "description": "Translates a key from your extension's locale files into a localized string. Supports interpolation with placeholder replacements and pluralization via the special `count` option.", "members": [], "value": "export interface I18nTranslate {\n (\n key: string,\n options?: Record,\n ): ReplacementType extends string | number\n ? string\n : (string | ReplacementType)[];\n}" }, @@ -5261,14 +5261,14 @@ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Localization", - "description": "", + "description": "The buyer's language, country, currency, and timezone context. Use this to adapt your extension to the buyer's region and display localized content.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "country", "value": "SubscribableSignalLike", - "description": "The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown." + "description": "The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n\nDerived from the buyer's shipping address. Returns `undefined` until the buyer enters a shipping address." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -5296,18 +5296,18 @@ "syntaxKind": "PropertySignature", "name": "market", "value": "SubscribableSignalLike", - "description": "The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n\n> Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.", - "deprecationMessage": "Deprecated as of version `2025-04`" + "description": "The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. The market context updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.", + "deprecationMessage": "Merchants now manage which extensions load for each\nmarket, so extensions no longer need to check this value." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "timezone", "value": "SubscribableSignalLike", - "description": "The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time." + "description": "The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time." } ], - "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n *\n * > Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" + "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n *\n * Derived from the buyer's shipping address. Returns `undefined` until the\n * buyer enters a shipping address.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout,\n * carried over from the cart context. Markets group countries and\n * regions with shared pricing, languages, and domains. The market\n * context updates when the buyer changes the country of their\n * shipping address. The value is `undefined` if the market is unknown.\n *\n * @deprecated Merchants now manage which extensions load for each\n * market, so extensions no longer need to check this value.\n */\n market: SubscribableSignalLike;\n}" }, { "filePath": "src/shared.ts", @@ -5508,7 +5508,7 @@ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SessionToken", - "description": "", + "description": "Authenticates requests between your extension and your app backend. Use session tokens to verify the identity of the buyer and the shop context when making server-side API calls. The token is a signed JWT that contains claims such as the customer ID, shop domain, and expiration.\n\nThe `sub` claim in the decoded token is present only when the buyer is logged in and the app has permission to read customer accounts. Absent for anonymous buyers.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -5531,7 +5531,7 @@ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Shop", - "description": "", + "description": "Metadata about the merchant's store, including its name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -5571,30 +5571,30 @@ "syntaxKind": "PropertySignature", "name": "storefrontUrl", "value": "string", - "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n\n> Caution: > As of version `2024-04` this value no longer has a trailing slash.", + "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.", "isOptional": true } ], - "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n *\n * > Caution:\n * > As of version `2024-04` this value no longer has a trailing slash.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom domain.\n */\n myshopifyDomain: string;\n}" + "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom domain.\n */\n myshopifyDomain: string;\n}" }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Storage", - "description": "A key-value storage object for the extension.\n\nStored data is available only to this specific extension and any of its instances.\n\nThe storage backend is implemented with `localStorage` and should persist across the buyer's checkout session. However, data persistence isn't guaranteed.", + "description": "Key-value storage for a specific extension. Use storage to save preferences or cached data that should survive page reloads without requiring a backend call. Stored data is only available to this specific extension. The storage backend is implemented with `localStorage` and data persistence isn't guaranteed.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "delete", "value": "(key: string) => Promise", - "description": "Delete stored data by key." + "description": "Deletes a previously stored value by key." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "read", "value": "(key: string) => Promise", - "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original primitive.\n\nReturns `null` if no stored data exists." + "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original type.\n\nReturns the stored value for the given key, or `null` when no value exists. Doesn't throw on a missing key." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -5604,7 +5604,7 @@ "description": "Write stored data for this key.\n\nThe data must be serializable to JSON." } ], - "value": "export interface Storage {\n /**\n * Read and return a stored value by key.\n *\n * The stored data is deserialized from JSON and returned as\n * its original primitive.\n *\n * Returns `null` if no stored data exists.\n */\n read(key: string): Promise;\n\n /**\n * Write stored data for this key.\n *\n * The data must be serializable to JSON.\n */\n write(key: string, data: any): Promise;\n\n /**\n * Delete stored data by key.\n */\n delete(key: string): Promise;\n}" + "value": "export interface Storage {\n /**\n * Read and return a stored value by key.\n *\n * The stored data is deserialized from JSON and returned as\n * its original type.\n *\n * Returns the stored value for the given key, or `null` when no value\n * exists. Doesn't throw on a missing key.\n */\n read(key: string): Promise;\n\n /**\n * Write stored data for this key.\n *\n * The data must be serializable to JSON.\n */\n write(key: string, data: any): Promise;\n\n /**\n * Deletes a previously stored value by key.\n */\n delete(key: string): Promise;\n}" }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -5888,7 +5888,7 @@ "syntaxKind": "PropertySignature", "name": "number", "value": "string", - "description": "A randomly generated alpha-numeric identifier for the order, distinct from `order.id`. The value is `undefined` for orders that were created before this field was introduced. All recent orders have a number.", + "description": "A randomly generated alpha-numeric identifier for the order, distinct from `order.id`. The value is `undefined` for orders that were created before this field was introduced. All recent orders have a number.\n\nOptional. Might not be present for orders created before 2024.", "isOptional": true }, { @@ -5899,7 +5899,7 @@ "description": "" } ], - "value": "export interface OrderConfirmation {\n order: {\n /**\n * A globally unique identifier for the order. This becomes the\n * [`Order`](/docs/api/admin-graphql/latest/objects/Order) object ID in the\n * GraphQL Admin API after the order is created.\n *\n * @example 'gid://shopify/Order/123'\n */\n id: string;\n };\n /**\n * A randomly generated alpha-numeric identifier for the order, distinct\n * from `order.id`. The value is `undefined` for orders that were created\n * before this field was introduced. All recent orders have a number.\n */\n number?: string;\n\n /**\n * Whether this is the customer's first completed order with this shop. `true` means the buyer hasn't placed an order here before. Use this to show first-purchase messaging or trigger welcome offers.\n */\n isFirstOrder: boolean;\n}" + "value": "export interface OrderConfirmation {\n order: {\n /**\n * A globally unique identifier for the order. This becomes the\n * [`Order`](/docs/api/admin-graphql/latest/objects/Order) object ID in the\n * GraphQL Admin API after the order is created.\n *\n * @example 'gid://shopify/Order/123'\n */\n id: string;\n };\n /**\n * A randomly generated alpha-numeric identifier for the order, distinct\n * from `order.id`. The value is `undefined` for orders that were created\n * before this field was introduced. All recent orders have a number.\n *\n * Optional. Might not be present for orders created before 2024.\n */\n number?: string;\n\n /**\n * Whether this is the customer's first completed order with this shop. `true` means the buyer hasn't placed an order here before. Use this to show first-purchase messaging or trigger welcome offers.\n */\n isFirstOrder: boolean;\n}" }, { "filePath": "src/surfaces/checkout/shared.ts", @@ -6036,7 +6036,7 @@ "syntaxKind": "PropertySignature", "name": "localization", "value": "Localization", - "description": "The details about the location, language, and currency of the customer. For utilities to easily format and translate content based on these details, you can use the [`i18n`](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-i18n) object instead." + "description": "The details about the location, language, and currency of the customer. For utilities to easily format and translate content based on these details, you can use the [`i18n`](/docs/api/checkout-ui-extensions/apis/localization#properties-propertydetail-i18n) object instead." }, { "filePath": "src/surfaces/checkout/api/address-autocomplete/standard.ts", @@ -6058,7 +6058,7 @@ "syntaxKind": "PropertySignature", "name": "sessionToken", "value": "SessionToken", - "description": "The session token providing a set of claims as a signed JSON Web Token (JWT).\n\nThe token has a TTL of 5 minutes.\n\nIf the previous token expires, this value will reflect a new session token with a new signature and expiry.\n\nRefer to [session token examples](/docs/api/checkout-ui-extensions/apis/session-token) for more information." + "description": "The session token providing a set of claims as a signed JSON Web Token (JWT).\n\nThe token has a TTL of 5 minutes.\n\nIf the previous token expires, this value will reflect a new session token with a new signature and expiry.\n\nLearn more about [session tokens](/docs/apps/build/authentication-authorization/session-tokens)." }, { "filePath": "src/surfaces/checkout/api/address-autocomplete/standard.ts", @@ -6109,7 +6109,7 @@ ] } ], - "value": "export interface AddressAutocompleteStandardApi<\n Target extends\n | 'purchase.address-autocomplete.suggest'\n | 'purchase.address-autocomplete.format-suggestion',\n> {\n /**\n * The metafields requested in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration)\n * file. These metafields are updated when there's a change in the merchandise items\n * being purchased by the customer.\n *\n * App owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` is not supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * > Tip:\n * > Cart metafields are only available on carts created via the Storefront API version `2023-04` or later.*\n */\n appMetafields: AppMetafieldEntry[];\n\n /**\n * The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event.\n */\n analytics: Analytics;\n\n /**\n * The custom attributes left by the customer to the merchant, either in their cart or during checkout.\n */\n attributes: Attribute[] | undefined;\n\n /**\n * The proposed customer billing address. The address updates when the field is\n * committed (on change) rather than every keystroke.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n billingAddress?: MailingAddress | undefined;\n\n /**\n * A stable ID that represents the current checkout.\n *\n * This matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data)\n * and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n */\n checkoutToken: CheckoutToken | undefined;\n\n /**\n * The meta information about the extension.\n */\n extension: Extension;\n\n /**\n * Utilities for translating content and formatting values according to the current\n * [`localization`](/docs/api/checkout-ui-extensions/apis/localization)\n * Type 'RunnableExtensionInstance' is not assignable to type 'ExtensionInstance'.\n *\n * Refer to [`localization` examples](/docs/api/checkout-ui-extensions/apis/localization#examples)\n * for more information.\n */\n i18n: I18n;\n\n /**\n * The details about the location, language, and currency of the customer. For utilities to easily\n * format and translate content based on these details, you can use the\n * [`i18n`](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-i18n)\n * object instead.\n */\n localization: Localization;\n\n /**\n * The metafields that apply to the current checkout.\n *\n * Metafields are stored locally on the client and are applied to the order object after the checkout completes.\n * They are shared by all extensions running on checkout, and\n * persist for as long as the customer is working on this checkout.\n *\n * Once the order is created, you can query these metafields using the\n * [GraphQL Admin API](/docs/admin-api/graphql/reference/orders/order#metafield-2021-01)\n *\n * > Caution:\n * `metafields` is deprecated. Use `appMetafields` with cart metafields instead.\n *\n * @deprecated Use `appMetafields` with cart metafields instead.\n */\n metafields: Metafield[];\n\n /**\n * The method used to query the Storefront GraphQL API with a prefetched token.\n *\n * Refer to [Storefront API access examples](/docs/api/checkout-ui-extensions/apis/storefront-api) for more information.\n */\n query: >(\n query: string,\n options?: {variables?: Variables; version?: StorefrontApiVersion},\n ) => Promise<{data?: Data; errors?: GraphQLError[]}>;\n\n /**\n * The session token providing a set of claims as a signed JSON Web Token (JWT).\n *\n * The token has a TTL of 5 minutes.\n *\n * If the previous token expires, this value will reflect a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/apis/session-token) for more information.\n */\n sessionToken: SessionToken;\n\n /**\n * The settings matching the settings definition written in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/apis/settings#examples) for more information.\n *\n * > Note: The settings are empty when an extension is being installed in the [checkout editor](https://help.shopify.com/en/manual/checkout-settings/checkout-extensibility/checkout-editor).\n\n */\n settings: ExtensionSettings;\n\n /**\n * The proposed customer shipping address. During the information step,\n * the address updates when the field is committed (on change) rather than every keystroke.\n *\n * > Note: An address value is only present if delivery is required. Otherwise, the subscribable value is undefined.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n shippingAddress?: MailingAddress | undefined;\n\n /** The shop where the checkout is taking place. */\n shop: Shop;\n\n /**\n * The key-value storage for the extension.\n *\n * It uses `localStorage` and should persist across the customer's current checkout session.\n *\n * > Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n *\n * Data is shared across all activated extension targets of this extension. In versions 2023-07 and earlier,\n * each activated extension target had its own storage.\n */\n storage: Storage;\n\n /**\n * The runner version being used for the extension.\n *\n * @example 'unstable'\n */\n version: Version;\n}" + "value": "export interface AddressAutocompleteStandardApi<\n Target extends\n | 'purchase.address-autocomplete.suggest'\n | 'purchase.address-autocomplete.format-suggestion',\n> {\n /**\n * The metafields requested in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration)\n * file. These metafields are updated when there's a change in the merchandise items\n * being purchased by the customer.\n *\n * App owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` is not supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * > Tip:\n * > Cart metafields are only available on carts created via the Storefront API version `2023-04` or later.*\n */\n appMetafields: AppMetafieldEntry[];\n\n /**\n * The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event.\n */\n analytics: Analytics;\n\n /**\n * The custom attributes left by the customer to the merchant, either in their cart or during checkout.\n */\n attributes: Attribute[] | undefined;\n\n /**\n * The proposed customer billing address. The address updates when the field is\n * committed (on change) rather than every keystroke.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n billingAddress?: MailingAddress | undefined;\n\n /**\n * A stable ID that represents the current checkout.\n *\n * This matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data)\n * and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n */\n checkoutToken: CheckoutToken | undefined;\n\n /**\n * The meta information about the extension.\n */\n extension: Extension;\n\n /**\n * Utilities for translating content and formatting values according to the current\n * [`localization`](/docs/api/checkout-ui-extensions/apis/localization)\n * Type 'RunnableExtensionInstance' is not assignable to type 'ExtensionInstance'.\n *\n * Refer to [`localization` examples](/docs/api/checkout-ui-extensions/apis/localization#examples)\n * for more information.\n */\n i18n: I18n;\n\n /**\n * The details about the location, language, and currency of the customer. For utilities to easily\n * format and translate content based on these details, you can use the\n * [`i18n`](/docs/api/checkout-ui-extensions/apis/localization#properties-propertydetail-i18n)\n * object instead.\n */\n localization: Localization;\n\n /**\n * The metafields that apply to the current checkout.\n *\n * Metafields are stored locally on the client and are applied to the order object after the checkout completes.\n * They are shared by all extensions running on checkout, and\n * persist for as long as the customer is working on this checkout.\n *\n * Once the order is created, you can query these metafields using the\n * [GraphQL Admin API](/docs/admin-api/graphql/reference/orders/order#metafield-2021-01)\n *\n * > Caution:\n * `metafields` is deprecated. Use `appMetafields` with cart metafields instead.\n *\n * @deprecated Use `appMetafields` with cart metafields instead.\n */\n metafields: Metafield[];\n\n /**\n * The method used to query the Storefront GraphQL API with a prefetched token.\n *\n * Refer to [Storefront API access examples](/docs/api/checkout-ui-extensions/apis/storefront-api) for more information.\n */\n query: >(\n query: string,\n options?: {variables?: Variables; version?: StorefrontApiVersion},\n ) => Promise<{data?: Data; errors?: GraphQLError[]}>;\n\n /**\n * The session token providing a set of claims as a signed JSON Web Token (JWT).\n *\n * The token has a TTL of 5 minutes.\n *\n * If the previous token expires, this value will reflect a new session token with a new signature and expiry.\n *\n * Learn more about [session tokens](/docs/apps/build/authentication-authorization/session-tokens).\n */\n sessionToken: SessionToken;\n\n /**\n * The settings matching the settings definition written in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/apis/settings#examples) for more information.\n *\n * > Note: The settings are empty when an extension is being installed in the [checkout editor](https://help.shopify.com/en/manual/checkout-settings/checkout-extensibility/checkout-editor).\n\n */\n settings: ExtensionSettings;\n\n /**\n * The proposed customer shipping address. During the information step,\n * the address updates when the field is committed (on change) rather than every keystroke.\n *\n * > Note: An address value is only present if delivery is required. Otherwise, the subscribable value is undefined.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n shippingAddress?: MailingAddress | undefined;\n\n /** The shop where the checkout is taking place. */\n shop: Shop;\n\n /**\n * The key-value storage for the extension.\n *\n * It uses `localStorage` and should persist across the customer's current checkout session.\n *\n * > Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n *\n * Data is shared across all activated extension targets of this extension. In versions 2023-07 and earlier,\n * each activated extension target had its own storage.\n */\n storage: Storage;\n\n /**\n * The runner version being used for the extension.\n *\n * @example 'unstable'\n */\n version: Version;\n}" }, { "filePath": "src/surfaces/checkout/api/address-autocomplete/format-suggestion.ts", @@ -6475,10 +6475,10 @@ "syntaxKind": "PropertySignature", "name": "suggestions", "value": "AddressAutocompleteSuggestion[]", - "description": "An array of address autocomplete suggestions to show to the buyer.\n\n> Note: Only the first five suggestions will be displayed to the buyer." + "description": "An array of address autocomplete suggestions to show to the buyer. Checkout displays up to five address suggestions. Return no more than five. Additional suggestions are ignored." } ], - "value": "export interface AddressAutocompleteSuggestOutput {\n /**\n * An array of address autocomplete suggestions to show to the buyer.\n *\n * > Note: Only the first five suggestions will be displayed to the buyer.\n */\n suggestions: AddressAutocompleteSuggestion[];\n}" + "value": "export interface AddressAutocompleteSuggestOutput {\n /**\n * An array of address autocomplete suggestions to show to the buyer.\n * Checkout displays up to five address suggestions. Return no more\n * than five. Additional suggestions are ignored.\n */\n suggestions: AddressAutocompleteSuggestion[];\n}" }, { "filePath": "src/surfaces/checkout/extension-targets.ts", @@ -7236,6 +7236,131 @@ ], "value": "export interface ShopifyGlobal {\n extend(\n target: ExtensionTarget,\n extend: () => ExtensionTargets[ExtensionTarget]['output'],\n ): void;\n reload(): void;\n}" }, + { + "filePath": "src/surfaces/customer-account/api/standard-api/standard-api.ts", + "name": "Navigation", + "description": "Navigates between pages in customer accounts, including other extensions and host pages. Full-page extensions also get access to the current navigation entry and history state.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/customer-account/api/standard-api/standard-api.ts", + "syntaxKind": "MethodSignature", + "name": "addEventListener", + "value": "(type: \"currententrychange\", cb: (event: NavigationCurrentEntryChangeEvent) => void) => void", + "description": "Registers a listener that fires whenever the current navigation entry changes, such as when the buyer navigates to a different page." + }, + { + "filePath": "src/surfaces/customer-account/api/standard-api/standard-api.ts", + "syntaxKind": "PropertySignature", + "name": "currentEntry", + "value": "NavigationHistoryEntry", + "description": "The current navigation history entry, representing the page the buyer is viewing. Only available in full-page extensions." + }, + { + "filePath": "src/surfaces/customer-account/api/standard-api/standard-api.ts", + "syntaxKind": "PropertySignature", + "name": "navigate", + "value": "NavigateFunction", + "description": "Navigates to a URL, updating any provided state in the history entries list. Supports [custom protocols](/docs/api/customer-account-ui-extensions/{API_VERSION}#custom-protocols) for navigating within customer accounts." + }, + { + "filePath": "src/surfaces/customer-account/api/standard-api/standard-api.ts", + "syntaxKind": "MethodSignature", + "name": "removeEventListener", + "value": "(type: \"currententrychange\", cb: (event: NavigationCurrentEntryChangeEvent) => void) => void", + "description": "Removes a previously registered `currententrychange` listener." + }, + { + "filePath": "src/surfaces/customer-account/api/standard-api/standard-api.ts", + "syntaxKind": "MethodSignature", + "name": "updateCurrentEntry", + "value": "(options: NavigationUpdateCurrentEntryOptions) => void", + "description": "Updates the state of the current history entry without triggering a navigation. Use this when the state change is independent of a page transition, such as saving form progress." + } + ], + "value": "export interface Navigation {\n /**\n * Navigates to a URL, updating any provided state in the history entries list. Supports [custom protocols](/docs/api/customer-account-ui-extensions/{API_VERSION}#custom-protocols) for navigating within customer accounts.\n */\n navigate: NavigateFunction;\n /**\n * The current navigation history entry, representing the page the buyer is viewing. Only available in full-page extensions.\n */\n currentEntry: NavigationHistoryEntry;\n /**\n * Updates the state of the current history entry without triggering a navigation. Use this when the state change is independent of a page transition, such as saving form progress.\n */\n updateCurrentEntry(options: NavigationUpdateCurrentEntryOptions): void;\n /**\n * Registers a listener that fires whenever the current navigation entry changes, such as when the buyer navigates to a different page.\n */\n addEventListener(\n type: 'currententrychange',\n cb: (event: NavigationCurrentEntryChangeEvent) => void,\n ): void;\n /**\n * Removes a previously registered `currententrychange` listener.\n */\n removeEventListener(\n type: 'currententrychange',\n cb: (event: NavigationCurrentEntryChangeEvent) => void,\n ): void;\n}" + }, + { + "filePath": "src/surfaces/customer-account/api/standard-api/standard-api.ts", + "name": "NavigationCurrentEntryChangeEvent", + "description": "The event object passed to `currententrychange` listeners when the current navigation entry changes.", + "members": [ + { + "filePath": "src/surfaces/customer-account/api/standard-api/standard-api.ts", + "syntaxKind": "PropertySignature", + "name": "from", + "value": "NavigationHistoryEntry", + "description": "The history entry the buyer navigated away from." + }, + { + "filePath": "src/surfaces/customer-account/api/standard-api/standard-api.ts", + "syntaxKind": "PropertySignature", + "name": "navigationType", + "value": "NavigationTypeString", + "description": "The type of navigation that caused the change: `'push'`, `'replace'`, or `'traverse'`.", + "isOptional": true + } + ], + "value": "export interface NavigationCurrentEntryChangeEvent {\n /**\n * The type of navigation that caused the change: `'push'`, `'replace'`, or `'traverse'`.\n */\n navigationType?: NavigationTypeString;\n /**\n * The history entry the buyer navigated away from.\n */\n from: NavigationHistoryEntry;\n}" + }, + { + "filePath": "src/surfaces/customer-account/api/standard-api/standard-api.ts", + "name": "NavigationHistoryEntry", + "description": "A single entry in the navigation history stack. Each entry has a unique key, a URL, and optional developer-defined state.", + "members": [ + { + "filePath": "src/surfaces/customer-account/api/standard-api/standard-api.ts", + "syntaxKind": "MethodSignature", + "name": "getState", + "value": "() => unknown", + "description": "Returns a clone of the developer-defined state associated with this history entry." + }, + { + "filePath": "src/surfaces/customer-account/api/standard-api/standard-api.ts", + "syntaxKind": "PropertySignature", + "name": "key", + "value": "string", + "description": "A unique, platform-generated identifier for this entry's position in the history stack. This value identifies the slot, not the content." + }, + { + "filePath": "src/surfaces/customer-account/api/standard-api/standard-api.ts", + "syntaxKind": "PropertySignature", + "name": "url", + "value": "string | null", + "description": "The URL associated with this history entry, or `null` if unavailable." + } + ], + "value": "export interface NavigationHistoryEntry {\n /**\n * A unique, platform-generated identifier for this entry's position in the history stack. This value identifies the slot, not the content.\n */\n key: string;\n /**\n * The URL associated with this history entry, or `null` if unavailable.\n */\n url: string | null;\n /**\n * Returns a clone of the developer-defined state associated with this history entry.\n */\n getState(): unknown;\n}" + }, + { + "filePath": "src/surfaces/customer-account/api/standard-api/standard-api.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "NavigationTypeString", + "value": "'push' | 'replace' | 'traverse'", + "description": "An enumerated value representing the type of navigation." + }, + { + "filePath": "src/surfaces/customer-account/api/standard-api/standard-api.ts", + "name": "NavigateFunction", + "description": "A callable function that navigates to a URL within customer accounts. Accepts a destination URL and optional navigation options.", + "members": [], + "value": "export interface NavigateFunction {\n /**\n * Navigates to a specific URL, updating any provided state in the history entries list.\n * @param url The destination URL to navigate to.\n */\n (url: string, options?: NavigationNavigateOptions): void;\n}" + }, + { + "filePath": "src/surfaces/customer-account/api/standard-api/standard-api.ts", + "name": "NavigationUpdateCurrentEntryOptions", + "description": "Options for `Navigation.updateCurrentEntry()`. Use this to update the state of the current history entry without triggering a navigation.", + "members": [ + { + "filePath": "src/surfaces/customer-account/api/standard-api/standard-api.ts", + "syntaxKind": "PropertySignature", + "name": "state", + "value": "unknown", + "description": "Developer-defined state to associate with the current navigation history entry." + } + ], + "value": "export interface NavigationUpdateCurrentEntryOptions {\n /**\n * Developer-defined state to associate with the current navigation history entry.\n */\n state: unknown;\n}" + }, { "filePath": "src/surfaces/customer-account/components/shared.ts", "name": "BaseElementProps", @@ -7337,7 +7462,7 @@ "syntaxKind": "PropertySignature", "name": "initials", "value": "string", - "description": "The initials to display in the avatar when no image is provided or fails to load. Typically one or two characters representing a person's first and last name initials, such as \"JD\" for John Doe.", + "description": "The initials to display in the avatar when no image is provided or fails to load. Typically one or two characters representing a person's first and last name initials, such as \"JD\" for John Doe.\n\nCharacters beyond the first two might be truncated. Special characters, emojis, and non-Latin scripts might not render as expected.", "isOptional": true }, { @@ -7437,7 +7562,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/customer-account/components.ts", @@ -9452,7 +9577,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/customer-account/components.ts", @@ -9781,7 +9906,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/customer-account/components.ts", @@ -11789,7 +11914,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/customer-account/components.ts", @@ -12060,7 +12185,7 @@ "syntaxKind": "PropertySignature", "name": "heading", "value": "string", - "description": "The main page heading", + "description": "The main heading displayed at the top of the page.", "isOptional": true }, { @@ -12076,7 +12201,7 @@ "syntaxKind": "PropertySignature", "name": "subheading", "value": "string", - "description": "The text to be used as subheading.", + "description": "A secondary heading displayed below the main heading for additional context.", "isOptional": true } ] @@ -12108,7 +12233,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/customer-account/components.ts", @@ -12991,7 +13116,7 @@ "syntaxKind": "PropertySignature", "name": "heading", "value": "string", - "description": "The main page heading", + "description": "The main heading displayed at the top of the page.", "isOptional": true }, { @@ -14124,7 +14249,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/customer-account/components.ts", @@ -14306,7 +14431,7 @@ "syntaxKind": "PropertySignature", "name": "subheading", "value": "string", - "description": "The text to be used as subheading.", + "description": "A secondary heading displayed below the main heading for additional context.", "isOptional": true }, { @@ -14395,7 +14520,7 @@ "syntaxKind": "PropertySignature", "name": "breadcrumb-actions", "value": "HTMLElement", - "description": "The breadcrumb actions for the page. Accepts a single button element with restricted properties (see below).", + "description": "A navigation link that lets the customer return to the previous page. Accepts a single [button](/docs/api/{API_NAME}/{API_VERSION}/web-components/actions/button) component. Learn more about [breadcrumb actions](#breadcrumb-actions).", "isOptional": true }, { @@ -14403,7 +14528,7 @@ "syntaxKind": "PropertySignature", "name": "primary-action", "value": "HTMLElement", - "description": "The primary action for the modal. Accepts a single [button](/docs/api/customer-account-ui-extensions/{API_VERSION}/web-components/actions/button) element. Use this for the main confirmation action, such as \"Submit\" or \"Confirm.\"", + "description": "The main call-to-action for the page. Accepts a single [button](/docs/api/{API_NAME}/{API_VERSION}/web-components/actions/button) component. Learn more about [primary actions](#primary-actions).", "isOptional": true }, { @@ -14411,7 +14536,7 @@ "syntaxKind": "PropertySignature", "name": "secondary-actions", "value": "HTMLElement", - "description": "The secondary actions for the modal. Accepts multiple [button](/docs/api/customer-account-ui-extensions/{API_VERSION}/web-components/actions/button) elements. Use this for dismissive actions like \"Cancel\" or alternative actions.", + "description": "Additional actions for the page. Accepts one or more [button](/docs/api/{API_NAME}/{API_VERSION}/web-components/actions/button) components. Learn more about [secondary actions](#secondary-actions).", "isOptional": true } ] @@ -14451,7 +14576,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/customer-account/components.ts", @@ -15371,7 +15496,7 @@ "syntaxKind": "PropertySignature", "name": "initials", "value": "string", - "description": "The initials to display in the avatar when no image is provided or fails to load. Typically one or two characters representing a person's first and last name initials, such as \"JD\" for John Doe.", + "description": "The initials to display in the avatar when no image is provided or fails to load. Typically one or two characters representing a person's first and last name initials, such as \"JD\" for John Doe.\n\nCharacters beyond the first two might be truncated. Special characters, emojis, and non-Latin scripts might not render as expected.", "isOptional": true }, { @@ -16476,7 +16601,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/customer-account/components.ts", @@ -16830,7 +16955,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/customer-account/components.ts", @@ -18839,7 +18964,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/customer-account/components.ts", @@ -19150,7 +19275,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/customer-account/components.ts", @@ -21159,7 +21284,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/customer-account/components.ts", @@ -21448,7 +21573,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityLabel", "value": "string", - "description": "A label used to describe the section that will be announced by assistive technologies.\n\nWhen no `heading` property is provided or included as a child of the section, you **must** provide an `accessibilityLabel` to describe the section. This is important as it allows assistive technologies to provide the right context to users.", + "description": "A label announced by assistive technologies that describes the purpose or contents of the element. Only set this when the element's visible content doesn't provide enough context on its own.", "isOptional": true }, { @@ -21456,7 +21581,7 @@ "syntaxKind": "PropertySignature", "name": "heading", "value": "string", - "description": "A title displayed at the top of the section. When provided, it serves as both a visible heading and the accessible name for the section. If omitted, you must provide an `accessibilityLabel` instead.", + "description": "A title that describes the content of the section.", "isOptional": true }, { @@ -21482,7 +21607,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityLabel", "value": "string", - "description": "A label used to describe the section that will be announced by assistive technologies.\n\nWhen no `heading` property is provided or included as a child of the section, you **must** provide an `accessibilityLabel` to describe the section. This is important as it allows assistive technologies to provide the right context to users.", + "description": "A label announced by assistive technologies that describes the purpose or contents of the element. Only set this when the element's visible content doesn't provide enough context on its own.", "isOptional": true }, { @@ -21504,7 +21629,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/customer-account/components.ts", @@ -22387,7 +22512,7 @@ "syntaxKind": "PropertySignature", "name": "heading", "value": "string", - "description": "A title displayed at the top of the section. When provided, it serves as both a visible heading and the accessible name for the section. If omitted, you must provide an `accessibilityLabel` instead.", + "description": "A title that describes the content of the section.", "isOptional": true }, { @@ -23521,7 +23646,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/customer-account/components.ts", @@ -23784,7 +23909,7 @@ "syntaxKind": "PropertySignature", "name": "primary-action", "value": "HTMLElement", - "description": "The primary action for the section. Accepts a single [button](/docs/api/customer-account-ui-extensions/{API_VERSION}/web-components/actions/button) element. Use this for the main action related to the section's content, such as \"Edit\" or \"Manage.\"", + "description": "The main call-to-action for the section. Accepts a single [button](/docs/api/{API_NAME}/{API_VERSION}/web-components/actions/button) component.", "isOptional": true }, { @@ -23792,77 +23917,82 @@ "syntaxKind": "PropertySignature", "name": "secondary-actions", "value": "HTMLElement", - "description": "The secondary actions for the section. Accepts multiple [button](/docs/api/customer-account-ui-extensions/{API_VERSION}/web-components/actions/button) elements. Use this for supplementary actions like \"Remove\" or \"View details.\"", + "description": "Additional actions for the section. Accepts one or more [button](/docs/api/{API_NAME}/{API_VERSION}/web-components/actions/button) components.", "isOptional": true } ] }, { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/docs.ts", "syntaxKind": "TypeAliasDeclaration", "name": "CallbackEvent", - "value": "TEvent & {\n currentTarget: HTMLElementTagNameMap[TTagName];\n}", - "description": "An event type that narrows the `currentTarget` to the specific HTML element associated with the custom element tag. This provides type-safe event handling in callback listeners.", - "isPublicDocs": true + "value": "TEvent & {\n currentTarget: HTMLElementTagNameMap[TTagName];\n}", + "description": "An event type that narrows the `currentTarget` to the specific HTML element associated with the custom element tag. This provides type-safe event handling in callback listeners." }, { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/docs.ts", "syntaxKind": "TypeAliasDeclaration", "name": "CallbackEventListener", - "value": "(EventListener & {\n (event: CallbackEvent & TData): void;\n}) | null", - "description": "A typed event listener for custom element events. The listener receives a `CallbackEvent` with the correct `currentTarget` type for the associated custom element tag.", - "isPublicDocs": true + "value": "(EventListener & {\n (event: CallbackEvent): void;\n }) | null", + "description": "A typed event listener for custom element events. The listener receives a `CallbackEvent` with the correct `currentTarget` type for the associated custom element tag." }, { - "filePath": "src/surfaces/checkout/components/Button.ts", - "name": "ButtonElementProps", - "description": "Properties for the button component element.", - "isPublicDocs": true, + "filePath": "src/surfaces/customer-account/api/docs.ts", + "name": "ButtonProps", + "description": "", "members": [ { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/docs.ts", "syntaxKind": "PropertySignature", "name": "accessibilityLabel", "value": "string", - "description": "A label that describes the purpose or content of the button for users of assistive technologies such as screen readers. Use this when the visible content alone doesn't provide enough context.", + "description": "A label that describes the purpose or contents of the Button. It will be read to users using assistive technologies such as screen readers.\n\nUse this when using only an icon or the button text is not enough context for users using assistive technologies.", "isOptional": true }, { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/docs.ts", + "syntaxKind": "PropertySignature", + "name": "click", + "value": "((event: CallbackEventListener) => void) | null", + "description": "Callback when the button is activated. This will be called before the action indicated by `type`.", + "isOptional": true + }, + { + "filePath": "src/surfaces/customer-account/api/docs.ts", "syntaxKind": "PropertySignature", "name": "command", "value": "'--auto' | '--show' | '--hide' | '--toggle' | '--copy'", - "description": "Sets the action the `commandFor` should take when this clickable is activated.\n\nSee the documentation of particular components for the actions they support.\n\n- `--auto`: Performs the default action for the target component.\n- `--show`: Displays the target component.\n- `--hide`: Conceals the target component.\n- `--toggle`: Alternates the target component.\n- `--copy`: Copies the target ClipboardItem.", + "description": "Sets the action the `commandFor` target should take when this component is activated.\n\n- `--auto`: A default action for the target component.\n- `--show`: Shows the target component.\n- `--hide`: Hides the target component.\n- `--toggle`: Toggles the target component.\n- `--copy`: Copies the target clipboard item.\n\nLearn more about the [`command` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).", "isOptional": true, "defaultValue": "'--auto'" }, { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/docs.ts", "syntaxKind": "PropertySignature", "name": "commandFor", "value": "string", - "description": "ID of a component that should respond to activations (such as clicks) on this component.\n\nSee `command` for how to control the behavior of the target.", + "description": "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).", "isOptional": true }, { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/docs.ts", "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Whether the button is disabled, preventing it from being clicked or receiving focus.", + "description": "Disables the button, disallowing any interaction.", "isOptional": true, "defaultValue": "false" }, { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/docs.ts", "syntaxKind": "PropertySignature", "name": "href", "value": "string", - "description": "The URL to navigate to when clicked. The `click` event fires first, then navigation occurs.\n\n- If set, it will navigate to the location specified by `href` after executing the `click` event.\n- If a `commandFor` is set, the `command` will be executed instead of the navigation.", + "description": "The URL to link to.\n\n- If set, it will navigate to the location specified by `href` after executing the `onClick` callback.\n- If a `commandFor` is set, the `command` will be executed instead of the navigation.", "isOptional": true }, { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/docs.ts", "syntaxKind": "PropertySignature", "name": "id", "value": "string", @@ -23870,1054 +24000,1683 @@ "isOptional": true }, { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "inlineSize", - "value": "'auto' | 'fill' | 'fit-content'", - "description": "The inline width of the button component.\n\n- `auto`: The size depends on the surface and context.\n- `fill`: The button takes up 100% of the available inline size.\n- `fit-content`: The button takes up the minimum inline-size required to fit its content.", - "isOptional": true, - "defaultValue": "'auto'" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "interestFor", - "value": "string", - "description": "The ID of the component to show when users hover over or focus on this component. Pair with a target component that supports interest-based interactions. Learn more about the [interestFor attribute](https://open-ui.org/components/interest-invokers.explainer/#the-pitch-in-code).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/docs.ts", "syntaxKind": "PropertySignature", "name": "loading", "value": "boolean", - "description": "Whether the button is in a loading state, which replaces the button content with a loading indicator while a background action is being performed.\n\nThis also disables the button.", + "description": "Replaces content with a loading indicator.", "isOptional": true, "defaultValue": "false" }, { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/docs.ts", "syntaxKind": "PropertySignature", "name": "target", - "value": "'auto' | '_blank'", + "value": "'auto' | '_self' | '_blank'", "description": "Specifies where to display the linked URL.", "isOptional": true, "defaultValue": "'auto'" }, { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/docs.ts", "syntaxKind": "PropertySignature", "name": "tone", "value": "'auto' | 'neutral' | 'critical'", - "description": "The semantic meaning and color treatment of the button.\n\n- `'auto'`: Automatically determined based on context.\n- `'neutral'`: General information without specific intent.\n- `'critical'`: Urgent problems or destructive actions.", + "description": "Sets the tone of the Button, based on the intention of the information being conveyed.", "isOptional": true, "defaultValue": "'auto'" }, { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/docs.ts", "syntaxKind": "PropertySignature", "name": "type", - "value": "'submit' | 'button'", - "description": "The behavioral type of the button component, which determines what action it performs when activated.\n\n- `submit`: Submits the closest form.\n- `button`: Performs no default action when activated.\n- `reset`: Resets the closest form (returning fields to their default values).\n\nThis property is ignored if the component supports `href` or `commandFor`/`command` and one of them is set.", + "value": "'button' | 'submit'", + "description": "The behavior of the button.\n\n- `'submit'`: Submits the nearest containing form.\n- `'button'`: Performs no default action, relying on the `click` event handler for behavior.\n\nThis property is ignored if the component supports `href` or `commandFor`/`command` and one of them is set.", "isOptional": true, "defaultValue": "'button'" }, { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/docs.ts", "syntaxKind": "PropertySignature", "name": "variant", "value": "'auto' | 'primary' | 'secondary'", - "description": "The visual style variant of the button component, which controls its prominence and emphasis.\n\n- `'auto'`: Automatically determined by the button's context.\n- `'primary'`: High-emphasis style for the main action.\n- `'secondary'`: Medium-emphasis style for supporting actions.\n- `'tertiary'`: Low-emphasis style for less prominent actions.", + "description": "Changes the visual appearance of the Button.", "isOptional": true, - "defaultValue": "'auto'" + "defaultValue": "'auto' - the variant is automatically determined by the Button's context" } ], - "value": "export interface ButtonElementProps extends Pick {\n target?: Extract;\n tone?: Extract;\n type?: Extract;\n variant?: Extract;\n}" + "value": "interface ButtonProps {\n /**\n * A label that describes the purpose or contents of the Button. It will be read to users using assistive technologies such as screen readers.\n *\n * Use this when using only an icon or the button text is not enough context\n * for users using assistive technologies.\n */\n accessibilityLabel?: string;\n /**\n * 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).\n */\n commandFor?: string;\n /**\n * Sets the action the `commandFor` target should take when this component is activated.\n *\n * - `--auto`: A default action for the target component.\n * - `--show`: Shows the target component.\n * - `--hide`: Hides the target component.\n * - `--toggle`: Toggles the target component.\n * - `--copy`: Copies the target clipboard item.\n *\n * Learn more about the [`command` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).\n *\n * @default '--auto'\n */\n command?: '--auto' | '--show' | '--hide' | '--toggle' | '--copy';\n /**\n * Disables the button, disallowing any interaction.\n *\n * @defaultValue false\n */\n disabled?: boolean;\n /**\n * The URL to link to.\n *\n * - If set, it will navigate to the location specified by `href` after executing the `onClick` callback.\n * - If a `commandFor` is set, the `command` will be executed instead of the navigation.\n */\n href?: string;\n /**\n * A unique identifier for the element.\n */\n id?: string;\n /**\n * Replaces content with a loading indicator.\n *\n * @defaultValue false\n */\n loading?: boolean;\n /**\n * Specifies where to display the linked URL.\n * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#target\n *\n * 'auto' - The target is automatically determined based on the origin of the URL. Surfaces can set specific rules on how they handle each URL.\n * It’s expected that the behavior of `auto` is as `_self` except in specific cases.\n * For example, a surface could decide to open cross-origin URLs in a new window (as `_blank`).\n *\n * @default 'auto'\n */\n target?: 'auto' | '_self' | '_blank';\n /**\n * Sets the tone of the Button, based on the intention of the information being conveyed.\n *\n * @default 'auto'\n */\n tone?: 'auto' | 'neutral' | 'critical';\n /**\n * The behavior of the button.\n *\n * - `'submit'`: Submits the nearest containing form.\n * - `'button'`: Performs no default action, relying on the `click` event handler for behavior.\n *\n * This property is ignored if the component supports `href` or `commandFor`/`command` and one of them is set.\n *\n * @default 'button'\n */\n type?: 'button' | 'submit';\n /**\n * Changes the visual appearance of the Button.\n *\n * @default 'auto' - the variant is automatically determined by the Button's context\n */\n variant?: 'auto' | 'primary' | 'secondary';\n\n /**\n * Callback when the button is activated.\n * This will be called before the action indicated by `type`.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event\n */\n click?: ((event: CallbackEventListener) => void) | null;\n}" }, { - "filePath": "src/surfaces/checkout/components/Button.ts", - "name": "ButtonEvents", + "filePath": "src/surfaces/customer-account/api/docs.ts", + "name": "Docs_OrderStatus_MetafieldsApi", "description": "", "isPublicDocs": true, "members": [ { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/docs.ts", "syntaxKind": "PropertySignature", - "name": "onClick", - "value": "(event: Event) => void", - "description": "A callback fired when the button is activated, before performing the action indicated by `type`. Learn more about the [click event](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event).", - "isOptional": true + "name": "appMetafields", + "value": "SubscribableSignalLike", + "description": "The [metafields](/docs/apps/build/custom-data/metafields) requested in the [`shopify.extension.toml`](/docs/apps/build/customer-accounts/metafields#create-the-metafield-definition) file. Metafields are custom data fields that store additional information on Shopify resources such as products, variants, customers, and the shop. These metafields are updated when there's a change in the merchandise items being purchased by the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when accessing metafields attached to `customer`, `company`, or `companyLocation` resources." + }, + { + "filePath": "src/surfaces/customer-account/api/docs.ts", + "syntaxKind": "PropertySignature", + "name": "metafields", + "value": "SubscribableSignalLike", + "description": "The [metafields](/docs/apps/build/custom-data/metafields) associated with the order. These metafields are shared across all extensions and persist throughout the checkout session.", + "deprecationMessage": "Use `appMetafields` instead, which provides richer data including the resource type and metafield content type." } ], - "value": "export interface ButtonEvents extends Pick {\n}" + "value": "export interface Docs_OrderStatus_MetafieldsApi\n extends Pick, 'appMetafields' | 'metafields'> {}" }, { - "filePath": "src/surfaces/checkout/components/Button.ts", - "name": "ButtonElementEvents", - "description": "The button component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", + "filePath": "src/surfaces/customer-account/api/docs.ts", + "name": "Docs_OrderStatus_AttributesApi", + "description": "", "isPublicDocs": true, "members": [ { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/docs.ts", "syntaxKind": "PropertySignature", - "name": "click", - "value": "CallbackEventListener", - "description": "A callback fired when the button is clicked. This will be called before the action indicated by `type`.\n\nLearn more about the [click event](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event).", - "isOptional": true + "name": "attributes", + "value": "SubscribableSignalLike", + "description": "The custom key-value pairs attached to the order by the customer or by other extensions during cart or checkout. These are commonly used for delivery instructions, gift messages, or other information the buyer provides. The value is `undefined` if no attributes were set." } ], - "value": "export interface ButtonElementEvents {\n /**\n * A callback fired when the button is clicked. This will be called before the action indicated by `type`.\n *\n * Learn more about the [click event](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event).\n */\n click?: CallbackEventListener;\n}" + "value": "export interface Docs_OrderStatus_AttributesApi\n extends Pick, 'attributes'> {}" }, { - "filePath": "src/surfaces/checkout/components/Button.ts", - "name": "ButtonElement", + "filePath": "src/surfaces/customer-account/api/docs.ts", + "name": "Docs_OrderStatus_BuyerIdentityApi", "description": "", "isPublicDocs": true, "members": [ { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/docs.ts", "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "A label that describes the purpose or content of the button for users of assistive technologies such as screen readers. Use this when the visible content alone doesn't provide enough context.", + "name": "buyerIdentity", + "value": "OrderStatusBuyerIdentity", + "description": "The buyer who placed the order, including their customer account, email, phone number, and B2B purchasing company. Use this to personalize the **Order status** page or identify B2B orders.\n\nReflects the customer account at the time the order was placed. Doesn't update if account details change afterward.", "isOptional": true - }, + } + ], + "value": "export interface Docs_OrderStatus_BuyerIdentityApi\n extends Pick, 'buyerIdentity'> {}" + }, + { + "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", + "name": "OrderStatusBuyerIdentity", + "description": "Information about the buyer who placed the order.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data). The `customer` and `purchasingCompany` properties require level 1 access. The `email` and `phone` properties require level 2 access.", + "members": [ { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", "syntaxKind": "PropertySignature", - "name": "accessKey", - "value": "string", - "description": "The **`HTMLElement.accessKey`** property sets the keystroke which a user can press to jump to a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKey)" + "name": "customer", + "value": "SubscribableSignalLike", + "description": "The buyer's customer account, including their ID and whether they have accepted marketing. The value is `undefined` if the buyer is a guest or hasn't logged in yet." }, { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", "syntaxKind": "PropertySignature", - "name": "accessKeyLabel", - "value": "string", - "description": "The **`HTMLElement.accessKeyLabel`** read-only property returns a string containing the element's browser-assigned access key (if any); otherwise it returns an empty string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKeyLabel)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "addEventListener", - "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "after", - "value": "(...nodes: (string | Node)[]) => void", - "description": "Inserts nodes just after node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/after)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "animate", - "value": "(keyframes: Keyframe[] | PropertyIndexedKeyframes, options?: number | KeyframeAnimationOptions) => Animation", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animate)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "append", - "value": "(...nodes: (string | Node)[]) => void", - "description": "Inserts nodes after the last child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/append)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "appendChild", - "value": "(node: T) => T", - "description": "The **`appendChild()`** method of the Node interface adds a node to the end of the list of children of a specified parent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/appendChild)" + "name": "email", + "value": "SubscribableSignalLike", + "description": "The email address associated with the order. This is the email the buyer provided during checkout for order confirmation and communication. The value is `undefined` if the app doesn't have access to customer data." }, { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", "syntaxKind": "PropertySignature", - "name": "ariaActiveDescendantElement", - "value": "Element | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaActiveDescendantElement)" + "name": "phone", + "value": "SubscribableSignalLike", + "description": "The phone number the buyer provided during checkout. The value is `undefined` if no phone number was provided or the app doesn't have access to customer data." }, { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", "syntaxKind": "PropertySignature", - "name": "ariaAtomic", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAtomic)" - }, + "name": "purchasingCompany", + "value": "SubscribableSignalLike<\n OrderStatusPurchasingCompany | undefined\n >", + "description": "The company and company location that a B2B (business-to-business) customer is purchasing on behalf of. Use this to identify the business context of the order. The value is `undefined` if the buyer isn't a B2B customer." + } + ], + "value": "export interface OrderStatusBuyerIdentity {\n /**\n * The buyer's customer account, including their ID and whether they have accepted marketing.\n * The value is `undefined` if the buyer is a guest or hasn't logged in yet.\n */\n customer: SubscribableSignalLike;\n\n /**\n * The email address associated with the order. This is the email the buyer provided during\n * checkout for order confirmation and communication. The value is `undefined` if the app\n * doesn't have access to customer data.\n */\n email: SubscribableSignalLike;\n\n /**\n * The phone number the buyer provided during checkout. The value is `undefined` if no phone\n * number was provided or the app doesn't have access to customer data.\n */\n phone: SubscribableSignalLike;\n\n /**\n * The company and company location that a B2B (business-to-business) customer is purchasing\n * on behalf of. Use this to identify the business context of the order. The value is\n * `undefined` if the buyer isn't a B2B customer.\n */\n purchasingCompany: SubscribableSignalLike<\n OrderStatusPurchasingCompany | undefined\n >;\n}" + }, + { + "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", + "name": "OrderStatusCustomer", + "description": "Information about a customer who has previously purchased from this shop.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data). The `id`, `image`, `acceptsMarketing`, and `storeCreditAccounts` properties require level 1 access. The `email`, `phone`, `fullName`, `firstName`, and `lastName` properties require level 2 access.", + "members": [ { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", "syntaxKind": "PropertySignature", - "name": "ariaAutoComplete", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAutoComplete)" + "name": "acceptsMarketing", + "value": "boolean", + "description": "Whether the customer has opted in to receiving marketing communications from the merchant, such as email campaigns and promotional offers." }, { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", "syntaxKind": "PropertySignature", - "name": "ariaBrailleLabel", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleLabel)" + "name": "email", + "value": "string", + "description": "The email address associated with the customer's account. The value is `undefined` if the app doesn't have the required access level.", + "isOptional": true }, { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", "syntaxKind": "PropertySignature", - "name": "ariaBrailleRoleDescription", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleRoleDescription)" + "name": "firstName", + "value": "string", + "description": "The customer's first name. The value is `undefined` if the app doesn't have the required access level.", + "isOptional": true }, { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", "syntaxKind": "PropertySignature", - "name": "ariaBusy", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBusy)" + "name": "fullName", + "value": "string", + "description": "The customer's full name, typically a combination of first and last name. The value is `undefined` if the app doesn't have the required access level.", + "isOptional": true }, { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", "syntaxKind": "PropertySignature", - "name": "ariaChecked", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaChecked)" + "name": "id", + "value": "string", + "description": "A globally-unique identifier for the customer in the format `gid://shopify/Customer/`. 'gid://shopify/Customer/123'" }, { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", "syntaxKind": "PropertySignature", - "name": "ariaColCount", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColCount)" + "name": "image", + "value": "ImageDetails", + "description": "The customer's profile image, such as a Gravatar avatar. Use this to personalize the extension UI for the logged-in buyer." }, { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", "syntaxKind": "PropertySignature", - "name": "ariaColIndex", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndex)" + "name": "lastName", + "value": "string", + "description": "The customer's last name. The value is `undefined` if the app doesn't have the required access level.", + "isOptional": true }, { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", "syntaxKind": "PropertySignature", - "name": "ariaColIndexText", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndexText)" + "name": "phone", + "value": "string", + "description": "The phone number associated with the customer's account. The value is `undefined` if no phone number is on file or the app doesn't have the required access level.", + "isOptional": true }, { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", "syntaxKind": "PropertySignature", - "name": "ariaColSpan", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColSpan)" - }, + "name": "storeCreditAccounts", + "value": "StoreCreditAccount[]", + "description": "The store credit accounts owned by this customer that can be used as payment during checkout. Each account has a balance representing available store credit.", + "isPrivate": true + } + ], + "value": "export interface OrderStatusCustomer {\n /**\n * A globally-unique identifier for the customer in the format `gid://shopify/Customer/`. 'gid://shopify/Customer/123'\n */\n id: string;\n /**\n * The email address associated with the customer's account. The value is `undefined` if the app doesn't have the required access level.\n */\n email?: string;\n /**\n * The phone number associated with the customer's account. The value is `undefined` if no phone number is on file or the app doesn't have the required access level.\n */\n phone?: string;\n /**\n * The customer's full name, typically a combination of first and last name. The value is `undefined` if the app doesn't have the required access level.\n */\n fullName?: string;\n /**\n * The customer's first name. The value is `undefined` if the app doesn't have the required access level.\n */\n firstName?: string;\n /**\n * The customer's last name. The value is `undefined` if the app doesn't have the required access level.\n */\n lastName?: string;\n /**\n * The customer's profile image, such as a Gravatar avatar. Use this to personalize the extension UI for the logged-in buyer.\n */\n image: ImageDetails;\n /**\n * Whether the customer has opted in to receiving marketing communications from the merchant, such as email campaigns and promotional offers.\n */\n acceptsMarketing: boolean;\n /**\n * The store credit accounts owned by this customer that can be used as payment during checkout. Each account has a balance representing available store credit.\n *\n * @private\n */\n storeCreditAccounts: StoreCreditAccount[];\n}" + }, + { + "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", + "name": "OrderStatusPurchasingCompany", + "description": "Information about a company that the business customer is purchasing on behalf of.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", + "members": [ { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", "syntaxKind": "PropertySignature", - "name": "ariaControlsElements", - "value": "ReadonlyArray | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaControlsElements)" + "name": "company", + "value": "OrderStatusCompany", + "description": "The company that the B2B customer is purchasing on behalf of, including the company ID, name, and optional external ID." }, { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", "syntaxKind": "PropertySignature", - "name": "ariaCurrent", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaCurrent)" - }, + "name": "location", + "value": "OrderStatusCompanyLocation", + "description": "The specific company location where the order is being placed, including the location ID, name, and optional external ID." + } + ], + "value": "export interface OrderStatusPurchasingCompany {\n /**\n * The company that the B2B customer is purchasing on behalf of, including the company ID, name, and optional external ID.\n */\n company: OrderStatusCompany;\n /**\n * The specific company location where the order is being placed, including the location ID, name, and optional external ID.\n */\n location: OrderStatusCompanyLocation;\n}" + }, + { + "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", + "name": "OrderStatusCompany", + "description": "{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", + "members": [ { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", "syntaxKind": "PropertySignature", - "name": "ariaDescribedByElements", - "value": "ReadonlyArray | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescribedByElements)" + "name": "externalId", + "value": "string", + "description": "A merchant-defined external identifier for the company, often used to map to an ID in an external ERP or CRM system. The value is `undefined` if no external ID has been set.", + "isOptional": true }, { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", "syntaxKind": "PropertySignature", - "name": "ariaDescription", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescription)" + "name": "id", + "value": "string", + "description": "A globally-unique identifier for the company in the format `gid://shopify/Company/`." }, { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", "syntaxKind": "PropertySignature", - "name": "ariaDetailsElements", - "value": "ReadonlyArray | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDetailsElements)" - }, + "name": "name", + "value": "string", + "description": "The registered business name of the company, as configured by the merchant in Shopify admin." + } + ], + "value": "export interface OrderStatusCompany {\n /**\n * A globally-unique identifier for the company in the format `gid://shopify/Company/`.\n */\n id: string;\n /**\n * The registered business name of the company, as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * A merchant-defined external identifier for the company, often used to map to an ID in an external ERP or CRM system. The value is `undefined` if no external ID has been set.\n */\n externalId?: string;\n}" + }, + { + "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", + "name": "OrderStatusCompanyLocation", + "description": "{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", + "members": [ { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", "syntaxKind": "PropertySignature", - "name": "ariaDisabled", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDisabled)" + "name": "externalId", + "value": "string", + "description": "A merchant-defined external identifier for the company location, often used to map to an ID in an external ERP or CRM system. The value is `undefined` if no external ID has been set.", + "isOptional": true }, { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", "syntaxKind": "PropertySignature", - "name": "ariaErrorMessageElements", - "value": "ReadonlyArray | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaErrorMessageElements)" + "name": "id", + "value": "string", + "description": "A globally-unique identifier for the company location in the format `gid://shopify/CompanyLocation/`." }, { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", "syntaxKind": "PropertySignature", - "name": "ariaExpanded", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaExpanded)" - }, + "name": "name", + "value": "string", + "description": "The display name of the company location, such as a branch office or warehouse name." + } + ], + "value": "export interface OrderStatusCompanyLocation {\n /**\n * A globally-unique identifier for the company location in the format `gid://shopify/CompanyLocation/`.\n */\n id: string;\n /**\n * The display name of the company location, such as a branch office or warehouse name.\n */\n name: string;\n /**\n * A merchant-defined external identifier for the company location, often used to map to an ID in an external ERP or CRM system. The value is `undefined` if no external ID has been set.\n */\n externalId?: string;\n}" + }, + { + "filePath": "src/surfaces/customer-account/api/docs.ts", + "name": "Docs_OrderStatus_CheckoutSettingsApi", + "description": "", + "isPublicDocs": true, + "members": [ { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/docs.ts", "syntaxKind": "PropertySignature", - "name": "ariaFlowToElements", - "value": "ReadonlyArray | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaFlowToElements)" - }, + "name": "checkoutSettings", + "value": "SubscribableSignalLike", + "description": "The checkout settings that were active when the buyer placed the order, such as whether order notes and login are enabled.\n\nReturns the merchant's checkout configuration at the time of checkout. Doesn't reflect updates made after the order was placed." + } + ], + "value": "export interface Docs_OrderStatus_CheckoutSettingsApi\n extends Pick, 'checkoutSettings'> {}" + }, + { + "filePath": "src/surfaces/customer-account/api/docs.ts", + "name": "Docs_OrderStatus_CostApi", + "description": "", + "isPublicDocs": true, + "members": [ { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/docs.ts", "syntaxKind": "PropertySignature", - "name": "ariaHasPopup", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHasPopup)" - }, + "name": "cost", + "value": "CartCost", + "description": "A breakdown of the costs for the order, including the subtotal, shipping, tax, and total amounts." + } + ], + "value": "export interface Docs_OrderStatus_CostApi\n extends Pick, 'cost'> {}" + }, + { + "filePath": "src/surfaces/customer-account/api/docs.ts", + "name": "Docs_OrderStatus_LocalizationApi", + "description": "", + "isPublicDocs": true, + "members": [ { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/docs.ts", "syntaxKind": "PropertySignature", - "name": "ariaHidden", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHidden)" - }, + "name": "localization", + "value": "OrderStatusLocalization", + "description": "The buyer's locale, currency, time zone, country, and market context for the order. Use these values to adapt your extension's content to the buyer's region. For formatted dates, numbers, and translated strings, use the [Localization API](/docs/api/customer-account-ui-extensions/{API_VERSION}/target-apis/platform-apis/localization-api) instead." + } + ], + "value": "export interface Docs_OrderStatus_LocalizationApi\n extends Pick, 'localization'> {}" + }, + { + "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", + "name": "OrderStatusLocalization", + "description": "Provides raw localization data only. The `i18n` translation and formatting helpers from the Localization API aren't available on order status targets.", + "members": [ { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", "syntaxKind": "PropertySignature", - "name": "ariaInvalid", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaInvalid)" + "name": "country", + "value": "SubscribableSignalLike", + "description": "The country associated with the order, carried over from the cart context where it was used to contextualize the storefront experience. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown." }, { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", "syntaxKind": "PropertySignature", - "name": "ariaKeyShortcuts", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaKeyShortcuts)" + "name": "currency", + "value": "SubscribableSignalLike", + "description": "The currency used to display money amounts on the **Order status** page. Use this value to format prices and totals in the buyer's expected currency." }, { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", "syntaxKind": "PropertySignature", - "name": "ariaLabel", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabel)" + "name": "extensionLanguage", + "value": "SubscribableSignalLike", + "description": "The best available language match for your extension based on the buyer's language. If the buyer's language is `fr-CA` but your extension only supports `fr`, this returns `fr`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension." }, { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", "syntaxKind": "PropertySignature", - "name": "ariaLabelledByElements", - "value": "ReadonlyArray | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabelledByElements)" + "name": "language", + "value": "SubscribableSignalLike", + "description": "The language the buyer sees on the **Order status** page. This reflects the language selected by the buyer or determined by their browser settings, and may differ from the languages your extension supports." }, { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", "syntaxKind": "PropertySignature", - "name": "ariaLevel", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLevel)" + "name": "market", + "value": "SubscribableSignalLike", + "description": "The [market](/docs/apps/build/markets) associated with the order, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. The value is `undefined` if the market is unknown." }, { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", "syntaxKind": "PropertySignature", - "name": "ariaLive", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLive)" - }, + "name": "timezone", + "value": "SubscribableSignalLike", + "description": "The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time." + } + ], + "value": "export interface OrderStatusLocalization {\n /**\n * The currency used to display money amounts on the **Order status** page. Use this value\n * to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, derived from their browser or account settings. Use this value\n * to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees on the **Order status** page. This reflects the language\n * selected by the buyer or determined by their browser settings, and may differ from\n * the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language.\n * If the buyer's language is `fr-CA` but your extension only supports `fr`, this\n * returns `fr`. If your extension doesn't support any variant of the buyer's language,\n * this falls back to your extension's default locale (the `.default.json` translation file).\n * Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country associated with the order, carried over from the cart context where it was\n * used to contextualize the storefront experience. Use this value to display region-specific\n * content such as local support information or regional policies. The value is `undefined`\n * if the buyer's country is unknown.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) associated with the order, carried\n * over from the cart context. Markets group countries and regions with shared pricing,\n * languages, and domains. The value is `undefined` if the market is unknown.\n */\n market: SubscribableSignalLike;\n}" + }, + { + "filePath": "src/surfaces/customer-account/api/docs.ts", + "name": "Docs_OrderStatus_DiscountsApi", + "description": "", + "isPublicDocs": true, + "members": [ { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/docs.ts", "syntaxKind": "PropertySignature", - "name": "ariaModal", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaModal)" + "name": "discountAllocations", + "value": "SubscribableSignalLike", + "description": "The cart-level discount allocations applied to the order. A discount allocation represents how a discount is distributed across the order. Each allocation includes the discounted amount and one of the following types:\n\n- `CartCodeDiscountAllocation`: A discount the buyer applied by entering a code at checkout.\n- `CartAutomaticDiscountAllocation`: A discount the merchant configured in Shopify admin to apply automatically.\n- `CartCustomDiscountAllocation`: A discount created programmatically by a [Shopify Function](/docs/apps/build/functions).\n\nReturns order-level discounts only. For per-line discount allocations, read from individual cart lines via the Cart Lines API." }, { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/docs.ts", "syntaxKind": "PropertySignature", - "name": "ariaMultiLine", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiLine)" - }, + "name": "discountCodes", + "value": "SubscribableSignalLike", + "description": "A list of discount codes that the buyer entered during checkout and that were applied to the order." + } + ], + "value": "export interface Docs_OrderStatus_DiscountsApi\n extends Pick, 'discountAllocations' | 'discountCodes'> {}" + }, + { + "filePath": "src/surfaces/customer-account/api/docs.ts", + "name": "Docs_OrderStatus_GiftCardsApi", + "description": "", + "isPublicDocs": true, + "members": [ { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/docs.ts", "syntaxKind": "PropertySignature", - "name": "ariaMultiSelectable", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiSelectable)" - }, + "name": "appliedGiftCards", + "value": "SubscribableSignalLike", + "description": "The gift cards that were applied to the order. Each gift card includes the last four characters of the code, the amount used for this order, and the remaining balance." + } + ], + "value": "export interface Docs_OrderStatus_GiftCardsApi\n extends Pick, 'appliedGiftCards'> {}" + }, + { + "filePath": "src/surfaces/customer-account/api/docs.ts", + "name": "Docs_OrderStatus_NoteApi", + "description": "", + "isPublicDocs": true, + "members": [ { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/docs.ts", "syntaxKind": "PropertySignature", - "name": "ariaOrientation", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOrientation)" - }, + "name": "note", + "value": "SubscribableSignalLike", + "description": "A note left by the customer to the merchant, either in their cart or during checkout. The value is `undefined` if no note was provided." + } + ], + "value": "export interface Docs_OrderStatus_NoteApi\n extends Pick, 'note'> {}" + }, + { + "filePath": "src/surfaces/customer-account/api/docs.ts", + "name": "Docs_OrderStatus_AddressApi", + "description": "", + "isPublicDocs": true, + "members": [ { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/docs.ts", "syntaxKind": "PropertySignature", - "name": "ariaOwnsElements", - "value": "ReadonlyArray | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOwnsElements)" + "name": "billingAddress", + "value": "SubscribableSignalLike", + "description": "The billing address associated with the buyer's payment method for the order. The value is `undefined` if the order doesn't have a billing address on file.\n\nReflects the state at the time the order was placed. Doesn't update if the customer changes their account address afterward.", + "isOptional": true }, { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/docs.ts", "syntaxKind": "PropertySignature", - "name": "ariaPlaceholder", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPlaceholder)" - }, + "name": "shippingAddress", + "value": "SubscribableSignalLike", + "description": "The shipping address that the buyer provided for the order. This is where physical goods are delivered. The value is `undefined` if the order contains only digital products or if a shipping address wasn't required.\n\nReflects the state at the time the order was placed. Doesn't update if the customer changes their account address afterward.", + "isOptional": true + } + ], + "value": "export interface Docs_OrderStatus_AddressApi\n extends Pick, 'shippingAddress' | 'billingAddress'> {}" + }, + { + "filePath": "src/surfaces/customer-account/api/docs.ts", + "name": "Docs_OrderStatus_ShopApi", + "description": "", + "isPublicDocs": true, + "members": [ { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/docs.ts", "syntaxKind": "PropertySignature", - "name": "ariaPosInSet", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPosInSet)" - }, + "name": "shop", + "value": "Shop", + "description": "The shop where the order was placed. Includes the shop ID, name, primary storefront URL, and myshopify.com domain." + } + ], + "value": "export interface Docs_OrderStatus_ShopApi\n extends Pick, 'shop'> {}" + }, + { + "filePath": "src/surfaces/customer-account/api/docs.ts", + "name": "Docs_OrderStatus_RequireLoginApi", + "description": "", + "isPublicDocs": true, + "members": [ { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/docs.ts", "syntaxKind": "PropertySignature", - "name": "ariaPressed", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPressed)" - }, + "name": "requireLogin", + "value": "() => Promise", + "description": "Triggers a login prompt if the customer is viewing a pre-authenticated **Order status** page. Use this to require full authentication before displaying sensitive information in your extension.\n\nTriggers a login prompt for pre-authenticated buyers. Doesn't guarantee the buyer completes the login. Handle the dismissal case in your code." + } + ], + "value": "export interface Docs_OrderStatus_RequireLoginApi\n extends Pick, 'requireLogin'> {}" + }, + { + "filePath": "src/surfaces/customer-account/api/docs.ts", + "name": "Docs_OrderStatus_AuthenticationStateApi", + "description": "", + "isPublicDocs": true, + "members": [ { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/docs.ts", "syntaxKind": "PropertySignature", - "name": "ariaReadOnly", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaReadOnly)" - }, + "name": "authenticationState", + "value": "SubscribableSignalLike", + "description": "The buyer's current authentication level on the **Order status** page. Use this to determine whether to display sensitive information or prompt the buyer to log in.\n\nRead-only. The authentication level can't be changed programmatically." + } + ], + "value": "export interface Docs_OrderStatus_AuthenticationStateApi\n extends Pick, 'authenticationState'> {}" + }, + { + "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "AuthenticationState", + "value": "'fully_authenticated' | 'pre_authenticated'", + "description": "The buyer's authentication status on the **Order status** page:\n\n- `'fully_authenticated'`: The buyer has logged in to their customer account.\n- `'pre_authenticated'`: The buyer accessed the page via a direct link, such as from an order confirmation email, without logging in." + }, + { + "filePath": "src/surfaces/customer-account/api/docs.ts", + "name": "Docs_OrderStatus_CartLinesApi", + "description": "", + "isPublicDocs": true, + "members": [ { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/docs.ts", "syntaxKind": "PropertySignature", - "name": "ariaRelevant", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRelevant)" - }, + "name": "lines", + "value": "SubscribableSignalLike", + "description": "A list of line items in the order. Each line includes the merchandise, quantity, cost, custom attributes, and discount allocations." + } + ], + "value": "export interface Docs_OrderStatus_CartLinesApi\n extends Pick, 'lines'> {}" + }, + { + "filePath": "src/surfaces/customer-account/api/docs.ts", + "name": "Docs_CartLineItem_CartLinesApi", + "description": "The API object provided to `customer-account.order-status.cart-line-item.render-after` extension targets for interacting with individual cart line items.", + "isPublicDocs": true, + "members": [ { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/docs.ts", "syntaxKind": "PropertySignature", - "name": "ariaRequired", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRequired)" - }, + "name": "target", + "value": "SubscribableSignalLike", + "description": "The cart line that this extension is attached to. Use this to read the line item's merchandise, quantity, cost, and attributes." + } + ], + "value": "export interface Docs_CartLineItem_CartLinesApi\n extends Pick {}" + }, + { + "filePath": "src/surfaces/customer-account/api/docs.ts", + "name": "Docs_OrderStatus_OrderApi", + "description": "", + "isPublicDocs": true, + "members": [ { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/docs.ts", "syntaxKind": "PropertySignature", - "name": "ariaRoleDescription", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRoleDescription)" - }, + "name": "order", + "value": "SubscribableSignalLike", + "description": "The order that was placed after checkout completion. Includes the order ID, display name, confirmation number, and timestamps for processing and cancellation. The value is `undefined` if the order hasn't been fully processed yet." + } + ], + "value": "export interface Docs_OrderStatus_OrderApi\n extends Pick, 'order'> {}" + }, + { + "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", + "name": "Order", + "description": "Information about an order that was placed.", + "members": [ { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", "syntaxKind": "PropertySignature", - "name": "ariaRowCount", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowCount)" + "name": "cancelledAt", + "value": "string", + "description": "The date and time when the order was cancelled, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. The value is `undefined` if the order hasn't been cancelled. Use this to conditionally display cancellation details to the buyer.", + "isOptional": true }, { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", "syntaxKind": "PropertySignature", - "name": "ariaRowIndex", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndex)" + "name": "confirmationNumber", + "value": "string", + "description": "A randomly generated alphanumeric identifier for the order that the buyer can use when contacting the merchant about their purchase. This is always present for orders created in 2024 and onwards. For older orders, this value may be `undefined`.", + "isOptional": true }, { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", "syntaxKind": "PropertySignature", - "name": "ariaRowIndexText", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndexText)" + "name": "id", + "value": "string", + "description": "A globally-unique identifier for the order in the format `gid://shopify/Order/`. Use this to reference the order in the [GraphQL Admin API](/docs/api/admin-graphql).", + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "'gid://shopify/Order/1'", + "title": "Example" + } + ] + } + ] }, { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", "syntaxKind": "PropertySignature", - "name": "ariaRowSpan", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowSpan)" + "name": "name", + "value": "string", + "description": "The merchant-facing order number prefixed with `#`, such as `#1001`. This is the human-readable identifier displayed to both the merchant in Shopify admin and the buyer on the **Order status** page and in email confirmations.", + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "'#1000'", + "title": "Example" + } + ] + } + ] }, { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", "syntaxKind": "PropertySignature", - "name": "ariaSelected", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSelected)" - }, + "name": "processedAt", + "value": "string", + "description": "The date and time when the order was processed, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. An order is processed after the buyer completes checkout and the payment is captured, at which point the order becomes visible in Shopify admin.", + "isOptional": true + } + ], + "value": "export interface Order {\n /**\n * A globally-unique identifier for the order in the format `gid://shopify/Order/`. Use this to reference the order in the [GraphQL Admin API](/docs/api/admin-graphql).\n *\n * @example 'gid://shopify/Order/1'\n */\n id: string;\n\n /**\n * The merchant-facing order number prefixed with `#`, such as `#1001`. This is the human-readable identifier displayed to both the merchant in Shopify admin and the buyer on the **Order status** page and in email confirmations.\n *\n * @example '#1000'\n */\n name: string;\n\n /**\n * The date and time when the order was cancelled, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. The value is `undefined` if the order hasn't been cancelled. Use this to conditionally display cancellation details to the buyer.\n */\n cancelledAt?: string;\n\n /**\n * A randomly generated alphanumeric identifier for the order that the buyer can use when contacting the merchant about their purchase. This is always present for orders created in 2024 and onwards. For older orders, this value may be `undefined`.\n */\n confirmationNumber?: string;\n\n /**\n * The date and time when the order was processed, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. An order is processed after the buyer completes checkout and the payment is captured, at which point the order becomes visible in Shopify admin.\n */\n processedAt?: string;\n}" + }, + { + "filePath": "src/surfaces/customer-account/api/docs.ts", + "name": "Docs_Standard_ExtensionApi", + "description": "", + "isPublicDocs": true, + "members": [ { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/docs.ts", "syntaxKind": "PropertySignature", - "name": "ariaSetSize", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSetSize)" - }, + "name": "extension", + "value": "Extension", + "description": "Metadata about the extension, including its target, version, and editor context. Use this to conditionally render content based on where the extension is running." + } + ], + "value": "export interface Docs_Standard_ExtensionApi\n extends Pick, 'extension'> {}" + }, + { + "filePath": "src/surfaces/customer-account/api/docs.ts", + "name": "Docs_Standard_AuthenticatedAccountApi", + "description": "", + "isPublicDocs": true, + "members": [ { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/docs.ts", "syntaxKind": "PropertySignature", - "name": "ariaSort", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSort)" - }, + "name": "authenticatedAccount", + "value": "AuthenticatedAccount", + "description": "The logged-in customer's account information, including their customer ID and B2B company details. Use this to personalize your extension based on who is viewing the page." + } + ], + "value": "export interface Docs_Standard_AuthenticatedAccountApi\n extends Pick, 'authenticatedAccount'> {}" + }, + { + "filePath": "src/surfaces/customer-account/api/shared.ts", + "name": "AuthenticatedAccount", + "description": "", + "members": [ { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/shared.ts", "syntaxKind": "PropertySignature", - "name": "ariaValueMax", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMax)" + "name": "customer", + "value": "SubscribableSignalLike", + "description": "The authenticated customer's account information. The value is `undefined` if the customer isn't logged in." }, { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/shared.ts", "syntaxKind": "PropertySignature", - "name": "ariaValueMin", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMin)" - }, + "name": "purchasingCompany", + "value": "SubscribableSignalLike", + "description": "The company that the authenticated B2B customer belongs to, including the company ID and location. The value is `undefined` if the customer isn't authenticated or isn't a B2B customer." + } + ], + "value": "export interface AuthenticatedAccount {\n /**\n * The company that the authenticated B2B customer belongs to, including the company ID and location. The value is `undefined` if the customer isn't authenticated or isn't a B2B customer.\n */\n purchasingCompany: SubscribableSignalLike;\n /**\n * The authenticated customer's account information. The value is `undefined` if the customer isn't logged in.\n */\n customer: SubscribableSignalLike;\n}" + }, + { + "filePath": "src/surfaces/customer-account/api/docs.ts", + "name": "Docs_Standard_VersionApi", + "description": "", + "isPublicDocs": true, + "members": [ { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/docs.ts", "syntaxKind": "PropertySignature", - "name": "ariaValueNow", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueNow)" - }, + "name": "version", + "value": "Version", + "description": "The API version your extension is running against. Use this to conditionally enable features or handle breaking changes when your extension supports multiple API versions.", + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "'unstable'", + "title": "Example" + } + ] + } + ] + } + ], + "value": "export interface Docs_Standard_VersionApi\n extends Pick, 'version'> {}" + }, + { + "filePath": "src/surfaces/customer-account/api/docs.ts", + "name": "Docs_Standard_LocalizationApi", + "description": "The base API object provided to this and other `customer-account` extension targets.", + "isPublicDocs": true, + "members": [ { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/docs.ts", "syntaxKind": "PropertySignature", - "name": "ariaValueText", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueText)" + "name": "i18n", + "value": "I18n", + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use this alongside `localization` to build fully localized extensions." }, { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/docs.ts", "syntaxKind": "PropertySignature", - "name": "assignedSlot", - "value": "HTMLSlotElement | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/assignedSlot)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "attachInternals", - "value": "() => ElementInternals", - "description": "The **`HTMLElement.attachInternals()`** method returns an ElementInternals object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attachInternals)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "attachShadow", - "value": "(init: ShadowRootInit) => ShadowRoot", - "description": "The **`Element.attachShadow()`** method attaches a shadow DOM tree to the specified element and returns a reference to its ShadowRoot.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attachShadow)" - }, + "name": "localization", + "value": "Localization", + "description": "The buyer's language, country, and locale context. Use this to adapt your extension to the buyer's region and display localized content." + } + ], + "value": "export interface Docs_Standard_LocalizationApi\n extends Pick, 'localization' | 'i18n'> {}" + }, + { + "filePath": "src/surfaces/customer-account/api/docs.ts", + "name": "Docs_Standard_SessionTokenApi", + "description": "The base API object provided to this and other `customer-account` extension targets.", + "isPublicDocs": true, + "members": [ { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/docs.ts", "syntaxKind": "PropertySignature", - "name": "ATTRIBUTE_NODE", - "value": "2", - "description": "" - }, + "name": "sessionToken", + "value": "SessionToken", + "description": "Authenticates requests between your extension and your app backend. Call `get()` to retrieve a signed JWT containing the customer ID, shop domain, and expiration time, then verify it server-side. For more information, refer to the [Session Token API](/docs/api/customer-account-ui-extensions/{API_VERSION}/target-apis/platform-apis/session-token-api)." + } + ], + "value": "export interface Docs_Standard_SessionTokenApi\n extends Pick, 'sessionToken'> {}" + }, + { + "filePath": "src/surfaces/customer-account/api/docs.ts", + "name": "Docs_Standard_AnalyticsApi", + "description": "The base API object provided to this and other `customer-account` extension targets.", + "isPublicDocs": true, + "members": [ { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/docs.ts", "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "NamedNodeMap", - "description": "The **`Element.attributes`** property returns a live collection of all attribute nodes registered to the specified node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attributes)" - }, + "name": "analytics", + "value": "Analytics", + "description": "Tracks custom events and sends visitor information to [web pixels](/docs/apps/build/marketing-analytics/pixels). Use `publish()` to emit events and `visitor()` to submit visitor data.\n\n> Note: Requires [connecting a third-party domain](https://help.shopify.com/en/manual/domains/add-a-domain/connecting-domains/connect-domain-customer-account) to Shopify for your customer account pages." + } + ], + "value": "export interface Docs_Standard_AnalyticsApi\n extends Pick, 'analytics'> {}" + }, + { + "filePath": "src/surfaces/customer-account/api/docs.ts", + "name": "Docs_Standard_SettingsApi", + "description": "The base API object provided to this and other `customer-account` extension targets.", + "isPublicDocs": true, + "members": [ { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/docs.ts", "syntaxKind": "PropertySignature", - "name": "attributeStyleMap", - "value": "StylePropertyMap", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attributeStyleMap)" - }, + "name": "settings", + "value": "SubscribableSignalLike", + "description": "Merchant-defined configuration values for your extension, as specified in the [settings definition](/docs/api/customer-account-ui-extensions/{API_VERSION}/configuration#settings-definition) of your `shopify.extension.toml` file. Settings update in real time as merchants edit them in the extension editor. The value is empty until a merchant sets it." + } + ], + "value": "export interface Docs_Standard_SettingsApi\n extends Pick {}" + }, + { + "filePath": "src/surfaces/customer-account/api/docs.ts", + "name": "Docs_Standard_StorageApi", + "description": "The base API object provided to this and other `customer-account` extension targets.", + "isPublicDocs": true, + "members": [ { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/docs.ts", "syntaxKind": "PropertySignature", - "name": "autocapitalize", - "value": "string", - "description": "The **`autocapitalize`** property of the HTMLElement interface represents the element's capitalization behavior for user input.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocapitalize)" - }, + "name": "storage", + "value": "Storage", + "description": "Key-value storage that persists across customer sessions for this extension target. Use this to store preferences, dismiss states, or cached data without requiring a backend call." + } + ], + "value": "export interface Docs_Standard_StorageApi\n extends Pick, 'storage'> {}" + }, + { + "filePath": "src/surfaces/customer-account/api/docs.ts", + "name": "Docs_Standard_CustomerPrivacyApi", + "description": "The base API object provided to this and other `customer-account` extension targets.", + "isPublicDocs": true, + "members": [ { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/docs.ts", "syntaxKind": "PropertySignature", - "name": "autocorrect", - "value": "boolean", - "description": "The **`autocorrect`** property of the HTMLElement interface controls whether or not autocorrection of editable text is enabled for spelling and/or punctuation errors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocorrect)" + "name": "applyTrackingConsentChange", + "value": "ApplyTrackingConsentChangeType", + "description": "Applies updated tracking consent preferences for the buyer, including their decisions for analytics, marketing, and data sale, along with any custom tracking consent [metafields](/docs/apps/build/custom-data/metafields). Returns a promise that resolves with the result of the consent update.\n\n{% include /apps/checkout/privacy-icon.md %} Requires the [`collect_buyer_consent` capability](/docs/apps/build/customer-accounts/capabilities#collect-buyer-consent) and access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." }, { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/docs.ts", "syntaxKind": "PropertySignature", - "name": "autofocus", - "value": "boolean", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autofocus)" - }, + "name": "customerPrivacy", + "value": "SubscribableSignalLike", + "description": "The buyer's current privacy consent settings, including their consent decisions for analytics, marketing, and data sale, whether a consent banner should be displayed, and whether the buyer is in a region that requires specific opt-out controls. Use this to read the buyer's consent state and determine how to display privacy-related UI." + } + ], + "value": "export interface Docs_Standard_CustomerPrivacyApi\n extends Pick<\n StandardApi,\n 'customerPrivacy' | 'applyTrackingConsentChange'\n > {}" + }, + { + "filePath": "src/surfaces/customer-account/api/docs.ts", + "name": "Docs_Standard_ToastApi", + "description": "The base API object provided to this and other `customer-account` extension targets.", + "isPublicDocs": true, + "members": [ { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/docs.ts", "syntaxKind": "PropertySignature", - "name": "baseURI", - "value": "string", - "description": "The read-only **`baseURI`** property of the Node interface returns the absolute base URL of the document containing the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/baseURI)" - }, + "name": "toast", + "value": "ToastApi", + "description": "Displays brief, non-blocking messages at the bottom of the page to confirm actions or report errors. Use noun + past tense verb format (for example, `Changes saved`). For persistent messages, use a [Banner](/docs/api/customer-account-ui-extensions/{API_VERSION}/ui-components/feedback-and-status-indicators/banner) component instead." + } + ], + "value": "export interface Docs_Standard_ToastApi\n extends Pick, 'toast'> {}" + }, + { + "filePath": "src/surfaces/customer-account/api/shared.ts", + "name": "ToastApi", + "description": "Displays brief, non-blocking notification messages to the customer. Use the Toast API to confirm successful actions, report errors, or surface contextual feedback without interrupting the customer workflow.", + "members": [ { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "before", - "value": "(...nodes: (string | Node)[]) => void", - "description": "Inserts nodes just before node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/before)" - }, + "filePath": "src/surfaces/customer-account/api/shared.ts", + "syntaxKind": "PropertySignature", + "name": "show", + "value": "(content: string) => Promise", + "description": "Show a toast notification with the given message. Returns a handle with a `hide()` method to dismiss the toast programmatically." + } + ], + "value": "export interface ToastApi {\n /**\n * Show a toast notification with the given message. Returns a handle with a `hide()` method to dismiss the toast programmatically.\n */\n show: (content: string) => Promise;\n}" + }, + { + "filePath": "src/surfaces/customer-account/api/shared.ts", + "name": "ToastApiResult", + "description": "A handle returned by `ToastApi.show()`. Call `hide()` to dismiss the toast notification programmatically.", + "members": [ { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "blur", + "filePath": "src/surfaces/customer-account/api/shared.ts", + "syntaxKind": "PropertySignature", + "name": "hide", "value": "() => void", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/blur)" + "description": "Dismisses the toast notification." + } + ], + "value": "export interface ToastApiResult {\n /**\n * Dismisses the toast notification.\n */\n hide: () => void;\n}" + }, + { + "filePath": "src/surfaces/customer-account/api/docs.ts", + "name": "Docs_Standard_QueryApi", + "description": "The base API object provided to this and other `customer-account` extension targets.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/customer-account/api/docs.ts", + "syntaxKind": "PropertySignature", + "name": "query", + "value": "(query: string, options?: { variables?: Variables; version?: StorefrontApiVersion; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>", + "description": "Queries the [Storefront GraphQL API](/docs/api/storefront) directly from your extension using a prefetched token. Use this to fetch product data, collection details, or other storefront information without routing requests through your app backend.\n\nRequires the [`api_access` capability](/docs/api/customer-account-ui-extensions/{API_VERSION}/configuration#api-access)." + } + ], + "value": "export interface Docs_Standard_QueryApi\n extends Pick, 'query'> {}" + }, + { + "filePath": "src/surfaces/customer-account/api/docs.ts", + "name": "Docs_StandardApi", + "description": "The base API object provided to this and other `customer-account` extension targets.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/customer-account/api/docs.ts", + "syntaxKind": "PropertySignature", + "name": "analytics", + "value": "Analytics", + "description": "Tracks custom events and sends visitor information to [web pixels](/docs/apps/build/marketing-analytics/pixels). Use `publish()` to emit events and `visitor()` to submit visitor data.\n\n> Note: Requires [connecting a third-party domain](https://help.shopify.com/en/manual/domains/add-a-domain/connecting-domains/connect-domain-customer-account) to Shopify for your customer account pages." }, { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/docs.ts", "syntaxKind": "PropertySignature", - "name": "CDATA_SECTION_NODE", - "value": "4", - "description": "node is a CDATASection node." + "name": "applyTrackingConsentChange", + "value": "ApplyTrackingConsentChangeType", + "description": "Applies updated tracking consent preferences for the buyer, including their decisions for analytics, marketing, and data sale, along with any custom tracking consent [metafields](/docs/apps/build/custom-data/metafields). Returns a promise that resolves with the result of the consent update.\n\n{% include /apps/checkout/privacy-icon.md %} Requires the [`collect_buyer_consent` capability](/docs/apps/build/customer-accounts/capabilities#collect-buyer-consent) and access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." }, { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "checkVisibility", - "value": "(options?: CheckVisibilityOptions) => boolean", - "description": "The **`checkVisibility()`** method of the Element interface checks whether the element is visible.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/checkVisibility)" + "filePath": "src/surfaces/customer-account/api/docs.ts", + "syntaxKind": "PropertySignature", + "name": "authenticatedAccount", + "value": "AuthenticatedAccount", + "description": "The logged-in customer's account information, including their customer ID and B2B company details. Use this to personalize your extension based on who is viewing the page." }, { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/docs.ts", "syntaxKind": "PropertySignature", - "name": "childElementCount", - "value": "number", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/childElementCount)" + "name": "customerPrivacy", + "value": "SubscribableSignalLike", + "description": "The buyer's current privacy consent settings, including their consent decisions for analytics, marketing, and data sale, whether a consent banner should be displayed, and whether the buyer is in a region that requires specific opt-out controls. Use this to read the buyer's consent state and determine how to display privacy-related UI." }, { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/docs.ts", "syntaxKind": "PropertySignature", - "name": "childNodes", - "value": "NodeListOf", - "description": "The read-only **`childNodes`** property of the Node interface returns a live the first child node is assigned index `0`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/childNodes)" + "name": "extension", + "value": "Extension", + "description": "Metadata about the extension, including its target, version, and editor context. Use this to conditionally render content based on where the extension is running." }, { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/docs.ts", "syntaxKind": "PropertySignature", - "name": "children", - "value": "HTMLCollection", - "description": "Returns the child elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/children)" + "name": "extensionPoint", + "value": "Target", + "description": "The identifier that specifies where in Shopify’s UI your code is being injected. This will be one of the [targets](/docs/api/customer-account-ui-extensions/{API_VERSION}/configuration#targets) you have included in your extension’s configuration file. For more information, refer to the [extension targets overview](/docs/api/customer-account-ui-extensions/{API_VERSION}/extension-targets-overview).", + "deprecationMessage": "Use `extension.target` instead.", + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "'customer-account.order-status.block.render'", + "title": "Example" + } + ] + } + ] }, { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "GetAccessor", - "name": "classList", - "value": "DOMTokenList", - "description": "The **`Element.classList`** is a read-only property that returns a live DOMTokenList collection of the `class` attributes of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/classList)" + "filePath": "src/surfaces/customer-account/api/docs.ts", + "syntaxKind": "PropertySignature", + "name": "i18n", + "value": "I18n", + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use this alongside `localization` to build fully localized extensions." }, { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/docs.ts", "syntaxKind": "PropertySignature", - "name": "className", - "value": "string", - "description": "The **`className`** property of the of the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/className)" + "name": "intents", + "value": "Intents", + "description": "Invokes built-in Shopify workflows for managing customer account resources. Use intents to trigger native modals and flows, such as replacing a payment method on a subscription contract, without building the UI yourself." }, { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "click", - "value": "() => void", - "description": "The **`HTMLElement.click()`** method simulates a mouse click on an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/click)" + "filePath": "src/surfaces/customer-account/api/docs.ts", + "syntaxKind": "PropertySignature", + "name": "localization", + "value": "Localization", + "description": "The buyer's language, country, and locale context. Use this to adapt your extension to the buyer's region and display localized content." }, { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/docs.ts", "syntaxKind": "PropertySignature", - "name": "clientHeight", - "value": "number", - "description": "The **`clientHeight`** read-only property of the Element interface is zero for elements with no CSS or inline layout boxes; otherwise, it's the inner height of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientHeight)" + "name": "query", + "value": "(query: string, options?: { variables?: Variables; version?: StorefrontApiVersion; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>", + "description": "Queries the [Storefront GraphQL API](/docs/api/storefront) directly from your extension using a prefetched token. Use this to fetch product data, collection details, or other storefront information without routing requests through your app backend.\n\nRequires the [`api_access` capability](/docs/api/customer-account-ui-extensions/{API_VERSION}/configuration#api-access)." }, { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/docs.ts", "syntaxKind": "PropertySignature", - "name": "clientLeft", - "value": "number", - "description": "The **`clientLeft`** read-only property of the Element interface returns the width of the left border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientLeft)" + "name": "sessionToken", + "value": "SessionToken", + "description": "Authenticates requests between your extension and your app backend. Call `get()` to retrieve a signed JWT containing the customer ID, shop domain, and expiration time, then verify it server-side. For more information, refer to the [Session Token API](/docs/api/customer-account-ui-extensions/{API_VERSION}/target-apis/platform-apis/session-token-api)." }, { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/docs.ts", "syntaxKind": "PropertySignature", - "name": "clientTop", - "value": "number", - "description": "The **`clientTop`** read-only property of the Element interface returns the width of the top border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientTop)" + "name": "settings", + "value": "SubscribableSignalLike", + "description": "Merchant-defined configuration values for your extension, as specified in the [settings definition](/docs/api/customer-account-ui-extensions/{API_VERSION}/configuration#settings-definition) of your `shopify.extension.toml` file. Settings update in real time as merchants edit them in the extension editor. The value is empty until a merchant sets it." }, { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/docs.ts", "syntaxKind": "PropertySignature", - "name": "clientWidth", - "value": "number", - "description": "The **`clientWidth`** read-only property of the Element interface is zero for inline elements and elements with no CSS; otherwise, it's the inner width of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientWidth)" + "name": "storage", + "value": "Storage", + "description": "Key-value storage that persists across customer sessions for this extension target. Use this to store preferences, dismiss states, or cached data without requiring a backend call." }, { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "cloneNode", - "value": "(subtree?: boolean) => Node", - "description": "The **`cloneNode()`** method of the Node interface returns a duplicate of the node on which this method was called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/cloneNode)" + "filePath": "src/surfaces/customer-account/api/docs.ts", + "syntaxKind": "PropertySignature", + "name": "toast", + "value": "ToastApi", + "description": "Displays brief, non-blocking messages at the bottom of the page to confirm actions or report errors. Use noun + past tense verb format (for example, `Changes saved`). For persistent messages, use a [Banner](/docs/api/customer-account-ui-extensions/{API_VERSION}/ui-components/feedback-and-status-indicators/banner) component instead." }, { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/docs.ts", + "syntaxKind": "PropertySignature", + "name": "version", + "value": "Version", + "description": "The API version your extension is running against. Use this to conditionally enable features or handle breaking changes when your extension supports multiple API versions.", + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "'unstable'", + "title": "Example" + } + ] + } + ] + } + ], + "value": "export interface Docs_StandardApi extends Omit, 'router'> {}" + }, + { + "filePath": "src/surfaces/customer-account/api/shared.ts", + "name": "Intents", + "description": "Invokes built-in Shopify workflows for managing customer account resources. Use the Intents API to trigger native Shopify modals and flows, such as replacing a payment method on a subscription contract, without building the UI yourself.\n\nIntents pair an `action` (verb) with a resource `type` and optional `value` and `data` to request a workflow.", + "members": [ + { + "filePath": "src/surfaces/customer-account/api/shared.ts", "syntaxKind": "MethodSignature", - "name": "closest", - "value": "{ (selector: K): HTMLElementTagNameMap[K]; (selector: K): SVGElementTagNameMap[K]; (selector: K): MathMLElementTagNameMap[K]; (selectors: string): E; }", - "description": "The **`closest()`** method of the Element interface traverses the element and its parents (heading toward the document root) until it finds a node that matches the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/closest)" + "name": "invoke", + "value": "{ (query: IntentQuery): Promise; (intentURL: string, options?: IntentQueryOptions): Promise; }", + "description": "Triggers a built-in Shopify workflow by passing a structured intent object. Specify an `action` (such as `'open'`), a resource `type`, and an optional `value` identifying the resource. Returns a promise that resolves to an `IntentActivity` you can use to track completion.\n\nTriggers a built-in Shopify workflow using a URL string in the format `action:type[,value][?params]`. Use this overload when composing intents from dynamic strings rather than structured objects.", + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "const activity = await shopify.intents.invoke(\n {\n action: 'open',\n type: 'shopify/SubscriptionContract',\n value: 'gid://shopify/SubscriptionContract/69372608568',\n data: { field: 'paymentMethod' },\n }\n);", + "title": "Example" + } + ] + }, + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "const activity = await shopify.intents.invoke('open:shopify/SubscriptionContract,gid://shopify/SubscriptionContract/69372608568?field=paymentMethod');\n\n// Or using a query string and options\nconst activity = await shopify.intents.invoke(\n 'open:shopify/SubscriptionContract',\n {\n value: 'gid://shopify/SubscriptionContract/69372608568',\n data: { field: 'paymentMethod' },\n }\n);\nconst response = await activity.complete;", + "title": "Using query string syntax" + } + ] + } + ] + } + ], + "value": "export interface Intents {\n /**\n * Triggers a built-in Shopify workflow by passing a structured intent object. Specify an `action` (such as `'open'`), a resource `type`, and an optional `value` identifying the resource. Returns a promise that resolves to an `IntentActivity` you can use to track completion.\n *\n * @param query - Structured intent description, including `action` and `type`.\n * @returns A promise for an {@link IntentActivity} that completes with an\n * {@link IntentResponse}.\n *\n * @example\n * ```javascript\n * const activity = await shopify.intents.invoke(\n * {\n * action: 'open',\n * type: 'shopify/SubscriptionContract',\n * value: 'gid://shopify/SubscriptionContract/69372608568',\n * data: { field: 'paymentMethod' },\n * }\n * );\n * ```\n */\n invoke(query: IntentQuery): Promise;\n /**\n * Triggers a built-in Shopify workflow using a URL string in the format `action:type[,value][?params]`. Use this overload when composing intents from dynamic strings rather than structured objects.\n *\n * @param intentURL - Intent in URL form, such as `'open:shopify/SubscriptionContract,gid://shopify/SubscriptionContract/123'`.\n * @param options - Optional supplemental inputs such as `value` or `data`.\n * @returns A promise for an {@link IntentActivity} that completes with an\n * {@link IntentResponse}.\n *\n * @example\n * ```javascript\n * // Using query string syntax\n * const activity = await shopify.intents.invoke('open:shopify/SubscriptionContract,gid://shopify/SubscriptionContract/69372608568?field=paymentMethod');\n *\n * // Or using a query string and options\n * const activity = await shopify.intents.invoke(\n * 'open:shopify/SubscriptionContract',\n * {\n * value: 'gid://shopify/SubscriptionContract/69372608568',\n * data: { field: 'paymentMethod' },\n * }\n * );\n * const response = await activity.complete;\n * ```\n */\n invoke(\n intentURL: string,\n options?: IntentQueryOptions,\n ): Promise;\n}" + }, + { + "filePath": "src/surfaces/customer-account/api/shared.ts", + "name": "IntentQuery", + "description": "Structured description of an intent to invoke.\n\nUse this object form when programmatically composing an intent at runtime. It pairs an action (verb) with a resource type and optional inputs.", + "members": [ + { + "filePath": "src/surfaces/customer-account/api/shared.ts", + "syntaxKind": "PropertySignature", + "name": "action", + "value": "IntentAction", + "description": "Verb describing the operation to perform on the target resource.\n\nCommon values include `create` and `open`. The set of allowed verbs is intent-specific; unknown verbs will fail validation." }, { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/shared.ts", "syntaxKind": "PropertySignature", - "name": "command", - "value": "'--auto' | '--show' | '--hide' | '--toggle' | '--copy'", - "description": "Sets the action the `commandFor` should take when this clickable is activated.\n\nSee the documentation of particular components for the actions they support.\n\n- `--auto`: Performs the default action for the target component.\n- `--show`: Displays the target component.\n- `--hide`: Conceals the target component.\n- `--toggle`: Alternates the target component.\n- `--copy`: Copies the target ClipboardItem.", - "isOptional": true, - "defaultValue": "'--auto'" + "name": "data", + "value": "Record", + "description": "Optional input payload passed to the intent. Used to seed forms or supply parameters. The accepted shape is intent-specific. For example, replacing a payment method on a subscription contract requires `{ field: 'paymentMethod' }`.", + "isOptional": true }, { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/shared.ts", "syntaxKind": "PropertySignature", - "name": "commandFor", + "name": "type", "value": "string", - "description": "ID of a component that should respond to activations (such as clicks) on this component.\n\nSee `command` for how to control the behavior of the target.", - "isOptional": true + "description": "The resource type (such as `shopify/SubscriptionContract`)." }, { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/shared.ts", "syntaxKind": "PropertySignature", - "name": "COMMENT_NODE", - "value": "8", - "description": "node is a Comment node." + "name": "value", + "value": "string", + "description": "The resource identifier for edit actions (such as `gid://shopify/SubscriptionContract/123`).", + "isOptional": true + } + ], + "value": "export interface IntentQuery extends IntentQueryOptions {\n /**\n * Verb describing the operation to perform on the target resource.\n *\n * Common values include `create` and `open`. The set of\n * allowed verbs is intent-specific; unknown verbs will fail validation.\n */\n action: IntentAction;\n /**\n * The resource type (such as `shopify/SubscriptionContract`).\n */\n type: string;\n}" + }, + { + "filePath": "src/surfaces/customer-account/api/shared.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "IntentAction", + "value": "'create' | 'open' | string", + "description": "Allowed actions that can be performed by an intent.\n\nCommon actions include:\n- `'create'`: Initiate creation of a new resource.\n- `'open'`: Modify an existing resource." + }, + { + "filePath": "src/surfaces/customer-account/api/shared.ts", + "name": "IntentActivity", + "description": "Activity handle for tracking intent workflow progress.", + "members": [ + { + "filePath": "src/surfaces/customer-account/api/shared.ts", + "syntaxKind": "PropertySignature", + "name": "complete", + "value": "Promise", + "description": "A Promise that resolves when the intent workflow completes, returning the response." + } + ], + "value": "export interface IntentActivity {\n /**\n * A Promise that resolves when the intent workflow completes, returning the response.\n */\n complete: Promise;\n}" + }, + { + "filePath": "src/surfaces/customer-account/api/shared.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "IntentResponse", + "value": "SuccessIntentResponse | ErrorIntentResponse | ClosedIntentResponse", + "description": "Result of an intent activity.\n\nDiscriminated union representing all possible completion outcomes for an invoked intent." + }, + { + "filePath": "src/surfaces/customer-account/api/shared.ts", + "name": "SuccessIntentResponse", + "description": "Successful intent completion.\n\n- `code` is always `'ok'`\n- `data` contains the output payload", + "members": [ + { + "filePath": "src/surfaces/customer-account/api/shared.ts", + "syntaxKind": "PropertySignature", + "name": "code", + "value": "'ok'", + "description": "Always `'ok'` for a successful response." }, { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "compareDocumentPosition", - "value": "(other: Node) => number", - "description": "The **`compareDocumentPosition()`** method of the Node interface reports the position of its argument node relative to the node on which it is called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/compareDocumentPosition)" + "filePath": "src/surfaces/customer-account/api/shared.ts", + "syntaxKind": "PropertySignature", + "name": "data", + "value": "Record", + "description": "Validated output payload produced by the workflow.\n\nThe shape is intent-specific. Consumers should narrow by `code === 'ok'` before accessing." + } + ], + "value": "export interface SuccessIntentResponse {\n /**\n * Always `'ok'` for a successful response.\n */\n code: 'ok';\n /**\n * Validated output payload produced by the workflow.\n *\n * The shape is intent-specific. Consumers should narrow by `code === 'ok'` before accessing.\n */\n data: Record;\n}" + }, + { + "filePath": "src/surfaces/customer-account/api/shared.ts", + "name": "ErrorIntentResponse", + "description": "Failed intent completion.\n\n- `code` is always `'error'`\n- `message` summarizes the failure\n- `issues` optionally provides structured details for validation or field-specific problems following the Standard Schema convention", + "members": [ + { + "filePath": "src/surfaces/customer-account/api/shared.ts", + "syntaxKind": "PropertySignature", + "name": "code", + "value": "'error'", + "description": "Set to `'error'` when present. This property is optional.", + "isOptional": true }, { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "computedStyleMap", - "value": "() => StylePropertyMapReadOnly", - "description": "The **`computedStyleMap()`** method of the Element interface returns a StylePropertyMapReadOnly interface which provides a read-only representation of a CSS declaration block that is an alternative to CSSStyleDeclaration.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/computedStyleMap)" + "filePath": "src/surfaces/customer-account/api/shared.ts", + "syntaxKind": "PropertySignature", + "name": "issues", + "value": "{ path?: string[]; message?: string; }[]", + "description": "Structured details for validation or field-specific problems, following the Standard Schema convention.", + "isOptional": true }, { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "contains", - "value": "(other: Node) => boolean", - "description": "The **`contains()`** method of the Node interface returns a boolean value indicating whether a node is a descendant of a given node, that is the node itself, one of its direct children (Node.childNodes), one of the children's direct children, and so on.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/contains)" + "filePath": "src/surfaces/customer-account/api/shared.ts", + "syntaxKind": "PropertySignature", + "name": "message", + "value": "string", + "description": "A human-readable summary of the failure.", + "isOptional": true + } + ], + "value": "export interface ErrorIntentResponse {\n /**\n * Set to `'error'` when present. This property is optional.\n */\n code?: 'error';\n /**\n * A human-readable summary of the failure.\n */\n message?: string;\n /**\n * Structured details for validation or field-specific problems, following the Standard Schema convention.\n */\n issues?: {\n /**\n * The path to the field with the issue.\n */\n path?: string[];\n /**\n * The error message for the issue.\n */\n message?: string;\n }[];\n}" + }, + { + "filePath": "src/surfaces/customer-account/api/shared.ts", + "name": "ClosedIntentResponse", + "description": "User dismissed or closed the workflow without completing it.\n\nDistinct from `error`: no failure occurred, the activity was simply abandoned by the user.", + "members": [ + { + "filePath": "src/surfaces/customer-account/api/shared.ts", + "syntaxKind": "PropertySignature", + "name": "code", + "value": "'closed'", + "description": "Always `'closed'` when the user dismissed the workflow without completing it." + } + ], + "value": "export interface ClosedIntentResponse {\n /**\n * Always `'closed'` when the user dismissed the workflow without completing it.\n */\n code: 'closed';\n}" + }, + { + "filePath": "src/surfaces/customer-account/api/shared.ts", + "name": "IntentQueryOptions", + "description": "Options for URL-based invocations.\n\nWhen invoking via URL syntax, `action` and `type` are parsed from the string. This companion type captures the remaining optional fields that can be provided alongside the URL.", + "members": [ + { + "filePath": "src/surfaces/customer-account/api/shared.ts", + "syntaxKind": "PropertySignature", + "name": "data", + "value": "Record", + "description": "Optional input payload passed to the intent. Used to seed forms or supply parameters. The accepted shape is intent-specific. For example, replacing a payment method on a subscription contract requires `{ field: 'paymentMethod' }`.", + "isOptional": true }, { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/shared.ts", "syntaxKind": "PropertySignature", - "name": "contentEditable", + "name": "value", "value": "string", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/contentEditable)" + "description": "The resource identifier for edit actions (such as `gid://shopify/SubscriptionContract/123`).", + "isOptional": true + } + ], + "value": "export interface IntentQueryOptions {\n /**\n * The resource identifier for edit actions (such as `gid://shopify/SubscriptionContract/123`).\n */\n value?: string;\n /**\n * Optional input payload passed to the intent. Used to seed forms or supply parameters. The accepted shape is intent-specific. For example, replacing a payment method on a subscription contract requires `{ field: 'paymentMethod' }`.\n */\n data?: Record;\n}" + }, + { + "filePath": "src/surfaces/customer-account/api/docs.ts", + "name": "Docs_Page_Button_PrimaryAction", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/customer-account/api/docs.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "A label that describes the button's purpose to assistive technologies. Use this when the button text alone doesn't provide enough context.", + "isOptional": true }, { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/docs.ts", "syntaxKind": "PropertySignature", - "name": "currentCSSZoom", - "value": "number", - "description": "The **`currentCSSZoom`** read-only property of the Element interface provides the 'effective' CSS `zoom` of an element, taking into account the zoom applied to the element and all its parent elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/currentCSSZoom)" + "name": "click", + "value": "(event: EventListener & ((event: CallbackEvent<\"s-button\", Event>) => void)) => void", + "description": "A callback that fires when the button is activated, before the action indicated by `type`.", + "isOptional": true }, { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/docs.ts", "syntaxKind": "PropertySignature", - "name": "dataset", - "value": "DOMStringMap", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dataset)" + "name": "command", + "value": "'--auto' | '--show' | '--hide' | '--toggle' | '--copy'", + "description": "The action the `commandFor` target should take when this button is activated.\n\n- `--auto`: A default action for the target component.\n- `--show`: Shows the target component.\n- `--hide`: Hides the target component.\n- `--toggle`: Toggles the target component.\n- `--copy`: Copies the target ClipboardItem.", + "isOptional": true, + "defaultValue": "'--auto'" }, { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/docs.ts", "syntaxKind": "PropertySignature", - "name": "dir", + "name": "commandFor", "value": "string", - "description": "The **`HTMLElement.dir`** property indicates the text writing directionality of the content of the current element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dir)" + "description": "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).", + "isOptional": true }, { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/docs.ts", "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Whether the button is disabled, preventing it from being clicked or receiving focus.", + "description": "Whether the button is disabled and non-interactive.", "isOptional": true, "defaultValue": "false" }, { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "dispatchEvent", - "value": "(event: Event) => boolean", - "description": "The **`dispatchEvent()`** method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/dispatchEvent)" + "filePath": "src/surfaces/customer-account/api/docs.ts", + "syntaxKind": "PropertySignature", + "name": "href", + "value": "string", + "description": "The URL to navigate to when the button is activated. If a `commandFor` is set, the `command` is executed instead of the navigation.", + "isOptional": true }, { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/docs.ts", "syntaxKind": "PropertySignature", - "name": "DOCUMENT_FRAGMENT_NODE", - "value": "11", - "description": "node is a DocumentFragment node." - }, + "name": "loading", + "value": "boolean", + "description": "Whether to replace the button content with a loading indicator.", + "isOptional": true, + "defaultValue": "false" + } + ], + "value": "export interface Docs_Page_Button_PrimaryAction\n extends Pick<\n ButtonProps,\n | 'click'\n | 'loading'\n | 'disabled'\n | 'accessibilityLabel'\n | 'href'\n | 'command'\n | 'commandFor'\n > {\n /**\n * A label that describes the button's purpose to assistive technologies. Use this when the button text alone doesn't provide enough context.\n */\n accessibilityLabel?: ButtonProps['accessibilityLabel'];\n /**\n * A callback that fires when the button is activated, before the action indicated by `type`.\n */\n click?: ButtonProps['click'];\n /**\n * The action the `commandFor` target should take when this button is activated.\n *\n * - `--auto`: A default action for the target component.\n * - `--show`: Shows the target component.\n * - `--hide`: Hides the target component.\n * - `--toggle`: Toggles the target component.\n * - `--copy`: Copies the target ClipboardItem.\n *\n * @default '--auto'\n */\n command?: ButtonProps['command'];\n /**\n * 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).\n */\n commandFor?: ButtonProps['commandFor'];\n /**\n * Whether the button is disabled and non-interactive.\n *\n * @default false\n */\n disabled?: ButtonProps['disabled'];\n /**\n * The URL to navigate to when the button is activated. If a `commandFor` is set, the `command` is executed instead of the navigation.\n */\n href?: ButtonProps['href'];\n /**\n * Whether to replace the button content with a loading indicator.\n *\n * @default false\n */\n loading?: ButtonProps['loading'];\n}" + }, + { + "filePath": "src/surfaces/customer-account/api/docs.ts", + "name": "Docs_Page_Button_SecondaryAction", + "description": "", + "isPublicDocs": true, + "members": [ { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/docs.ts", "syntaxKind": "PropertySignature", - "name": "DOCUMENT_NODE", - "value": "9", - "description": "node is a document." + "name": "accessibilityLabel", + "value": "string", + "description": "A label that describes the button's purpose to assistive technologies. Use this when the button text alone doesn't provide enough context.", + "isOptional": true }, { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/docs.ts", "syntaxKind": "PropertySignature", - "name": "DOCUMENT_POSITION_CONTAINED_BY", - "value": "16", - "description": "Set when other is a descendant of node." + "name": "click", + "value": "(event: EventListener & ((event: CallbackEvent<\"s-button\", Event>) => void)) => void", + "description": "A callback that fires when the button is activated, before the action indicated by `type`.", + "isOptional": true }, { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/docs.ts", "syntaxKind": "PropertySignature", - "name": "DOCUMENT_POSITION_CONTAINS", - "value": "8", - "description": "Set when other is an ancestor of node." + "name": "command", + "value": "'--auto' | '--show' | '--hide' | '--toggle' | '--copy'", + "description": "The action the `commandFor` target should take when this button is activated.\n\n- `--auto`: A default action for the target component.\n- `--show`: Shows the target component.\n- `--hide`: Hides the target component.\n- `--toggle`: Toggles the target component.\n- `--copy`: Copies the target ClipboardItem.", + "isOptional": true, + "defaultValue": "'--auto'" }, { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/docs.ts", "syntaxKind": "PropertySignature", - "name": "DOCUMENT_POSITION_DISCONNECTED", - "value": "1", - "description": "Set when node and other are not in the same tree." + "name": "commandFor", + "value": "string", + "description": "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).", + "isOptional": true }, { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/docs.ts", "syntaxKind": "PropertySignature", - "name": "DOCUMENT_POSITION_FOLLOWING", - "value": "4", - "description": "Set when other is following node." + "name": "disabled", + "value": "boolean", + "description": "Whether the button is disabled and non-interactive.", + "isOptional": true, + "defaultValue": "false" }, { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/docs.ts", "syntaxKind": "PropertySignature", - "name": "DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC", - "value": "32", - "description": "" + "name": "href", + "value": "string", + "description": "The URL to navigate to when the button is activated. If a `commandFor` is set, the `command` is executed instead of the navigation.", + "isOptional": true }, { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/docs.ts", "syntaxKind": "PropertySignature", - "name": "DOCUMENT_POSITION_PRECEDING", - "value": "2", - "description": "Set when other is preceding node." - }, + "name": "loading", + "value": "boolean", + "description": "Whether to replace the button content with a loading indicator.", + "isOptional": true, + "defaultValue": "false" + } + ], + "value": "export interface Docs_Page_Button_SecondaryAction\n extends Pick<\n ButtonProps,\n | 'click'\n | 'loading'\n | 'disabled'\n | 'accessibilityLabel'\n | 'href'\n | 'command'\n | 'commandFor'\n > {\n /**\n * A label that describes the button's purpose to assistive technologies. Use this when the button text alone doesn't provide enough context.\n */\n accessibilityLabel?: ButtonProps['accessibilityLabel'];\n /**\n * A callback that fires when the button is activated, before the action indicated by `type`.\n */\n click?: ButtonProps['click'];\n /**\n * The action the `commandFor` target should take when this button is activated.\n *\n * - `--auto`: A default action for the target component.\n * - `--show`: Shows the target component.\n * - `--hide`: Hides the target component.\n * - `--toggle`: Toggles the target component.\n * - `--copy`: Copies the target ClipboardItem.\n *\n * @default '--auto'\n */\n command?: ButtonProps['command'];\n /**\n * 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).\n */\n commandFor?: ButtonProps['commandFor'];\n /**\n * Whether the button is disabled and non-interactive.\n *\n * @default false\n */\n disabled?: ButtonProps['disabled'];\n /**\n * The URL to navigate to when the button is activated. If a `commandFor` is set, the `command` is executed instead of the navigation.\n */\n href?: ButtonProps['href'];\n /**\n * Whether to replace the button content with a loading indicator.\n *\n * @default false\n */\n loading?: ButtonProps['loading'];\n}" + }, + { + "filePath": "src/surfaces/customer-account/api/docs.ts", + "name": "Docs_Page_Button_BreadcrumbAction", + "description": "", + "isPublicDocs": true, + "members": [ { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/docs.ts", "syntaxKind": "PropertySignature", - "name": "DOCUMENT_TYPE_NODE", - "value": "10", - "description": "node is a doctype." + "name": "accessibilityLabel", + "value": "string", + "description": "A label that describes the breadcrumb's destination to assistive technologies. Required because `children` passed to this button are discarded." }, { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/docs.ts", "syntaxKind": "PropertySignature", - "name": "draggable", - "value": "boolean", - "description": "The **`draggable`** property of the HTMLElement interface gets and sets a Boolean primitive indicating if the element is draggable.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/draggable)" + "name": "click", + "value": "(event: EventListener & ((event: CallbackEvent<\"s-button\", Event>) => void)) => void", + "description": "A callback that fires when the breadcrumb is activated.", + "isOptional": true }, { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/docs.ts", "syntaxKind": "PropertySignature", - "name": "ELEMENT_NODE", - "value": "1", - "description": "node is an element." - }, + "name": "href", + "value": "string", + "description": "The URL to navigate to when the breadcrumb is activated.", + "isOptional": true + } + ], + "value": "export interface Docs_Page_Button_BreadcrumbAction\n extends Pick {\n /**\n * A label that describes the breadcrumb's destination to assistive technologies. Required because `children` passed to this button are discarded.\n */\n accessibilityLabel: ButtonProps['accessibilityLabel'];\n /**\n * A callback that fires when the breadcrumb is activated.\n */\n click?: ButtonProps['click'];\n /**\n * The URL to navigate to when the breadcrumb is activated.\n */\n href?: ButtonProps['href'];\n}" + }, + { + "filePath": "src/surfaces/customer-account/api/docs.ts", + "name": "Docs_Menu_Button_Action", + "description": "The menu component exclusively accepts button elements with restricted props as its children. The `tone` prop will always be set to monochrome by default.", + "isPublicDocs": true, + "members": [ { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/docs.ts", "syntaxKind": "PropertySignature", - "name": "enterKeyHint", + "name": "accessibilityLabel", "value": "string", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/enterKeyHint)" + "description": "A label that describes the purpose or contents of the Button. It will be read to users using assistive technologies such as screen readers.\n\nUse this when using only an icon or the button text is not enough context for users using assistive technologies.", + "isOptional": true }, { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/docs.ts", "syntaxKind": "PropertySignature", - "name": "ENTITY_NODE", - "value": "6", - "description": "" + "name": "click", + "value": "((event: CallbackEventListener) => void) | null", + "description": "Callback when the button is activated. This will be called before the action indicated by `type`.", + "isOptional": true }, { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/docs.ts", "syntaxKind": "PropertySignature", - "name": "ENTITY_REFERENCE_NODE", - "value": "5", - "description": "" + "name": "command", + "value": "'--auto' | '--show' | '--hide' | '--toggle' | '--copy'", + "description": "Sets the action the `commandFor` target should take when this component is activated.\n\n- `--auto`: A default action for the target component.\n- `--show`: Shows the target component.\n- `--hide`: Hides the target component.\n- `--toggle`: Toggles the target component.\n- `--copy`: Copies the target clipboard item.\n\nLearn more about the [`command` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).", + "isOptional": true, + "defaultValue": "'--auto'" }, { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/docs.ts", "syntaxKind": "PropertySignature", - "name": "firstChild", - "value": "ChildNode | null", - "description": "The read-only **`firstChild`** property of the Node interface returns the node's first child in the tree, or `null` if the node has no children.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/firstChild)" + "name": "commandFor", + "value": "string", + "description": "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).", + "isOptional": true }, { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/docs.ts", "syntaxKind": "PropertySignature", - "name": "firstElementChild", - "value": "Element | null", - "description": "Returns the first child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/firstElementChild)" + "name": "disabled", + "value": "boolean", + "description": "Disables the button, disallowing any interaction.", + "isOptional": true, + "defaultValue": "false" }, { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "focus", - "value": "(options?: FocusOptions) => void", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/focus)" + "filePath": "src/surfaces/customer-account/api/docs.ts", + "syntaxKind": "PropertySignature", + "name": "href", + "value": "string", + "description": "The URL to link to.\n\n- If set, it will navigate to the location specified by `href` after executing the `onClick` callback.\n- If a `commandFor` is set, the `command` will be executed instead of the navigation.", + "isOptional": true }, { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "getAnimations", - "value": "(options?: GetAnimationsOptions) => Animation[]", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAnimations)" + "filePath": "src/surfaces/customer-account/api/docs.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element.", + "isOptional": true }, { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "getAttribute", - "value": "(qualifiedName: string) => string", - "description": "The **`getAttribute()`** method of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttribute)" + "filePath": "src/surfaces/customer-account/api/docs.ts", + "syntaxKind": "PropertySignature", + "name": "loading", + "value": "boolean", + "description": "Replaces content with a loading indicator.", + "isOptional": true, + "defaultValue": "false" }, { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "getAttributeNames", - "value": "() => string[]", - "description": "The **`getAttributeNames()`** method of the array.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNames)" + "filePath": "src/surfaces/customer-account/api/docs.ts", + "syntaxKind": "PropertySignature", + "name": "target", + "value": "'auto' | '_self' | '_blank'", + "description": "Specifies where to display the linked URL.", + "isOptional": true, + "defaultValue": "'auto'" }, { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "getAttributeNode", - "value": "(qualifiedName: string) => Attr", - "description": "Returns the specified attribute of the specified element, as an Attr node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNode)" + "filePath": "src/surfaces/customer-account/api/docs.ts", + "syntaxKind": "PropertySignature", + "name": "tone", + "value": "'auto' | 'neutral' | 'critical'", + "description": "Sets the tone of the Button, based on the intention of the information being conveyed.", + "isOptional": true, + "defaultValue": "'auto'" }, { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "getAttributeNodeNS", - "value": "(namespace: string, localName: string) => Attr", - "description": "The **`getAttributeNodeNS()`** method of the Element interface returns the namespaced Attr node of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNodeNS)" - }, + "filePath": "src/surfaces/customer-account/api/docs.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "'button' | 'submit'", + "description": "The behavior of the button.\n\n- `'submit'`: Submits the nearest containing form.\n- `'button'`: Performs no default action, relying on the `click` event handler for behavior.\n\nThis property is ignored if the component supports `href` or `commandFor`/`command` and one of them is set.", + "isOptional": true, + "defaultValue": "'button'" + } + ], + "value": "export interface Docs_Menu_Button_Action\n extends Omit<\n ButtonProps,\n 'variant' | 'textDecoration' | 'inlineAlignment' | 'inlineSize' | 'size'\n > {}" + }, + { + "filePath": "src/surfaces/customer-account/api/docs.ts", + "name": "Docs_OrderActionMenu_Button", + "description": "", + "isPublicDocs": true, + "members": [ { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "getAttributeNS", - "value": "(namespace: string, localName: string) => string", - "description": "The **`getAttributeNS()`** method of the Element interface returns the string value of the attribute with the specified namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNS)" + "filePath": "src/surfaces/customer-account/api/docs.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "A label that describes the purpose or contents of the Button. It will be read to users using assistive technologies such as screen readers.\n\nUse this when using only an icon or the button text is not enough context for users using assistive technologies.", + "isOptional": true }, { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "getBoundingClientRect", - "value": "() => DOMRect", - "description": "The **`Element.getBoundingClientRect()`** method returns a position relative to the viewport.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getBoundingClientRect)" + "filePath": "src/surfaces/customer-account/api/docs.ts", + "syntaxKind": "PropertySignature", + "name": "click", + "value": "((event: CallbackEventListener) => void) | null", + "description": "Callback when the button is activated. This will be called before the action indicated by `type`.", + "isOptional": true }, { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "getClientRects", - "value": "() => DOMRectList", - "description": "The **`getClientRects()`** method of the Element interface returns a collection of DOMRect objects that indicate the bounding rectangles for each CSS border box in a client.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getClientRects)" + "filePath": "src/surfaces/customer-account/api/docs.ts", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Disables the button, disallowing any interaction.", + "isOptional": true, + "defaultValue": "false" }, { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "getElementsByClassName", - "value": "(classNames: string) => HTMLCollectionOf", - "description": "The Element method **`getElementsByClassName()`** returns a live specified class name or names.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByClassName)" + "filePath": "src/surfaces/customer-account/api/docs.ts", + "syntaxKind": "PropertySignature", + "name": "href", + "value": "string", + "description": "Destination URL to link to.\n\nE.g. `extension:/` to navigate to the Full-page extension." }, { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "getElementsByTagName", - "value": "{ (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: string): HTMLCollectionOf; }", - "description": "The **`Element.getElementsByTagName()`** method returns a live All descendants of the specified element are searched, but not the element itself.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagName)", - "deprecationMessage": "Deprecated" + "filePath": "src/surfaces/customer-account/api/docs.ts", + "syntaxKind": "PropertySignature", + "name": "loading", + "value": "boolean", + "description": "Replaces content with a loading indicator.", + "isOptional": true, + "defaultValue": "false" }, { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "getElementsByTagNameNS", - "value": "{ (namespaceURI: \"http://www.w3.org/1999/xhtml\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/2000/svg\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/1998/Math/MathML\", localName: string): HTMLCollectionOf; (namespace: string, localName: string): HTMLCollectionOf; }", - "description": "The **`Element.getElementsByTagNameNS()`** method returns a live HTMLCollection of elements with the given tag name belonging to the given namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagNameNS)" + "filePath": "src/surfaces/customer-account/api/docs.ts", + "syntaxKind": "PropertySignature", + "name": "tone", + "value": "'auto' | 'neutral' | 'critical'", + "description": "Sets the tone of the Button, based on the intention of the information being conveyed.", + "isOptional": true, + "defaultValue": "'auto'" + } + ], + "value": "export interface Docs_OrderActionMenu_Button\n extends Pick<\n ButtonProps,\n 'click' | 'loading' | 'disabled' | 'accessibilityLabel' | 'href' | 'tone'\n > {\n /**\n * Destination URL to link to.\n *\n * E.g. `extension:/` to navigate to the Full-page extension.\n */\n href: ButtonProps['href'];\n}" + }, + { + "filePath": "src/surfaces/customer-account/api/docs.ts", + "name": "Docs_CustomerAccountAction_SlotButton", + "description": "Supported props for Buttons used inside CustomerAccountAction slots.

`children` only support text.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/customer-account/api/docs.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "A label that describes the purpose or contents of the Button. It will be read to users using assistive technologies such as screen readers.\n\nUse this when using only an icon or the button text is not enough context for users using assistive technologies.", + "isOptional": true }, { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "getHTML", - "value": "(options?: GetHTMLOptions) => string", - "description": "The **`getHTML()`** method of the Element interface is used to serialize an element's DOM to an HTML string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getHTML)" + "filePath": "src/surfaces/customer-account/api/docs.ts", + "syntaxKind": "PropertySignature", + "name": "click", + "value": "((event: CallbackEventListener) => void) | null", + "description": "Callback when the button is activated. This will be called before the action indicated by `type`.", + "isOptional": true }, { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "getRootNode", - "value": "(options?: GetRootNodeOptions) => Node", - "description": "The **`getRootNode()`** method of the Node interface returns the context object's root, which optionally includes the shadow root if it is available.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/getRootNode)" + "filePath": "src/surfaces/customer-account/api/docs.ts", + "syntaxKind": "PropertySignature", + "name": "command", + "value": "'--auto' | '--show' | '--hide' | '--toggle' | '--copy'", + "description": "Sets the action the `commandFor` target should take when this component is activated.\n\n- `--auto`: A default action for the target component.\n- `--show`: Shows the target component.\n- `--hide`: Hides the target component.\n- `--toggle`: Toggles the target component.\n- `--copy`: Copies the target clipboard item.\n\nLearn more about the [`command` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).", + "isOptional": true, + "defaultValue": "'--auto'" }, { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "hasAttribute", - "value": "(qualifiedName: string) => boolean", - "description": "The **`Element.hasAttribute()`** method returns a **Boolean** value indicating whether the specified element has the specified attribute or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttribute)" + "filePath": "src/surfaces/customer-account/api/docs.ts", + "syntaxKind": "PropertySignature", + "name": "commandFor", + "value": "string", + "description": "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).", + "isOptional": true }, { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "hasAttributeNS", - "value": "(namespace: string, localName: string) => boolean", - "description": "The **`hasAttributeNS()`** method of the Element interface returns a boolean value indicating whether the current element has the specified attribute with the specified namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributeNS)" + "filePath": "src/surfaces/customer-account/api/docs.ts", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Disables the button, disallowing any interaction.", + "isOptional": true, + "defaultValue": "false" }, { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "hasAttributes", - "value": "() => boolean", - "description": "The **`hasAttributes()`** method of the Element interface returns a boolean value indicating whether the current element has any attributes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributes)" + "filePath": "src/surfaces/customer-account/api/docs.ts", + "syntaxKind": "PropertySignature", + "name": "href", + "value": "string", + "description": "The URL to link to.\n\n- If set, it will navigate to the location specified by `href` after executing the `onClick` callback.\n- If a `commandFor` is set, the `command` will be executed instead of the navigation.", + "isOptional": true }, + { + "filePath": "src/surfaces/customer-account/api/docs.ts", + "syntaxKind": "PropertySignature", + "name": "loading", + "value": "boolean", + "description": "Replaces content with a loading indicator.", + "isOptional": true, + "defaultValue": "false" + } + ], + "value": "export interface Docs_CustomerAccountAction_SlotButton\n extends Pick<\n ButtonProps,\n | 'click'\n | 'loading'\n | 'disabled'\n | 'accessibilityLabel'\n | 'href'\n | 'command'\n | 'commandFor'\n > {}" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "name": "ButtonElementProps", + "description": "", + "isPublicDocs": true, + "members": [ { "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "hasChildNodes", - "value": "() => boolean", - "description": "The **`hasChildNodes()`** method of the Node interface returns a boolean value indicating whether the given Node has child nodes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/hasChildNodes)" + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "A label that describes the purpose or content of the button for users of assistive technologies such as screen readers. Use this when the visible content alone doesn't provide enough context.", + "isOptional": true }, { "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "hasPointerCapture", - "value": "(pointerId: number) => boolean", - "description": "The **`hasPointerCapture()`** method of the pointer capture for the pointer identified by the given pointer ID.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasPointerCapture)" + "syntaxKind": "PropertySignature", + "name": "command", + "value": "'--auto' | '--show' | '--hide' | '--toggle' | '--copy'", + "description": "Sets the action the `commandFor` target should take when this component is activated.\n\n- `--auto`: Performs the default action for the target component.\n- `--show`: Displays the target component.\n- `--hide`: Conceals the target component.\n- `--toggle`: Alternates the target component.\n- `--copy`: Copies the target ClipboardItem.\n\nLearn more about the [`command` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).", + "isOptional": true, + "defaultValue": "'--auto'" }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "hidden", - "value": "boolean", - "description": "The HTMLElement property **`hidden`** reflects the value of the element's `hidden` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidden)" + "name": "commandFor", + "value": "string", + "description": "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).\n\nWhen both `commandFor` and `href` are set, `commandFor` takes precedence. The command runs and the link doesn't navigate.", + "isOptional": true }, { "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "hidePopover", - "value": "() => void", - "description": "The **`hidePopover()`** method of the HTMLElement interface hides a popover element (i.e., one that has a valid `popover` attribute) by removing it from the top layer and styling it with `display: none`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidePopover)" + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Whether the button is disabled, preventing it from being clicked or receiving focus.", + "isOptional": true, + "defaultValue": "false" }, { "filePath": "src/surfaces/checkout/components/Button.ts", @@ -24932,16 +25691,9 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "inert", - "value": "boolean", - "description": "The HTMLElement property **`inert`** reflects the value of the element's `inert` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inert)" - }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", @@ -24954,2022 +25706,2966 @@ { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "innerHTML", + "name": "interestFor", "value": "string", - "description": "The **`innerHTML`** property of the Element interface gets or sets the HTML or XML markup contained within the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/innerHTML)" + "description": "The ID of the component to show when users hover over or focus on this component. Pair with a target component that supports interest-based interactions. Learn more about the [interestFor attribute](https://open-ui.org/components/interest-invokers.explainer/#the-pitch-in-code).", + "isOptional": true }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "innerText", - "value": "string", - "description": "The **`innerText`** property of the HTMLElement interface represents the rendered text content of a node and its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/innerText)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "inputMode", - "value": "string", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inputMode)" + "name": "loading", + "value": "boolean", + "description": "Whether the button is in a loading state, which replaces the button content with a loading indicator while a background action is being performed.\n\nThis also disables the button.", + "isOptional": true, + "defaultValue": "false" }, { "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "insertAdjacentElement", - "value": "(where: InsertPosition, element: Element) => Element", - "description": "The **`insertAdjacentElement()`** method of the relative to the element it is invoked upon.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentElement)" + "syntaxKind": "PropertySignature", + "name": "target", + "value": "'auto' | '_blank'", + "description": "Specifies where to display the linked URL.", + "isOptional": true, + "defaultValue": "'auto'" }, { "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "insertAdjacentHTML", - "value": "(position: InsertPosition, string: string) => void", - "description": "The **`insertAdjacentHTML()`** method of the the resulting nodes into the DOM tree at a specified position.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentHTML)" + "syntaxKind": "PropertySignature", + "name": "tone", + "value": "'auto' | 'neutral' | 'critical'", + "description": "The semantic meaning and color treatment of the button.\n\n- `'auto'`: Automatically determined based on context.\n- `'neutral'`: General information without specific intent.\n- `'critical'`: Urgent problems or destructive actions.", + "isOptional": true, + "defaultValue": "'auto'" }, { "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "insertAdjacentText", - "value": "(where: InsertPosition, data: string) => void", - "description": "The **`insertAdjacentText()`** method of the Element interface, given a relative position and a string, inserts a new text node at the given position relative to the element it is called from.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentText)" + "syntaxKind": "PropertySignature", + "name": "type", + "value": "'submit' | 'button'", + "description": "The behavioral type of the button component, which determines what action it performs when activated.\n\n- `submit`: Submits the nearest containing form.\n- `button`: Performs no default action, relying on the `click` event handler for behavior.\n\nThis property is ignored if `href` or `commandFor`/`command` is set.", + "isOptional": true, + "defaultValue": "'button'" }, { "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "insertBefore", - "value": "(node: T, child: Node) => T", - "description": "The **`insertBefore()`** method of the Node interface inserts a node before a _reference node_ as a child of a specified _parent node_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/insertBefore)" - }, + "syntaxKind": "PropertySignature", + "name": "variant", + "value": "'auto' | 'primary' | 'secondary'", + "description": "The visual style variant of the button component, which controls its prominence and emphasis.\n\n- `'auto'`: Automatically determined by the button's context.\n- `'primary'`: High-emphasis style for the main action.\n- `'secondary'`: Medium-emphasis style for supporting actions.\n- `'tertiary'`: Low-emphasis style for less prominent actions.", + "isOptional": true, + "defaultValue": "'auto'" + } + ], + "value": "export interface ButtonElementProps extends Pick {\n target?: Extract;\n tone?: Extract;\n /**\n * The behavioral type of the button component, which determines what action it performs when activated.\n *\n * - `submit`: Submits the nearest containing form.\n * - `button`: Performs no default action, relying on the `click` event handler for behavior.\n *\n * This property is ignored if `href` or `commandFor`/`command` is set.\n *\n * @default 'button'\n */\n type?: Extract;\n variant?: Extract;\n}" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "name": "ButtonEvents", + "description": "", + "isPublicDocs": true, + "members": [ { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "interestFor", + "name": "onClick", + "value": "(event: Event) => void", + "description": "A callback fired when the button is activated, before performing the action indicated by `type`. Learn more about the [click event](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event).", + "isOptional": true + } + ], + "value": "export interface ButtonEvents extends Pick {\n}" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "name": "ButtonElementEvents", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "click", + "value": "CallbackEventListener", + "description": "A callback fired when the button is clicked. This will be called before the action indicated by `type`.\n\nLearn more about the [click event](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event).", + "isOptional": true + } + ], + "value": "export interface ButtonElementEvents {\n /**\n * A callback fired when the button is clicked. This will be called before the action indicated by `type`.\n *\n * Learn more about the [click event](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event).\n */\n click?: CallbackEventListener;\n}" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "name": "ButtonElement", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", "value": "string", - "description": "The ID of the component to show when users hover over or focus on this component. Pair with a target component that supports interest-based interactions. Learn more about the [interestFor attribute](https://open-ui.org/components/interest-invokers.explainer/#the-pitch-in-code).", + "description": "A label that describes the purpose or content of the button for users of assistive technologies such as screen readers. Use this when the visible content alone doesn't provide enough context.", "isOptional": true }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "isConnected", - "value": "boolean", - "description": "The read-only **`isConnected`** property of the Node interface returns a boolean indicating whether the node is connected (directly or indirectly) to a Document object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isConnected)" + "name": "accessKey", + "value": "string", + "description": "The **`HTMLElement.accessKey`** property sets the keystroke which a user can press to jump to a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKey)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "isContentEditable", - "value": "boolean", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/isContentEditable)" + "name": "accessKeyLabel", + "value": "string", + "description": "The **`HTMLElement.accessKeyLabel`** read-only property returns a string containing the element's browser-assigned access key (if any); otherwise it returns an empty string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKeyLabel)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "MethodSignature", - "name": "isDefaultNamespace", - "value": "(namespace: string) => boolean", - "description": "The **`isDefaultNamespace()`** method of the Node interface accepts a namespace URI as an argument.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isDefaultNamespace)" + "name": "addEventListener", + "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "MethodSignature", - "name": "isEqualNode", - "value": "(otherNode: Node) => boolean", - "description": "The **`isEqualNode()`** method of the Node interface tests whether two nodes are equal.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isEqualNode)" + "name": "after", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes just after node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/after)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "MethodSignature", - "name": "isSameNode", - "value": "(otherNode: Node) => boolean", - "description": "The **`isSameNode()`** method of the Node interface is a legacy alias the for the `===` strict equality operator.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isSameNode)" + "name": "animate", + "value": "(keyframes: Keyframe[] | PropertyIndexedKeyframes, options?: number | KeyframeAnimationOptions) => Animation", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animate)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "lang", - "value": "string", - "description": "The **`lang`** property of the HTMLElement interface indicates the base language of an element's attribute values and text content, in the form of a MISSING: RFC(5646, 'BCP 47 language identifier tag')].\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/lang)" + "syntaxKind": "MethodSignature", + "name": "append", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes after the last child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/append)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "lastChild", - "value": "ChildNode | null", - "description": "The read-only **`lastChild`** property of the Node interface returns the last child of the node, or `null` if there are no child nodes.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lastChild)" + "syntaxKind": "MethodSignature", + "name": "appendChild", + "value": "(node: T) => T", + "description": "The **`appendChild()`** method of the Node interface adds a node to the end of the list of children of a specified parent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/appendChild)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "lastElementChild", + "name": "ariaActiveDescendantElement", "value": "Element | null", - "description": "Returns the last child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/lastElementChild)" + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaActiveDescendantElement)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "loading", - "value": "boolean", - "description": "Whether the button is in a loading state, which replaces the button content with a loading indicator while a background action is being performed.\n\nThis also disables the button.", - "isOptional": true, - "defaultValue": "false" + "name": "ariaAtomic", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAtomic)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "localName", - "value": "string", - "description": "The **`Element.localName`** read-only property returns the local part of the qualified name of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/localName)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "lookupNamespaceURI", - "value": "(prefix: string) => string", - "description": "The **`lookupNamespaceURI()`** method of the Node interface takes a prefix as parameter and returns the namespace URI associated with it on the given node if found (and `null` if not).\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupNamespaceURI)" + "name": "ariaAutoComplete", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAutoComplete)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "lookupPrefix", - "value": "(namespace: string) => string", - "description": "The **`lookupPrefix()`** method of the Node interface returns a string containing the prefix for a given namespace URI, if present, and `null` if not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupPrefix)" + "syntaxKind": "PropertySignature", + "name": "ariaBrailleLabel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleLabel)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "matches", - "value": "(selectors: string) => boolean", - "description": "The **`matches()`** method of the Element interface tests whether the element would be selected by the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" + "syntaxKind": "PropertySignature", + "name": "ariaBrailleRoleDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleRoleDescription)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "namespaceURI", + "name": "ariaBusy", "value": "string | null", - "description": "The **`Element.namespaceURI`** read-only property returns the namespace URI of the element, or `null` if the element is not in a namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/namespaceURI)" + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBusy)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "nextElementSibling", - "value": "Element | null", - "description": "Returns the first following sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/nextElementSibling)" + "name": "ariaChecked", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaChecked)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "nextSibling", - "value": "ChildNode | null", - "description": "The read-only **`nextSibling`** property of the Node interface returns the node immediately following the specified one in their parent's Node.childNodes, or returns `null` if the specified node is the last child in the parent element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nextSibling)" + "name": "ariaColCount", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColCount)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "nodeName", - "value": "string", - "description": "The read-only **`nodeName`** property of Node returns the name of the current node as a string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeName)" + "name": "ariaColIndex", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndex)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "nodeType", - "value": "number", - "description": "The read-only **`nodeType`** property of a Node interface is an integer that identifies what the node is.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeType)" + "name": "ariaColIndexText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndexText)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "nodeValue", + "name": "ariaColSpan", "value": "string | null", - "description": "The **`nodeValue`** property of the Node interface returns or sets the value of the current node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeValue)" + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColSpan)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "nonce", - "value": "string", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/nonce)", - "isOptional": true + "name": "ariaControlsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaControlsElements)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "normalize", - "value": "() => void", - "description": "The **`normalize()`** method of the Node interface puts the specified node and all of its sub-tree into a _normalized_ form.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/normalize)" + "syntaxKind": "PropertySignature", + "name": "ariaCurrent", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaCurrent)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "NOTATION_NODE", - "value": "12", - "description": "" + "name": "ariaDescribedByElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescribedByElements)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "offsetHeight", - "value": "number", - "description": "The **`offsetHeight`** read-only property of the HTMLElement interface returns the height of an element, including vertical padding and borders, as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetHeight)" + "name": "ariaDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescription)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "offsetLeft", - "value": "number", - "description": "The **`offsetLeft`** read-only property of the HTMLElement interface returns the number of pixels that the _upper left corner_ of the current element is offset to the left within the HTMLElement.offsetParent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetLeft)" + "name": "ariaDetailsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDetailsElements)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "offsetParent", - "value": "Element | null", - "description": "The **`HTMLElement.offsetParent`** read-only property returns a reference to the element which is the closest (nearest in the containment hierarchy) positioned ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetParent)" + "name": "ariaDisabled", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDisabled)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "offsetTop", - "value": "number", - "description": "The **`offsetTop`** read-only property of the HTMLElement interface returns the distance from the outer border of the current element (including its margin) to the top padding edge of the HTMLelement.offsetParent, the _closest positioned_ ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetTop)" + "name": "ariaErrorMessageElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaErrorMessageElements)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "offsetWidth", - "value": "number", - "description": "The **`offsetWidth`** read-only property of the HTMLElement interface returns the layout width of an element as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetWidth)" + "name": "ariaExpanded", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaExpanded)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "onabort", - "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/abort_event)" + "name": "ariaFlowToElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaFlowToElements)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "onanimationcancel", - "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationcancel_event)" + "name": "ariaHasPopup", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHasPopup)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "onanimationend", - "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" + "name": "ariaHidden", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHidden)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "onanimationiteration", - "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" + "name": "ariaInvalid", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaInvalid)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "onanimationstart", - "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" + "name": "ariaKeyShortcuts", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaKeyShortcuts)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "onauxclick", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/auxclick_event)" + "name": "ariaLabel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabel)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "onbeforeinput", - "value": "((this: GlobalEventHandlers, ev: InputEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforeinput_event)" + "name": "ariaLabelledByElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabelledByElements)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "onbeforematch", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforematch_event)" + "name": "ariaLevel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLevel)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "onbeforetoggle", - "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/beforetoggle_event)" + "name": "ariaLive", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLive)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "onblur", - "value": "((this: GlobalEventHandlers, ev: FocusEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/blur_event)" + "name": "ariaModal", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaModal)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "oncancel", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/cancel_event)" + "name": "ariaMultiLine", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiLine)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "oncanplay", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplay_event)" + "name": "ariaMultiSelectable", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiSelectable)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "oncanplaythrough", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplaythrough_event)" + "name": "ariaOrientation", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOrientation)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "onchange", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/change_event)" + "name": "ariaOwnsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOwnsElements)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "onclick", - "value": "(event: Event) => void", - "description": "" + "name": "ariaPlaceholder", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPlaceholder)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "onclose", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/close_event)" + "name": "ariaPosInSet", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPosInSet)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "oncontextlost", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextlost_event)" + "name": "ariaPressed", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPressed)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "oncontextmenu", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/contextmenu_event)" + "name": "ariaReadOnly", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaReadOnly)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "oncontextrestored", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextrestored_event)" + "name": "ariaRelevant", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRelevant)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "oncopy", - "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/copy_event)" + "name": "ariaRequired", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRequired)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "oncuechange", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLTrackElement/cuechange_event)" + "name": "ariaRoleDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRoleDescription)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "oncut", - "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/cut_event)" + "name": "ariaRowCount", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowCount)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "ondblclick", - "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/dblclick_event)" + "name": "ariaRowIndex", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndex)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "ondrag", - "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drag_event)" + "name": "ariaRowIndexText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndexText)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "ondragend", - "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragend_event)" + "name": "ariaRowSpan", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowSpan)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "ondragenter", - "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragenter_event)" + "name": "ariaSelected", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSelected)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "ondragleave", - "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragleave_event)" + "name": "ariaSetSize", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSetSize)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "ondragover", - "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragover_event)" + "name": "ariaSort", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSort)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "ondragstart", - "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragstart_event)" + "name": "ariaValueMax", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMax)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "ondrop", - "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drop_event)" + "name": "ariaValueMin", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMin)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "ondurationchange", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/durationchange_event)" + "name": "ariaValueNow", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueNow)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "onemptied", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/emptied_event)" + "name": "ariaValueText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueText)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "onended", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ended_event)" + "name": "assignedSlot", + "value": "HTMLSlotElement | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/assignedSlot)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "onerror", - "value": "OnErrorEventHandler", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/error_event)" + "syntaxKind": "MethodSignature", + "name": "attachInternals", + "value": "() => ElementInternals", + "description": "The **`HTMLElement.attachInternals()`** method returns an ElementInternals object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attachInternals)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "onfocus", - "value": "((this: GlobalEventHandlers, ev: FocusEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/focus_event)" + "syntaxKind": "MethodSignature", + "name": "attachShadow", + "value": "(init: ShadowRootInit) => ShadowRoot", + "description": "The **`Element.attachShadow()`** method attaches a shadow DOM tree to the specified element and returns a reference to its ShadowRoot.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attachShadow)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "onformdata", - "value": "((this: GlobalEventHandlers, ev: FormDataEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/formdata_event)" + "name": "ATTRIBUTE_NODE", + "value": "2", + "description": "" }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "onfullscreenchange", - "value": "((this: Element, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenchange_event)" + "name": "attributes", + "value": "NamedNodeMap", + "description": "The **`Element.attributes`** property returns a live collection of all attribute nodes registered to the specified node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attributes)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "onfullscreenerror", - "value": "((this: Element, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenerror_event)" + "name": "attributeStyleMap", + "value": "StylePropertyMap", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attributeStyleMap)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "ongotpointercapture", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/gotpointercapture_event)" + "name": "autocapitalize", + "value": "string", + "description": "The **`autocapitalize`** property of the HTMLElement interface represents the element's capitalization behavior for user input.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocapitalize)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "oninput", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/input_event)" + "name": "autocorrect", + "value": "boolean", + "description": "The **`autocorrect`** property of the HTMLElement interface controls whether or not autocorrection of editable text is enabled for spelling and/or punctuation errors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocorrect)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "oninvalid", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/invalid_event)" + "name": "autofocus", + "value": "boolean", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autofocus)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "onkeydown", - "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keydown_event)" + "name": "baseURI", + "value": "string", + "description": "The read-only **`baseURI`** property of the Node interface returns the absolute base URL of the document containing the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/baseURI)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "onkeypress", - "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", - "description": "", - "deprecationMessage": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keypress_event)" + "syntaxKind": "MethodSignature", + "name": "before", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes just before node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/before)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "onkeyup", - "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keyup_event)" + "syntaxKind": "MethodSignature", + "name": "blur", + "value": "() => void", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/blur)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "onload", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/load_event)" + "name": "CDATA_SECTION_NODE", + "value": "4", + "description": "node is a CDATASection node." }, { "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "onloadeddata", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadeddata_event)" + "syntaxKind": "MethodSignature", + "name": "checkVisibility", + "value": "(options?: CheckVisibilityOptions) => boolean", + "description": "The **`checkVisibility()`** method of the Element interface checks whether the element is visible.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/checkVisibility)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "onloadedmetadata", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadedmetadata_event)" + "name": "childElementCount", + "value": "number", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/childElementCount)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "onloadstart", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadstart_event)" + "name": "childNodes", + "value": "NodeListOf", + "description": "The read-only **`childNodes`** property of the Node interface returns a live the first child node is assigned index `0`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/childNodes)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "onlostpointercapture", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/lostpointercapture_event)" + "name": "children", + "value": "HTMLCollection", + "description": "Returns the child elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/children)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "onmousedown", - "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousedown_event)" + "syntaxKind": "GetAccessor", + "name": "classList", + "value": "DOMTokenList", + "description": "The **`Element.classList`** is a read-only property that returns a live DOMTokenList collection of the `class` attributes of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/classList)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "onmouseenter", - "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseenter_event)" + "name": "className", + "value": "string", + "description": "The **`className`** property of the of the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/className)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "onmouseleave", - "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseleave_event)" + "syntaxKind": "MethodSignature", + "name": "click", + "value": "() => void", + "description": "The **`HTMLElement.click()`** method simulates a mouse click on an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/click)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "onmousemove", - "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousemove_event)" + "name": "clientHeight", + "value": "number", + "description": "The **`clientHeight`** read-only property of the Element interface is zero for elements with no CSS or inline layout boxes; otherwise, it's the inner height of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientHeight)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "onmouseout", - "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseout_event)" + "name": "clientLeft", + "value": "number", + "description": "The **`clientLeft`** read-only property of the Element interface returns the width of the left border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientLeft)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "onmouseover", - "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseover_event)" + "name": "clientTop", + "value": "number", + "description": "The **`clientTop`** read-only property of the Element interface returns the width of the top border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientTop)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "onmouseup", - "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseup_event)" + "name": "clientWidth", + "value": "number", + "description": "The **`clientWidth`** read-only property of the Element interface is zero for inline elements and elements with no CSS; otherwise, it's the inner width of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientWidth)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "onpaste", - "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/paste_event)" + "syntaxKind": "MethodSignature", + "name": "cloneNode", + "value": "(subtree?: boolean) => Node", + "description": "The **`cloneNode()`** method of the Node interface returns a duplicate of the node on which this method was called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/cloneNode)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "onpause", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/pause_event)" + "syntaxKind": "MethodSignature", + "name": "closest", + "value": "{ (selector: K): HTMLElementTagNameMap[K]; (selector: K): SVGElementTagNameMap[K]; (selector: K): MathMLElementTagNameMap[K]; (selectors: string): E; }", + "description": "The **`closest()`** method of the Element interface traverses the element and its parents (heading toward the document root) until it finds a node that matches the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/closest)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "onplay", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/play_event)" + "name": "command", + "value": "'--auto' | '--show' | '--hide' | '--toggle' | '--copy'", + "description": "Sets the action the `commandFor` target should take when this component is activated.\n\n- `--auto`: Performs the default action for the target component.\n- `--show`: Displays the target component.\n- `--hide`: Conceals the target component.\n- `--toggle`: Alternates the target component.\n- `--copy`: Copies the target ClipboardItem.\n\nLearn more about the [`command` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).", + "isOptional": true, + "defaultValue": "'--auto'" }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "onplaying", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/playing_event)" + "name": "commandFor", + "value": "string", + "description": "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).\n\nWhen both `commandFor` and `href` are set, `commandFor` takes precedence. The command runs and the link doesn't navigate.", + "isOptional": true }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "onpointercancel", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointercancel_event)" + "name": "COMMENT_NODE", + "value": "8", + "description": "node is a Comment node." }, { "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "onpointerdown", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerdown_event)" + "syntaxKind": "MethodSignature", + "name": "compareDocumentPosition", + "value": "(other: Node) => number", + "description": "The **`compareDocumentPosition()`** method of the Node interface reports the position of its argument node relative to the node on which it is called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/compareDocumentPosition)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "onpointerenter", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerenter_event)" + "syntaxKind": "MethodSignature", + "name": "computedStyleMap", + "value": "() => StylePropertyMapReadOnly", + "description": "The **`computedStyleMap()`** method of the Element interface returns a StylePropertyMapReadOnly interface which provides a read-only representation of a CSS declaration block that is an alternative to CSSStyleDeclaration.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/computedStyleMap)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "onpointerleave", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerleave_event)" + "syntaxKind": "MethodSignature", + "name": "contains", + "value": "(other: Node) => boolean", + "description": "The **`contains()`** method of the Node interface returns a boolean value indicating whether a node is a descendant of a given node, that is the node itself, one of its direct children (Node.childNodes), one of the children's direct children, and so on.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/contains)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "onpointermove", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointermove_event)" + "name": "contentEditable", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/contentEditable)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "onpointerout", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerout_event)" + "name": "currentCSSZoom", + "value": "number", + "description": "The **`currentCSSZoom`** read-only property of the Element interface provides the 'effective' CSS `zoom` of an element, taking into account the zoom applied to the element and all its parent elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/currentCSSZoom)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "onpointerover", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerover_event)" + "name": "dataset", + "value": "DOMStringMap", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dataset)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "onpointerrawupdate", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "Available only in secure contexts.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerrawupdate_event)" + "name": "dir", + "value": "string", + "description": "The **`HTMLElement.dir`** property indicates the text writing directionality of the content of the current element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dir)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "onpointerup", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerup_event)" + "name": "disabled", + "value": "boolean", + "description": "Whether the button is disabled, preventing it from being clicked or receiving focus.", + "isOptional": true, + "defaultValue": "false" }, { "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "onprogress", - "value": "((this: GlobalEventHandlers, ev: ProgressEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/progress_event)" + "syntaxKind": "MethodSignature", + "name": "dispatchEvent", + "value": "(event: Event) => boolean", + "description": "The **`dispatchEvent()`** method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/dispatchEvent)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "onratechange", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ratechange_event)" + "name": "DOCUMENT_FRAGMENT_NODE", + "value": "11", + "description": "node is a DocumentFragment node." }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "onreset", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/reset_event)" + "name": "DOCUMENT_NODE", + "value": "9", + "description": "node is a document." }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "onresize", - "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLVideoElement/resize_event)" + "name": "DOCUMENT_POSITION_CONTAINED_BY", + "value": "16", + "description": "Set when other is a descendant of node." }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "onscroll", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scroll_event)" + "name": "DOCUMENT_POSITION_CONTAINS", + "value": "8", + "description": "Set when other is an ancestor of node." }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "onscrollend", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scrollend_event)" + "name": "DOCUMENT_POSITION_DISCONNECTED", + "value": "1", + "description": "Set when node and other are not in the same tree." }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "onsecuritypolicyviolation", - "value": "((this: GlobalEventHandlers, ev: SecurityPolicyViolationEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/securitypolicyviolation_event)" + "name": "DOCUMENT_POSITION_FOLLOWING", + "value": "4", + "description": "Set when other is following node." }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "onseeked", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeked_event)" + "name": "DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC", + "value": "32", + "description": "" }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "onseeking", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeking_event)" + "name": "DOCUMENT_POSITION_PRECEDING", + "value": "2", + "description": "Set when other is preceding node." }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "onselect", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/select_event)" + "name": "DOCUMENT_TYPE_NODE", + "value": "10", + "description": "node is a doctype." }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "onselectionchange", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/selectionchange_event)" + "name": "draggable", + "value": "boolean", + "description": "The **`draggable`** property of the HTMLElement interface gets and sets a Boolean primitive indicating if the element is draggable.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/draggable)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "onselectstart", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/selectstart_event)" + "name": "ELEMENT_NODE", + "value": "1", + "description": "node is an element." }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "onslotchange", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLSlotElement/slotchange_event)" + "name": "enterKeyHint", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/enterKeyHint)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "onstalled", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/stalled_event)" + "name": "ENTITY_NODE", + "value": "6", + "description": "" }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "onsubmit", - "value": "((this: GlobalEventHandlers, ev: SubmitEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/submit_event)" + "name": "ENTITY_REFERENCE_NODE", + "value": "5", + "description": "" }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "onsuspend", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/suspend_event)" + "name": "firstChild", + "value": "ChildNode | null", + "description": "The read-only **`firstChild`** property of the Node interface returns the node's first child in the tree, or `null` if the node has no children.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/firstChild)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "ontimeupdate", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/timeupdate_event)" + "name": "firstElementChild", + "value": "Element | null", + "description": "Returns the first child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/firstElementChild)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "ontoggle", - "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/toggle_event)" + "syntaxKind": "MethodSignature", + "name": "focus", + "value": "(options?: FocusOptions) => void", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/focus)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "ontouchcancel", - "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchcancel_event)", - "isOptional": true + "syntaxKind": "MethodSignature", + "name": "getAnimations", + "value": "(options?: GetAnimationsOptions) => Animation[]", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAnimations)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "ontouchend", - "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchend_event)", - "isOptional": true + "syntaxKind": "MethodSignature", + "name": "getAttribute", + "value": "(qualifiedName: string) => string", + "description": "The **`getAttribute()`** method of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttribute)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "ontouchmove", - "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchmove_event)", - "isOptional": true + "syntaxKind": "MethodSignature", + "name": "getAttributeNames", + "value": "() => string[]", + "description": "The **`getAttributeNames()`** method of the array.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNames)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "ontouchstart", - "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchstart_event)", - "isOptional": true + "syntaxKind": "MethodSignature", + "name": "getAttributeNode", + "value": "(qualifiedName: string) => Attr", + "description": "Returns the specified attribute of the specified element, as an Attr node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNode)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "ontransitioncancel", - "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitioncancel_event)" + "syntaxKind": "MethodSignature", + "name": "getAttributeNodeNS", + "value": "(namespace: string, localName: string) => Attr", + "description": "The **`getAttributeNodeNS()`** method of the Element interface returns the namespaced Attr node of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNodeNS)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "ontransitionend", - "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" + "syntaxKind": "MethodSignature", + "name": "getAttributeNS", + "value": "(namespace: string, localName: string) => string", + "description": "The **`getAttributeNS()`** method of the Element interface returns the string value of the attribute with the specified namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNS)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "ontransitionrun", - "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionrun_event)" + "syntaxKind": "MethodSignature", + "name": "getBoundingClientRect", + "value": "() => DOMRect", + "description": "The **`Element.getBoundingClientRect()`** method returns a position relative to the viewport.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getBoundingClientRect)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "ontransitionstart", - "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionstart_event)" + "syntaxKind": "MethodSignature", + "name": "getClientRects", + "value": "() => DOMRectList", + "description": "The **`getClientRects()`** method of the Element interface returns a collection of DOMRect objects that indicate the bounding rectangles for each CSS border box in a client.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getClientRects)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "onvolumechange", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/volumechange_event)" + "syntaxKind": "MethodSignature", + "name": "getElementsByClassName", + "value": "(classNames: string) => HTMLCollectionOf", + "description": "The Element method **`getElementsByClassName()`** returns a live specified class name or names.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByClassName)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "onwaiting", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/waiting_event)" + "syntaxKind": "MethodSignature", + "name": "getElementsByTagName", + "value": "{ (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: string): HTMLCollectionOf; }", + "description": "The **`Element.getElementsByTagName()`** method returns a live All descendants of the specified element are searched, but not the element itself.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagName)", + "deprecationMessage": "Deprecated" }, { "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "onwebkitanimationend", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "", - "deprecationMessage": "This is a legacy alias of `onanimationend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" + "syntaxKind": "MethodSignature", + "name": "getElementsByTagNameNS", + "value": "{ (namespaceURI: \"http://www.w3.org/1999/xhtml\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/2000/svg\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/1998/Math/MathML\", localName: string): HTMLCollectionOf; (namespace: string, localName: string): HTMLCollectionOf; }", + "description": "The **`Element.getElementsByTagNameNS()`** method returns a live HTMLCollection of elements with the given tag name belonging to the given namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagNameNS)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "onwebkitanimationiteration", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "", - "deprecationMessage": "This is a legacy alias of `onanimationiteration`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" + "syntaxKind": "MethodSignature", + "name": "getHTML", + "value": "(options?: GetHTMLOptions) => string", + "description": "The **`getHTML()`** method of the Element interface is used to serialize an element's DOM to an HTML string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getHTML)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "onwebkitanimationstart", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "", - "deprecationMessage": "This is a legacy alias of `onanimationstart`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" + "syntaxKind": "MethodSignature", + "name": "getRootNode", + "value": "(options?: GetRootNodeOptions) => Node", + "description": "The **`getRootNode()`** method of the Node interface returns the context object's root, which optionally includes the shadow root if it is available.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/getRootNode)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "onwebkittransitionend", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "", - "deprecationMessage": "This is a legacy alias of `ontransitionend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" + "syntaxKind": "MethodSignature", + "name": "hasAttribute", + "value": "(qualifiedName: string) => boolean", + "description": "The **`Element.hasAttribute()`** method returns a **Boolean** value indicating whether the specified element has the specified attribute or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttribute)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "onwheel", - "value": "((this: GlobalEventHandlers, ev: WheelEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/wheel_event)" + "syntaxKind": "MethodSignature", + "name": "hasAttributeNS", + "value": "(namespace: string, localName: string) => boolean", + "description": "The **`hasAttributeNS()`** method of the Element interface returns a boolean value indicating whether the current element has the specified attribute with the specified namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributeNS)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "outerHTML", - "value": "string", - "description": "The **`outerHTML`** attribute of the Element DOM interface gets the serialized HTML fragment describing the element including its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/outerHTML)" + "syntaxKind": "MethodSignature", + "name": "hasAttributes", + "value": "() => boolean", + "description": "The **`hasAttributes()`** method of the Element interface returns a boolean value indicating whether the current element has any attributes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributes)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "outerText", - "value": "string", - "description": "The **`outerText`** property of the HTMLElement interface returns the same value as HTMLElement.innerText.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/outerText)" + "syntaxKind": "MethodSignature", + "name": "hasChildNodes", + "value": "() => boolean", + "description": "The **`hasChildNodes()`** method of the Node interface returns a boolean value indicating whether the given Node has child nodes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/hasChildNodes)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "ownerDocument", - "value": "Document", - "description": "The read-only **`ownerDocument`** property of the Node interface returns the top-level document object of the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/ownerDocument)" + "syntaxKind": "MethodSignature", + "name": "hasPointerCapture", + "value": "(pointerId: number) => boolean", + "description": "The **`hasPointerCapture()`** method of the pointer capture for the pointer identified by the given pointer ID.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasPointerCapture)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "parentElement", - "value": "HTMLElement | null", - "description": "The read-only **`parentElement`** property of Node interface returns the DOM node's parent Element, or `null` if the node either has no parent, or its parent isn't a DOM Element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentElement)" + "name": "hidden", + "value": "boolean", + "description": "The HTMLElement property **`hidden`** reflects the value of the element's `hidden` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidden)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "parentNode", - "value": "ParentNode | null", - "description": "The read-only **`parentNode`** property of the Node interface returns the parent of the specified node in the DOM tree.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentNode)" + "syntaxKind": "MethodSignature", + "name": "hidePopover", + "value": "() => void", + "description": "The **`hidePopover()`** method of the HTMLElement interface hides a popover element (i.e., one that has a valid `popover` attribute) by removing it from the top layer and styling it with `display: none`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidePopover)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "GetAccessor", - "name": "part", - "value": "DOMTokenList", - "description": "The **`part`** property of the Element interface represents the part identifier(s) of the element (i.e., set using the `part` attribute), returned as a DOMTokenList.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/part)" + "syntaxKind": "PropertySignature", + "name": "href", + "value": "string", + "description": "The URL to navigate to when clicked. The `click` event fires first, then navigation occurs.\n\n- If set, it will navigate to the location specified by `href` after executing the `click` event.\n- If a `commandFor` is set, the `command` will be executed instead of the navigation.", + "isOptional": true }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "popover", - "value": "string | null", - "description": "The **`popover`** property of the HTMLElement interface gets and sets an element's popover state via JavaScript (`'auto'`, `'hint'`, or `'manual'`), and can be used for feature detection.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/popover)" + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "prefix", - "value": "string | null", - "description": "The **`Element.prefix`** read-only property returns the namespace prefix of the specified element, or `null` if no prefix is specified.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/prefix)" + "name": "inert", + "value": "boolean", + "description": "The HTMLElement property **`inert`** reflects the value of the element's `inert` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inert)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "prepend", - "value": "(...nodes: (string | Node)[]) => void", - "description": "Inserts nodes before the first child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/prepend)" + "syntaxKind": "PropertySignature", + "name": "inlineSize", + "value": "'auto' | 'fill' | 'fit-content'", + "description": "The inline width of the button component.\n\n- `auto`: The size depends on the surface and context.\n- `fill`: The button takes up 100% of the available inline size.\n- `fit-content`: The button takes up the minimum inline-size required to fit its content.", + "isOptional": true, + "defaultValue": "'auto'" }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "previousElementSibling", - "value": "Element | null", - "description": "Returns the first preceding sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/previousElementSibling)" + "name": "innerHTML", + "value": "string", + "description": "The **`innerHTML`** property of the Element interface gets or sets the HTML or XML markup contained within the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/innerHTML)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "previousSibling", - "value": "ChildNode | null", - "description": "The read-only **`previousSibling`** property of the Node interface returns the node immediately preceding the specified one in its parent's or `null` if the specified node is the first in that list.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/previousSibling)" + "name": "innerText", + "value": "string", + "description": "The **`innerText`** property of the HTMLElement interface represents the rendered text content of a node and its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/innerText)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "PROCESSING_INSTRUCTION_NODE", - "value": "7", - "description": "node is a ProcessingInstruction node." + "name": "inputMode", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inputMode)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "MethodSignature", - "name": "querySelector", - "value": "{ (selectors: K): HTMLElementTagNameMap[K]; (selectors: K): SVGElementTagNameMap[K]; (selectors: K): MathMLElementTagNameMap[K]; (selectors: K): HTMLElementDeprecatedTagNameMap[K]; (selectors: string): E; }", - "description": "Returns the first element that is a descendant of node that matches selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelector)", - "deprecationMessage": "Deprecated" + "name": "insertAdjacentElement", + "value": "(where: InsertPosition, element: Element) => Element", + "description": "The **`insertAdjacentElement()`** method of the relative to the element it is invoked upon.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentElement)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "MethodSignature", - "name": "querySelectorAll", - "value": "{ (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: string): NodeListOf; }", - "description": "Returns all element descendants of node that match selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelectorAll)", - "deprecationMessage": "Deprecated" + "name": "insertAdjacentHTML", + "value": "(position: InsertPosition, string: string) => void", + "description": "The **`insertAdjacentHTML()`** method of the the resulting nodes into the DOM tree at a specified position.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentHTML)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "MethodSignature", - "name": "releasePointerCapture", - "value": "(pointerId: number) => void", - "description": "The **`releasePointerCapture()`** method of the previously set for a specific (PointerEvent) _pointer_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/releasePointerCapture)" + "name": "insertAdjacentText", + "value": "(where: InsertPosition, data: string) => void", + "description": "The **`insertAdjacentText()`** method of the Element interface, given a relative position and a string, inserts a new text node at the given position relative to the element it is called from.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentText)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "MethodSignature", - "name": "remove", - "value": "() => void", - "description": "Removes node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/remove)" + "name": "insertBefore", + "value": "(node: T, child: Node) => T", + "description": "The **`insertBefore()`** method of the Node interface inserts a node before a _reference node_ as a child of a specified _parent node_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/insertBefore)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "removeAttribute", - "value": "(qualifiedName: string) => void", - "description": "The Element method **`removeAttribute()`** removes the attribute with the specified name from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttribute)" + "syntaxKind": "PropertySignature", + "name": "interestFor", + "value": "string", + "description": "The ID of the component to show when users hover over or focus on this component. Pair with a target component that supports interest-based interactions. Learn more about the [interestFor attribute](https://open-ui.org/components/interest-invokers.explainer/#the-pitch-in-code).", + "isOptional": true }, { "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "removeAttributeNode", - "value": "(attr: Attr) => Attr", - "description": "The **`removeAttributeNode()`** method of the Element interface removes the specified Attr node from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNode)" + "syntaxKind": "PropertySignature", + "name": "isConnected", + "value": "boolean", + "description": "The read-only **`isConnected`** property of the Node interface returns a boolean indicating whether the node is connected (directly or indirectly) to a Document object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isConnected)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "removeAttributeNS", - "value": "(namespace: string, localName: string) => void", - "description": "The **`removeAttributeNS()`** method of the If you are working with HTML and you don't need to specify the requested attribute as being part of a specific namespace, use the Element.removeAttribute() method instead.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNS)" + "syntaxKind": "PropertySignature", + "name": "isContentEditable", + "value": "boolean", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/isContentEditable)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "MethodSignature", - "name": "removeChild", - "value": "(child: T) => T", - "description": "The **`removeChild()`** method of the Node interface removes a child node from the DOM and returns the removed node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/removeChild)" + "name": "isDefaultNamespace", + "value": "(namespace: string) => boolean", + "description": "The **`isDefaultNamespace()`** method of the Node interface accepts a namespace URI as an argument.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isDefaultNamespace)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "MethodSignature", - "name": "removeEventListener", - "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "name": "isEqualNode", + "value": "(otherNode: Node) => boolean", + "description": "The **`isEqualNode()`** method of the Node interface tests whether two nodes are equal.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isEqualNode)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "MethodSignature", - "name": "replaceChild", - "value": "(node: Node, child: T) => T", - "description": "The **`replaceChild()`** method of the Node interface replaces a child node within the given (parent) node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/replaceChild)" + "name": "isSameNode", + "value": "(otherNode: Node) => boolean", + "description": "The **`isSameNode()`** method of the Node interface is a legacy alias the for the `===` strict equality operator.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isSameNode)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "replaceChildren", - "value": "(...nodes: (string | Node)[]) => void", - "description": "Replace all children of node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/replaceChildren)" + "syntaxKind": "PropertySignature", + "name": "lang", + "value": "string", + "description": "The **`lang`** property of the HTMLElement interface indicates the base language of an element's attribute values and text content, in the form of a MISSING: RFC(5646, 'BCP 47 language identifier tag')].\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/lang)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "replaceWith", - "value": "(...nodes: (string | Node)[]) => void", - "description": "Replaces node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/replaceWith)" + "syntaxKind": "PropertySignature", + "name": "lastChild", + "value": "ChildNode | null", + "description": "The read-only **`lastChild`** property of the Node interface returns the last child of the node, or `null` if there are no child nodes.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lastChild)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "requestFullscreen", - "value": "(options?: FullscreenOptions) => Promise", - "description": "The **`Element.requestFullscreen()`** method issues an asynchronous request to make the element be displayed in fullscreen mode.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestFullscreen)" + "syntaxKind": "PropertySignature", + "name": "lastElementChild", + "value": "Element | null", + "description": "Returns the last child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/lastElementChild)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "requestPointerLock", - "value": "(options?: PointerLockOptions) => Promise", - "description": "The **`requestPointerLock()`** method of the Element interface lets you asynchronously ask for the pointer to be locked on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestPointerLock)" + "syntaxKind": "PropertySignature", + "name": "loading", + "value": "boolean", + "description": "Whether the button is in a loading state, which replaces the button content with a loading indicator while a background action is being performed.\n\nThis also disables the button.", + "isOptional": true, + "defaultValue": "false" }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "role", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/role)" + "name": "localName", + "value": "string", + "description": "The **`Element.localName`** read-only property returns the local part of the qualified name of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/localName)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "MethodSignature", - "name": "scroll", - "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", - "description": "The **`scroll()`** method of the Element interface scrolls the element to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scroll)" + "name": "lookupNamespaceURI", + "value": "(prefix: string) => string", + "description": "The **`lookupNamespaceURI()`** method of the Node interface takes a prefix as parameter and returns the namespace URI associated with it on the given node if found (and `null` if not).\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupNamespaceURI)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "MethodSignature", - "name": "scrollBy", - "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", - "description": "The **`scrollBy()`** method of the Element interface scrolls an element by the given amount.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollBy)" + "name": "lookupPrefix", + "value": "(namespace: string) => string", + "description": "The **`lookupPrefix()`** method of the Node interface returns a string containing the prefix for a given namespace URI, if present, and `null` if not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupPrefix)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "scrollHeight", - "value": "number", - "description": "The **`scrollHeight`** read-only property of the Element interface is a measurement of the height of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollHeight)" + "syntaxKind": "MethodSignature", + "name": "matches", + "value": "(selectors: string) => boolean", + "description": "The **`matches()`** method of the Element interface tests whether the element would be selected by the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "scrollIntoView", - "value": "(arg?: boolean | ScrollIntoViewOptions) => void", - "description": "The Element interface's **`scrollIntoView()`** method scrolls the element's ancestor containers such that the element on which `scrollIntoView()` is called is visible to the user.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollIntoView)" + "syntaxKind": "PropertySignature", + "name": "namespaceURI", + "value": "string | null", + "description": "The **`Element.namespaceURI`** read-only property returns the namespace URI of the element, or `null` if the element is not in a namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/namespaceURI)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "scrollLeft", - "value": "number", - "description": "The **`scrollLeft`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its left edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollLeft)" + "name": "nextElementSibling", + "value": "Element | null", + "description": "Returns the first following sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/nextElementSibling)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "scrollTo", - "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", - "description": "The **`scrollTo()`** method of the Element interface scrolls to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTo)" + "syntaxKind": "PropertySignature", + "name": "nextSibling", + "value": "ChildNode | null", + "description": "The read-only **`nextSibling`** property of the Node interface returns the node immediately following the specified one in their parent's Node.childNodes, or returns `null` if the specified node is the last child in the parent element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nextSibling)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "scrollTop", - "value": "number", - "description": "The **`scrollTop`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its top edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTop)" + "name": "nodeName", + "value": "string", + "description": "The read-only **`nodeName`** property of Node returns the name of the current node as a string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeName)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "scrollWidth", + "name": "nodeType", "value": "number", - "description": "The **`scrollWidth`** read-only property of the Element interface is a measurement of the width of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollWidth)" + "description": "The read-only **`nodeType`** property of a Node interface is an integer that identifies what the node is.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeType)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "setAttribute", - "value": "(qualifiedName: string, value: string) => void", - "description": "The **`setAttribute()`** method of the Element interface sets the value of an attribute on the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttribute)" + "syntaxKind": "PropertySignature", + "name": "nodeValue", + "value": "string | null", + "description": "The **`nodeValue`** property of the Node interface returns or sets the value of the current node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeValue)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "setAttributeNode", - "value": "(attr: Attr) => Attr", - "description": "The **`setAttributeNode()`** method of the Element interface adds a new Attr node to the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNode)" + "syntaxKind": "PropertySignature", + "name": "nonce", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/nonce)", + "isOptional": true }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "MethodSignature", - "name": "setAttributeNodeNS", - "value": "(attr: Attr) => Attr", - "description": "The **`setAttributeNodeNS()`** method of the Element interface adds a new namespaced Attr node to an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNodeNS)" + "name": "normalize", + "value": "() => void", + "description": "The **`normalize()`** method of the Node interface puts the specified node and all of its sub-tree into a _normalized_ form.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/normalize)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "setAttributeNS", - "value": "(namespace: string, qualifiedName: string, value: string) => void", - "description": "`setAttributeNS` adds a new attribute or changes the value of an attribute with the given namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNS)" + "syntaxKind": "PropertySignature", + "name": "NOTATION_NODE", + "value": "12", + "description": "" }, { "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "setHTMLUnsafe", - "value": "(html: string) => void", - "description": "The **`setHTMLUnsafe()`** method of the Element interface is used to parse a string of HTML into a DocumentFragment, optionally filtering out unwanted elements and attributes, and those that don't belong in the context, and then using it to replace the element's subtree in the DOM.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setHTMLUnsafe)" + "syntaxKind": "PropertySignature", + "name": "offsetHeight", + "value": "number", + "description": "The **`offsetHeight`** read-only property of the HTMLElement interface returns the height of an element, including vertical padding and borders, as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetHeight)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "setPointerCapture", - "value": "(pointerId: number) => void", - "description": "The **`setPointerCapture()`** method of the _capture target_ of future pointer events.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setPointerCapture)" + "syntaxKind": "PropertySignature", + "name": "offsetLeft", + "value": "number", + "description": "The **`offsetLeft`** read-only property of the HTMLElement interface returns the number of pixels that the _upper left corner_ of the current element is offset to the left within the HTMLElement.offsetParent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetLeft)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "shadowRoot", - "value": "ShadowRoot | null", - "description": "The `Element.shadowRoot` read-only property represents the shadow root hosted by the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/shadowRoot)" + "name": "offsetParent", + "value": "Element | null", + "description": "The **`HTMLElement.offsetParent`** read-only property returns a reference to the element which is the closest (nearest in the containment hierarchy) positioned ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetParent)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "showPopover", - "value": "() => void", - "description": "The **`showPopover()`** method of the HTMLElement interface shows a Popover_API element (i.e., one that has a valid `popover` attribute) by adding it to the top layer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/showPopover)" + "syntaxKind": "PropertySignature", + "name": "offsetTop", + "value": "number", + "description": "The **`offsetTop`** read-only property of the HTMLElement interface returns the distance from the outer border of the current element (including its margin) to the top padding edge of the HTMLelement.offsetParent, the _closest positioned_ ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetTop)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "slot", - "value": "string", - "description": "The **`slot`** property of the Element interface returns the name of the shadow DOM slot the element is inserted in.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/slot)" + "name": "offsetWidth", + "value": "number", + "description": "The **`offsetWidth`** read-only property of the HTMLElement interface returns the layout width of an element as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetWidth)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "spellcheck", - "value": "boolean", - "description": "The **`spellcheck`** property of the HTMLElement interface represents a boolean value that controls the spell-checking hint.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/spellcheck)" + "name": "onabort", + "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/abort_event)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "GetAccessor", - "name": "style", - "value": "CSSStyleDeclaration", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/style)" + "syntaxKind": "PropertySignature", + "name": "onanimationcancel", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationcancel_event)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "tabIndex", - "value": "number", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/tabIndex)" + "name": "onanimationend", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "tagName", - "value": "string", - "description": "The **`tagName`** read-only property of the Element interface returns the tag name of the element on which it's called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/tagName)" + "name": "onanimationiteration", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "target", - "value": "'auto' | '_blank'", - "description": "Specifies where to display the linked URL.", - "isOptional": true, - "defaultValue": "'auto'" + "name": "onanimationstart", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "TEXT_NODE", - "value": "3", - "description": "node is a Text node." + "name": "onauxclick", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/auxclick_event)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "GetAccessor", - "name": "textContent", - "value": "string", - "description": "[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/Node/textContent)" + "syntaxKind": "PropertySignature", + "name": "onbeforeinput", + "value": "((this: GlobalEventHandlers, ev: InputEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforeinput_event)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The **`HTMLElement.title`** property represents the title of the element: the text usually displayed in a 'tooltip' popup when the mouse is over the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/title)" + "name": "onbeforematch", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforematch_event)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "toggleAttribute", - "value": "(qualifiedName: string, force?: boolean) => boolean", - "description": "The **`toggleAttribute()`** method of the present and adding it if it is not present) on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/toggleAttribute)" + "syntaxKind": "PropertySignature", + "name": "onbeforetoggle", + "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/beforetoggle_event)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "togglePopover", - "value": "(options?: boolean) => boolean", - "description": "The **`togglePopover()`** method of the HTMLElement interface toggles a Popover_API element (i.e., one that has a valid `popover` attribute) between the hidden and showing states.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/togglePopover)" + "syntaxKind": "PropertySignature", + "name": "onblur", + "value": "((this: GlobalEventHandlers, ev: FocusEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/blur_event)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "tone", - "value": "'auto' | 'neutral' | 'critical'", - "description": "The semantic meaning and color treatment of the button.\n\n- `'auto'`: Automatically determined based on context.\n- `'neutral'`: General information without specific intent.\n- `'critical'`: Urgent problems or destructive actions.", - "isOptional": true, - "defaultValue": "'auto'" + "name": "oncancel", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/cancel_event)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "translate", - "value": "boolean", - "description": "The **`translate`** property of the HTMLElement interface indicates whether an element's attribute values and the values of its Text node children are to be translated when the page is localized, or whether to leave them unchanged.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/translate)" + "name": "oncanplay", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplay_event)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "type", - "value": "'submit' | 'button'", - "description": "The behavioral type of the button component, which determines what action it performs when activated.\n\n- `submit`: Submits the closest form.\n- `button`: Performs no default action when activated.\n- `reset`: Resets the closest form (returning fields to their default values).\n\nThis property is ignored if the component supports `href` or `commandFor`/`command` and one of them is set.", - "isOptional": true, - "defaultValue": "'button'" + "name": "oncanplaythrough", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplaythrough_event)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "variant", - "value": "'auto' | 'primary' | 'secondary'", - "description": "The visual style variant of the button component, which controls its prominence and emphasis.\n\n- `'auto'`: Automatically determined by the button's context.\n- `'primary'`: High-emphasis style for the main action.\n- `'secondary'`: Medium-emphasis style for supporting actions.\n- `'tertiary'`: Low-emphasis style for less prominent actions.", - "isOptional": true, - "defaultValue": "'auto'" + "name": "onchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/change_event)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "webkitMatchesSelector", - "value": "(selectors: string) => boolean", - "description": "", - "deprecationMessage": "This is a legacy alias of `matches`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" + "syntaxKind": "PropertySignature", + "name": "onclick", + "value": "(event: Event) => void", + "description": "" }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "writingSuggestions", - "value": "string", - "description": "The **`writingSuggestions`** property of the HTMLElement interface is a string indicating if browser-provided writing suggestions should be enabled under the scope of the element or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/writingSuggestions)" - } - ], - "value": "export interface ButtonElement extends ButtonElementProps, Omit {\n onclick: ButtonEvents['onClick'];\n}" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "name": "ButtonProps", - "description": "", - "isPublicDocs": true, - "members": [ + "name": "onclose", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/close_event)" + }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "A label that describes the purpose or content of the button for users of assistive technologies such as screen readers. Use this when the visible content alone doesn't provide enough context.", - "isOptional": true + "name": "oncontextlost", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextlost_event)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "command", - "value": "'--auto' | '--show' | '--hide' | '--toggle' | '--copy'", - "description": "Sets the action the `commandFor` should take when this clickable is activated.\n\nSee the documentation of particular components for the actions they support.\n\n- `--auto`: Performs the default action for the target component.\n- `--show`: Displays the target component.\n- `--hide`: Conceals the target component.\n- `--toggle`: Alternates the target component.\n- `--copy`: Copies the target ClipboardItem.", - "isOptional": true, - "defaultValue": "'--auto'" + "name": "oncontextmenu", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/contextmenu_event)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "commandFor", - "value": "string", - "description": "ID of a component that should respond to activations (such as clicks) on this component.\n\nSee `command` for how to control the behavior of the target.", - "isOptional": true + "name": "oncontextrestored", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextrestored_event)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "Whether the button is disabled, preventing it from being clicked or receiving focus.", - "isOptional": true, - "defaultValue": "false" + "name": "oncopy", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/copy_event)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "href", - "value": "string", - "description": "The URL to navigate to when clicked. The `click` event fires first, then navigation occurs.\n\n- If set, it will navigate to the location specified by `href` after executing the `click` event.\n- If a `commandFor` is set, the `command` will be executed instead of the navigation.", - "isOptional": true + "name": "oncuechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLTrackElement/cuechange_event)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the element.", - "isOptional": true + "name": "oncut", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/cut_event)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "inlineSize", - "value": "'auto' | 'fill' | 'fit-content'", - "description": "The inline width of the button component.\n\n- `auto`: The size depends on the surface and context.\n- `fill`: The button takes up 100% of the available inline size.\n- `fit-content`: The button takes up the minimum inline-size required to fit its content.", - "isOptional": true, - "defaultValue": "'auto'" + "name": "ondblclick", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/dblclick_event)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "interestFor", - "value": "string", - "description": "The ID of the component to show when users hover over or focus on this component. Pair with a target component that supports interest-based interactions. Learn more about the [interestFor attribute](https://open-ui.org/components/interest-invokers.explainer/#the-pitch-in-code).", - "isOptional": true + "name": "ondrag", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drag_event)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "loading", - "value": "boolean", - "description": "Whether the button is in a loading state, which replaces the button content with a loading indicator while a background action is being performed.\n\nThis also disables the button.", - "isOptional": true, - "defaultValue": "false" + "name": "ondragend", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragend_event)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "onClick", - "value": "(event: Event) => void", - "description": "A callback fired when the button is activated, before performing the action indicated by `type`. Learn more about the [click event](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event).", - "isOptional": true + "name": "ondragenter", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragenter_event)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "target", - "value": "'auto' | '_blank'", - "description": "Specifies where to display the linked URL.", - "isOptional": true, - "defaultValue": "'auto'" + "name": "ondragleave", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragleave_event)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "tone", - "value": "'auto' | 'neutral' | 'critical'", - "description": "The semantic meaning and color treatment of the button.\n\n- `'auto'`: Automatically determined based on context.\n- `'neutral'`: General information without specific intent.\n- `'critical'`: Urgent problems or destructive actions.", - "isOptional": true, - "defaultValue": "'auto'" + "name": "ondragover", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragover_event)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "type", - "value": "'submit' | 'button'", - "description": "The behavioral type of the button component, which determines what action it performs when activated.\n\n- `submit`: Submits the closest form.\n- `button`: Performs no default action when activated.\n- `reset`: Resets the closest form (returning fields to their default values).\n\nThis property is ignored if the component supports `href` or `commandFor`/`command` and one of them is set.", - "isOptional": true, - "defaultValue": "'button'" + "name": "ondragstart", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragstart_event)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "variant", - "value": "'auto' | 'primary' | 'secondary'", - "description": "The visual style variant of the button component, which controls its prominence and emphasis.\n\n- `'auto'`: Automatically determined by the button's context.\n- `'primary'`: High-emphasis style for the main action.\n- `'secondary'`: Medium-emphasis style for supporting actions.\n- `'tertiary'`: Low-emphasis style for less prominent actions.", - "isOptional": true, - "defaultValue": "'auto'" - } - ], - "value": "export interface ButtonProps extends ButtonElementProps, ButtonEvents {\n}" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "name": "CheckboxElementProps", - "description": "Properties for the Checkbox component element.", - "isPublicDocs": true, - "members": [ - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "A label used for users using assistive technologies like screen readers. When set, any children or `label` supplied will not be announced. This can also be used to display a control without a visual label, while still providing context to users using screen readers.", - "isOptional": true + "name": "ondrop", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drop_event)" }, { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "checked", - "value": "boolean", - "description": "Whether the control is active.", - "isOptional": true, - "defaultValue": "false" + "name": "ondurationchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/durationchange_event)" }, { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "command", - "value": "'--auto' | '--show' | '--hide' | '--toggle'", - "description": "Sets the action the `commandFor` should take when this clickable is activated.\n\nSee the documentation of particular components for the actions they support.\n\n- `--auto`: Performs the default action for the target component.\n- `--show`: Displays the target component.\n- `--hide`: Conceals the target component.\n- `--toggle`: Alternates the target component.\n- `--copy`: Copies the target ClipboardItem.", - "isOptional": true, - "defaultValue": "'--auto'" + "name": "onemptied", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/emptied_event)" }, { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "commandFor", - "value": "string", - "description": "ID of a component that should respond to activations (such as clicks) on this component.\n\nSee `command` for how to control the behavior of the target.", - "isOptional": true + "name": "onended", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ended_event)" }, { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "defaultChecked", - "value": "boolean", - "description": "Whether the control is active by default.", - "isOptional": true, - "defaultValue": "false" + "name": "onerror", + "value": "OnErrorEventHandler", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/error_event)" }, { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "Disables the control, disallowing any interaction.", - "isOptional": true, - "defaultValue": "false" + "name": "onfocus", + "value": "((this: GlobalEventHandlers, ev: FocusEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/focus_event)" }, { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "error", - "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", - "isOptional": true + "name": "onformdata", + "value": "((this: GlobalEventHandlers, ev: FormDataEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/formdata_event)" }, { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the element.", - "isOptional": true + "name": "onfullscreenchange", + "value": "((this: Element, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenchange_event)" }, { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "label", - "value": "string", - "description": "Visual content to use as the control label.", - "isOptional": true + "name": "onfullscreenerror", + "value": "((this: Element, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenerror_event)" }, { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "An identifier for the control that is unique within the nearest containing `Form` component.", - "isOptional": true + "name": "ongotpointercapture", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/gotpointercapture_event)" }, { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "required", - "value": "boolean", - "description": "Whether the field needs a value. This requirement adds semantic value to the field, but it will not cause an error to appear automatically. If you want to present an error when this field is empty, you can do so with the `error` property.", - "isOptional": true, - "defaultValue": "false" + "name": "oninput", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/input_event)" }, { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value used in form data when the control is checked.", - "isOptional": true - } - ], - "value": "export interface CheckboxElementProps extends Pick {\n command?: Extract;\n}" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "name": "CheckboxEvents", - "description": "", - "isPublicDocs": true, - "members": [ + "name": "oninvalid", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/invalid_event)" + }, { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "onChange", - "value": "(event: Event) => void", - "description": "A callback that is run whenever the control is changed.", - "isOptional": true - } - ], - "value": "export interface CheckboxEvents extends Pick {\n}" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "name": "CheckboxElementEvents", - "description": "Events for the Checkbox component element.", - "isPublicDocs": true, - "members": [ + "name": "onkeydown", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keydown_event)" + }, { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "change", - "value": "CallbackEventListener", - "description": "A callback that is run whenever the control is changed.", - "isOptional": true - } - ], - "value": "export interface CheckboxElementEvents {\n /**\n * A callback that is run whenever the control is changed.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event\n */\n change?: CallbackEventListener;\n}" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "name": "CheckboxElement", - "description": "", - "isPublicDocs": true, - "members": [ + "name": "onkeypress", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "", + "deprecationMessage": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keypress_event)" + }, { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "A label used for users using assistive technologies like screen readers. When set, any children or `label` supplied will not be announced. This can also be used to display a control without a visual label, while still providing context to users using screen readers.", - "isOptional": true + "name": "onkeyup", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keyup_event)" }, { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "accessKey", - "value": "string", - "description": "The **`HTMLElement.accessKey`** property sets the keystroke which a user can press to jump to a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKey)" + "name": "onload", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/load_event)" }, { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "accessKeyLabel", - "value": "string", - "description": "The **`HTMLElement.accessKeyLabel`** read-only property returns a string containing the element's browser-assigned access key (if any); otherwise it returns an empty string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKeyLabel)" + "name": "onloadeddata", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadeddata_event)" }, { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "MethodSignature", - "name": "addEventListener", - "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "onloadedmetadata", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadedmetadata_event)" }, { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "MethodSignature", - "name": "after", - "value": "(...nodes: (string | Node)[]) => void", - "description": "Inserts nodes just after node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/after)" + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "onloadstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadstart_event)" }, { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "MethodSignature", - "name": "animate", - "value": "(keyframes: Keyframe[] | PropertyIndexedKeyframes, options?: number | KeyframeAnimationOptions) => Animation", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animate)" + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "onlostpointercapture", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/lostpointercapture_event)" }, { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "MethodSignature", - "name": "append", - "value": "(...nodes: (string | Node)[]) => void", - "description": "Inserts nodes after the last child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/append)" + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "onmousedown", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousedown_event)" }, { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "MethodSignature", - "name": "appendChild", - "value": "(node: T) => T", - "description": "The **`appendChild()`** method of the Node interface adds a node to the end of the list of children of a specified parent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/appendChild)" + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseenter", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseenter_event)" }, { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "ariaActiveDescendantElement", - "value": "Element | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaActiveDescendantElement)" + "name": "onmouseleave", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseleave_event)" }, { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "ariaAtomic", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAtomic)" + "name": "onmousemove", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousemove_event)" }, { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "ariaAutoComplete", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAutoComplete)" + "name": "onmouseout", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseout_event)" }, { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "ariaBrailleLabel", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleLabel)" + "name": "onmouseover", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseover_event)" }, { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "ariaBrailleRoleDescription", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleRoleDescription)" + "name": "onmouseup", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseup_event)" }, { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "ariaBusy", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBusy)" + "name": "onpaste", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/paste_event)" }, { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "ariaChecked", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaChecked)" + "name": "onpause", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/pause_event)" }, { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "ariaColCount", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColCount)" + "name": "onplay", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/play_event)" }, { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "ariaColIndex", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndex)" + "name": "onplaying", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/playing_event)" }, { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "ariaColIndexText", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndexText)" + "name": "onpointercancel", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointercancel_event)" }, { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "ariaColSpan", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColSpan)" + "name": "onpointerdown", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerdown_event)" }, { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "ariaControlsElements", - "value": "ReadonlyArray | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaControlsElements)" + "name": "onpointerenter", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerenter_event)" }, { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "ariaCurrent", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaCurrent)" + "name": "onpointerleave", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerleave_event)" }, { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "ariaDescribedByElements", - "value": "ReadonlyArray | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescribedByElements)" + "name": "onpointermove", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointermove_event)" }, { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "ariaDescription", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescription)" + "name": "onpointerout", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerout_event)" }, { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "ariaDetailsElements", - "value": "ReadonlyArray | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDetailsElements)" + "name": "onpointerover", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerover_event)" }, { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "ariaDisabled", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDisabled)" + "name": "onpointerrawupdate", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "Available only in secure contexts.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerrawupdate_event)" }, { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "ariaErrorMessageElements", - "value": "ReadonlyArray | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaErrorMessageElements)" + "name": "onpointerup", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerup_event)" }, { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "ariaExpanded", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaExpanded)" + "name": "onprogress", + "value": "((this: GlobalEventHandlers, ev: ProgressEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/progress_event)" }, { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "ariaFlowToElements", - "value": "ReadonlyArray | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaFlowToElements)" + "name": "onratechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ratechange_event)" }, { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "ariaHasPopup", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHasPopup)" + "name": "onreset", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/reset_event)" }, { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "ariaHidden", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHidden)" + "name": "onresize", + "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLVideoElement/resize_event)" }, { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "ariaInvalid", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaInvalid)" + "name": "onscroll", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scroll_event)" }, { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "ariaKeyShortcuts", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaKeyShortcuts)" + "name": "onscrollend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scrollend_event)" }, { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "ariaLabel", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabel)" + "name": "onsecuritypolicyviolation", + "value": "((this: GlobalEventHandlers, ev: SecurityPolicyViolationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/securitypolicyviolation_event)" }, { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "ariaLabelledByElements", - "value": "ReadonlyArray | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabelledByElements)" + "name": "onseeked", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeked_event)" }, { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "ariaLevel", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLevel)" + "name": "onseeking", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeking_event)" }, { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "ariaLive", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLive)" + "name": "onselect", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/select_event)" }, { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "ariaModal", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaModal)" + "name": "onselectionchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/selectionchange_event)" }, { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "ariaMultiLine", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiLine)" + "name": "onselectstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/selectstart_event)" }, { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "ariaMultiSelectable", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiSelectable)" + "name": "onslotchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLSlotElement/slotchange_event)" }, { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "ariaOrientation", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOrientation)" + "name": "onstalled", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/stalled_event)" }, { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "ariaOwnsElements", - "value": "ReadonlyArray | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOwnsElements)" + "name": "onsubmit", + "value": "((this: GlobalEventHandlers, ev: SubmitEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/submit_event)" }, { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "ariaPlaceholder", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPlaceholder)" + "name": "onsuspend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/suspend_event)" }, { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "ariaPosInSet", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPosInSet)" + "name": "ontimeupdate", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/timeupdate_event)" }, { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "ariaPressed", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPressed)" + "name": "ontoggle", + "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/toggle_event)" }, { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "ariaReadOnly", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaReadOnly)" + "name": "ontouchcancel", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchcancel_event)", + "isOptional": true }, { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "ariaRelevant", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRelevant)" + "name": "ontouchend", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchend_event)", + "isOptional": true }, { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "ariaRequired", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRequired)" + "name": "ontouchmove", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchmove_event)", + "isOptional": true }, { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "filePath": "src/surfaces/checkout/components/Button.ts", "syntaxKind": "PropertySignature", - "name": "ariaRoleDescription", + "name": "ontouchstart", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchstart_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitioncancel", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitioncancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionend", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionrun", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionrun_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionstart", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "onvolumechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/volumechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "onwaiting", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/waiting_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationiteration", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationiteration`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationstart`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkittransitionend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `ontransitionend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "onwheel", + "value": "((this: GlobalEventHandlers, ev: WheelEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/wheel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "outerHTML", + "value": "string", + "description": "The **`outerHTML`** attribute of the Element DOM interface gets the serialized HTML fragment describing the element including its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/outerHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "outerText", + "value": "string", + "description": "The **`outerText`** property of the HTMLElement interface returns the same value as HTMLElement.innerText.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/outerText)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "ownerDocument", + "value": "Document", + "description": "The read-only **`ownerDocument`** property of the Node interface returns the top-level document object of the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/ownerDocument)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "parentElement", + "value": "HTMLElement | null", + "description": "The read-only **`parentElement`** property of Node interface returns the DOM node's parent Element, or `null` if the node either has no parent, or its parent isn't a DOM Element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentElement)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "parentNode", + "value": "ParentNode | null", + "description": "The read-only **`parentNode`** property of the Node interface returns the parent of the specified node in the DOM tree.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "GetAccessor", + "name": "part", + "value": "DOMTokenList", + "description": "The **`part`** property of the Element interface represents the part identifier(s) of the element (i.e., set using the `part` attribute), returned as a DOMTokenList.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/part)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "popover", + "value": "string | null", + "description": "The **`popover`** property of the HTMLElement interface gets and sets an element's popover state via JavaScript (`'auto'`, `'hint'`, or `'manual'`), and can be used for feature detection.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/popover)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "prefix", + "value": "string | null", + "description": "The **`Element.prefix`** read-only property returns the namespace prefix of the specified element, or `null` if no prefix is specified.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/prefix)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "MethodSignature", + "name": "prepend", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes before the first child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/prepend)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "previousElementSibling", + "value": "Element | null", + "description": "Returns the first preceding sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/previousElementSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "previousSibling", + "value": "ChildNode | null", + "description": "The read-only **`previousSibling`** property of the Node interface returns the node immediately preceding the specified one in its parent's or `null` if the specified node is the first in that list.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/previousSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "PROCESSING_INSTRUCTION_NODE", + "value": "7", + "description": "node is a ProcessingInstruction node." + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "MethodSignature", + "name": "querySelector", + "value": "{ (selectors: K): HTMLElementTagNameMap[K]; (selectors: K): SVGElementTagNameMap[K]; (selectors: K): MathMLElementTagNameMap[K]; (selectors: K): HTMLElementDeprecatedTagNameMap[K]; (selectors: string): E; }", + "description": "Returns the first element that is a descendant of node that matches selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelector)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "MethodSignature", + "name": "querySelectorAll", + "value": "{ (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: string): NodeListOf; }", + "description": "Returns all element descendants of node that match selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelectorAll)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "MethodSignature", + "name": "releasePointerCapture", + "value": "(pointerId: number) => void", + "description": "The **`releasePointerCapture()`** method of the previously set for a specific (PointerEvent) _pointer_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/releasePointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "MethodSignature", + "name": "remove", + "value": "() => void", + "description": "Removes node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/remove)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttribute", + "value": "(qualifiedName: string) => void", + "description": "The Element method **`removeAttribute()`** removes the attribute with the specified name from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttributeNode", + "value": "(attr: Attr) => Attr", + "description": "The **`removeAttributeNode()`** method of the Element interface removes the specified Attr node from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttributeNS", + "value": "(namespace: string, localName: string) => void", + "description": "The **`removeAttributeNS()`** method of the If you are working with HTML and you don't need to specify the requested attribute as being part of a specific namespace, use the Element.removeAttribute() method instead.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "MethodSignature", + "name": "removeChild", + "value": "(child: T) => T", + "description": "The **`removeChild()`** method of the Node interface removes a child node from the DOM and returns the removed node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/removeChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "MethodSignature", + "name": "removeEventListener", + "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "MethodSignature", + "name": "replaceChild", + "value": "(node: Node, child: T) => T", + "description": "The **`replaceChild()`** method of the Node interface replaces a child node within the given (parent) node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/replaceChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "MethodSignature", + "name": "replaceChildren", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Replace all children of node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/replaceChildren)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "MethodSignature", + "name": "replaceWith", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Replaces node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/replaceWith)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "MethodSignature", + "name": "requestFullscreen", + "value": "(options?: FullscreenOptions) => Promise", + "description": "The **`Element.requestFullscreen()`** method issues an asynchronous request to make the element be displayed in fullscreen mode.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestFullscreen)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "MethodSignature", + "name": "requestPointerLock", + "value": "(options?: PointerLockOptions) => Promise", + "description": "The **`requestPointerLock()`** method of the Element interface lets you asynchronously ask for the pointer to be locked on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestPointerLock)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "role", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/role)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "MethodSignature", + "name": "scroll", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scroll()`** method of the Element interface scrolls the element to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scroll)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "MethodSignature", + "name": "scrollBy", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scrollBy()`** method of the Element interface scrolls an element by the given amount.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollBy)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "scrollHeight", + "value": "number", + "description": "The **`scrollHeight`** read-only property of the Element interface is a measurement of the height of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "MethodSignature", + "name": "scrollIntoView", + "value": "(arg?: boolean | ScrollIntoViewOptions) => void", + "description": "The Element interface's **`scrollIntoView()`** method scrolls the element's ancestor containers such that the element on which `scrollIntoView()` is called is visible to the user.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollIntoView)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "scrollLeft", + "value": "number", + "description": "The **`scrollLeft`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its left edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "MethodSignature", + "name": "scrollTo", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scrollTo()`** method of the Element interface scrolls to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTo)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "scrollTop", + "value": "number", + "description": "The **`scrollTop`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its top edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTop)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "scrollWidth", + "value": "number", + "description": "The **`scrollWidth`** read-only property of the Element interface is a measurement of the width of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "MethodSignature", + "name": "setAttribute", + "value": "(qualifiedName: string, value: string) => void", + "description": "The **`setAttribute()`** method of the Element interface sets the value of an attribute on the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNode", + "value": "(attr: Attr) => Attr", + "description": "The **`setAttributeNode()`** method of the Element interface adds a new Attr node to the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNodeNS", + "value": "(attr: Attr) => Attr", + "description": "The **`setAttributeNodeNS()`** method of the Element interface adds a new namespaced Attr node to an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNodeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNS", + "value": "(namespace: string, qualifiedName: string, value: string) => void", + "description": "`setAttributeNS` adds a new attribute or changes the value of an attribute with the given namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "MethodSignature", + "name": "setHTMLUnsafe", + "value": "(html: string) => void", + "description": "The **`setHTMLUnsafe()`** method of the Element interface is used to parse a string of HTML into a DocumentFragment, optionally filtering out unwanted elements and attributes, and those that don't belong in the context, and then using it to replace the element's subtree in the DOM.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setHTMLUnsafe)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "MethodSignature", + "name": "setPointerCapture", + "value": "(pointerId: number) => void", + "description": "The **`setPointerCapture()`** method of the _capture target_ of future pointer events.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setPointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "shadowRoot", + "value": "ShadowRoot | null", + "description": "The `Element.shadowRoot` read-only property represents the shadow root hosted by the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/shadowRoot)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "MethodSignature", + "name": "showPopover", + "value": "() => void", + "description": "The **`showPopover()`** method of the HTMLElement interface shows a Popover_API element (i.e., one that has a valid `popover` attribute) by adding it to the top layer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/showPopover)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "slot", + "value": "string", + "description": "The **`slot`** property of the Element interface returns the name of the shadow DOM slot the element is inserted in.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/slot)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "spellcheck", + "value": "boolean", + "description": "The **`spellcheck`** property of the HTMLElement interface represents a boolean value that controls the spell-checking hint.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/spellcheck)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "GetAccessor", + "name": "style", + "value": "CSSStyleDeclaration", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/style)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "tabIndex", + "value": "number", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/tabIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "tagName", + "value": "string", + "description": "The **`tagName`** read-only property of the Element interface returns the tag name of the element on which it's called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/tagName)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "target", + "value": "'auto' | '_blank'", + "description": "Specifies where to display the linked URL.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "TEXT_NODE", + "value": "3", + "description": "node is a Text node." + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "GetAccessor", + "name": "textContent", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/Node/textContent)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "title", + "value": "string", + "description": "The **`HTMLElement.title`** property represents the title of the element: the text usually displayed in a 'tooltip' popup when the mouse is over the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/title)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "MethodSignature", + "name": "toggleAttribute", + "value": "(qualifiedName: string, force?: boolean) => boolean", + "description": "The **`toggleAttribute()`** method of the present and adding it if it is not present) on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/toggleAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "MethodSignature", + "name": "togglePopover", + "value": "(options?: boolean) => boolean", + "description": "The **`togglePopover()`** method of the HTMLElement interface toggles a Popover_API element (i.e., one that has a valid `popover` attribute) between the hidden and showing states.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/togglePopover)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "tone", + "value": "'auto' | 'neutral' | 'critical'", + "description": "The semantic meaning and color treatment of the button.\n\n- `'auto'`: Automatically determined based on context.\n- `'neutral'`: General information without specific intent.\n- `'critical'`: Urgent problems or destructive actions.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "translate", + "value": "boolean", + "description": "The **`translate`** property of the HTMLElement interface indicates whether an element's attribute values and the values of its Text node children are to be translated when the page is localized, or whether to leave them unchanged.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/translate)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "'submit' | 'button'", + "description": "The behavioral type of the button component, which determines what action it performs when activated.\n\n- `submit`: Submits the nearest containing form.\n- `button`: Performs no default action, relying on the `click` event handler for behavior.\n\nThis property is ignored if `href` or `commandFor`/`command` is set.", + "isOptional": true, + "defaultValue": "'button'" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "variant", + "value": "'auto' | 'primary' | 'secondary'", + "description": "The visual style variant of the button component, which controls its prominence and emphasis.\n\n- `'auto'`: Automatically determined by the button's context.\n- `'primary'`: High-emphasis style for the main action.\n- `'secondary'`: Medium-emphasis style for supporting actions.\n- `'tertiary'`: Low-emphasis style for less prominent actions.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "MethodSignature", + "name": "webkitMatchesSelector", + "value": "(selectors: string) => boolean", + "description": "", + "deprecationMessage": "This is a legacy alias of `matches`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "writingSuggestions", + "value": "string", + "description": "The **`writingSuggestions`** property of the HTMLElement interface is a string indicating if browser-provided writing suggestions should be enabled under the scope of the element or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/writingSuggestions)" + } + ], + "value": "export interface ButtonElement extends ButtonElementProps, Omit {\n onclick: ButtonEvents['onClick'];\n}" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "name": "CheckboxElementProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "A label used for users using assistive technologies like screen readers. When set, any children or `label` supplied will not be announced. This can also be used to display a control without a visual label, while still providing context to users using screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "checked", + "value": "boolean", + "description": "Whether the control is currently checked.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "command", + "value": "'--auto' | '--show' | '--hide' | '--toggle'", + "description": "Sets the action the `commandFor` target should take when this component is activated.\n\n- `--auto`: Performs the default action for the target component.\n- `--show`: Displays the target component.\n- `--hide`: Conceals the target component.\n- `--toggle`: Alternates the target component.\n- `--copy`: Copies the target ClipboardItem.\n\nLearn more about the [`command` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).", + "isOptional": true, + "defaultValue": "'--auto'" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "commandFor", + "value": "string", + "description": "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).\n\nWhen both `commandFor` and `href` are set, `commandFor` takes precedence. The command runs and the link doesn't navigate.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "defaultChecked", + "value": "boolean", + "description": "Whether the control is checked by default.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Whether the control is disabled, preventing any user interaction.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "error", + "value": "string", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "label", + "value": "string", + "description": "The visual content to use as the control label. Use a string to provide a simple text label displayed to the user.\n\nIf a `label` slot is also provided, the slot content takes precedence. [Learn more about slots](/docs/api/{API_NAME}/{API_VERSION}/web-components/forms/checkbox#slots-propertydetail-label).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "name", + "value": "string", + "description": "The name attribute for the control, used to identify its value when the form is submitted. Must be unique within the nearest containing form.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "required", + "value": "boolean", + "description": "Whether the field needs a value. This requirement adds semantic value to the field, but it will not cause an error to appear automatically. If you want to present an error when this field is empty, you can do so with the `error` property.\n\nAdds semantic meaning for accessibility. Doesn't trigger automatic validation or display an error. Implement validation logic yourself and use the `error` prop to show results.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "value", + "value": "string", + "description": "The value used in form data when the control is checked.", + "isOptional": true + } + ], + "value": "export interface CheckboxElementProps extends Pick {\n command?: Extract;\n /**\n * The visual content to use as the control label. Use a string to provide a simple text label displayed to the user.\n *\n * If a `label` slot is also provided, the slot content takes precedence. [Learn more about slots](/docs/api/{API_NAME}/{API_VERSION}/web-components/forms/checkbox#slots-propertydetail-label).\n */\n label?: string;\n}" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "name": "CheckboxEvents", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "onChange", + "value": "(event: Event) => void", + "description": "A callback that is run whenever the control is changed.", + "isOptional": true + } + ], + "value": "export interface CheckboxEvents extends Pick {\n}" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "name": "CheckboxElementEvents", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "change", + "value": "CallbackEventListener", + "description": "A callback fired when the checkbox value changes.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", + "isOptional": true + } + ], + "value": "export interface CheckboxElementEvents {\n /**\n * A callback fired when the checkbox value changes.\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change?: CallbackEventListener;\n}" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "name": "CheckboxElement", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "A label used for users using assistive technologies like screen readers. When set, any children or `label` supplied will not be announced. This can also be used to display a control without a visual label, while still providing context to users using screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "accessKey", + "value": "string", + "description": "The **`HTMLElement.accessKey`** property sets the keystroke which a user can press to jump to a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKey)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "accessKeyLabel", + "value": "string", + "description": "The **`HTMLElement.accessKeyLabel`** read-only property returns a string containing the element's browser-assigned access key (if any); otherwise it returns an empty string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKeyLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "MethodSignature", + "name": "addEventListener", + "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "MethodSignature", + "name": "after", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes just after node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/after)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "MethodSignature", + "name": "animate", + "value": "(keyframes: Keyframe[] | PropertyIndexedKeyframes, options?: number | KeyframeAnimationOptions) => Animation", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animate)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "MethodSignature", + "name": "append", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes after the last child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/append)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "MethodSignature", + "name": "appendChild", + "value": "(node: T) => T", + "description": "The **`appendChild()`** method of the Node interface adds a node to the end of the list of children of a specified parent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/appendChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaActiveDescendantElement", + "value": "Element | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaActiveDescendantElement)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaAtomic", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAtomic)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaAutoComplete", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAutoComplete)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBrailleLabel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBrailleRoleDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleRoleDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBusy", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBusy)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaChecked", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaChecked)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColCount", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColCount)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColIndex", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColIndexText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndexText)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColSpan", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColSpan)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaControlsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaControlsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaCurrent", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaCurrent)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDescribedByElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescribedByElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDetailsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDetailsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDisabled", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDisabled)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaErrorMessageElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaErrorMessageElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaExpanded", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaExpanded)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaFlowToElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaFlowToElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaHasPopup", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHasPopup)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaHidden", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHidden)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaInvalid", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaInvalid)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaKeyShortcuts", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaKeyShortcuts)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLabel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLabelledByElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabelledByElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLevel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLevel)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLive", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLive)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaModal", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaModal)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaMultiLine", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiLine)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaMultiSelectable", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiSelectable)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaOrientation", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOrientation)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaOwnsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOwnsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPlaceholder", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPlaceholder)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPosInSet", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPosInSet)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPressed", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPressed)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaReadOnly", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaReadOnly)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRelevant", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRelevant)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRequired", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRequired)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRoleDescription", "value": "string | null", "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRoleDescription)" }, @@ -27146,7 +28842,7 @@ "syntaxKind": "PropertySignature", "name": "checked", "value": "boolean", - "description": "Whether the control is active.", + "description": "Whether the control is currently checked.", "isOptional": true, "defaultValue": "false" }, @@ -27246,7 +28942,7 @@ "syntaxKind": "PropertySignature", "name": "command", "value": "'--auto' | '--show' | '--hide' | '--toggle'", - "description": "Sets the action the `commandFor` should take when this clickable is activated.\n\nSee the documentation of particular components for the actions they support.\n\n- `--auto`: Performs the default action for the target component.\n- `--show`: Displays the target component.\n- `--hide`: Conceals the target component.\n- `--toggle`: Alternates the target component.\n- `--copy`: Copies the target ClipboardItem.", + "description": "Sets the action the `commandFor` target should take when this component is activated.\n\n- `--auto`: Performs the default action for the target component.\n- `--show`: Displays the target component.\n- `--hide`: Conceals the target component.\n- `--toggle`: Alternates the target component.\n- `--copy`: Copies the target ClipboardItem.\n\nLearn more about the [`command` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).", "isOptional": true, "defaultValue": "'--auto'" }, @@ -27255,7 +28951,7 @@ "syntaxKind": "PropertySignature", "name": "commandFor", "value": "string", - "description": "ID of a component that should respond to activations (such as clicks) on this component.\n\nSee `command` for how to control the behavior of the target.", + "description": "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).\n\nWhen both `commandFor` and `href` are set, `commandFor` takes precedence. The command runs and the link doesn't navigate.", "isOptional": true }, { @@ -27312,7 +29008,7 @@ "syntaxKind": "PropertySignature", "name": "defaultChecked", "value": "boolean", - "description": "Whether the control is active by default.", + "description": "Whether the control is checked by default.", "isOptional": true, "defaultValue": "false" }, @@ -27328,7 +29024,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the control, disallowing any interaction.", + "description": "Whether the control is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -27442,7 +29138,7 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -27612,7 +29308,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -27711,7 +29407,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Visual content to use as the control label.", + "description": "The visual content to use as the control label. Use a string to provide a simple text label displayed to the user.\n\nIf a `label` slot is also provided, the slot content takes precedence. [Learn more about slots](/docs/api/{API_NAME}/{API_VERSION}/web-components/forms/checkbox#slots-propertydetail-label).", "isOptional": true }, { @@ -27768,7 +29464,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the control that is unique within the nearest containing `Form` component.", + "description": "The name attribute for the control, used to identify its value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -28740,7 +30436,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/Checkbox.ts", @@ -28782,7 +30478,7 @@ "syntaxKind": "PropertySignature", "name": "required", "value": "boolean", - "description": "Whether the field needs a value. This requirement adds semantic value to the field, but it will not cause an error to appear automatically. If you want to present an error when this field is empty, you can do so with the `error` property.", + "description": "Whether the field needs a value. This requirement adds semantic value to the field, but it will not cause an error to appear automatically. If you want to present an error when this field is empty, you can do so with the `error` property.\n\nAdds semantic meaning for accessibility. Doesn't trigger automatic validation or display an error. Implement validation logic yourself and use the `error` prop to show results.", "isOptional": true, "defaultValue": "false" }, @@ -29008,6 +30704,23 @@ ], "value": "export interface CheckboxElement extends CheckboxElementProps, Omit {\n onchange: CheckboxEvents['onChange'];\n}" }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "name": "CheckboxElementSlots", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "label", + "value": "HTMLElement", + "description": "The visual content to use as the control label.\n\nUse an `HTMLElement` as a rich control label composed of elements. Only an `s-text` element is supported with plain text and `s-link` as its only allowed children. Any other elements are stripped while preserving their text content.", + "isOptional": true + } + ], + "value": "export interface CheckboxElementSlots {\n /**\n * The visual content to use as the control label.\n *\n * Use an `HTMLElement` as a rich control label composed of elements. Only an `s-text` element is supported with plain text and `s-link` as its only allowed children. Any other elements are stripped while preserving their text content.\n */\n label?: HTMLElement;\n}" + }, { "filePath": "src/surfaces/checkout/components/Checkbox.ts", "name": "CheckboxProps", @@ -29027,7 +30740,7 @@ "syntaxKind": "PropertySignature", "name": "checked", "value": "boolean", - "description": "Whether the control is active.", + "description": "Whether the control is currently checked.", "isOptional": true, "defaultValue": "false" }, @@ -29036,7 +30749,7 @@ "syntaxKind": "PropertySignature", "name": "command", "value": "'--auto' | '--show' | '--hide' | '--toggle'", - "description": "Sets the action the `commandFor` should take when this clickable is activated.\n\nSee the documentation of particular components for the actions they support.\n\n- `--auto`: Performs the default action for the target component.\n- `--show`: Displays the target component.\n- `--hide`: Conceals the target component.\n- `--toggle`: Alternates the target component.\n- `--copy`: Copies the target ClipboardItem.", + "description": "Sets the action the `commandFor` target should take when this component is activated.\n\n- `--auto`: Performs the default action for the target component.\n- `--show`: Displays the target component.\n- `--hide`: Conceals the target component.\n- `--toggle`: Alternates the target component.\n- `--copy`: Copies the target ClipboardItem.\n\nLearn more about the [`command` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).", "isOptional": true, "defaultValue": "'--auto'" }, @@ -29045,7 +30758,7 @@ "syntaxKind": "PropertySignature", "name": "commandFor", "value": "string", - "description": "ID of a component that should respond to activations (such as clicks) on this component.\n\nSee `command` for how to control the behavior of the target.", + "description": "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).\n\nWhen both `commandFor` and `href` are set, `commandFor` takes precedence. The command runs and the link doesn't navigate.", "isOptional": true }, { @@ -29053,7 +30766,7 @@ "syntaxKind": "PropertySignature", "name": "defaultChecked", "value": "boolean", - "description": "Whether the control is active by default.", + "description": "Whether the control is checked by default.", "isOptional": true, "defaultValue": "false" }, @@ -29062,7 +30775,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the control, disallowing any interaction.", + "description": "Whether the control is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -29071,7 +30784,7 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -29079,7 +30792,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -29087,7 +30800,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Visual content to use as the control label.", + "description": "The visual content to use as the control label. Use a string to provide a simple text label displayed to the user.\n\nIf a `label` slot is also provided, the slot content takes precedence. [Learn more about slots](/docs/api/{API_NAME}/{API_VERSION}/web-components/forms/checkbox#slots-propertydetail-label).", "isOptional": true }, { @@ -29095,7 +30808,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the control that is unique within the nearest containing `Form` component.", + "description": "The name attribute for the control, used to identify its value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -29111,7 +30824,7 @@ "syntaxKind": "PropertySignature", "name": "required", "value": "boolean", - "description": "Whether the field needs a value. This requirement adds semantic value to the field, but it will not cause an error to appear automatically. If you want to present an error when this field is empty, you can do so with the `error` property.", + "description": "Whether the field needs a value. This requirement adds semantic value to the field, but it will not cause an error to appear automatically. If you want to present an error when this field is empty, you can do so with the `error` property.\n\nAdds semantic meaning for accessibility. Doesn't trigger automatic validation or display an error. Implement validation logic yourself and use the `error` prop to show results.", "isOptional": true, "defaultValue": "false" }, @@ -29130,7 +30843,7 @@ "filePath": "src/surfaces/checkout/components/TextField.ts", "syntaxKind": "TypeAliasDeclaration", "name": "ReducedIconTypes", - "value": "'cart' | 'reset' | 'map' | 'menu' | 'search' | 'circle' | 'filter' | 'image' | 'disabled' | 'info' | 'alert-circle' | 'alert-triangle-filled' | 'alert-triangle' | 'arrow-down' | 'arrow-left' | 'arrow-right' | 'arrow-up-right' | 'arrow-up' | 'bag' | 'bullet' | 'calendar' | 'camera' | 'caret-down' | 'cash-dollar' | 'categories' | 'check-circle' | 'check-circle-filled' | 'check' | 'chevron-down' | 'chevron-left' | 'chevron-right' | 'chevron-up' | 'clipboard' | 'clock' | 'credit-card' | 'delete' | 'delivered' | 'delivery' | 'discount' | 'edit' | 'email' | 'empty' | 'external' | 'geolocation' | 'gift-card' | 'globe' | 'grid' | 'info-filled' | 'list-bulleted' | 'location' | 'lock' | 'menu-horizontal' | 'menu-vertical' | 'minus' | 'mobile' | 'note' | 'order' | 'organization' | 'plus' | 'profile' | 'question-circle-filled' | 'question-circle' | 'reorder' | 'return' | 'savings' | 'settings' | 'star-filled' | 'star-half' | 'star' | 'store' | 'truck' | 'upload' | 'x-circle-filled' | 'x-circle' | 'x'", + "value": "'cart' | 'reset' | 'map' | 'menu' | 'search' | 'circle' | 'filter' | 'image' | 'note' | 'order' | 'settings' | 'disabled' | 'info' | 'alert-circle' | 'alert-triangle-filled' | 'alert-triangle' | 'arrow-down' | 'arrow-left' | 'arrow-right' | 'arrow-up-right' | 'arrow-up' | 'bag' | 'bullet' | 'calendar' | 'camera' | 'caret-down' | 'cash-dollar' | 'categories' | 'check-circle' | 'check-circle-filled' | 'check' | 'chevron-down' | 'chevron-left' | 'chevron-right' | 'chevron-up' | 'clipboard' | 'clock' | 'credit-card' | 'delete' | 'delivered' | 'delivery' | 'discount' | 'edit' | 'email' | 'empty' | 'external' | 'geolocation' | 'gift-card' | 'globe' | 'grid' | 'info-filled' | 'list-bulleted' | 'location' | 'lock' | 'menu-horizontal' | 'menu-vertical' | 'minus' | 'mobile' | 'organization' | 'plus' | 'profile' | 'question-circle-filled' | 'question-circle' | 'reorder' | 'return' | 'savings' | 'star-filled' | 'star-half' | 'star' | 'store' | 'truck' | 'upload' | 'x-circle-filled' | 'x-circle' | 'x'", "description": "", "isPublicDocs": true }, @@ -29145,7 +30858,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -29161,7 +30874,7 @@ "filePath": "src/surfaces/checkout/components/TextField.ts", "syntaxKind": "PropertySignature", "name": "tone", - "value": "'success' | 'custom' | 'auto' | 'neutral' | 'info' | 'warning' | 'critical'", + "value": "'success' | 'custom' | 'auto' | 'neutral' | 'critical' | 'info' | 'warning'", "description": "The semantic meaning and color treatment of the icon.\n\n- `'info'`: Informational content or helpful tips.\n- `'auto'`: Automatically determined based on context.\n- `'neutral'`: General information without specific intent.\n- `'success'`: Positive outcomes or successful states.\n- `'warning'`: Important warnings about potential issues.\n- `'critical'`: Urgent problems or destructive actions.\n- `'custom'`: Inherits a custom color from its parent element's CSS.", "isOptional": true, "defaultValue": "'auto'" @@ -29202,7 +30915,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/TextField.ts", @@ -30099,7 +31812,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -31211,7 +32924,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/TextField.ts", @@ -31450,7 +33163,7 @@ "filePath": "src/surfaces/checkout/components/TextField.ts", "syntaxKind": "PropertySignature", "name": "tone", - "value": "'success' | 'custom' | 'auto' | 'neutral' | 'info' | 'warning' | 'critical'", + "value": "'success' | 'custom' | 'auto' | 'neutral' | 'critical' | 'info' | 'warning'", "description": "The semantic meaning and color treatment of the icon.\n\n- `'info'`: Informational content or helpful tips.\n- `'auto'`: Automatically determined based on context.\n- `'neutral'`: General information without specific intent.\n- `'success'`: Positive outcomes or successful states.\n- `'warning'`: Important warnings about potential issues.\n- `'critical'`: Urgent problems or destructive actions.\n- `'custom'`: Inherits a custom color from its parent element's CSS.", "isOptional": true, "defaultValue": "'auto'" @@ -31499,7 +33212,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -31515,7 +33228,7 @@ "filePath": "src/surfaces/checkout/components/TextField.ts", "syntaxKind": "PropertySignature", "name": "tone", - "value": "'success' | 'custom' | 'auto' | 'neutral' | 'info' | 'warning' | 'critical'", + "value": "'success' | 'custom' | 'auto' | 'neutral' | 'critical' | 'info' | 'warning'", "description": "The semantic meaning and color treatment of the icon.\n\n- `'info'`: Informational content or helpful tips.\n- `'auto'`: Automatically determined based on context.\n- `'neutral'`: General information without specific intent.\n- `'success'`: Positive outcomes or successful states.\n- `'warning'`: Important warnings about potential issues.\n- `'critical'`: Urgent problems or destructive actions.\n- `'custom'`: Inherits a custom color from its parent element's CSS.", "isOptional": true, "defaultValue": "'auto'" @@ -31534,7 +33247,7 @@ { "filePath": "src/surfaces/checkout/components/TextField.ts", "name": "TextFieldElementProps", - "description": "Properties for the TextField component element.", + "description": "", "isPublicDocs": true, "members": [ { @@ -31542,7 +33255,7 @@ "syntaxKind": "PropertySignature", "name": "autocomplete", "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", "isOptional": true, "defaultValue": "'on' for everything else" }, @@ -31551,7 +33264,7 @@ "syntaxKind": "PropertySignature", "name": "defaultValue", "value": "string", - "description": "The default value for the field.", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces this value.", "isOptional": true }, { @@ -31559,7 +33272,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -31568,14 +33281,14 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { "filePath": "src/surfaces/checkout/components/TextField.ts", "syntaxKind": "PropertySignature", "name": "icon", - "value": "'' | 'cart' | 'reset' | 'map' | 'menu' | 'search' | 'circle' | 'filter' | 'image' | 'disabled' | 'info' | 'alert-circle' | 'alert-triangle-filled' | 'alert-triangle' | 'arrow-down' | 'arrow-left' | 'arrow-right' | 'arrow-up-right' | 'arrow-up' | 'bag' | 'bullet' | 'calendar' | 'camera' | 'caret-down' | 'cash-dollar' | 'categories' | 'check-circle' | 'check-circle-filled' | 'check' | 'chevron-down' | 'chevron-left' | 'chevron-right' | 'chevron-up' | 'clipboard' | 'clock' | 'credit-card' | 'delete' | 'delivered' | 'delivery' | 'discount' | 'edit' | 'email' | 'empty' | 'external' | 'geolocation' | 'gift-card' | 'globe' | 'grid' | 'info-filled' | 'list-bulleted' | 'location' | 'lock' | 'menu-horizontal' | 'menu-vertical' | 'minus' | 'mobile' | 'note' | 'order' | 'organization' | 'plus' | 'profile' | 'question-circle-filled' | 'question-circle' | 'reorder' | 'return' | 'savings' | 'settings' | 'star-filled' | 'star-half' | 'star' | 'store' | 'truck' | 'upload' | 'x-circle-filled' | 'x-circle' | 'x'", + "value": "'' | 'cart' | 'reset' | 'map' | 'menu' | 'search' | 'circle' | 'filter' | 'image' | 'note' | 'order' | 'settings' | 'disabled' | 'info' | 'alert-circle' | 'alert-triangle-filled' | 'alert-triangle' | 'arrow-down' | 'arrow-left' | 'arrow-right' | 'arrow-up-right' | 'arrow-up' | 'bag' | 'bullet' | 'calendar' | 'camera' | 'caret-down' | 'cash-dollar' | 'categories' | 'check-circle' | 'check-circle-filled' | 'check' | 'chevron-down' | 'chevron-left' | 'chevron-right' | 'chevron-up' | 'clipboard' | 'clock' | 'credit-card' | 'delete' | 'delivered' | 'delivery' | 'discount' | 'edit' | 'email' | 'empty' | 'external' | 'geolocation' | 'gift-card' | 'globe' | 'grid' | 'info-filled' | 'list-bulleted' | 'location' | 'lock' | 'menu-horizontal' | 'menu-vertical' | 'minus' | 'mobile' | 'organization' | 'plus' | 'profile' | 'question-circle-filled' | 'question-circle' | 'reorder' | 'return' | 'savings' | 'star-filled' | 'star-half' | 'star' | 'store' | 'truck' | 'upload' | 'x-circle-filled' | 'x-circle' | 'x'", "description": "The type of icon to be displayed in the field.", "isOptional": true, "defaultValue": "''" @@ -31585,7 +33298,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -31593,7 +33306,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Content to use as the field label.", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", "isOptional": true }, { @@ -31601,7 +33314,7 @@ "syntaxKind": "PropertySignature", "name": "labelAccessibilityVisibility", "value": "'visible' | 'exclusive'", - "description": "Changes the visibility of the component's label.\n\n- `visible`: the label is visible to all users.\n- `exclusive`: the label is visually hidden but remains in the accessibility tree.", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone.\n- `exclusive`: The label is visually hidden but still announced by screen readers.", "isOptional": true, "defaultValue": "'visible'" }, @@ -31619,7 +33332,7 @@ "syntaxKind": "PropertySignature", "name": "minLength", "value": "number", - "description": "Specifies the min number of characters allowed.", + "description": "Specifies the minimum number of characters allowed.", "isOptional": true, "defaultValue": "0" }, @@ -31628,7 +33341,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -31646,7 +33359,7 @@ "syntaxKind": "PropertySignature", "name": "prefix", "value": "string", - "description": "A value to be displayed immediately before the editable portion of the field.\n\nThis is useful for displaying an implied part of the value, such as \"https://\" or \"+353\".\n\nThis cannot be edited by the user, and it isn't included in the value of the field.\n\nIt may not be displayed until the user has interacted with the input. For example, an inline label may take the place of the prefix until the user focuses the input.", + "description": "A value to be displayed immediately before the editable portion of the field.\n\nThis is useful for displaying an implied part of the value, such as \"https://\" or \"+353\".\n\nThis can't be edited by the user, and it isn't included in the value of the field.\n\nIt may not be displayed until the user has interacted with the input. For example, an inline label may take the place of the prefix until the user focuses the input.", "isOptional": true, "defaultValue": "''" }, @@ -31655,7 +33368,7 @@ "syntaxKind": "PropertySignature", "name": "readOnly", "value": "boolean", - "description": "The field cannot be edited by the user. It is focusable will be announced by screen readers.", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", "isOptional": true, "defaultValue": "false" }, @@ -31673,7 +33386,7 @@ "syntaxKind": "PropertySignature", "name": "suffix", "value": "string", - "description": "A value to be displayed immediately after the editable portion of the field.\n\nThis is useful for displaying an implied part of the value, such as \"@shopify.com\", or \"%\".\n\nThis cannot be edited by the user, and it isn't included in the value of the field.\n\nIt may not be displayed until the user has interacted with the input. For example, an inline label may take the place of the suffix until the user focuses the input.", + "description": "A value to be displayed immediately after the editable portion of the field.\n\nThis is useful for displaying an implied part of the value, such as \"@shopify.com\", or \"%\".\n\nThis can't be edited by the user, and it isn't included in the value of the field.\n\nIt may not be displayed until the user has interacted with the input. For example, an inline label may take the place of the suffix until the user focuses the input.", "isOptional": true, "defaultValue": "''" }, @@ -31707,7 +33420,7 @@ "syntaxKind": "PropertySignature", "name": "onChange", "value": "(event: Event) => void", - "description": "Callback when the user has **finished editing** a field, for example, once they have blurred the field.", + "description": "A callback fired when the user has **finished editing** a field, such as when they blur the field or press Enter.", "isOptional": true }, { @@ -31723,7 +33436,7 @@ "syntaxKind": "PropertySignature", "name": "onInput", "value": "(event: Event) => void", - "description": "Callback when the user makes any changes in the field.", + "description": "A callback fired when the user makes any changes in the field, such as typing a character.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).", "isOptional": true } ], @@ -31732,7 +33445,7 @@ { "filePath": "src/surfaces/checkout/components/TextField.ts", "name": "TextFieldElementEvents", - "description": "Events for the TextField component element.", + "description": "", "isPublicDocs": true, "members": [ { @@ -31740,7 +33453,7 @@ "syntaxKind": "PropertySignature", "name": "blur", "value": "CallbackEventListener", - "description": "A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "description": "<<<<<<< HEAD A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n======= A callback fired when the text field loses focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) \n Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", "isOptional": true }, { @@ -31748,7 +33461,7 @@ "syntaxKind": "PropertySignature", "name": "change", "value": "CallbackEventListener", - "description": "Callback when the user has **finished editing** a field, for example, once they have blurred the field.", + "description": "<<<<<<< HEAD Callback when the user has **finished editing** a field, for example, once they have blurred the field.\n======= A callback fired when the text field value changes.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) \n Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", "isOptional": true }, { @@ -31756,7 +33469,7 @@ "syntaxKind": "PropertySignature", "name": "focus", "value": "CallbackEventListener", - "description": "A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "description": "<<<<<<< HEAD A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n======= A callback fired when the text field receives focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) \n Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", "isOptional": true }, { @@ -31764,16 +33477,16 @@ "syntaxKind": "PropertySignature", "name": "input", "value": "CallbackEventListener", - "description": "Callback when the user makes any changes in the field.", + "description": "A callback fired when the user inputs data into the text field.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).", "isOptional": true } ], - "value": "export interface TextFieldElementEvents {\n /**\n * A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event\n */\n blur?: CallbackEventListener;\n /**\n * Callback when the user has **finished editing** a field, for example, once they have blurred the field.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event\n */\n change?: CallbackEventListener;\n /**\n * A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event\n */\n focus?: CallbackEventListener;\n /**\n * Callback when the user makes any changes in the field.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event\n */\n input?: CallbackEventListener;\n}" + "value": "export interface TextFieldElementEvents {\n /**\n<<<<<<< HEAD\n * A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n=======\n * A callback fired when the text field loses focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality)\n *\n * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur?: CallbackEventListener;\n /**\n<<<<<<< HEAD\n * Callback when the user has **finished editing** a field, for example, once they have blurred the field.\n=======\n * A callback fired when the text field value changes.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality)\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change?: CallbackEventListener;\n /**\n<<<<<<< HEAD\n * A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n=======\n * A callback fired when the text field receives focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality)\n *\n * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus?: CallbackEventListener;\n /**\n * A callback fired when the user inputs data into the text field.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input?: CallbackEventListener;\n}" }, { "filePath": "src/surfaces/checkout/components/TextField.ts", "name": "TextFieldElementSlots", - "description": "Slots for the TextField component element.", + "description": "", "isPublicDocs": true, "members": [ { @@ -31781,11 +33494,11 @@ "syntaxKind": "PropertySignature", "name": "accessory", "value": "HTMLElement", - "description": "Additional content to be displayed in the field. Commonly used to display an icon that activates a tooltip providing more information.", + "description": "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.", "isOptional": true } ], - "value": "export interface TextFieldElementSlots {\n /**\n * Additional content to be displayed in the field.\n * Commonly used to display an icon that activates a tooltip providing more information.\n */\n accessory?: HTMLElement;\n}" + "value": "export interface TextFieldElementSlots {\n /**\n * 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.\n */\n accessory?: HTMLElement;\n}" }, { "filePath": "src/surfaces/checkout/components/TextField.ts", @@ -31812,7 +33525,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/TextField.ts", @@ -32253,7 +33966,7 @@ "syntaxKind": "PropertySignature", "name": "autocomplete", "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", "isOptional": true, "defaultValue": "'on' for everything else" }, @@ -32444,7 +34157,7 @@ "syntaxKind": "PropertySignature", "name": "defaultValue", "value": "string", - "description": "The default value for the field.", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces this value.", "isOptional": true }, { @@ -32459,7 +34172,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -32573,7 +34286,7 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -32742,7 +34455,7 @@ "filePath": "src/surfaces/checkout/components/TextField.ts", "syntaxKind": "PropertySignature", "name": "icon", - "value": "'' | 'cart' | 'reset' | 'map' | 'menu' | 'search' | 'circle' | 'filter' | 'image' | 'disabled' | 'info' | 'alert-circle' | 'alert-triangle-filled' | 'alert-triangle' | 'arrow-down' | 'arrow-left' | 'arrow-right' | 'arrow-up-right' | 'arrow-up' | 'bag' | 'bullet' | 'calendar' | 'camera' | 'caret-down' | 'cash-dollar' | 'categories' | 'check-circle' | 'check-circle-filled' | 'check' | 'chevron-down' | 'chevron-left' | 'chevron-right' | 'chevron-up' | 'clipboard' | 'clock' | 'credit-card' | 'delete' | 'delivered' | 'delivery' | 'discount' | 'edit' | 'email' | 'empty' | 'external' | 'geolocation' | 'gift-card' | 'globe' | 'grid' | 'info-filled' | 'list-bulleted' | 'location' | 'lock' | 'menu-horizontal' | 'menu-vertical' | 'minus' | 'mobile' | 'note' | 'order' | 'organization' | 'plus' | 'profile' | 'question-circle-filled' | 'question-circle' | 'reorder' | 'return' | 'savings' | 'settings' | 'star-filled' | 'star-half' | 'star' | 'store' | 'truck' | 'upload' | 'x-circle-filled' | 'x-circle' | 'x'", + "value": "'' | 'cart' | 'reset' | 'map' | 'menu' | 'search' | 'circle' | 'filter' | 'image' | 'note' | 'order' | 'settings' | 'disabled' | 'info' | 'alert-circle' | 'alert-triangle-filled' | 'alert-triangle' | 'arrow-down' | 'arrow-left' | 'arrow-right' | 'arrow-up-right' | 'arrow-up' | 'bag' | 'bullet' | 'calendar' | 'camera' | 'caret-down' | 'cash-dollar' | 'categories' | 'check-circle' | 'check-circle-filled' | 'check' | 'chevron-down' | 'chevron-left' | 'chevron-right' | 'chevron-up' | 'clipboard' | 'clock' | 'credit-card' | 'delete' | 'delivered' | 'delivery' | 'discount' | 'edit' | 'email' | 'empty' | 'external' | 'geolocation' | 'gift-card' | 'globe' | 'grid' | 'info-filled' | 'list-bulleted' | 'location' | 'lock' | 'menu-horizontal' | 'menu-vertical' | 'minus' | 'mobile' | 'organization' | 'plus' | 'profile' | 'question-circle-filled' | 'question-circle' | 'reorder' | 'return' | 'savings' | 'star-filled' | 'star-half' | 'star' | 'store' | 'truck' | 'upload' | 'x-circle-filled' | 'x-circle' | 'x'", "description": "The type of icon to be displayed in the field.", "isOptional": true }, @@ -32751,7 +34464,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -32850,7 +34563,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Content to use as the field label.", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", "isOptional": true }, { @@ -32858,7 +34571,7 @@ "syntaxKind": "PropertySignature", "name": "labelAccessibilityVisibility", "value": "'visible' | 'exclusive'", - "description": "Changes the visibility of the component's label.\n\n- `visible`: the label is visible to all users.\n- `exclusive`: the label is visually hidden but remains in the accessibility tree.", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone.\n- `exclusive`: The label is visually hidden but still announced by screen readers.", "isOptional": true, "defaultValue": "'visible'" }, @@ -32925,7 +34638,7 @@ "syntaxKind": "PropertySignature", "name": "minLength", "value": "number", - "description": "Specifies the min number of characters allowed.", + "description": "Specifies the minimum number of characters allowed.", "isOptional": true, "defaultValue": "0" }, @@ -32934,7 +34647,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -33823,7 +35536,7 @@ "syntaxKind": "PropertySignature", "name": "prefix", "value": "string", - "description": "A value to be displayed immediately before the editable portion of the field.\n\nThis is useful for displaying an implied part of the value, such as \"https://\" or \"+353\".\n\nThis cannot be edited by the user, and it isn't included in the value of the field.\n\nIt may not be displayed until the user has interacted with the input. For example, an inline label may take the place of the prefix until the user focuses the input.", + "description": "A value to be displayed immediately before the editable portion of the field.\n\nThis is useful for displaying an implied part of the value, such as \"https://\" or \"+353\".\n\nThis can't be edited by the user, and it isn't included in the value of the field.\n\nIt may not be displayed until the user has interacted with the input. For example, an inline label may take the place of the prefix until the user focuses the input.", "isOptional": true, "defaultValue": "''" }, @@ -33876,7 +35589,7 @@ "syntaxKind": "PropertySignature", "name": "readOnly", "value": "boolean", - "description": "The field cannot be edited by the user. It is focusable will be announced by screen readers.", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", "isOptional": true, "defaultValue": "false" }, @@ -33927,7 +35640,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/TextField.ts", @@ -34118,7 +35831,7 @@ "syntaxKind": "PropertySignature", "name": "suffix", "value": "string", - "description": "A value to be displayed immediately after the editable portion of the field.\n\nThis is useful for displaying an implied part of the value, such as \"@shopify.com\", or \"%\".\n\nThis cannot be edited by the user, and it isn't included in the value of the field.\n\nIt may not be displayed until the user has interacted with the input. For example, an inline label may take the place of the suffix until the user focuses the input.", + "description": "A value to be displayed immediately after the editable portion of the field.\n\nThis is useful for displaying an implied part of the value, such as \"@shopify.com\", or \"%\".\n\nThis can't be edited by the user, and it isn't included in the value of the field.\n\nIt may not be displayed until the user has interacted with the input. For example, an inline label may take the place of the suffix until the user focuses the input.", "isOptional": true, "defaultValue": "''" }, @@ -34215,7 +35928,7 @@ "syntaxKind": "PropertySignature", "name": "autocomplete", "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", "isOptional": true, "defaultValue": "'on' for everything else" }, @@ -34224,7 +35937,7 @@ "syntaxKind": "PropertySignature", "name": "defaultValue", "value": "string", - "description": "The default value for the field.", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces this value.", "isOptional": true }, { @@ -34232,7 +35945,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -34241,14 +35954,14 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { "filePath": "src/surfaces/checkout/components/TextField.ts", "syntaxKind": "PropertySignature", "name": "icon", - "value": "'' | 'cart' | 'reset' | 'map' | 'menu' | 'search' | 'circle' | 'filter' | 'image' | 'disabled' | 'info' | 'alert-circle' | 'alert-triangle-filled' | 'alert-triangle' | 'arrow-down' | 'arrow-left' | 'arrow-right' | 'arrow-up-right' | 'arrow-up' | 'bag' | 'bullet' | 'calendar' | 'camera' | 'caret-down' | 'cash-dollar' | 'categories' | 'check-circle' | 'check-circle-filled' | 'check' | 'chevron-down' | 'chevron-left' | 'chevron-right' | 'chevron-up' | 'clipboard' | 'clock' | 'credit-card' | 'delete' | 'delivered' | 'delivery' | 'discount' | 'edit' | 'email' | 'empty' | 'external' | 'geolocation' | 'gift-card' | 'globe' | 'grid' | 'info-filled' | 'list-bulleted' | 'location' | 'lock' | 'menu-horizontal' | 'menu-vertical' | 'minus' | 'mobile' | 'note' | 'order' | 'organization' | 'plus' | 'profile' | 'question-circle-filled' | 'question-circle' | 'reorder' | 'return' | 'savings' | 'settings' | 'star-filled' | 'star-half' | 'star' | 'store' | 'truck' | 'upload' | 'x-circle-filled' | 'x-circle' | 'x'", + "value": "'' | 'cart' | 'reset' | 'map' | 'menu' | 'search' | 'circle' | 'filter' | 'image' | 'note' | 'order' | 'settings' | 'disabled' | 'info' | 'alert-circle' | 'alert-triangle-filled' | 'alert-triangle' | 'arrow-down' | 'arrow-left' | 'arrow-right' | 'arrow-up-right' | 'arrow-up' | 'bag' | 'bullet' | 'calendar' | 'camera' | 'caret-down' | 'cash-dollar' | 'categories' | 'check-circle' | 'check-circle-filled' | 'check' | 'chevron-down' | 'chevron-left' | 'chevron-right' | 'chevron-up' | 'clipboard' | 'clock' | 'credit-card' | 'delete' | 'delivered' | 'delivery' | 'discount' | 'edit' | 'email' | 'empty' | 'external' | 'geolocation' | 'gift-card' | 'globe' | 'grid' | 'info-filled' | 'list-bulleted' | 'location' | 'lock' | 'menu-horizontal' | 'menu-vertical' | 'minus' | 'mobile' | 'organization' | 'plus' | 'profile' | 'question-circle-filled' | 'question-circle' | 'reorder' | 'return' | 'savings' | 'star-filled' | 'star-half' | 'star' | 'store' | 'truck' | 'upload' | 'x-circle-filled' | 'x-circle' | 'x'", "description": "The type of icon to be displayed in the field.", "isOptional": true }, @@ -34257,7 +35970,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -34265,7 +35978,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Content to use as the field label.", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", "isOptional": true }, { @@ -34273,7 +35986,7 @@ "syntaxKind": "PropertySignature", "name": "labelAccessibilityVisibility", "value": "'visible' | 'exclusive'", - "description": "Changes the visibility of the component's label.\n\n- `visible`: the label is visible to all users.\n- `exclusive`: the label is visually hidden but remains in the accessibility tree.", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone.\n- `exclusive`: The label is visually hidden but still announced by screen readers.", "isOptional": true, "defaultValue": "'visible'" }, @@ -34291,7 +36004,7 @@ "syntaxKind": "PropertySignature", "name": "minLength", "value": "number", - "description": "Specifies the min number of characters allowed.", + "description": "Specifies the minimum number of characters allowed.", "isOptional": true, "defaultValue": "0" }, @@ -34300,7 +36013,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -34316,7 +36029,7 @@ "syntaxKind": "PropertySignature", "name": "onChange", "value": "(event: Event) => void", - "description": "Callback when the user has **finished editing** a field, for example, once they have blurred the field.", + "description": "A callback fired when the user has **finished editing** a field, such as when they blur the field or press Enter.", "isOptional": true }, { @@ -34332,7 +36045,7 @@ "syntaxKind": "PropertySignature", "name": "onInput", "value": "(event: Event) => void", - "description": "Callback when the user makes any changes in the field.", + "description": "A callback fired when the user makes any changes in the field, such as typing a character.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).", "isOptional": true }, { @@ -34350,7 +36063,7 @@ "syntaxKind": "PropertySignature", "name": "prefix", "value": "string", - "description": "A value to be displayed immediately before the editable portion of the field.\n\nThis is useful for displaying an implied part of the value, such as \"https://\" or \"+353\".\n\nThis cannot be edited by the user, and it isn't included in the value of the field.\n\nIt may not be displayed until the user has interacted with the input. For example, an inline label may take the place of the prefix until the user focuses the input.", + "description": "A value to be displayed immediately before the editable portion of the field.\n\nThis is useful for displaying an implied part of the value, such as \"https://\" or \"+353\".\n\nThis can't be edited by the user, and it isn't included in the value of the field.\n\nIt may not be displayed until the user has interacted with the input. For example, an inline label may take the place of the prefix until the user focuses the input.", "isOptional": true, "defaultValue": "''" }, @@ -34359,7 +36072,7 @@ "syntaxKind": "PropertySignature", "name": "readOnly", "value": "boolean", - "description": "The field cannot be edited by the user. It is focusable will be announced by screen readers.", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", "isOptional": true, "defaultValue": "false" }, @@ -34377,7 +36090,7 @@ "syntaxKind": "PropertySignature", "name": "suffix", "value": "string", - "description": "A value to be displayed immediately after the editable portion of the field.\n\nThis is useful for displaying an implied part of the value, such as \"@shopify.com\", or \"%\".\n\nThis cannot be edited by the user, and it isn't included in the value of the field.\n\nIt may not be displayed until the user has interacted with the input. For example, an inline label may take the place of the suffix until the user focuses the input.", + "description": "A value to be displayed immediately after the editable portion of the field.\n\nThis is useful for displaying an implied part of the value, such as \"@shopify.com\", or \"%\".\n\nThis can't be edited by the user, and it isn't included in the value of the field.\n\nIt may not be displayed until the user has interacted with the input. For example, an inline label may take the place of the suffix until the user focuses the input.", "isOptional": true, "defaultValue": "''" }, @@ -34395,7 +36108,7 @@ { "filePath": "src/surfaces/checkout/components/Select.ts", "name": "SelectElementProps", - "description": "Properties for the Select component element.", + "description": "", "isPublicDocs": true, "members": [ { @@ -34403,7 +36116,7 @@ "syntaxKind": "PropertySignature", "name": "autocomplete", "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", "isOptional": true, "defaultValue": "'on' for everything else" }, @@ -34412,7 +36125,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -34421,7 +36134,7 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -34429,7 +36142,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -34437,7 +36150,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Content to use as the field label.", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", "isOptional": true }, { @@ -34445,7 +36158,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -34453,7 +36166,7 @@ "syntaxKind": "PropertySignature", "name": "placeholder", "value": "string", - "description": "A short hint that describes the expected value of the field.", + "description": "The placeholder text displayed in the field when it's empty, providing a hint about the expected input format or value.", "isOptional": true }, { @@ -34495,7 +36208,7 @@ "syntaxKind": "PropertySignature", "name": "onChange", "value": "(event: Event) => void", - "description": "Callback when the user has **finished editing** a field, for example, once they have blurred the field.", + "description": "A callback fired when the user has **finished editing** a field, such as when they blur the field or press Enter.", "isOptional": true }, { @@ -34512,7 +36225,7 @@ { "filePath": "src/surfaces/checkout/components/Select.ts", "name": "SelectElementEvents", - "description": "Events for the Select component element.", + "description": "", "isPublicDocs": true, "members": [ { @@ -34520,7 +36233,7 @@ "syntaxKind": "PropertySignature", "name": "blur", "value": "CallbackEventListener", - "description": "A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "description": "<<<<<<< HEAD A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n======= A callback fired when the select loses focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) \n Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", "isOptional": true }, { @@ -34528,7 +36241,7 @@ "syntaxKind": "PropertySignature", "name": "change", "value": "CallbackEventListener", - "description": "Callback when the user has **finished editing** a field, for example, once they have blurred the field.", + "description": "<<<<<<< HEAD Callback when the user has **finished editing** a field, for example, once they have blurred the field.\n======= A callback fired when the select value changes.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) \n Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", "isOptional": true }, { @@ -34536,11 +36249,11 @@ "syntaxKind": "PropertySignature", "name": "focus", "value": "CallbackEventListener", - "description": "A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "description": "<<<<<<< HEAD A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n======= A callback fired when the select receives focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) \n Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", "isOptional": true } ], - "value": "export interface SelectElementEvents {\n /**\n * A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event\n */\n blur?: CallbackEventListener;\n /**\n * Callback when the user has **finished editing** a field, for example, once they have blurred the field.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event\n */\n change?: CallbackEventListener;\n /**\n * A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event\n */\n focus?: CallbackEventListener;\n}" + "value": "export interface SelectElementEvents {\n /**\n<<<<<<< HEAD\n * A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n=======\n * A callback fired when the select loses focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality)\n *\n * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur?: CallbackEventListener;\n /**\n<<<<<<< HEAD\n * Callback when the user has **finished editing** a field, for example, once they have blurred the field.\n=======\n * A callback fired when the select value changes.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality)\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change?: CallbackEventListener;\n /**\n<<<<<<< HEAD\n * A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n=======\n * A callback fired when the select receives focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality)\n *\n * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus?: CallbackEventListener;\n}" }, { "filePath": "src/surfaces/checkout/components/Select.ts", @@ -34567,7 +36280,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/Select.ts", @@ -35008,7 +36721,7 @@ "syntaxKind": "PropertySignature", "name": "autocomplete", "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", "isOptional": true, "defaultValue": "'on' for everything else" }, @@ -35206,7 +36919,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -35320,7 +37033,7 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -35490,7 +37203,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -35589,7 +37302,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Content to use as the field label.", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", "isOptional": true }, { @@ -35646,7 +37359,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -36518,7 +38231,7 @@ "syntaxKind": "PropertySignature", "name": "placeholder", "value": "string", - "description": "A short hint that describes the expected value of the field.", + "description": "The placeholder text displayed in the field when it's empty, providing a hint about the expected input format or value.", "isOptional": true }, { @@ -36626,7 +38339,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/Select.ts", @@ -36905,7 +38618,7 @@ "syntaxKind": "PropertySignature", "name": "autocomplete", "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", "isOptional": true, "defaultValue": "'on' for everything else" }, @@ -36914,7 +38627,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -36923,7 +38636,7 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -36931,7 +38644,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -36939,7 +38652,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Content to use as the field label.", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", "isOptional": true }, { @@ -36947,7 +38660,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -36963,7 +38676,7 @@ "syntaxKind": "PropertySignature", "name": "onChange", "value": "(event: Event) => void", - "description": "Callback when the user has **finished editing** a field, for example, once they have blurred the field.", + "description": "A callback fired when the user has **finished editing** a field, such as when they blur the field or press Enter.", "isOptional": true }, { @@ -36979,7 +38692,7 @@ "syntaxKind": "PropertySignature", "name": "placeholder", "value": "string", - "description": "A short hint that describes the expected value of the field.", + "description": "The placeholder text displayed in the field when it's empty, providing a hint about the expected input format or value.", "isOptional": true }, { @@ -37005,7 +38718,7 @@ { "filePath": "src/surfaces/checkout/components/ClickableChip.ts", "name": "ClickableChipElementProps", - "description": "The clickable chip component displays interactive labels or categories that users can click or remove. Use clickable chip to show filter tags, selected options, or merchant-created labels that users need to interact with or dismiss.\n\nClickable chips support multiple visual variants, optional icons, and can function as both clickable buttons and removable tags for flexible interaction patterns. For non-interactive labels, use [chip](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/typography-and-content/chip).", + "description": "", "isPublicDocs": true, "members": [ { @@ -37013,7 +38726,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityLabel", "value": "string", - "description": "A label that describes the purpose or contents of the chip. It will be read to users using assistive technologies such as screen readers.", + "description": "A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.", "isOptional": true }, { @@ -37021,7 +38734,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the chip, disallowing any interaction.", + "description": "Disables the chip, preventing all user interaction including clicks and removal. Disabled chips are visually dimmed to indicate they are not interactive.", "isOptional": true, "defaultValue": "false" }, @@ -37030,7 +38743,7 @@ "syntaxKind": "PropertySignature", "name": "hidden", "value": "boolean", - "description": "Determines whether the chip is hidden.\n\nIf this property is being set on each framework render (as in 'controlled' usage), and the chip is `removable`, ensure you update app state for this property when the `remove` event fires.\n\nIf the chip is not `removable`, it can still be hidden by setting this property.", + "description": "Determines whether the chip is hidden.\n\nIf this property is being set on each framework render (as in 'controlled' usage), and the chip is `removable`, ensure you update app state for this property when the `remove` event fires.\n\nIf the chip is not `removable`, it can still be hidden by setting this property.\n\nWhen using the `removable` variant, keep `hidden` synced with your app state. If `hidden` isn't updated after the chip is removed, the chip can become permanently hidden.", "isOptional": true, "defaultValue": "false" }, @@ -37047,7 +38760,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -37055,7 +38768,7 @@ "syntaxKind": "PropertySignature", "name": "removable", "value": "boolean", - "description": "Whether the chip is removable.", + "description": "Whether the chip displays a remove button, allowing users to dismiss it. When `true`, clicking the remove button fires the `remove` event.", "isOptional": true, "defaultValue": "false" } @@ -37073,7 +38786,7 @@ "syntaxKind": "PropertySignature", "name": "onAfterHide", "value": "(event: Event) => void", - "description": "Event handler when the chip has fully hidden.\n\nThe `hidden` property will be `true` when this event fires.", + "description": "A callback fired when the chip has fully hidden after a removal animation.\n\nThe `hidden` property will be `true` when this event fires.", "isOptional": true }, { @@ -37081,7 +38794,7 @@ "syntaxKind": "PropertySignature", "name": "onClick", "value": "(event: Event) => void", - "description": "Callback when the chip is clicked.", + "description": "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).", "isOptional": true }, { @@ -37089,7 +38802,7 @@ "syntaxKind": "PropertySignature", "name": "onRemove", "value": "(event: Event) => void", - "description": "Callback when the chip is removed.", + "description": "A callback fired when the chip is removed by the user clicking the remove button.", "isOptional": true } ], @@ -37098,7 +38811,7 @@ { "filePath": "src/surfaces/checkout/components/ClickableChip.ts", "name": "ClickableChipElementEvents", - "description": "The clickable chip component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", + "description": "", "isPublicDocs": true, "members": [ { @@ -37131,7 +38844,7 @@ { "filePath": "src/surfaces/checkout/components/ClickableChip.ts", "name": "ClickableChipElementSlots", - "description": "The clickable chip component supports slots for additional content placement. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", + "description": "", "isPublicDocs": true, "members": [ { @@ -37139,11 +38852,11 @@ "syntaxKind": "PropertySignature", "name": "graphic", "value": "HTMLElement", - "description": "The graphic to display inside of the chip.\n\nOnly `s-icon` element and its `type` attribute are supported.", + "description": "An optional graphic displayed at the start of the chip, such as an icon to visually reinforce the chip's label. Only the `s-icon` element and its `type` attribute are supported.", "isOptional": true } ], - "value": "export interface ClickableChipElementSlots {\n /**\n * The graphic to display inside of the chip.\n *\n * Only `s-icon` element and its `type` attribute are supported.\n */\n graphic?: HTMLElement;\n}" + "value": "export interface ClickableChipElementSlots {\n /**\n * An optional graphic displayed at the start of the chip, such as an icon to visually reinforce the chip's label. Only the `s-icon` element and its `type` attribute are supported.\n */\n graphic?: HTMLElement;\n}" }, { "filePath": "src/surfaces/checkout/components/ClickableChip.ts", @@ -37156,7 +38869,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityLabel", "value": "string", - "description": "A label that describes the purpose or contents of the chip. It will be read to users using assistive technologies such as screen readers.", + "description": "A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.", "isOptional": true }, { @@ -37178,7 +38891,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/ClickableChip.ts", @@ -37808,7 +39521,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the chip, disallowing any interaction.", + "description": "Disables the chip, preventing all user interaction including clicks and removal. Disabled chips are visually dimmed to indicate they are not interactive.", "isOptional": true, "defaultValue": "false" }, @@ -38070,7 +39783,7 @@ "syntaxKind": "PropertySignature", "name": "hidden", "value": "boolean", - "description": "Determines whether the chip is hidden.\n\nIf this property is being set on each framework render (as in 'controlled' usage), and the chip is `removable`, ensure you update app state for this property when the `remove` event fires.\n\nIf the chip is not `removable`, it can still be hidden by setting this property.", + "description": "Determines whether the chip is hidden.\n\nIf this property is being set on each framework render (as in 'controlled' usage), and the chip is `removable`, ensure you update app state for this property when the `remove` event fires.\n\nIf the chip is not `removable`, it can still be hidden by setting this property.\n\nWhen using the `removable` variant, keep `hidden` synced with your app state. If `hidden` isn't updated after the chip is removed, the chip can become permanently hidden.", "isOptional": true, "defaultValue": "false" }, @@ -38094,7 +39807,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -39185,7 +40898,7 @@ "syntaxKind": "PropertySignature", "name": "removable", "value": "boolean", - "description": "Whether the chip is removable.", + "description": "Whether the chip displays a remove button, allowing users to dismiss it. When `true`, clicking the remove button fires the `remove` event.", "isOptional": true, "defaultValue": "false" }, @@ -39229,7 +40942,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/ClickableChip.ts", @@ -39491,7 +41204,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityLabel", "value": "string", - "description": "A label that describes the purpose or contents of the chip. It will be read to users using assistive technologies such as screen readers.", + "description": "A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.", "isOptional": true }, { @@ -39499,7 +41212,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the chip, disallowing any interaction.", + "description": "Disables the chip, preventing all user interaction including clicks and removal. Disabled chips are visually dimmed to indicate they are not interactive.", "isOptional": true, "defaultValue": "false" }, @@ -39508,7 +41221,7 @@ "syntaxKind": "PropertySignature", "name": "hidden", "value": "boolean", - "description": "Determines whether the chip is hidden.\n\nIf this property is being set on each framework render (as in 'controlled' usage), and the chip is `removable`, ensure you update app state for this property when the `remove` event fires.\n\nIf the chip is not `removable`, it can still be hidden by setting this property.", + "description": "Determines whether the chip is hidden.\n\nIf this property is being set on each framework render (as in 'controlled' usage), and the chip is `removable`, ensure you update app state for this property when the `remove` event fires.\n\nIf the chip is not `removable`, it can still be hidden by setting this property.\n\nWhen using the `removable` variant, keep `hidden` synced with your app state. If `hidden` isn't updated after the chip is removed, the chip can become permanently hidden.", "isOptional": true, "defaultValue": "false" }, @@ -39525,7 +41238,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -39533,7 +41246,7 @@ "syntaxKind": "PropertySignature", "name": "onAfterHide", "value": "(event: Event) => void", - "description": "Event handler when the chip has fully hidden.\n\nThe `hidden` property will be `true` when this event fires.", + "description": "A callback fired when the chip has fully hidden after a removal animation.\n\nThe `hidden` property will be `true` when this event fires.", "isOptional": true }, { @@ -39541,7 +41254,7 @@ "syntaxKind": "PropertySignature", "name": "onClick", "value": "(event: Event) => void", - "description": "Callback when the chip is clicked.", + "description": "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).", "isOptional": true }, { @@ -39549,7 +41262,7 @@ "syntaxKind": "PropertySignature", "name": "onRemove", "value": "(event: Event) => void", - "description": "Callback when the chip is removed.", + "description": "A callback fired when the chip is removed by the user clicking the remove button.", "isOptional": true }, { @@ -39557,7 +41270,7 @@ "syntaxKind": "PropertySignature", "name": "removable", "value": "boolean", - "description": "Whether the chip is removable.", + "description": "Whether the chip displays a remove button, allowing users to dismiss it. When `true`, clicking the remove button fires the `remove` event.", "isOptional": true, "defaultValue": "false" } @@ -39567,7 +41280,7 @@ { "filePath": "src/surfaces/checkout/components/Badge.ts", "name": "BadgeElementProps", - "description": "Properties for the Badge component element.", + "description": "", "isPublicDocs": true, "members": [ { @@ -39575,7 +41288,7 @@ "syntaxKind": "PropertySignature", "name": "color", "value": "'base' | 'subdued'", - "description": "Modify the color to be more or less intense.", + "description": "Controls the visual weight and emphasis of the badge.\n\n- `base`: Standard weight with moderate emphasis, suitable for most use cases.\n- `subdued`: Reduced visual weight for less prominent or secondary badges.", "isOptional": true, "defaultValue": "'base'" }, @@ -39584,7 +41297,7 @@ "syntaxKind": "PropertySignature", "name": "icon", "value": "'' | ReducedIconTypes", - "description": "The type of icon to be displayed in the badge.", + "description": "An icon displayed inside the badge to provide additional visual context or reinforce the badge's meaning. Set to an empty string to display no icon.", "isOptional": true, "defaultValue": "''" }, @@ -39593,7 +41306,7 @@ "syntaxKind": "PropertySignature", "name": "iconPosition", "value": "'start' | 'end'", - "description": "The position of the icon in relation to the text.", + "description": "The position of the icon relative to the badge text.\n\n- `start`: Places the icon before the text.\n- `end`: Places the icon after the text.", "isOptional": true }, { @@ -39601,7 +41314,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -39609,7 +41322,7 @@ "syntaxKind": "PropertySignature", "name": "size", "value": "'small' | 'small-100' | 'base'", - "description": "Adjusts the size.", + "description": "The size of the badge.\n\n- `base`: The default size, suitable for most use cases.\n- `small`: A smaller badge for compact layouts.\n- `small-100`: The smallest badge for tight spaces or dense lists.", "isOptional": true, "defaultValue": "'base'" }, @@ -39618,12 +41331,12 @@ "syntaxKind": "PropertySignature", "name": "tone", "value": "'auto' | 'neutral' | 'critical'", - "description": "Sets the tone of the Badge, based on the intention of the information being conveyed.", + "description": "The semantic meaning and color treatment of the badge.\n\n- `auto`: Automatically determined based on context.\n- `neutral`: General information without specific intent.\n- `critical`: Urgent problems or destructive actions.", "isOptional": true, "defaultValue": "'auto'" } ], - "value": "export interface BadgeElementProps extends Pick {\n size?: Extract;\n tone?: Extract;\n color?: Extract;\n icon?: '' | ReducedIconTypes;\n}" + "value": "export interface BadgeElementProps extends Pick {\n /**\n * The size of the badge.\n *\n * - `base`: The default size, suitable for most use cases.\n * - `small`: A smaller badge for compact layouts.\n * - `small-100`: The smallest badge for tight spaces or dense lists.\n *\n * @default 'base'\n */\n size?: Extract;\n /**\n * The semantic meaning and color treatment of the badge.\n *\n * - `auto`: Automatically determined based on context.\n * - `neutral`: General information without specific intent.\n * - `critical`: Urgent problems or destructive actions.\n *\n * @default 'auto'\n */\n tone?: Extract;\n /**\n * Controls the visual weight and emphasis of the badge.\n *\n * - `base`: Standard weight with moderate emphasis, suitable for most use cases.\n * - `subdued`: Reduced visual weight for less prominent or secondary badges.\n *\n * @default 'base'\n */\n color?: Extract;\n /**\n * An icon displayed inside the badge to provide additional visual context or reinforce the badge's meaning. Set to an empty string to display no icon.\n *\n * @default ''\n */\n icon?: '' | ReducedIconTypes;\n /**\n * The position of the icon relative to the badge text.\n *\n * - `start`: Places the icon before the text.\n * - `end`: Places the icon after the text.\n */\n iconPosition?: BadgeProps$1['iconPosition'];\n}" }, { "filePath": "src/surfaces/checkout/components/Badge.ts", @@ -39650,7 +41363,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/Badge.ts", @@ -40224,7 +41937,7 @@ "syntaxKind": "PropertySignature", "name": "color", "value": "'base' | 'subdued'", - "description": "Modify the color to be more or less intense.", + "description": "Controls the visual weight and emphasis of the badge.\n\n- `base`: Standard weight with moderate emphasis, suitable for most use cases.\n- `subdued`: Reduced visual weight for less prominent or secondary badges.", "isOptional": true, "defaultValue": "'base'" }, @@ -40556,15 +42269,16 @@ "syntaxKind": "PropertySignature", "name": "icon", "value": "'' | ReducedIconTypes", - "description": "The type of icon to be displayed in the badge.", - "isOptional": true + "description": "An icon displayed inside the badge to provide additional visual context or reinforce the badge's meaning. Set to an empty string to display no icon.", + "isOptional": true, + "defaultValue": "''" }, { "filePath": "src/surfaces/checkout/components/Badge.ts", "syntaxKind": "PropertySignature", "name": "iconPosition", "value": "'start' | 'end'", - "description": "The position of the icon in relation to the text.", + "description": "The position of the icon relative to the badge text.\n\n- `start`: Places the icon before the text.\n- `end`: Places the icon after the text.", "isOptional": true }, { @@ -40572,7 +42286,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -41684,7 +43398,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/Badge.ts", @@ -41845,7 +43559,7 @@ "syntaxKind": "PropertySignature", "name": "size", "value": "'small' | 'small-100' | 'base'", - "description": "Adjusts the size.", + "description": "The size of the badge.\n\n- `base`: The default size, suitable for most use cases.\n- `small`: A smaller badge for compact layouts.\n- `small-100`: The smallest badge for tight spaces or dense lists.", "isOptional": true, "defaultValue": "'base'" }, @@ -41924,7 +43638,7 @@ "syntaxKind": "PropertySignature", "name": "tone", "value": "'auto' | 'neutral' | 'critical'", - "description": "Sets the tone of the Badge, based on the intention of the information being conveyed.", + "description": "The semantic meaning and color treatment of the badge.\n\n- `auto`: Automatically determined based on context.\n- `neutral`: General information without specific intent.\n- `critical`: Urgent problems or destructive actions.", "isOptional": true, "defaultValue": "'auto'" }, @@ -41964,7 +43678,7 @@ "syntaxKind": "PropertySignature", "name": "color", "value": "'base' | 'subdued'", - "description": "Modify the color to be more or less intense.", + "description": "Controls the visual weight and emphasis of the badge.\n\n- `base`: Standard weight with moderate emphasis, suitable for most use cases.\n- `subdued`: Reduced visual weight for less prominent or secondary badges.", "isOptional": true, "defaultValue": "'base'" }, @@ -41973,15 +43687,16 @@ "syntaxKind": "PropertySignature", "name": "icon", "value": "'' | ReducedIconTypes", - "description": "The type of icon to be displayed in the badge.", - "isOptional": true + "description": "An icon displayed inside the badge to provide additional visual context or reinforce the badge's meaning. Set to an empty string to display no icon.", + "isOptional": true, + "defaultValue": "''" }, { "filePath": "src/surfaces/checkout/components/Badge.ts", "syntaxKind": "PropertySignature", "name": "iconPosition", "value": "'start' | 'end'", - "description": "The position of the icon in relation to the text.", + "description": "The position of the icon relative to the badge text.\n\n- `start`: Places the icon before the text.\n- `end`: Places the icon after the text.", "isOptional": true }, { @@ -41989,7 +43704,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -41997,7 +43712,7 @@ "syntaxKind": "PropertySignature", "name": "size", "value": "'small' | 'small-100' | 'base'", - "description": "Adjusts the size.", + "description": "The size of the badge.\n\n- `base`: The default size, suitable for most use cases.\n- `small`: A smaller badge for compact layouts.\n- `small-100`: The smallest badge for tight spaces or dense lists.", "isOptional": true, "defaultValue": "'base'" }, @@ -42006,7 +43721,7 @@ "syntaxKind": "PropertySignature", "name": "tone", "value": "'auto' | 'neutral' | 'critical'", - "description": "Sets the tone of the Badge, based on the intention of the information being conveyed.", + "description": "The semantic meaning and color treatment of the badge.\n\n- `auto`: Automatically determined based on context.\n- `neutral`: General information without specific intent.\n- `critical`: Urgent problems or destructive actions.", "isOptional": true, "defaultValue": "'auto'" } @@ -42016,7 +43731,7 @@ { "filePath": "src/surfaces/checkout/components/Spinner.ts", "name": "SpinnerElementProps", - "description": "Properties for the Spinner component element.", + "description": "", "isPublicDocs": true, "members": [ { @@ -42024,7 +43739,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityLabel", "value": "string", - "description": "A label that describes the purpose of the progress. When set, it will be announced to users using assistive technologies and will provide them with more context. Providing an `accessibilityLabel` is recommended if there is no accompanying text describing that something is loading.", + "description": "A label that describes the purpose of the spinner for assistive technologies like screen readers. Provide an `accessibilityLabel` when there is no visible text that conveys a loading state.", "isOptional": true }, { @@ -42032,7 +43747,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -42040,12 +43755,12 @@ "syntaxKind": "PropertySignature", "name": "size", "value": "'small' | 'large' | 'small-100' | 'base' | 'large-100'", - "description": "Adjusts the size of the spinner icon.", + "description": "The size of the spinner icon.\n\n- `base`: The default size, suitable for most use cases.\n- `small`: A compact size for secondary loading states.\n- `small-100`: The smallest size for tight spaces or inline indicators.\n- `large`: A larger size for more prominent loading states.\n- `large-100`: The largest size for full-page or section-level loading indicators.", "isOptional": true, "defaultValue": "'base'" } ], - "value": "export interface SpinnerElementProps extends SpinnerProps$1 {\n size?: Extract;\n}" + "value": "export interface SpinnerElementProps extends SpinnerProps$1 {\n /**\n * A label that describes the purpose of the spinner for assistive technologies like screen readers. Provide an `accessibilityLabel` when there is no visible text that conveys a loading state.\n */\n accessibilityLabel?: SpinnerProps$1['accessibilityLabel'];\n /**\n * The size of the spinner icon.\n *\n * - `base`: The default size, suitable for most use cases.\n * - `small`: A compact size for secondary loading states.\n * - `small-100`: The smallest size for tight spaces or inline indicators.\n * - `large`: A larger size for more prominent loading states.\n * - `large-100`: The largest size for full-page or section-level loading indicators.\n *\n * @default 'base'\n */\n size?: Extract;\n}" }, { "filePath": "src/surfaces/checkout/components/Spinner.ts", @@ -42058,7 +43773,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityLabel", "value": "string", - "description": "A label that describes the purpose of the progress. When set, it will be announced to users using assistive technologies and will provide them with more context. Providing an `accessibilityLabel` is recommended if there is no accompanying text describing that something is loading.", + "description": "A label that describes the purpose of the spinner for assistive technologies like screen readers. Provide an `accessibilityLabel` when there is no visible text that conveys a loading state.", "isOptional": true }, { @@ -42080,7 +43795,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/Spinner.ts", @@ -42977,7 +44692,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -44089,7 +45804,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/Spinner.ts", @@ -44250,7 +45965,7 @@ "syntaxKind": "PropertySignature", "name": "size", "value": "'small' | 'large' | 'small-100' | 'base' | 'large-100'", - "description": "Adjusts the size of the spinner icon.", + "description": "The size of the spinner icon.\n\n- `base`: The default size, suitable for most use cases.\n- `small`: A compact size for secondary loading states.\n- `small-100`: The smallest size for tight spaces or inline indicators.\n- `large`: A larger size for more prominent loading states.\n- `large-100`: The largest size for full-page or section-level loading indicators.", "isOptional": true, "defaultValue": "'base'" }, @@ -44360,7 +46075,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityLabel", "value": "string", - "description": "A label that describes the purpose of the progress. When set, it will be announced to users using assistive technologies and will provide them with more context. Providing an `accessibilityLabel` is recommended if there is no accompanying text describing that something is loading.", + "description": "A label that describes the purpose of the spinner for assistive technologies like screen readers. Provide an `accessibilityLabel` when there is no visible text that conveys a loading state.", "isOptional": true }, { @@ -44368,7 +46083,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -44376,7 +46091,7 @@ "syntaxKind": "PropertySignature", "name": "size", "value": "'small' | 'large' | 'small-100' | 'base' | 'large-100'", - "description": "Adjusts the size of the spinner icon.", + "description": "The size of the spinner icon.\n\n- `base`: The default size, suitable for most use cases.\n- `small`: A compact size for secondary loading states.\n- `small-100`: The smallest size for tight spaces or inline indicators.\n- `large`: A larger size for more prominent loading states.\n- `large-100`: The largest size for full-page or section-level loading indicators.", "isOptional": true, "defaultValue": "'base'" } @@ -44386,7 +46101,7 @@ { "filePath": "src/surfaces/checkout/components/Tooltip.ts", "name": "TooltipElementProps", - "description": "Properties for the Tooltip component element.", + "description": "", "isPublicDocs": true, "members": [ { @@ -44394,7 +46109,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true } ], @@ -44411,7 +46126,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true } ], @@ -44420,7 +46135,7 @@ { "filePath": "src/surfaces/checkout/components/Tooltip.ts", "name": "TooltipProps", - "description": "The properties for the tooltip component when it's used in JSX.", + "description": "", "isPublicDocs": true, "members": [ { @@ -44428,7 +46143,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true } ], @@ -44437,7 +46152,7 @@ { "filePath": "src/surfaces/checkout/components/Chip.ts", "name": "ChipElementProps", - "description": "Properties for the Chip component element.", + "description": "", "isPublicDocs": true, "members": [ { @@ -44445,7 +46160,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityLabel", "value": "string", - "description": "A label that describes the purpose or contents of the chip. It will be read to users using assistive technologies such as screen readers.", + "description": "A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.", "isOptional": true }, { @@ -44453,7 +46168,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true } ], @@ -44462,7 +46177,7 @@ { "filePath": "src/surfaces/checkout/components/Chip.ts", "name": "ChipElementSlots", - "description": "Slots for the Chip component element.", + "description": "", "isPublicDocs": true, "members": [ { @@ -44470,11 +46185,11 @@ "syntaxKind": "PropertySignature", "name": "graphic", "value": "HTMLElement", - "description": "The graphic to display inside of the chip.\n\nOnly `s-icon` element and its `type` attribute are supported.", + "description": "An optional graphic displayed at the start of the chip, such as an icon to visually reinforce the chip's label. Only the `s-icon` element and its `type` attribute are supported.", "isOptional": true } ], - "value": "export interface ChipElementSlots {\n /**\n * The graphic to display inside of the chip.\n *\n * Only `s-icon` element and its `type` attribute are supported.\n */\n graphic?: HTMLElement;\n}" + "value": "export interface ChipElementSlots {\n /**\n * An optional graphic displayed at the start of the chip, such as an icon to visually reinforce the chip's label. Only the `s-icon` element and its `type` attribute are supported.\n */\n graphic?: HTMLElement;\n}" }, { "filePath": "src/surfaces/checkout/components/Chip.ts", @@ -44487,7 +46202,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityLabel", "value": "string", - "description": "A label that describes the purpose or contents of the chip. It will be read to users using assistive technologies such as screen readers.", + "description": "A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.", "isOptional": true }, { @@ -44495,7 +46210,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true } ], @@ -44512,7 +46227,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityLabel", "value": "string", - "description": "A label that describes the purpose or contents of the chip. It will be read to users using assistive technologies such as screen readers.", + "description": "A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.", "isOptional": true }, { @@ -44534,7 +46249,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/Chip.ts", @@ -45431,7 +47146,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -46543,7 +48258,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/Chip.ts", @@ -46797,7 +48512,7 @@ { "filePath": "src/surfaces/checkout/components/UnorderedList.ts", "name": "UnorderedListElementProps", - "description": "Properties for the UnorderedList component element.", + "description": "", "isPublicDocs": true, "members": [ { @@ -46805,7 +48520,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true } ], @@ -46836,7 +48551,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/UnorderedList.ts", @@ -47733,7 +49448,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -48845,7 +50560,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/UnorderedList.ts", @@ -49107,7 +50822,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true } ], @@ -49116,7 +50831,7 @@ { "filePath": "src/surfaces/checkout/components/OrderedList.ts", "name": "OrderedListElementProps", - "description": "Properties for the OrderedList component element.", + "description": "", "isPublicDocs": true, "members": [ { @@ -49124,7 +50839,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true } ], @@ -49155,7 +50870,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/OrderedList.ts", @@ -50052,7 +51767,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -50929,2099 +52644,508 @@ "isOptional": true }, { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ontouchstart", - "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchstart_event)", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ontransitioncancel", - "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitioncancel_event)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ontransitionend", - "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ontransitionrun", - "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionrun_event)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ontransitionstart", - "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionstart_event)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onvolumechange", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/volumechange_event)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onwaiting", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/waiting_event)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onwebkitanimationend", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "", - "deprecationMessage": "This is a legacy alias of `onanimationend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onwebkitanimationiteration", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "", - "deprecationMessage": "This is a legacy alias of `onanimationiteration`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onwebkitanimationstart", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "", - "deprecationMessage": "This is a legacy alias of `onanimationstart`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onwebkittransitionend", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "", - "deprecationMessage": "This is a legacy alias of `ontransitionend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onwheel", - "value": "((this: GlobalEventHandlers, ev: WheelEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/wheel_event)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "outerHTML", - "value": "string", - "description": "The **`outerHTML`** attribute of the Element DOM interface gets the serialized HTML fragment describing the element including its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/outerHTML)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "outerText", - "value": "string", - "description": "The **`outerText`** property of the HTMLElement interface returns the same value as HTMLElement.innerText.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/outerText)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ownerDocument", - "value": "Document", - "description": "The read-only **`ownerDocument`** property of the Node interface returns the top-level document object of the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/ownerDocument)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "parentElement", - "value": "HTMLElement | null", - "description": "The read-only **`parentElement`** property of Node interface returns the DOM node's parent Element, or `null` if the node either has no parent, or its parent isn't a DOM Element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentElement)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "parentNode", - "value": "ParentNode | null", - "description": "The read-only **`parentNode`** property of the Node interface returns the parent of the specified node in the DOM tree.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentNode)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "GetAccessor", - "name": "part", - "value": "DOMTokenList", - "description": "The **`part`** property of the Element interface represents the part identifier(s) of the element (i.e., set using the `part` attribute), returned as a DOMTokenList.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/part)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "popover", - "value": "string | null", - "description": "The **`popover`** property of the HTMLElement interface gets and sets an element's popover state via JavaScript (`'auto'`, `'hint'`, or `'manual'`), and can be used for feature detection.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/popover)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "prefix", - "value": "string | null", - "description": "The **`Element.prefix`** read-only property returns the namespace prefix of the specified element, or `null` if no prefix is specified.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/prefix)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "MethodSignature", - "name": "prepend", - "value": "(...nodes: (string | Node)[]) => void", - "description": "Inserts nodes before the first child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/prepend)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "previousElementSibling", - "value": "Element | null", - "description": "Returns the first preceding sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/previousElementSibling)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "previousSibling", - "value": "ChildNode | null", - "description": "The read-only **`previousSibling`** property of the Node interface returns the node immediately preceding the specified one in its parent's or `null` if the specified node is the first in that list.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/previousSibling)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "PROCESSING_INSTRUCTION_NODE", - "value": "7", - "description": "node is a ProcessingInstruction node." - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "MethodSignature", - "name": "querySelector", - "value": "{ (selectors: K): HTMLElementTagNameMap[K]; (selectors: K): SVGElementTagNameMap[K]; (selectors: K): MathMLElementTagNameMap[K]; (selectors: K): HTMLElementDeprecatedTagNameMap[K]; (selectors: string): E; }", - "description": "Returns the first element that is a descendant of node that matches selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelector)", - "deprecationMessage": "Deprecated" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "MethodSignature", - "name": "querySelectorAll", - "value": "{ (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: string): NodeListOf; }", - "description": "Returns all element descendants of node that match selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelectorAll)", - "deprecationMessage": "Deprecated" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "MethodSignature", - "name": "releasePointerCapture", - "value": "(pointerId: number) => void", - "description": "The **`releasePointerCapture()`** method of the previously set for a specific (PointerEvent) _pointer_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/releasePointerCapture)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "MethodSignature", - "name": "remove", - "value": "() => void", - "description": "Removes node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/remove)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "MethodSignature", - "name": "removeAttribute", - "value": "(qualifiedName: string) => void", - "description": "The Element method **`removeAttribute()`** removes the attribute with the specified name from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttribute)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "MethodSignature", - "name": "removeAttributeNode", - "value": "(attr: Attr) => Attr", - "description": "The **`removeAttributeNode()`** method of the Element interface removes the specified Attr node from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNode)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "MethodSignature", - "name": "removeAttributeNS", - "value": "(namespace: string, localName: string) => void", - "description": "The **`removeAttributeNS()`** method of the If you are working with HTML and you don't need to specify the requested attribute as being part of a specific namespace, use the Element.removeAttribute() method instead.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNS)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "MethodSignature", - "name": "removeChild", - "value": "(child: T) => T", - "description": "The **`removeChild()`** method of the Node interface removes a child node from the DOM and returns the removed node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/removeChild)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "MethodSignature", - "name": "removeEventListener", - "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "MethodSignature", - "name": "replaceChild", - "value": "(node: Node, child: T) => T", - "description": "The **`replaceChild()`** method of the Node interface replaces a child node within the given (parent) node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/replaceChild)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "MethodSignature", - "name": "replaceChildren", - "value": "(...nodes: (string | Node)[]) => void", - "description": "Replace all children of node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/replaceChildren)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "MethodSignature", - "name": "replaceWith", - "value": "(...nodes: (string | Node)[]) => void", - "description": "Replaces node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/replaceWith)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "MethodSignature", - "name": "requestFullscreen", - "value": "(options?: FullscreenOptions) => Promise", - "description": "The **`Element.requestFullscreen()`** method issues an asynchronous request to make the element be displayed in fullscreen mode.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestFullscreen)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "MethodSignature", - "name": "requestPointerLock", - "value": "(options?: PointerLockOptions) => Promise", - "description": "The **`requestPointerLock()`** method of the Element interface lets you asynchronously ask for the pointer to be locked on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestPointerLock)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "role", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/role)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "MethodSignature", - "name": "scroll", - "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", - "description": "The **`scroll()`** method of the Element interface scrolls the element to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scroll)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "MethodSignature", - "name": "scrollBy", - "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", - "description": "The **`scrollBy()`** method of the Element interface scrolls an element by the given amount.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollBy)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "scrollHeight", - "value": "number", - "description": "The **`scrollHeight`** read-only property of the Element interface is a measurement of the height of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollHeight)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "MethodSignature", - "name": "scrollIntoView", - "value": "(arg?: boolean | ScrollIntoViewOptions) => void", - "description": "The Element interface's **`scrollIntoView()`** method scrolls the element's ancestor containers such that the element on which `scrollIntoView()` is called is visible to the user.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollIntoView)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "scrollLeft", - "value": "number", - "description": "The **`scrollLeft`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its left edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollLeft)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "MethodSignature", - "name": "scrollTo", - "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", - "description": "The **`scrollTo()`** method of the Element interface scrolls to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTo)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "scrollTop", - "value": "number", - "description": "The **`scrollTop`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its top edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTop)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "scrollWidth", - "value": "number", - "description": "The **`scrollWidth`** read-only property of the Element interface is a measurement of the width of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollWidth)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "MethodSignature", - "name": "setAttribute", - "value": "(qualifiedName: string, value: string) => void", - "description": "The **`setAttribute()`** method of the Element interface sets the value of an attribute on the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttribute)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "MethodSignature", - "name": "setAttributeNode", - "value": "(attr: Attr) => Attr", - "description": "The **`setAttributeNode()`** method of the Element interface adds a new Attr node to the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNode)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "MethodSignature", - "name": "setAttributeNodeNS", - "value": "(attr: Attr) => Attr", - "description": "The **`setAttributeNodeNS()`** method of the Element interface adds a new namespaced Attr node to an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNodeNS)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "MethodSignature", - "name": "setAttributeNS", - "value": "(namespace: string, qualifiedName: string, value: string) => void", - "description": "`setAttributeNS` adds a new attribute or changes the value of an attribute with the given namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNS)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "MethodSignature", - "name": "setHTMLUnsafe", - "value": "(html: string) => void", - "description": "The **`setHTMLUnsafe()`** method of the Element interface is used to parse a string of HTML into a DocumentFragment, optionally filtering out unwanted elements and attributes, and those that don't belong in the context, and then using it to replace the element's subtree in the DOM.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setHTMLUnsafe)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "MethodSignature", - "name": "setPointerCapture", - "value": "(pointerId: number) => void", - "description": "The **`setPointerCapture()`** method of the _capture target_ of future pointer events.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setPointerCapture)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "shadowRoot", - "value": "ShadowRoot | null", - "description": "The `Element.shadowRoot` read-only property represents the shadow root hosted by the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/shadowRoot)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "MethodSignature", - "name": "showPopover", - "value": "() => void", - "description": "The **`showPopover()`** method of the HTMLElement interface shows a Popover_API element (i.e., one that has a valid `popover` attribute) by adding it to the top layer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/showPopover)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "slot", - "value": "string", - "description": "The **`slot`** property of the Element interface returns the name of the shadow DOM slot the element is inserted in.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/slot)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "spellcheck", - "value": "boolean", - "description": "The **`spellcheck`** property of the HTMLElement interface represents a boolean value that controls the spell-checking hint.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/spellcheck)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "GetAccessor", - "name": "style", - "value": "CSSStyleDeclaration", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/style)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "tabIndex", - "value": "number", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/tabIndex)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "tagName", - "value": "string", - "description": "The **`tagName`** read-only property of the Element interface returns the tag name of the element on which it's called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/tagName)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "TEXT_NODE", - "value": "3", - "description": "node is a Text node." - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "GetAccessor", - "name": "textContent", - "value": "string", - "description": "[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/Node/textContent)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The **`HTMLElement.title`** property represents the title of the element: the text usually displayed in a 'tooltip' popup when the mouse is over the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/title)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "MethodSignature", - "name": "toggleAttribute", - "value": "(qualifiedName: string, force?: boolean) => boolean", - "description": "The **`toggleAttribute()`** method of the present and adding it if it is not present) on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/toggleAttribute)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "MethodSignature", - "name": "togglePopover", - "value": "(options?: boolean) => boolean", - "description": "The **`togglePopover()`** method of the HTMLElement interface toggles a Popover_API element (i.e., one that has a valid `popover` attribute) between the hidden and showing states.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/togglePopover)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "translate", - "value": "boolean", - "description": "The **`translate`** property of the HTMLElement interface indicates whether an element's attribute values and the values of its Text node children are to be translated when the page is localized, or whether to leave them unchanged.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/translate)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "MethodSignature", - "name": "webkitMatchesSelector", - "value": "(selectors: string) => boolean", - "description": "", - "deprecationMessage": "This is a legacy alias of `matches`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "writingSuggestions", - "value": "string", - "description": "The **`writingSuggestions`** property of the HTMLElement interface is a string indicating if browser-provided writing suggestions should be enabled under the scope of the element or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/writingSuggestions)" - } - ], - "value": "export interface OrderedListElement extends OrderedListElementProps, Omit {\n}" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "name": "OrderedListProps", - "description": "", - "isPublicDocs": true, - "members": [ - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the element.", - "isOptional": true - } - ], - "value": "export interface OrderedListProps extends OrderedListElementProps {\n}" - }, - { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "name": "Docs_OrderStatus_MetafieldsApi", - "description": "", - "isPublicDocs": true, - "members": [ - { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "syntaxKind": "PropertySignature", - "name": "appMetafields", - "value": "SubscribableSignalLike", - "description": "The [metafields](/docs/apps/build/custom-data/metafields) requested in the [`shopify.extension.toml`](/docs/api/customer-account-ui-extensions/latest#configuration) file. Metafields are custom data fields that store additional information on Shopify resources such as products, variants, customers, and the shop. These metafields are updated when there's a change in the merchandise items being purchased by the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when accessing metafields attached to `customer`, `company`, or `companyLocation` resources." - }, - { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "SubscribableSignalLike", - "description": "The [metafields](/docs/apps/build/custom-data/metafields) associated with the order. These metafields are shared across all extensions and persist throughout the checkout session.", - "deprecationMessage": "Use `appMetafields` instead, which provides richer data including the resource type and metafield content type." - } - ], - "value": "export interface Docs_OrderStatus_MetafieldsApi\n extends Pick, 'appMetafields' | 'metafields'> {}" - }, - { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "name": "Docs_OrderStatus_AttributesApi", - "description": "", - "isPublicDocs": true, - "members": [ - { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "SubscribableSignalLike", - "description": "The custom key-value pairs attached to the order by the customer or by other extensions during cart or checkout. These are commonly used for delivery instructions, gift messages, or other information the buyer provides. The value is `undefined` if no attributes were set." - } - ], - "value": "export interface Docs_OrderStatus_AttributesApi\n extends Pick, 'attributes'> {}" - }, - { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "name": "Docs_OrderStatus_BuyerIdentityApi", - "description": "", - "isPublicDocs": true, - "members": [ - { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "syntaxKind": "PropertySignature", - "name": "buyerIdentity", - "value": "OrderStatusBuyerIdentity", - "description": "The buyer who placed the order, including their customer account, email, phone number, and B2B purchasing company. Use this to personalize the **Order status** page or identify B2B orders.", - "isOptional": true - } - ], - "value": "export interface Docs_OrderStatus_BuyerIdentityApi\n extends Pick, 'buyerIdentity'> {}" - }, - { - "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", - "name": "OrderStatusBuyerIdentity", - "description": "Information about the buyer who placed the order.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data). The `customer` and `purchasingCompany` properties require level 1 access. The `email` and `phone` properties require level 2 access.", - "members": [ - { - "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", - "syntaxKind": "PropertySignature", - "name": "customer", - "value": "SubscribableSignalLike", - "description": "The buyer's customer account, including their ID and whether they have accepted marketing. The value is `undefined` if the buyer is a guest or hasn't logged in yet." - }, - { - "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", - "syntaxKind": "PropertySignature", - "name": "email", - "value": "SubscribableSignalLike", - "description": "The email address associated with the order. This is the email the buyer provided during checkout for order confirmation and communication. The value is `undefined` if the app doesn't have access to customer data." - }, - { - "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "SubscribableSignalLike", - "description": "The phone number the buyer provided during checkout. The value is `undefined` if no phone number was provided or the app doesn't have access to customer data." - }, - { - "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", - "syntaxKind": "PropertySignature", - "name": "purchasingCompany", - "value": "SubscribableSignalLike<\n OrderStatusPurchasingCompany | undefined\n >", - "description": "The company and company location that a B2B (business-to-business) customer is purchasing on behalf of. Use this to identify the business context of the order. The value is `undefined` if the buyer isn't a B2B customer." - } - ], - "value": "export interface OrderStatusBuyerIdentity {\n /**\n * The buyer's customer account, including their ID and whether they have accepted marketing.\n * The value is `undefined` if the buyer is a guest or hasn't logged in yet.\n */\n customer: SubscribableSignalLike;\n\n /**\n * The email address associated with the order. This is the email the buyer provided during\n * checkout for order confirmation and communication. The value is `undefined` if the app\n * doesn't have access to customer data.\n */\n email: SubscribableSignalLike;\n\n /**\n * The phone number the buyer provided during checkout. The value is `undefined` if no phone\n * number was provided or the app doesn't have access to customer data.\n */\n phone: SubscribableSignalLike;\n\n /**\n * The company and company location that a B2B (business-to-business) customer is purchasing\n * on behalf of. Use this to identify the business context of the order. The value is\n * `undefined` if the buyer isn't a B2B customer.\n */\n purchasingCompany: SubscribableSignalLike<\n OrderStatusPurchasingCompany | undefined\n >;\n}" - }, - { - "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", - "name": "OrderStatusCustomer", - "description": "Information about a customer who has previously purchased from this shop.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data). The `id`, `image`, `acceptsMarketing`, and `storeCreditAccounts` properties require level 1 access. The `email`, `phone`, `fullName`, `firstName`, and `lastName` properties require level 2 access.", - "members": [ - { - "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", - "syntaxKind": "PropertySignature", - "name": "acceptsMarketing", - "value": "boolean", - "description": "Whether the customer has opted in to receiving marketing communications from the merchant, such as email campaigns and promotional offers." - }, - { - "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", - "syntaxKind": "PropertySignature", - "name": "email", - "value": "string", - "description": "The email address associated with the customer's account. The value is `undefined` if the app doesn't have the required access level.", - "isOptional": true - }, - { - "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The customer's first name. The value is `undefined` if the app doesn't have the required access level.", - "isOptional": true - }, - { - "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", - "syntaxKind": "PropertySignature", - "name": "fullName", - "value": "string", - "description": "The customer's full name, typically a combination of first and last name. The value is `undefined` if the app doesn't have the required access level.", - "isOptional": true - }, - { - "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier for the customer in the format `gid://shopify/Customer/`. 'gid://shopify/Customer/123'" - }, - { - "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", - "syntaxKind": "PropertySignature", - "name": "image", - "value": "ImageDetails", - "description": "The customer's profile image, such as a Gravatar avatar. Use this to personalize the extension UI for the logged-in buyer." - }, - { - "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The customer's last name. The value is `undefined` if the app doesn't have the required access level.", - "isOptional": true - }, - { - "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The phone number associated with the customer's account. The value is `undefined` if no phone number is on file or the app doesn't have the required access level.", - "isOptional": true - }, - { - "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", - "syntaxKind": "PropertySignature", - "name": "storeCreditAccounts", - "value": "StoreCreditAccount[]", - "description": "The store credit accounts owned by this customer that can be used as payment during checkout. Each account has a balance representing available store credit.", - "isPrivate": true - } - ], - "value": "export interface OrderStatusCustomer {\n /**\n * A globally-unique identifier for the customer in the format `gid://shopify/Customer/`. 'gid://shopify/Customer/123'\n */\n id: string;\n /**\n * The email address associated with the customer's account. The value is `undefined` if the app doesn't have the required access level.\n */\n email?: string;\n /**\n * The phone number associated with the customer's account. The value is `undefined` if no phone number is on file or the app doesn't have the required access level.\n */\n phone?: string;\n /**\n * The customer's full name, typically a combination of first and last name. The value is `undefined` if the app doesn't have the required access level.\n */\n fullName?: string;\n /**\n * The customer's first name. The value is `undefined` if the app doesn't have the required access level.\n */\n firstName?: string;\n /**\n * The customer's last name. The value is `undefined` if the app doesn't have the required access level.\n */\n lastName?: string;\n /**\n * The customer's profile image, such as a Gravatar avatar. Use this to personalize the extension UI for the logged-in buyer.\n */\n image: ImageDetails;\n /**\n * Whether the customer has opted in to receiving marketing communications from the merchant, such as email campaigns and promotional offers.\n */\n acceptsMarketing: boolean;\n /**\n * The store credit accounts owned by this customer that can be used as payment during checkout. Each account has a balance representing available store credit.\n *\n * @private\n */\n storeCreditAccounts: StoreCreditAccount[];\n}" - }, - { - "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", - "name": "OrderStatusPurchasingCompany", - "description": "Information about a company that the business customer is purchasing on behalf of.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "members": [ - { - "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "OrderStatusCompany", - "description": "The company that the B2B customer is purchasing on behalf of, including the company ID, name, and optional external ID." - }, - { - "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", - "syntaxKind": "PropertySignature", - "name": "location", - "value": "OrderStatusCompanyLocation", - "description": "The specific company location where the order is being placed, including the location ID, name, and optional external ID." - } - ], - "value": "export interface OrderStatusPurchasingCompany {\n /**\n * The company that the B2B customer is purchasing on behalf of, including the company ID, name, and optional external ID.\n */\n company: OrderStatusCompany;\n /**\n * The specific company location where the order is being placed, including the location ID, name, and optional external ID.\n */\n location: OrderStatusCompanyLocation;\n}" - }, - { - "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", - "name": "OrderStatusCompany", - "description": "{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "members": [ - { - "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", - "syntaxKind": "PropertySignature", - "name": "externalId", - "value": "string", - "description": "A merchant-defined external identifier for the company, often used to map to an ID in an external ERP or CRM system. The value is `undefined` if no external ID has been set.", - "isOptional": true - }, - { - "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier for the company in the format `gid://shopify/Company/`." - }, - { - "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The registered business name of the company, as configured by the merchant in Shopify admin." - } - ], - "value": "export interface OrderStatusCompany {\n /**\n * A globally-unique identifier for the company in the format `gid://shopify/Company/`.\n */\n id: string;\n /**\n * The registered business name of the company, as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * A merchant-defined external identifier for the company, often used to map to an ID in an external ERP or CRM system. The value is `undefined` if no external ID has been set.\n */\n externalId?: string;\n}" - }, - { - "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", - "name": "OrderStatusCompanyLocation", - "description": "{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "members": [ - { - "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", - "syntaxKind": "PropertySignature", - "name": "externalId", - "value": "string", - "description": "A merchant-defined external identifier for the company location, often used to map to an ID in an external ERP or CRM system. The value is `undefined` if no external ID has been set.", - "isOptional": true - }, - { - "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier for the company location in the format `gid://shopify/CompanyLocation/`." - }, - { - "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The display name of the company location, such as a branch office or warehouse name." - } - ], - "value": "export interface OrderStatusCompanyLocation {\n /**\n * A globally-unique identifier for the company location in the format `gid://shopify/CompanyLocation/`.\n */\n id: string;\n /**\n * The display name of the company location, such as a branch office or warehouse name.\n */\n name: string;\n /**\n * A merchant-defined external identifier for the company location, often used to map to an ID in an external ERP or CRM system. The value is `undefined` if no external ID has been set.\n */\n externalId?: string;\n}" - }, - { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "name": "Docs_OrderStatus_CheckoutSettingsApi", - "description": "", - "isPublicDocs": true, - "members": [ - { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "syntaxKind": "PropertySignature", - "name": "checkoutSettings", - "value": "SubscribableSignalLike", - "description": "The checkout settings that were active when the buyer placed the order, such as whether order notes and login are enabled." - } - ], - "value": "export interface Docs_OrderStatus_CheckoutSettingsApi\n extends Pick, 'checkoutSettings'> {}" - }, - { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "name": "Docs_OrderStatus_CostApi", - "description": "", - "isPublicDocs": true, - "members": [ - { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartCost", - "description": "A breakdown of the costs for the order, including the subtotal, shipping, tax, and total amounts." - } - ], - "value": "export interface Docs_OrderStatus_CostApi\n extends Pick, 'cost'> {}" - }, - { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "name": "Docs_OrderStatus_LocalizationApi", - "description": "", - "isPublicDocs": true, - "members": [ - { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "syntaxKind": "PropertySignature", - "name": "localization", - "value": "OrderStatusLocalization", - "description": "The buyer's locale, currency, time zone, country, and market context for the order. Use these values to adapt your extension's content to the buyer's region. For formatted dates, numbers, and translated strings, use the [Localization API](/docs/api/customer-account-ui-extensions/target-apis/platform-apis/localization-api) instead." - } - ], - "value": "export interface Docs_OrderStatus_LocalizationApi\n extends Pick, 'localization'> {}" - }, - { - "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", - "name": "OrderStatusLocalization", - "description": "", - "members": [ - { - "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", - "syntaxKind": "PropertySignature", - "name": "country", - "value": "SubscribableSignalLike", - "description": "The country associated with the order, carried over from the cart context where it was used to contextualize the storefront experience. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown." - }, - { - "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", - "syntaxKind": "PropertySignature", - "name": "currency", - "value": "SubscribableSignalLike", - "description": "The currency used to display money amounts on the **Order status** page. Use this value to format prices and totals in the buyer's expected currency." - }, - { - "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", - "syntaxKind": "PropertySignature", - "name": "extensionLanguage", - "value": "SubscribableSignalLike", - "description": "The best available language match for your extension based on the buyer's language. If the buyer's language is `fr-CA` but your extension only supports `fr`, this returns `fr`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension." - }, - { - "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", - "syntaxKind": "PropertySignature", - "name": "language", - "value": "SubscribableSignalLike", - "description": "The language the buyer sees on the **Order status** page. This reflects the language selected by the buyer or determined by their browser settings, and may differ from the languages your extension supports." - }, - { - "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", - "syntaxKind": "PropertySignature", - "name": "market", - "value": "SubscribableSignalLike", - "description": "The [market](/docs/apps/build/markets) associated with the order, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. The value is `undefined` if the market is unknown." - }, - { - "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", - "syntaxKind": "PropertySignature", - "name": "timezone", - "value": "SubscribableSignalLike", - "description": "The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time." - } - ], - "value": "export interface OrderStatusLocalization {\n /**\n * The currency used to display money amounts on the **Order status** page. Use this value\n * to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, derived from their browser or account settings. Use this value\n * to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees on the **Order status** page. This reflects the language\n * selected by the buyer or determined by their browser settings, and may differ from\n * the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language.\n * If the buyer's language is `fr-CA` but your extension only supports `fr`, this\n * returns `fr`. If your extension doesn't support any variant of the buyer's language,\n * this falls back to your extension's default locale (the `.default.json` translation file).\n * Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country associated with the order, carried over from the cart context where it was\n * used to contextualize the storefront experience. Use this value to display region-specific\n * content such as local support information or regional policies. The value is `undefined`\n * if the buyer's country is unknown.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) associated with the order, carried\n * over from the cart context. Markets group countries and regions with shared pricing,\n * languages, and domains. The value is `undefined` if the market is unknown.\n */\n market: SubscribableSignalLike;\n}" - }, - { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "name": "Docs_OrderStatus_DiscountsApi", - "description": "", - "isPublicDocs": true, - "members": [ - { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "syntaxKind": "PropertySignature", - "name": "discountAllocations", - "value": "SubscribableSignalLike", - "description": "The cart-level discount allocations applied to the order. A discount allocation represents how a discount is distributed across the order. Each allocation includes the discounted amount and one of the following types:\n\n- `CartCodeDiscountAllocation`: A discount the buyer applied by entering a code at checkout.\n- `CartAutomaticDiscountAllocation`: A discount the merchant configured in Shopify admin to apply automatically.\n- `CartCustomDiscountAllocation`: A discount created programmatically by a [Shopify Function](/docs/apps/build/functions)." - }, - { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "syntaxKind": "PropertySignature", - "name": "discountCodes", - "value": "SubscribableSignalLike", - "description": "A list of discount codes that the buyer entered during checkout and that were applied to the order." - } - ], - "value": "export interface Docs_OrderStatus_DiscountsApi\n extends Pick, 'discountAllocations' | 'discountCodes'> {}" - }, - { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "name": "Docs_OrderStatus_GiftCardsApi", - "description": "", - "isPublicDocs": true, - "members": [ - { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "syntaxKind": "PropertySignature", - "name": "appliedGiftCards", - "value": "SubscribableSignalLike", - "description": "The gift cards that were applied to the order. Each gift card includes the last four characters of the code, the amount used for this order, and the remaining balance." - } - ], - "value": "export interface Docs_OrderStatus_GiftCardsApi\n extends Pick, 'appliedGiftCards'> {}" - }, - { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "name": "Docs_OrderStatus_NoteApi", - "description": "", - "isPublicDocs": true, - "members": [ - { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "syntaxKind": "PropertySignature", - "name": "note", - "value": "SubscribableSignalLike", - "description": "A note left by the customer to the merchant, either in their cart or during checkout. The value is `undefined` if no note was provided." - } - ], - "value": "export interface Docs_OrderStatus_NoteApi\n extends Pick, 'note'> {}" - }, - { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "name": "Docs_OrderStatus_AddressApi", - "description": "", - "isPublicDocs": true, - "members": [ - { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "syntaxKind": "PropertySignature", - "name": "billingAddress", - "value": "SubscribableSignalLike", - "description": "The billing address associated with the buyer's payment method for the order. The value is `undefined` if the order doesn't have a billing address on file.", - "isOptional": true - }, - { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "syntaxKind": "PropertySignature", - "name": "shippingAddress", - "value": "SubscribableSignalLike", - "description": "The shipping address that the buyer provided for the order. This is where physical goods are delivered. The value is `undefined` if the order contains only digital products or if a shipping address wasn't required.", - "isOptional": true - } - ], - "value": "export interface Docs_OrderStatus_AddressApi\n extends Pick, 'shippingAddress' | 'billingAddress'> {}" - }, - { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "name": "Docs_OrderStatus_ShopApi", - "description": "", - "isPublicDocs": true, - "members": [ - { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "syntaxKind": "PropertySignature", - "name": "shop", - "value": "Shop", - "description": "The shop where the order was placed. Includes the shop ID, name, primary storefront URL, and myshopify.com domain." - } - ], - "value": "export interface Docs_OrderStatus_ShopApi\n extends Pick, 'shop'> {}" - }, - { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "name": "Docs_OrderStatus_RequireLoginApi", - "description": "", - "isPublicDocs": true, - "members": [ - { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "syntaxKind": "PropertySignature", - "name": "requireLogin", - "value": "() => Promise", - "description": "Triggers a login prompt if the customer is viewing a pre-authenticated **Order status** page. Use this to require full authentication before displaying sensitive information in your extension." - } - ], - "value": "export interface Docs_OrderStatus_RequireLoginApi\n extends Pick, 'requireLogin'> {}" - }, - { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "name": "Docs_OrderStatus_AuthenticationStateApi", - "description": "", - "isPublicDocs": true, - "members": [ - { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "syntaxKind": "PropertySignature", - "name": "authenticationState", - "value": "SubscribableSignalLike", - "description": "The buyer's current authentication level on the **Order status** page. Use this to determine whether to display sensitive information or prompt the buyer to log in." - } - ], - "value": "export interface Docs_OrderStatus_AuthenticationStateApi\n extends Pick, 'authenticationState'> {}" - }, - { - "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "AuthenticationState", - "value": "'fully_authenticated' | 'pre_authenticated'", - "description": "The buyer's authentication status on the **Order status** page:\n\n- `'fully_authenticated'`: The buyer has logged in to their customer account.\n- `'pre_authenticated'`: The buyer accessed the page via a direct link, such as from an order confirmation email, without logging in." - }, - { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "name": "Docs_OrderStatus_CartLinesApi", - "description": "", - "isPublicDocs": true, - "members": [ - { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "syntaxKind": "PropertySignature", - "name": "lines", - "value": "SubscribableSignalLike", - "description": "A list of line items in the order. Each line includes the merchandise, quantity, cost, custom attributes, and discount allocations." - } - ], - "value": "export interface Docs_OrderStatus_CartLinesApi\n extends Pick, 'lines'> {}" - }, - { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "name": "Docs_CartLineItem_CartLinesApi", - "description": "", - "isPublicDocs": true, - "members": [ - { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "SubscribableSignalLike", - "description": "The cart line the extension is attached to." - } - ], - "value": "export interface Docs_CartLineItem_CartLinesApi\n extends Pick {}" - }, - { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "name": "Docs_OrderStatus_OrderApi", - "description": "", - "isPublicDocs": true, - "members": [ - { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "syntaxKind": "PropertySignature", - "name": "order", - "value": "SubscribableSignalLike", - "description": "The order that was placed after checkout completion. Includes the order ID, display name, confirmation number, and timestamps for processing and cancellation. The value is `undefined` if the order hasn't been fully processed yet." - } - ], - "value": "export interface Docs_OrderStatus_OrderApi\n extends Pick, 'order'> {}" - }, - { - "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", - "name": "Order", - "description": "Information about an order that was placed.", - "members": [ - { - "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", - "syntaxKind": "PropertySignature", - "name": "cancelledAt", - "value": "string", - "description": "The date and time when the order was cancelled, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. The value is `undefined` if the order hasn't been cancelled. Use this to conditionally display cancellation details to the buyer.", - "isOptional": true - }, - { - "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", - "syntaxKind": "PropertySignature", - "name": "confirmationNumber", - "value": "string", - "description": "A randomly generated alphanumeric identifier for the order that the buyer can use when contacting the merchant about their purchase. This is always present for orders created in 2024 and onwards. For older orders, this value may be `undefined`.", - "isOptional": true - }, - { - "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier for the order in the format `gid://shopify/Order/`. Use this to reference the order in the [GraphQL Admin API](/docs/api/admin-graphql).", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/Order/1'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The merchant-facing order number prefixed with `#`, such as `#1001`. This is the human-readable identifier displayed to both the merchant in Shopify admin and the buyer on the **Order status** page and in email confirmations.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'#1000'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", - "syntaxKind": "PropertySignature", - "name": "processedAt", - "value": "string", - "description": "The date and time when the order was processed, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. An order is processed after the buyer completes checkout and the payment is captured, at which point the order becomes visible in Shopify admin.", - "isOptional": true - } - ], - "value": "export interface Order {\n /**\n * A globally-unique identifier for the order in the format `gid://shopify/Order/`. Use this to reference the order in the [GraphQL Admin API](/docs/api/admin-graphql).\n *\n * @example 'gid://shopify/Order/1'\n */\n id: string;\n\n /**\n * The merchant-facing order number prefixed with `#`, such as `#1001`. This is the human-readable identifier displayed to both the merchant in Shopify admin and the buyer on the **Order status** page and in email confirmations.\n *\n * @example '#1000'\n */\n name: string;\n\n /**\n * The date and time when the order was cancelled, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. The value is `undefined` if the order hasn't been cancelled. Use this to conditionally display cancellation details to the buyer.\n */\n cancelledAt?: string;\n\n /**\n * A randomly generated alphanumeric identifier for the order that the buyer can use when contacting the merchant about their purchase. This is always present for orders created in 2024 and onwards. For older orders, this value may be `undefined`.\n */\n confirmationNumber?: string;\n\n /**\n * The date and time when the order was processed, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. An order is processed after the buyer completes checkout and the payment is captured, at which point the order becomes visible in Shopify admin.\n */\n processedAt?: string;\n}" - }, - { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "name": "Docs_Standard_ExtensionApi", - "description": "", - "isPublicDocs": true, - "members": [ - { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "syntaxKind": "PropertySignature", - "name": "extension", - "value": "Extension", - "description": "Metadata about the extension, including its target, version, and editor context. Use this to conditionally render content based on where the extension is running." - } - ], - "value": "export interface Docs_Standard_ExtensionApi\n extends Pick, 'extension'> {}" - }, - { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "name": "Docs_Standard_AuthenticatedAccountApi", - "description": "", - "isPublicDocs": true, - "members": [ - { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "syntaxKind": "PropertySignature", - "name": "authenticatedAccount", - "value": "AuthenticatedAccount", - "description": "The logged-in customer's account information, including their customer ID and B2B company details. Use this to personalize your extension based on who is viewing the page." - } - ], - "value": "export interface Docs_Standard_AuthenticatedAccountApi\n extends Pick, 'authenticatedAccount'> {}" - }, - { - "filePath": "src/surfaces/customer-account/api/shared.ts", - "name": "AuthenticatedAccount", - "description": "", - "members": [ - { - "filePath": "src/surfaces/customer-account/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "customer", - "value": "SubscribableSignalLike", - "description": "The authenticated customer's account information. The value is `undefined` if the customer isn't logged in." - }, - { - "filePath": "src/surfaces/customer-account/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "purchasingCompany", - "value": "SubscribableSignalLike", - "description": "The company that the authenticated B2B customer belongs to, including the company ID and location. The value is `undefined` if the customer isn't authenticated or isn't a B2B customer." - } - ], - "value": "export interface AuthenticatedAccount {\n /**\n * The company that the authenticated B2B customer belongs to, including the company ID and location. The value is `undefined` if the customer isn't authenticated or isn't a B2B customer.\n */\n purchasingCompany: SubscribableSignalLike;\n /**\n * The authenticated customer's account information. The value is `undefined` if the customer isn't logged in.\n */\n customer: SubscribableSignalLike;\n}" - }, - { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "name": "Docs_Standard_VersionApi", - "description": "", - "isPublicDocs": true, - "members": [ - { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "syntaxKind": "PropertySignature", - "name": "version", - "value": "Version", - "description": "The API version your extension is running against. Use this to conditionally enable features or handle breaking changes when your extension supports multiple API versions.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'unstable'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Docs_Standard_VersionApi\n extends Pick, 'version'> {}" - }, - { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "name": "Docs_Standard_LocalizationApi", - "description": "The base API object provided to this and other `customer-account` extension targets.", - "isPublicDocs": true, - "members": [ - { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "syntaxKind": "PropertySignature", - "name": "i18n", - "value": "I18n", - "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use this alongside `localization` to build fully localized extensions." - }, - { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "syntaxKind": "PropertySignature", - "name": "localization", - "value": "Localization", - "description": "The buyer's language, country, and locale context. Use this to adapt your extension to the buyer's region and display localized content." - } - ], - "value": "export interface Docs_Standard_LocalizationApi\n extends Pick, 'localization' | 'i18n'> {}" - }, - { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "name": "Docs_Standard_SessionTokenApi", - "description": "The base API object provided to this and other `customer-account` extension targets.", - "isPublicDocs": true, - "members": [ - { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "syntaxKind": "PropertySignature", - "name": "sessionToken", - "value": "SessionToken", - "description": "Authenticates requests between your extension and your app backend. Call `get()` to retrieve a signed JWT containing the customer ID, shop domain, and expiration time, then verify it server-side. For more information, refer to the [Session Token API](/docs/api/customer-account-ui-extensions/{API_VERSION}/target-apis/platform-apis/session-token-api)." - } - ], - "value": "export interface Docs_Standard_SessionTokenApi\n extends Pick, 'sessionToken'> {}" - }, - { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "name": "Docs_Standard_AnalyticsApi", - "description": "The base API object provided to this and other `customer-account` extension targets.", - "isPublicDocs": true, - "members": [ - { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "Analytics", - "description": "Tracks custom events and sends visitor information to [web pixels](/docs/apps/build/marketing-analytics/pixels). Use `publish()` to emit events and `visitor()` to submit visitor data.\n\n> Note: Requires [connecting a third-party domain](https://help.shopify.com/en/manual/domains/add-a-domain/connecting-domains/connect-domain-customer-account) to Shopify for your customer account pages." - } - ], - "value": "export interface Docs_Standard_AnalyticsApi\n extends Pick, 'analytics'> {}" - }, - { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "name": "Docs_Standard_SettingsApi", - "description": "The base API object provided to this and other `customer-account` extension targets.", - "isPublicDocs": true, - "members": [ - { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "syntaxKind": "PropertySignature", - "name": "settings", - "value": "SubscribableSignalLike", - "description": "Merchant-defined configuration values for your extension, as specified in the [settings definition](/docs/api/customer-account-ui-extensions/{API_VERSION}/configuration#settings-definition) of your `shopify.extension.toml` file. Settings update in real time as merchants edit them in the extension editor. The value is empty until a merchant sets it." - } - ], - "value": "export interface Docs_Standard_SettingsApi\n extends Pick {}" - }, - { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "name": "Docs_Standard_StorageApi", - "description": "The base API object provided to this and other `customer-account` extension targets.", - "isPublicDocs": true, - "members": [ - { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "syntaxKind": "PropertySignature", - "name": "storage", - "value": "Storage", - "description": "Key-value storage that persists across customer sessions for this extension target. Use this to store preferences, dismiss states, or cached data without requiring a backend call." - } - ], - "value": "export interface Docs_Standard_StorageApi\n extends Pick, 'storage'> {}" - }, - { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "name": "Docs_Standard_CustomerPrivacyApi", - "description": "The base API object provided to this and other `customer-account` extension targets.", - "isPublicDocs": true, - "members": [ - { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "syntaxKind": "PropertySignature", - "name": "applyTrackingConsentChange", - "value": "ApplyTrackingConsentChangeType", - "description": "Applies updated tracking consent preferences for the buyer, including their decisions for analytics, marketing, and data sale, along with any custom tracking consent [metafields](/docs/apps/build/custom-data/metafields). Returns a promise that resolves with the result of the consent update.\n\n{% include /apps/checkout/privacy-icon.md %} Requires the [`customer_privacy` capability](/docs/api/customer-account-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent) and access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "syntaxKind": "PropertySignature", - "name": "customerPrivacy", - "value": "SubscribableSignalLike", - "description": "The buyer's current privacy consent settings, including their consent decisions for analytics, marketing, and data sale, whether a consent banner should be displayed, and whether the buyer is in a region that requires specific opt-out controls. Use this to read the buyer's consent state and determine how to display privacy-related UI." - } - ], - "value": "export interface Docs_Standard_CustomerPrivacyApi\n extends Pick<\n StandardApi,\n 'customerPrivacy' | 'applyTrackingConsentChange'\n > {}" - }, - { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "name": "Docs_Standard_ToastApi", - "description": "The base API object provided to this and other `customer-account` extension targets.", - "isPublicDocs": true, - "members": [ - { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "syntaxKind": "PropertySignature", - "name": "toast", - "value": "ToastApi", - "description": "Displays brief, non-blocking messages at the bottom of the page to confirm actions or report errors. Use noun + past tense verb format (for example, `Changes saved`). For persistent messages, use a [Banner](/docs/api/customer-account-ui-extensions/{API_VERSION}/ui-components/feedback-and-status-indicators/banner) component instead." - } - ], - "value": "export interface Docs_Standard_ToastApi\n extends Pick, 'toast'> {}" - }, - { - "filePath": "src/surfaces/customer-account/api/shared.ts", - "name": "ToastApi", - "description": "Displays brief, non-blocking notification messages to the customer. Use the Toast API to confirm successful actions, report errors, or surface contextual feedback without interrupting the customer workflow.", - "members": [ - { - "filePath": "src/surfaces/customer-account/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "show", - "value": "(content: string) => Promise", - "description": "Show a toast notification with the given message. Returns a handle with a `hide()` method to dismiss the toast programmatically." - } - ], - "value": "export interface ToastApi {\n /**\n * Show a toast notification with the given message. Returns a handle with a `hide()` method to dismiss the toast programmatically.\n */\n show: (content: string) => Promise;\n}" - }, - { - "filePath": "src/surfaces/customer-account/api/shared.ts", - "name": "ToastApiResult", - "description": "A handle returned by `ToastApi.show()`. Call `hide()` to dismiss the toast notification programmatically.", - "members": [ - { - "filePath": "src/surfaces/customer-account/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "hide", - "value": "() => void", - "description": "Dismisses the toast notification." - } - ], - "value": "export interface ToastApiResult {\n /**\n * Dismisses the toast notification.\n */\n hide: () => void;\n}" - }, - { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "name": "Docs_Standard_QueryApi", - "description": "The base API object provided to this and other `customer-account` extension targets.", - "isPublicDocs": true, - "members": [ - { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "syntaxKind": "PropertySignature", - "name": "query", - "value": "(query: string, options?: { variables?: Variables; version?: StorefrontApiVersion; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>", - "description": "Queries the [Storefront GraphQL API](/docs/api/storefront) directly from your extension using a prefetched token. Use this to fetch product data, collection details, or other storefront information without routing requests through your app backend.\n\nRequires the [`api_access` capability](/docs/api/customer-account-ui-extensions/{API_VERSION}/configuration#api-access)." - } - ], - "value": "export interface Docs_Standard_QueryApi\n extends Pick, 'query'> {}" - }, - { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "name": "Docs_StandardApi", - "description": "The base API object provided to this and other `customer-account` extension targets.", - "isPublicDocs": true, - "members": [ - { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "syntaxKind": "PropertySignature", - "name": "analytics", - "value": "Analytics", - "description": "Tracks custom events and sends visitor information to [web pixels](/docs/apps/build/marketing-analytics/pixels). Use `publish()` to emit events and `visitor()` to submit visitor data.\n\n> Note: Requires [connecting a third-party domain](https://help.shopify.com/en/manual/domains/add-a-domain/connecting-domains/connect-domain-customer-account) to Shopify for your customer account pages." - }, - { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "syntaxKind": "PropertySignature", - "name": "applyTrackingConsentChange", - "value": "ApplyTrackingConsentChangeType", - "description": "Applies updated tracking consent preferences for the buyer, including their decisions for analytics, marketing, and data sale, along with any custom tracking consent [metafields](/docs/apps/build/custom-data/metafields). Returns a promise that resolves with the result of the consent update.\n\n{% include /apps/checkout/privacy-icon.md %} Requires the [`customer_privacy` capability](/docs/api/customer-account-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent) and access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." - }, - { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "syntaxKind": "PropertySignature", - "name": "authenticatedAccount", - "value": "AuthenticatedAccount", - "description": "The logged-in customer's account information, including their customer ID and B2B company details. Use this to personalize your extension based on who is viewing the page." - }, - { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "syntaxKind": "PropertySignature", - "name": "customerPrivacy", - "value": "SubscribableSignalLike", - "description": "The buyer's current privacy consent settings, including their consent decisions for analytics, marketing, and data sale, whether a consent banner should be displayed, and whether the buyer is in a region that requires specific opt-out controls. Use this to read the buyer's consent state and determine how to display privacy-related UI." - }, - { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "syntaxKind": "PropertySignature", - "name": "extension", - "value": "Extension", - "description": "Metadata about the extension, including its target, version, and editor context. Use this to conditionally render content based on where the extension is running." - }, - { - "filePath": "src/surfaces/customer-account/api/docs.ts", + "filePath": "src/surfaces/checkout/components/OrderedList.ts", "syntaxKind": "PropertySignature", - "name": "extensionPoint", - "value": "Target", - "description": "The identifier that specifies where in Shopify’s UI your code is being injected. This will be one of the [targets](/docs/api/customer-account-ui-extensions/{API_VERSION}/configuration#targets) you have included in your extension’s configuration file. For more information, refer to the [extension targets overview](/docs/api/customer-account-ui-extensions/{API_VERSION}/extension-targets-overview).", - "deprecationMessage": "Deprecated as of version `2023-07`, use `extension.target` instead.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'customer-account.order-status.block.render'", - "title": "Example" - } - ] - } - ] + "name": "ontouchstart", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchstart_event)", + "isOptional": true }, { - "filePath": "src/surfaces/customer-account/api/docs.ts", + "filePath": "src/surfaces/checkout/components/OrderedList.ts", "syntaxKind": "PropertySignature", - "name": "i18n", - "value": "I18n", - "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use this alongside `localization` to build fully localized extensions." + "name": "ontransitioncancel", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitioncancel_event)" }, { - "filePath": "src/surfaces/customer-account/api/docs.ts", + "filePath": "src/surfaces/checkout/components/OrderedList.ts", "syntaxKind": "PropertySignature", - "name": "intents", - "value": "Intents", - "description": "Invokes built-in Shopify workflows for managing customer account resources. Use intents to trigger native modals and flows, such as replacing a payment method on a subscription contract, without building the UI yourself." + "name": "ontransitionend", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" }, { - "filePath": "src/surfaces/customer-account/api/docs.ts", + "filePath": "src/surfaces/checkout/components/OrderedList.ts", "syntaxKind": "PropertySignature", - "name": "localization", - "value": "Localization", - "description": "The buyer's language, country, and locale context. Use this to adapt your extension to the buyer's region and display localized content." + "name": "ontransitionrun", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionrun_event)" }, { - "filePath": "src/surfaces/customer-account/api/docs.ts", + "filePath": "src/surfaces/checkout/components/OrderedList.ts", "syntaxKind": "PropertySignature", - "name": "query", - "value": "(query: string, options?: { variables?: Variables; version?: StorefrontApiVersion; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>", - "description": "Queries the [Storefront GraphQL API](/docs/api/storefront) directly from your extension using a prefetched token. Use this to fetch product data, collection details, or other storefront information without routing requests through your app backend.\n\nRequires the [`api_access` capability](/docs/api/customer-account-ui-extensions/{API_VERSION}/configuration#api-access)." + "name": "ontransitionstart", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionstart_event)" }, { - "filePath": "src/surfaces/customer-account/api/docs.ts", + "filePath": "src/surfaces/checkout/components/OrderedList.ts", "syntaxKind": "PropertySignature", - "name": "sessionToken", - "value": "SessionToken", - "description": "Authenticates requests between your extension and your app backend. Call `get()` to retrieve a signed JWT containing the customer ID, shop domain, and expiration time, then verify it server-side. For more information, refer to the [Session Token API](/docs/api/customer-account-ui-extensions/{API_VERSION}/target-apis/platform-apis/session-token-api)." + "name": "onvolumechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/volumechange_event)" }, { - "filePath": "src/surfaces/customer-account/api/docs.ts", + "filePath": "src/surfaces/checkout/components/OrderedList.ts", "syntaxKind": "PropertySignature", - "name": "settings", - "value": "SubscribableSignalLike", - "description": "Merchant-defined configuration values for your extension, as specified in the [settings definition](/docs/api/customer-account-ui-extensions/{API_VERSION}/configuration#settings-definition) of your `shopify.extension.toml` file. Settings update in real time as merchants edit them in the extension editor. The value is empty until a merchant sets it." + "name": "onwaiting", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/waiting_event)" }, { - "filePath": "src/surfaces/customer-account/api/docs.ts", + "filePath": "src/surfaces/checkout/components/OrderedList.ts", "syntaxKind": "PropertySignature", - "name": "storage", - "value": "Storage", - "description": "Key-value storage that persists across customer sessions for this extension target. Use this to store preferences, dismiss states, or cached data without requiring a backend call." + "name": "onwebkitanimationend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" }, { - "filePath": "src/surfaces/customer-account/api/docs.ts", + "filePath": "src/surfaces/checkout/components/OrderedList.ts", "syntaxKind": "PropertySignature", - "name": "toast", - "value": "ToastApi", - "description": "Displays brief, non-blocking messages at the bottom of the page to confirm actions or report errors. Use noun + past tense verb format (for example, `Changes saved`). For persistent messages, use a [Banner](/docs/api/customer-account-ui-extensions/{API_VERSION}/ui-components/feedback-and-status-indicators/banner) component instead." + "name": "onwebkitanimationiteration", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationiteration`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" }, { - "filePath": "src/surfaces/customer-account/api/docs.ts", + "filePath": "src/surfaces/checkout/components/OrderedList.ts", "syntaxKind": "PropertySignature", - "name": "version", - "value": "Version", - "description": "The API version your extension is running against. Use this to conditionally enable features or handle breaking changes when your extension supports multiple API versions.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'unstable'", - "title": "Example" - } - ] - } - ] - } - ], - "value": "export interface Docs_StandardApi extends Omit, 'router'> {}" - }, - { - "filePath": "src/surfaces/customer-account/api/shared.ts", - "name": "Intents", - "description": "Invokes built-in Shopify workflows for managing customer account resources. Use the Intents API to trigger native Shopify modals and flows, such as replacing a payment method on a subscription contract, without building the UI yourself.\n\nIntents pair an `action` (verb) with a resource `type` and optional `value` and `data` to request a workflow.", - "members": [ - { - "filePath": "src/surfaces/customer-account/api/shared.ts", - "syntaxKind": "MethodSignature", - "name": "invoke", - "value": "{ (query: IntentQuery): Promise; (intentURL: string, options?: IntentQueryOptions): Promise; }", - "description": "Triggers a built-in Shopify workflow by passing a structured intent object. Specify an `action` (such as `'open'`), a resource `type`, and an optional `value` identifying the resource. Returns a promise that resolves to an `IntentActivity` you can use to track completion.\n\nTriggers a built-in Shopify workflow using a URL string in the format `action:type[,value][?params]`. Use this overload when composing intents from dynamic strings rather than structured objects.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "const activity = await shopify.intents.invoke(\n {\n action: 'open',\n type: 'shopify/SubscriptionContract',\n value: 'gid://shopify/SubscriptionContract/69372608568',\n data: { field: 'paymentMethod' },\n }\n);", - "title": "Example" - } - ] - }, - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "const activity = await shopify.intents.invoke('open:shopify/SubscriptionContract,gid://shopify/SubscriptionContract/69372608568?field=paymentMethod');\n\n// Or using a query string and options\nconst activity = await shopify.intents.invoke(\n 'open:shopify/SubscriptionContract',\n {\n value: 'gid://shopify/SubscriptionContract/69372608568',\n data: { field: 'paymentMethod' },\n }\n);\nconst response = await activity.complete;", - "title": "Using query string syntax" - } - ] - } - ] - } - ], - "value": "export interface Intents {\n /**\n * Triggers a built-in Shopify workflow by passing a structured intent object. Specify an `action` (such as `'open'`), a resource `type`, and an optional `value` identifying the resource. Returns a promise that resolves to an `IntentActivity` you can use to track completion.\n *\n * @param query - Structured intent description, including `action` and `type`.\n * @returns A promise for an {@link IntentActivity} that completes with an\n * {@link IntentResponse}.\n *\n * @example\n * ```javascript\n * const activity = await shopify.intents.invoke(\n * {\n * action: 'open',\n * type: 'shopify/SubscriptionContract',\n * value: 'gid://shopify/SubscriptionContract/69372608568',\n * data: { field: 'paymentMethod' },\n * }\n * );\n * ```\n */\n invoke(query: IntentQuery): Promise;\n /**\n * Triggers a built-in Shopify workflow using a URL string in the format `action:type[,value][?params]`. Use this overload when composing intents from dynamic strings rather than structured objects.\n *\n * @param intentURL - Intent in URL form, such as `'open:shopify/SubscriptionContract,gid://shopify/SubscriptionContract/123'`.\n * @param options - Optional supplemental inputs such as `value` or `data`.\n * @returns A promise for an {@link IntentActivity} that completes with an\n * {@link IntentResponse}.\n *\n * @example\n * ```javascript\n * // Using query string syntax\n * const activity = await shopify.intents.invoke('open:shopify/SubscriptionContract,gid://shopify/SubscriptionContract/69372608568?field=paymentMethod');\n *\n * // Or using a query string and options\n * const activity = await shopify.intents.invoke(\n * 'open:shopify/SubscriptionContract',\n * {\n * value: 'gid://shopify/SubscriptionContract/69372608568',\n * data: { field: 'paymentMethod' },\n * }\n * );\n * const response = await activity.complete;\n * ```\n */\n invoke(\n intentURL: string,\n options?: IntentQueryOptions,\n ): Promise;\n}" - }, - { - "filePath": "src/surfaces/customer-account/api/shared.ts", - "name": "IntentQuery", - "description": "Structured description of an intent to invoke.\n\nUse this object form when programmatically composing an intent at runtime. It pairs an action (verb) with a resource type and optional inputs.", - "members": [ + "name": "onwebkitanimationstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationstart`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" + }, { - "filePath": "src/surfaces/customer-account/api/shared.ts", + "filePath": "src/surfaces/checkout/components/OrderedList.ts", "syntaxKind": "PropertySignature", - "name": "action", - "value": "IntentAction", - "description": "Verb describing the operation to perform on the target resource.\n\nCommon values include `create` and `open`. The set of allowed verbs is intent-specific; unknown verbs will fail validation." + "name": "onwebkittransitionend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `ontransitionend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" }, { - "filePath": "src/surfaces/customer-account/api/shared.ts", + "filePath": "src/surfaces/checkout/components/OrderedList.ts", "syntaxKind": "PropertySignature", - "name": "data", - "value": "Record", - "description": "Optional input payload passed to the intent. Used to seed forms or supply parameters. The accepted shape is intent-specific. For example, replacing a payment method on a subscription contract requires `{ field: 'paymentMethod' }`.", - "isOptional": true + "name": "onwheel", + "value": "((this: GlobalEventHandlers, ev: WheelEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/wheel_event)" }, { - "filePath": "src/surfaces/customer-account/api/shared.ts", + "filePath": "src/surfaces/checkout/components/OrderedList.ts", "syntaxKind": "PropertySignature", - "name": "type", + "name": "outerHTML", "value": "string", - "description": "The resource type (e.g. `shopify/SubscriptionContract`)." + "description": "The **`outerHTML`** attribute of the Element DOM interface gets the serialized HTML fragment describing the element including its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/outerHTML)" }, { - "filePath": "src/surfaces/customer-account/api/shared.ts", + "filePath": "src/surfaces/checkout/components/OrderedList.ts", "syntaxKind": "PropertySignature", - "name": "value", + "name": "outerText", "value": "string", - "description": "The resource identifier for edit actions (e.g. `gid://shopify/SubscriptionContract/123`).", - "isOptional": true - } - ], - "value": "export interface IntentQuery extends IntentQueryOptions {\n /**\n * Verb describing the operation to perform on the target resource.\n *\n * Common values include `create` and `open`. The set of\n * allowed verbs is intent-specific; unknown verbs will fail validation.\n */\n action: IntentAction;\n /**\n * The resource type (e.g. `shopify/SubscriptionContract`).\n */\n type: string;\n}" - }, - { - "filePath": "src/surfaces/customer-account/api/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "IntentAction", - "value": "'create' | 'open' | string", - "description": "Allowed actions that can be performed by an intent.\n\nCommon actions include:\n- `'create'`: Initiate creation of a new resource.\n- `'open'`: Modify an existing resource." - }, - { - "filePath": "src/surfaces/customer-account/api/shared.ts", - "name": "IntentActivity", - "description": "Activity handle for tracking intent workflow progress.", - "members": [ + "description": "The **`outerText`** property of the HTMLElement interface returns the same value as HTMLElement.innerText.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/outerText)" + }, { - "filePath": "src/surfaces/customer-account/api/shared.ts", + "filePath": "src/surfaces/checkout/components/OrderedList.ts", "syntaxKind": "PropertySignature", - "name": "complete", - "value": "Promise", - "description": "A Promise that resolves when the intent workflow completes, returning the response." - } - ], - "value": "export interface IntentActivity {\n /**\n * A Promise that resolves when the intent workflow completes, returning the response.\n */\n complete: Promise;\n}" - }, - { - "filePath": "src/surfaces/customer-account/api/shared.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "IntentResponse", - "value": "SuccessIntentResponse | ErrorIntentResponse | ClosedIntentResponse", - "description": "Result of an intent activity.\n\nDiscriminated union representing all possible completion outcomes for an invoked intent." - }, - { - "filePath": "src/surfaces/customer-account/api/shared.ts", - "name": "SuccessIntentResponse", - "description": "Successful intent completion.\n\n- `code` is always `'ok'`\n- `data` contains the output payload", - "members": [ + "name": "ownerDocument", + "value": "Document", + "description": "The read-only **`ownerDocument`** property of the Node interface returns the top-level document object of the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/ownerDocument)" + }, { - "filePath": "src/surfaces/customer-account/api/shared.ts", + "filePath": "src/surfaces/checkout/components/OrderedList.ts", "syntaxKind": "PropertySignature", - "name": "code", - "value": "'ok'", - "description": "Always `'ok'` for a successful response." + "name": "parentElement", + "value": "HTMLElement | null", + "description": "The read-only **`parentElement`** property of Node interface returns the DOM node's parent Element, or `null` if the node either has no parent, or its parent isn't a DOM Element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentElement)" }, { - "filePath": "src/surfaces/customer-account/api/shared.ts", + "filePath": "src/surfaces/checkout/components/OrderedList.ts", "syntaxKind": "PropertySignature", - "name": "data", - "value": "Record", - "description": "Validated output payload produced by the workflow.\n\nThe shape is intent-specific. Consumers should narrow by `code === 'ok'` before accessing." - } - ], - "value": "export interface SuccessIntentResponse {\n /**\n * Always `'ok'` for a successful response.\n */\n code: 'ok';\n /**\n * Validated output payload produced by the workflow.\n *\n * The shape is intent-specific. Consumers should narrow by `code === 'ok'` before accessing.\n */\n data: Record;\n}" - }, - { - "filePath": "src/surfaces/customer-account/api/shared.ts", - "name": "ErrorIntentResponse", - "description": "Failed intent completion.\n\n- `code` is always `'error'`\n- `message` summarizes the failure\n- `issues` optionally provides structured details for validation or field-specific problems following the Standard Schema convention", - "members": [ + "name": "parentNode", + "value": "ParentNode | null", + "description": "The read-only **`parentNode`** property of the Node interface returns the parent of the specified node in the DOM tree.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentNode)" + }, { - "filePath": "src/surfaces/customer-account/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "'error'", - "description": "Set to `'error'` when present. This property is optional.", - "isOptional": true + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "GetAccessor", + "name": "part", + "value": "DOMTokenList", + "description": "The **`part`** property of the Element interface represents the part identifier(s) of the element (i.e., set using the `part` attribute), returned as a DOMTokenList.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/part)" }, { - "filePath": "src/surfaces/customer-account/api/shared.ts", + "filePath": "src/surfaces/checkout/components/OrderedList.ts", "syntaxKind": "PropertySignature", - "name": "issues", - "value": "{ path?: string[]; message?: string; }[]", - "description": "Structured details for validation or field-specific problems, following the Standard Schema convention.", - "isOptional": true + "name": "popover", + "value": "string | null", + "description": "The **`popover`** property of the HTMLElement interface gets and sets an element's popover state via JavaScript (`'auto'`, `'hint'`, or `'manual'`), and can be used for feature detection.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/popover)" }, { - "filePath": "src/surfaces/customer-account/api/shared.ts", + "filePath": "src/surfaces/checkout/components/OrderedList.ts", "syntaxKind": "PropertySignature", - "name": "message", - "value": "string", - "description": "A human-readable summary of the failure.", - "isOptional": true - } - ], - "value": "export interface ErrorIntentResponse {\n /**\n * Set to `'error'` when present. This property is optional.\n */\n code?: 'error';\n /**\n * A human-readable summary of the failure.\n */\n message?: string;\n /**\n * Structured details for validation or field-specific problems, following the Standard Schema convention.\n */\n issues?: {\n /**\n * The path to the field with the issue.\n */\n path?: string[];\n /**\n * The error message for the issue.\n */\n message?: string;\n }[];\n}" - }, - { - "filePath": "src/surfaces/customer-account/api/shared.ts", - "name": "ClosedIntentResponse", - "description": "User dismissed or closed the workflow without completing it.\n\nDistinct from `error`: no failure occurred, the activity was simply abandoned by the user.", - "members": [ + "name": "prefix", + "value": "string | null", + "description": "The **`Element.prefix`** read-only property returns the namespace prefix of the specified element, or `null` if no prefix is specified.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/prefix)" + }, { - "filePath": "src/surfaces/customer-account/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "code", - "value": "'closed'", - "description": "Always `'closed'` when the user dismissed the workflow without completing it." - } - ], - "value": "export interface ClosedIntentResponse {\n /**\n * Always `'closed'` when the user dismissed the workflow without completing it.\n */\n code: 'closed';\n}" - }, - { - "filePath": "src/surfaces/customer-account/api/shared.ts", - "name": "IntentQueryOptions", - "description": "Options for URL-based invocations.\n\nWhen invoking via URL syntax, `action` and `type` are parsed from the string. This companion type captures the remaining optional fields that can be provided alongside the URL.", - "members": [ + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "MethodSignature", + "name": "prepend", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes before the first child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/prepend)" + }, { - "filePath": "src/surfaces/customer-account/api/shared.ts", + "filePath": "src/surfaces/checkout/components/OrderedList.ts", "syntaxKind": "PropertySignature", - "name": "data", - "value": "Record", - "description": "Optional input payload passed to the intent. Used to seed forms or supply parameters. The accepted shape is intent-specific. For example, replacing a payment method on a subscription contract requires `{ field: 'paymentMethod' }`.", - "isOptional": true + "name": "previousElementSibling", + "value": "Element | null", + "description": "Returns the first preceding sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/previousElementSibling)" }, { - "filePath": "src/surfaces/customer-account/api/shared.ts", + "filePath": "src/surfaces/checkout/components/OrderedList.ts", "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The resource identifier for edit actions (e.g. `gid://shopify/SubscriptionContract/123`).", - "isOptional": true - } - ], - "value": "export interface IntentQueryOptions {\n /**\n * The resource identifier for edit actions (e.g. `gid://shopify/SubscriptionContract/123`).\n */\n value?: string;\n /**\n * Optional input payload passed to the intent. Used to seed forms or supply parameters. The accepted shape is intent-specific. For example, replacing a payment method on a subscription contract requires `{ field: 'paymentMethod' }`.\n */\n data?: Record;\n}" - }, - { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "name": "Docs_Page_Button_PrimaryAction", - "description": "Supported props for Buttons used inside Page `primary-action` slot.

`children` only support text.", - "isPublicDocs": true, - "members": [ + "name": "previousSibling", + "value": "ChildNode | null", + "description": "The read-only **`previousSibling`** property of the Node interface returns the node immediately preceding the specified one in its parent's or `null` if the specified node is the first in that list.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/previousSibling)" + }, { - "filePath": "src/surfaces/customer-account/api/docs.ts", + "filePath": "src/surfaces/checkout/components/OrderedList.ts", "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "A label that describes the purpose or contents of the Button. It will be read to users using assistive technologies such as screen readers.\n\nUse this when using only an icon or the button text is not enough context for users using assistive technologies.", - "isOptional": true + "name": "PROCESSING_INSTRUCTION_NODE", + "value": "7", + "description": "node is a ProcessingInstruction node." }, { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "syntaxKind": "PropertySignature", - "name": "click", - "value": "((event: CallbackEventListener) => void) | null", - "description": "Callback when the button is activated. This will be called before the action indicated by `type`.", - "isOptional": true + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "MethodSignature", + "name": "querySelector", + "value": "{ (selectors: K): HTMLElementTagNameMap[K]; (selectors: K): SVGElementTagNameMap[K]; (selectors: K): MathMLElementTagNameMap[K]; (selectors: K): HTMLElementDeprecatedTagNameMap[K]; (selectors: string): E; }", + "description": "Returns the first element that is a descendant of node that matches selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelector)", + "deprecationMessage": "Deprecated" }, { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "syntaxKind": "PropertySignature", - "name": "command", - "value": "'--auto' | '--show' | '--hide' | '--toggle' | '--copy'", - "description": "Sets the action the `commandFor` should take when this clickable is activated.\n\nSee the documentation of particular components for the actions they support.\n\n- `--auto`: a default action for the target component.\n- `--show`: shows the target component.\n- `--hide`: hides the target component.\n- `--toggle`: toggles the target component.\n- `--copy`: copies the target ClipboardItem.", - "isOptional": true, - "defaultValue": "'--auto'" + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "MethodSignature", + "name": "querySelectorAll", + "value": "{ (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: string): NodeListOf; }", + "description": "Returns all element descendants of node that match selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelectorAll)", + "deprecationMessage": "Deprecated" }, { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "syntaxKind": "PropertySignature", - "name": "commandFor", - "value": "string", - "description": "ID of a component that should respond to activations (e.g. clicks) on this component.\n\nSee `command` for how to control the behavior of the target.", - "isOptional": true + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "MethodSignature", + "name": "releasePointerCapture", + "value": "(pointerId: number) => void", + "description": "The **`releasePointerCapture()`** method of the previously set for a specific (PointerEvent) _pointer_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/releasePointerCapture)" }, { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "Disables the button, disallowing any interaction.", - "isOptional": true, - "defaultValue": "false" + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "MethodSignature", + "name": "remove", + "value": "() => void", + "description": "Removes node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/remove)" }, { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "syntaxKind": "PropertySignature", - "name": "href", - "value": "string", - "description": "The URL to link to.\n\n- If set, it will navigate to the location specified by `href` after executing the `onClick` callback.\n- If a `commandFor` is set, the `command` will be executed instead of the navigation.", - "isOptional": true + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttribute", + "value": "(qualifiedName: string) => void", + "description": "The Element method **`removeAttribute()`** removes the attribute with the specified name from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttribute)" }, { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "syntaxKind": "PropertySignature", - "name": "loading", - "value": "boolean", - "description": "Replaces content with a loading indicator.", - "isOptional": true, - "defaultValue": "false" - } - ], - "value": "export interface Docs_Page_Button_PrimaryAction\n extends Pick<\n ButtonProps,\n | 'click'\n | 'loading'\n | 'disabled'\n | 'accessibilityLabel'\n | 'href'\n | 'command'\n | 'commandFor'\n > {}" - }, - { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "name": "Docs_Page_Button_SecondaryAction", - "description": "Supported props for Button used inside Page `secondary-actions` slot.

`children` only support text.", - "isPublicDocs": true, - "members": [ + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttributeNode", + "value": "(attr: Attr) => Attr", + "description": "The **`removeAttributeNode()`** method of the Element interface removes the specified Attr node from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNode)" + }, { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "A label that describes the purpose or contents of the Button. It will be read to users using assistive technologies such as screen readers.\n\nUse this when using only an icon or the button text is not enough context for users using assistive technologies.", - "isOptional": true + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttributeNS", + "value": "(namespace: string, localName: string) => void", + "description": "The **`removeAttributeNS()`** method of the If you are working with HTML and you don't need to specify the requested attribute as being part of a specific namespace, use the Element.removeAttribute() method instead.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNS)" }, { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "syntaxKind": "PropertySignature", - "name": "click", - "value": "((event: CallbackEventListener) => void) | null", - "description": "Callback when the button is activated. This will be called before the action indicated by `type`.", - "isOptional": true + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "MethodSignature", + "name": "removeChild", + "value": "(child: T) => T", + "description": "The **`removeChild()`** method of the Node interface removes a child node from the DOM and returns the removed node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/removeChild)" }, { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "syntaxKind": "PropertySignature", - "name": "command", - "value": "'--auto' | '--show' | '--hide' | '--toggle' | '--copy'", - "description": "Sets the action the `commandFor` should take when this clickable is activated.\n\nSee the documentation of particular components for the actions they support.\n\n- `--auto`: a default action for the target component.\n- `--show`: shows the target component.\n- `--hide`: hides the target component.\n- `--toggle`: toggles the target component.\n- `--copy`: copies the target ClipboardItem.", - "isOptional": true, - "defaultValue": "'--auto'" + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "MethodSignature", + "name": "removeEventListener", + "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "syntaxKind": "PropertySignature", - "name": "commandFor", - "value": "string", - "description": "ID of a component that should respond to activations (e.g. clicks) on this component.\n\nSee `command` for how to control the behavior of the target.", - "isOptional": true + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "MethodSignature", + "name": "replaceChild", + "value": "(node: Node, child: T) => T", + "description": "The **`replaceChild()`** method of the Node interface replaces a child node within the given (parent) node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/replaceChild)" }, { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "Disables the button, disallowing any interaction.", - "isOptional": true, - "defaultValue": "false" + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "MethodSignature", + "name": "replaceChildren", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Replace all children of node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/replaceChildren)" }, { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "syntaxKind": "PropertySignature", - "name": "href", - "value": "string", - "description": "The URL to link to.\n\n- If set, it will navigate to the location specified by `href` after executing the `onClick` callback.\n- If a `commandFor` is set, the `command` will be executed instead of the navigation.", - "isOptional": true + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "MethodSignature", + "name": "replaceWith", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Replaces node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/replaceWith)" }, { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "syntaxKind": "PropertySignature", - "name": "loading", - "value": "boolean", - "description": "Replaces content with a loading indicator.", - "isOptional": true, - "defaultValue": "false" - } - ], - "value": "export interface Docs_Page_Button_SecondaryAction\n extends Pick<\n ButtonProps,\n | 'click'\n | 'loading'\n | 'disabled'\n | 'accessibilityLabel'\n | 'href'\n | 'command'\n | 'commandFor'\n > {}" - }, - { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "name": "Docs_Page_Button_BreadcrumbAction", - "description": "Supported props for Button used inside Page `breadcrumb-actions` slot.

`children` are not supported.
Use `accessibilityLabel` instead.", - "isPublicDocs": true, - "members": [ + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "MethodSignature", + "name": "requestFullscreen", + "value": "(options?: FullscreenOptions) => Promise", + "description": "The **`Element.requestFullscreen()`** method issues an asynchronous request to make the element be displayed in fullscreen mode.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestFullscreen)" + }, { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "A label used for buyers using assistive technologies. Needed because `children` passed to this component will be discarded." + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "MethodSignature", + "name": "requestPointerLock", + "value": "(options?: PointerLockOptions) => Promise", + "description": "The **`requestPointerLock()`** method of the Element interface lets you asynchronously ask for the pointer to be locked on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestPointerLock)" }, { - "filePath": "src/surfaces/customer-account/api/docs.ts", + "filePath": "src/surfaces/checkout/components/OrderedList.ts", "syntaxKind": "PropertySignature", - "name": "click", - "value": "((event: CallbackEventListener) => void) | null", - "description": "Callback when the button is activated. This will be called before the action indicated by `type`.", - "isOptional": true + "name": "role", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/role)" }, { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "syntaxKind": "PropertySignature", - "name": "href", - "value": "string", - "description": "The URL to link to.\n\n- If set, it will navigate to the location specified by `href` after executing the `onClick` callback.\n- If a `commandFor` is set, the `command` will be executed instead of the navigation.", - "isOptional": true - } - ], - "value": "export interface Docs_Page_Button_BreadcrumbAction\n extends Pick {\n /**\n * A label used for buyers using assistive technologies. Needed because `children` passed to this component will be discarded.\n */\n accessibilityLabel: ButtonProps['accessibilityLabel'];\n}" - }, - { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "name": "Docs_Menu_Button_Action", - "description": "The menu component exclusively accepts button elements with restricted props as its children. The `tone` prop will always be set to monochrome by default.", - "isPublicDocs": true, - "members": [ + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "MethodSignature", + "name": "scroll", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scroll()`** method of the Element interface scrolls the element to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scroll)" + }, { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "A label that describes the purpose or contents of the Button. It will be read to users using assistive technologies such as screen readers.\n\nUse this when using only an icon or the button text is not enough context for users using assistive technologies.", - "isOptional": true + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "MethodSignature", + "name": "scrollBy", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scrollBy()`** method of the Element interface scrolls an element by the given amount.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollBy)" }, { - "filePath": "src/surfaces/customer-account/api/docs.ts", + "filePath": "src/surfaces/checkout/components/OrderedList.ts", "syntaxKind": "PropertySignature", - "name": "click", - "value": "((event: CallbackEventListener) => void) | null", - "description": "Callback when the button is activated. This will be called before the action indicated by `type`.", - "isOptional": true + "name": "scrollHeight", + "value": "number", + "description": "The **`scrollHeight`** read-only property of the Element interface is a measurement of the height of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollHeight)" }, { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "syntaxKind": "PropertySignature", - "name": "command", - "value": "'--auto' | '--show' | '--hide' | '--toggle' | '--copy'", - "description": "Sets the action the `commandFor` should take when this clickable is activated.\n\nSee the documentation of particular components for the actions they support.\n\n- `--auto`: a default action for the target component.\n- `--show`: shows the target component.\n- `--hide`: hides the target component.\n- `--toggle`: toggles the target component.\n- `--copy`: copies the target ClipboardItem.", - "isOptional": true, - "defaultValue": "'--auto'" + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "MethodSignature", + "name": "scrollIntoView", + "value": "(arg?: boolean | ScrollIntoViewOptions) => void", + "description": "The Element interface's **`scrollIntoView()`** method scrolls the element's ancestor containers such that the element on which `scrollIntoView()` is called is visible to the user.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollIntoView)" }, { - "filePath": "src/surfaces/customer-account/api/docs.ts", + "filePath": "src/surfaces/checkout/components/OrderedList.ts", "syntaxKind": "PropertySignature", - "name": "commandFor", - "value": "string", - "description": "ID of a component that should respond to activations (e.g. clicks) on this component.\n\nSee `command` for how to control the behavior of the target.", - "isOptional": true + "name": "scrollLeft", + "value": "number", + "description": "The **`scrollLeft`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its left edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollLeft)" }, { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "Disables the button, disallowing any interaction.", - "isOptional": true, - "defaultValue": "false" + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "MethodSignature", + "name": "scrollTo", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scrollTo()`** method of the Element interface scrolls to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTo)" }, { - "filePath": "src/surfaces/customer-account/api/docs.ts", + "filePath": "src/surfaces/checkout/components/OrderedList.ts", "syntaxKind": "PropertySignature", - "name": "href", - "value": "string", - "description": "The URL to link to.\n\n- If set, it will navigate to the location specified by `href` after executing the `onClick` callback.\n- If a `commandFor` is set, the `command` will be executed instead of the navigation.", - "isOptional": true + "name": "scrollTop", + "value": "number", + "description": "The **`scrollTop`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its top edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTop)" }, { - "filePath": "src/surfaces/customer-account/api/docs.ts", + "filePath": "src/surfaces/checkout/components/OrderedList.ts", "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the element.", - "isOptional": true + "name": "scrollWidth", + "value": "number", + "description": "The **`scrollWidth`** read-only property of the Element interface is a measurement of the width of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollWidth)" }, { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "syntaxKind": "PropertySignature", - "name": "loading", - "value": "boolean", - "description": "Replaces content with a loading indicator.", - "isOptional": true, - "defaultValue": "false" + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "MethodSignature", + "name": "setAttribute", + "value": "(qualifiedName: string, value: string) => void", + "description": "The **`setAttribute()`** method of the Element interface sets the value of an attribute on the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttribute)" }, { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "'auto' | '_self' | '_blank'", - "description": "Specifies where to display the linked URL.", - "isOptional": true, - "defaultValue": "'auto'" + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNode", + "value": "(attr: Attr) => Attr", + "description": "The **`setAttributeNode()`** method of the Element interface adds a new Attr node to the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNode)" }, { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "syntaxKind": "PropertySignature", - "name": "tone", - "value": "'auto' | 'neutral' | 'critical'", - "description": "Sets the tone of the Button, based on the intention of the information being conveyed.", - "isOptional": true, - "defaultValue": "'auto'" + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNodeNS", + "value": "(attr: Attr) => Attr", + "description": "The **`setAttributeNodeNS()`** method of the Element interface adds a new namespaced Attr node to an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNodeNS)" }, { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'button' | 'submit'", - "description": "The behavior of the button.\n\n- `'submit'` - Used to indicate the component acts as a submit button, meaning it submits the closest form.\n- `'button'` - Used to indicate the component acts as a button, meaning it has no default action.\n- `'reset'` - Used to indicate the component acts as a reset button, meaning it resets the closest form (returning fields to their default values).\n\nThis property is ignored if the component supports `href` or `commandFor`/`command` and one of them is set.", - "isOptional": true, - "defaultValue": "'button'" - } - ], - "value": "export interface Docs_Menu_Button_Action\n extends Omit<\n ButtonProps,\n 'variant' | 'textDecoration' | 'inlineAlignment' | 'inlineSize' | 'size'\n > {}" - }, - { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "name": "Docs_OrderActionMenu_Button", - "description": "", - "isPublicDocs": true, - "members": [ + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNS", + "value": "(namespace: string, qualifiedName: string, value: string) => void", + "description": "`setAttributeNS` adds a new attribute or changes the value of an attribute with the given namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNS)" + }, { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "A label that describes the purpose or contents of the Button. It will be read to users using assistive technologies such as screen readers.\n\nUse this when using only an icon or the button text is not enough context for users using assistive technologies.", - "isOptional": true + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "MethodSignature", + "name": "setHTMLUnsafe", + "value": "(html: string) => void", + "description": "The **`setHTMLUnsafe()`** method of the Element interface is used to parse a string of HTML into a DocumentFragment, optionally filtering out unwanted elements and attributes, and those that don't belong in the context, and then using it to replace the element's subtree in the DOM.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setHTMLUnsafe)" }, { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "syntaxKind": "PropertySignature", - "name": "click", - "value": "((event: CallbackEventListener) => void) | null", - "description": "Callback when the button is activated. This will be called before the action indicated by `type`.", - "isOptional": true + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "MethodSignature", + "name": "setPointerCapture", + "value": "(pointerId: number) => void", + "description": "The **`setPointerCapture()`** method of the _capture target_ of future pointer events.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setPointerCapture)" }, { - "filePath": "src/surfaces/customer-account/api/docs.ts", + "filePath": "src/surfaces/checkout/components/OrderedList.ts", "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "Disables the button, disallowing any interaction.", - "isOptional": true, - "defaultValue": "false" + "name": "shadowRoot", + "value": "ShadowRoot | null", + "description": "The `Element.shadowRoot` read-only property represents the shadow root hosted by the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/shadowRoot)" }, { - "filePath": "src/surfaces/customer-account/api/docs.ts", + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "MethodSignature", + "name": "showPopover", + "value": "() => void", + "description": "The **`showPopover()`** method of the HTMLElement interface shows a Popover_API element (i.e., one that has a valid `popover` attribute) by adding it to the top layer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/showPopover)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", "syntaxKind": "PropertySignature", - "name": "href", + "name": "slot", "value": "string", - "description": "Destination URL to link to.\n\nE.g. `extension:/` to navigate to the Full-page extension." + "description": "The **`slot`** property of the Element interface returns the name of the shadow DOM slot the element is inserted in.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/slot)" }, { - "filePath": "src/surfaces/customer-account/api/docs.ts", + "filePath": "src/surfaces/checkout/components/OrderedList.ts", "syntaxKind": "PropertySignature", - "name": "loading", + "name": "spellcheck", "value": "boolean", - "description": "Replaces content with a loading indicator.", - "isOptional": true, - "defaultValue": "false" + "description": "The **`spellcheck`** property of the HTMLElement interface represents a boolean value that controls the spell-checking hint.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/spellcheck)" }, { - "filePath": "src/surfaces/customer-account/api/docs.ts", + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "GetAccessor", + "name": "style", + "value": "CSSStyleDeclaration", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/style)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", "syntaxKind": "PropertySignature", - "name": "tone", - "value": "'auto' | 'neutral' | 'critical'", - "description": "Sets the tone of the Button, based on the intention of the information being conveyed.", - "isOptional": true, - "defaultValue": "'auto'" - } - ], - "value": "export interface Docs_OrderActionMenu_Button\n extends Pick<\n ButtonProps,\n 'click' | 'loading' | 'disabled' | 'accessibilityLabel' | 'href' | 'tone'\n > {\n /**\n * Destination URL to link to.\n *\n * E.g. `extension:/` to navigate to the Full-page extension.\n */\n href: ButtonProps['href'];\n}" - }, - { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "name": "Docs_CustomerAccountAction_SlotButton", - "description": "Supported props for Buttons used inside CustomerAccountAction slots.

`children` only support text.", - "isPublicDocs": true, - "members": [ + "name": "tabIndex", + "value": "number", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/tabIndex)" + }, { - "filePath": "src/surfaces/customer-account/api/docs.ts", + "filePath": "src/surfaces/checkout/components/OrderedList.ts", "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", + "name": "tagName", "value": "string", - "description": "A label that describes the purpose or contents of the Button. It will be read to users using assistive technologies such as screen readers.\n\nUse this when using only an icon or the button text is not enough context for users using assistive technologies.", - "isOptional": true + "description": "The **`tagName`** read-only property of the Element interface returns the tag name of the element on which it's called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/tagName)" }, { - "filePath": "src/surfaces/customer-account/api/docs.ts", + "filePath": "src/surfaces/checkout/components/OrderedList.ts", "syntaxKind": "PropertySignature", - "name": "click", - "value": "((event: CallbackEventListener) => void) | null", - "description": "Callback when the button is activated. This will be called before the action indicated by `type`.", - "isOptional": true + "name": "TEXT_NODE", + "value": "3", + "description": "node is a Text node." }, { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "syntaxKind": "PropertySignature", - "name": "command", - "value": "'--auto' | '--show' | '--hide' | '--toggle' | '--copy'", - "description": "Sets the action the `commandFor` should take when this clickable is activated.\n\nSee the documentation of particular components for the actions they support.\n\n- `--auto`: a default action for the target component.\n- `--show`: shows the target component.\n- `--hide`: hides the target component.\n- `--toggle`: toggles the target component.\n- `--copy`: copies the target ClipboardItem.", - "isOptional": true, - "defaultValue": "'--auto'" + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "GetAccessor", + "name": "textContent", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/Node/textContent)" }, { - "filePath": "src/surfaces/customer-account/api/docs.ts", + "filePath": "src/surfaces/checkout/components/OrderedList.ts", "syntaxKind": "PropertySignature", - "name": "commandFor", + "name": "title", "value": "string", - "description": "ID of a component that should respond to activations (e.g. clicks) on this component.\n\nSee `command` for how to control the behavior of the target.", - "isOptional": true + "description": "The **`HTMLElement.title`** property represents the title of the element: the text usually displayed in a 'tooltip' popup when the mouse is over the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/title)" }, { - "filePath": "src/surfaces/customer-account/api/docs.ts", + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "MethodSignature", + "name": "toggleAttribute", + "value": "(qualifiedName: string, force?: boolean) => boolean", + "description": "The **`toggleAttribute()`** method of the present and adding it if it is not present) on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/toggleAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "MethodSignature", + "name": "togglePopover", + "value": "(options?: boolean) => boolean", + "description": "The **`togglePopover()`** method of the HTMLElement interface toggles a Popover_API element (i.e., one that has a valid `popover` attribute) between the hidden and showing states.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/togglePopover)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", "syntaxKind": "PropertySignature", - "name": "disabled", + "name": "translate", "value": "boolean", - "description": "Disables the button, disallowing any interaction.", - "isOptional": true, - "defaultValue": "false" + "description": "The **`translate`** property of the HTMLElement interface indicates whether an element's attribute values and the values of its Text node children are to be translated when the page is localized, or whether to leave them unchanged.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/translate)" }, { - "filePath": "src/surfaces/customer-account/api/docs.ts", + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "MethodSignature", + "name": "webkitMatchesSelector", + "value": "(selectors: string) => boolean", + "description": "", + "deprecationMessage": "This is a legacy alias of `matches`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", "syntaxKind": "PropertySignature", - "name": "href", + "name": "writingSuggestions", "value": "string", - "description": "The URL to link to.\n\n- If set, it will navigate to the location specified by `href` after executing the `onClick` callback.\n- If a `commandFor` is set, the `command` will be executed instead of the navigation.", - "isOptional": true - }, + "description": "The **`writingSuggestions`** property of the HTMLElement interface is a string indicating if browser-provided writing suggestions should be enabled under the scope of the element or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/writingSuggestions)" + } + ], + "value": "export interface OrderedListElement extends OrderedListElementProps, Omit {\n}" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "name": "OrderedListProps", + "description": "", + "isPublicDocs": true, + "members": [ { - "filePath": "src/surfaces/customer-account/api/docs.ts", + "filePath": "src/surfaces/checkout/components/OrderedList.ts", "syntaxKind": "PropertySignature", - "name": "loading", - "value": "boolean", - "description": "Replaces content with a loading indicator.", - "isOptional": true, - "defaultValue": "false" + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true } ], - "value": "export interface Docs_CustomerAccountAction_SlotButton\n extends Pick<\n ButtonProps,\n | 'click'\n | 'loading'\n | 'disabled'\n | 'accessibilityLabel'\n | 'href'\n | 'command'\n | 'commandFor'\n > {}" + "value": "export interface OrderedListProps extends OrderedListElementProps {\n}" }, { "filePath": "src/surfaces/checkout/shared.ts", @@ -53049,10 +53173,10 @@ "syntaxKind": "PropertySignature", "name": "target", "value": "SubscribableSignalLike", - "description": "The cart line that this extension is attached to. Use this to read the line item's merchandise, quantity, cost, and attributes.\n\n> Note: Until version `2023-04`, this property was a `ReadonlySignalLike`." + "description": "The cart line that this extension is attached to. Use this to read the line item's merchandise, quantity, cost, and attributes.\n\nAvailable only on the corresponding item target. Shipping option item targets expose shipping option properties; pickup location item targets expose pickup location properties.\n\n> Note: Until version `2023-04`, this property was a `ReadonlySignalLike`." } ], - "value": "export interface CartLineItemApi {\n /**\n * The cart line that this extension is attached to. Use this to read the\n * line item's merchandise, quantity, cost, and attributes.\n *\n * > Note: Until version `2023-04`, this property was a `ReadonlySignalLike`.\n */\n target: SubscribableSignalLike;\n}" + "value": "export interface CartLineItemApi {\n /**\n * The cart line that this extension is attached to. Use this to read the\n * line item's merchandise, quantity, cost, and attributes.\n *\n * Available only on the corresponding item target. Shipping option item\n * targets expose shipping option properties; pickup location item targets\n * expose pickup location properties.\n *\n * > Note: Until version `2023-04`, this property was a `ReadonlySignalLike`.\n */\n target: SubscribableSignalLike;\n}" }, { "filePath": "src/surfaces/checkout/shared.ts", @@ -53197,7 +53321,7 @@ "syntaxKind": "PropertySignature", "name": "value", "value": "string", - "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.", + "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.\n\nAttribute values are always strings. To store structured data, serialize it to JSON and parse it when reading.", "examples": [ { "title": "Example", @@ -53212,7 +53336,7 @@ ] } ], - "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" + "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * Attribute values are always strings. To store structured data, serialize\n * it to JSON and parse it when reading.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -53703,10 +53827,10 @@ "syntaxKind": "PropertySignature", "name": "isLocationFormVisible", "value": "SubscribableSignalLike", - "description": "Whether the location search form is currently visible to the buyer. Use this to conditionally render UI that depends on the buyer actively searching for pickup points." + "description": "Reflects which view was active when the extension loaded. When the buyer moves to the next view, the extension restarts with the current value rather than updating in place." } ], - "value": "export interface PickupPointListApi {\n /**\n * Whether the location search form is currently visible to the buyer.\n * Use this to conditionally render UI that depends on the buyer actively\n * searching for pickup points.\n */\n isLocationFormVisible: SubscribableSignalLike;\n}" + "value": "export interface PickupPointListApi {\n /**\n * Reflects which view was active when the extension loaded. When the\n * buyer moves to the next view, the extension restarts with the\n * current value rather than updating in place.\n */\n isLocationFormVisible: SubscribableSignalLike;\n}" }, { "filePath": "src/surfaces/checkout/api/pickup/pickup-location-item.ts", @@ -53719,17 +53843,17 @@ "syntaxKind": "PropertySignature", "name": "isTargetSelected", "value": "SubscribableSignalLike", - "description": "Whether the buyer has selected the target pickup location. When `true`, the target location is the buyer's active choice. When `false`, the buyer has chosen a different pickup location." + "description": "Whether the buyer has selected the target pickup location. When `true`, the target location is the buyer's active choice. When `false`, the buyer has chosen a different pickup location.\n\nAvailable only on the corresponding item target. Shipping option item targets expose shipping option properties; pickup location item targets expose pickup location properties." }, { "filePath": "src/surfaces/checkout/api/pickup/pickup-location-item.ts", "syntaxKind": "PropertySignature", "name": "target", "value": "SubscribableSignalLike", - "description": "The pickup location that this extension is attached to. Use this to read the location's name, address, and other details." + "description": "The pickup location that this extension is attached to. Use this to read the location's name, address, and other details.\n\nAvailable only on the corresponding item target. Shipping option item targets expose shipping option properties; pickup location item targets expose pickup location properties." } ], - "value": "export interface PickupLocationItemApi {\n /**\n * The pickup location that this extension is attached to. Use this to read the location's name, address, and other details.\n */\n target: SubscribableSignalLike;\n\n /**\n * Whether the buyer has selected the target pickup location. When `true`, the target location is the buyer's active choice. When `false`, the buyer has chosen a different pickup location.\n */\n isTargetSelected: SubscribableSignalLike;\n}" + "value": "export interface PickupLocationItemApi {\n /**\n * The pickup location that this extension is attached to. Use this to read the location's name, address, and other details.\n *\n * Available only on the corresponding item target. Shipping option item\n * targets expose shipping option properties; pickup location item targets\n * expose pickup location properties.\n */\n target: SubscribableSignalLike;\n\n /**\n * Whether the buyer has selected the target pickup location. When `true`, the target location is the buyer's active choice. When `false`, the buyer has chosen a different pickup location.\n *\n * Available only on the corresponding item target. Shipping option item\n * targets expose shipping option properties; pickup location item targets\n * expose pickup location properties.\n */\n isTargetSelected: SubscribableSignalLike;\n}" }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -54135,7 +54259,7 @@ "syntaxKind": "PropertySignature", "name": "isTargetSelected", "value": "SubscribableSignalLike", - "description": "Whether the buyer has selected the target shipping option. When `true`, the target option is the buyer's active choice. When `false`, the buyer has chosen a different shipping option." + "description": "Whether the buyer has selected the target shipping option. When `true`, the target option is the buyer's active choice. When `false`, the buyer has chosen a different shipping option.\n\nAvailable only on the corresponding item target. Shipping option item targets expose shipping option properties; pickup location item targets expose pickup location properties." }, { "filePath": "src/surfaces/checkout/api/shipping/shipping-option-item.ts", @@ -54149,10 +54273,10 @@ "syntaxKind": "PropertySignature", "name": "target", "value": "SubscribableSignalLike", - "description": "The shipping option that this extension is attached to. Use this to read the option's cost, carrier, delivery estimate, and other details." + "description": "The shipping option that this extension is attached to. Use this to read the option's cost, carrier, delivery estimate, and other details.\n\nAvailable only on the corresponding item target. Shipping option item targets expose shipping option properties; pickup location item targets expose pickup location properties." } ], - "value": "export interface ShippingOptionItemApi {\n /**\n * The shipping option that this extension is attached to. Use this to read the option's cost, carrier, delivery estimate, and other details.\n */\n target: SubscribableSignalLike;\n\n /**\n * Whether the buyer has selected the target shipping option. When `true`, the target option is the buyer's active choice. When `false`, the buyer has chosen a different shipping option.\n */\n isTargetSelected: SubscribableSignalLike;\n\n /**\n * The render mode of this shipping option, indicating how the extension is displayed in the checkout UI.\n */\n renderMode: ShippingOptionItemRenderMode;\n}" + "value": "export interface ShippingOptionItemApi {\n /**\n * The shipping option that this extension is attached to. Use this to read the option's cost, carrier, delivery estimate, and other details.\n *\n * Available only on the corresponding item target. Shipping option item\n * targets expose shipping option properties; pickup location item targets\n * expose pickup location properties.\n */\n target: SubscribableSignalLike;\n\n /**\n * Whether the buyer has selected the target shipping option. When `true`, the target option is the buyer's active choice. When `false`, the buyer has chosen a different shipping option.\n *\n * Available only on the corresponding item target. Shipping option item\n * targets expose shipping option properties; pickup location item targets\n * expose pickup location properties.\n */\n isTargetSelected: SubscribableSignalLike;\n\n /**\n * The render mode of this shipping option, indicating how the extension is displayed in the checkout UI.\n */\n renderMode: ShippingOptionItemRenderMode;\n}" }, { "filePath": "src/surfaces/checkout/api/shipping/shipping-option-item.ts", @@ -55169,7 +55293,7 @@ "syntaxKind": "MethodSignature", "name": "applyAttributeChange", "value": "(change: AttributeChange) => Promise", - "description": "Updates or removes an attribute on the cart and checkout. On success, the [`attributes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/attributes#standardapi-propertydetail-attributes) property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.", + "description": "Updates or removes an attribute on the cart and checkout. On success, the [`attributes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/attributes#properties-propertydetail-attributes) property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.", "deprecationMessage": "Use cart metafields instead." }, { @@ -55177,42 +55301,42 @@ "syntaxKind": "MethodSignature", "name": "applyCartLinesChange", "value": "(change: CartLineChange) => Promise", - "description": "Adds, removes, or updates line items in the cart. The returned promise resolves when the change has been applied by the server, and the [`lines`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-lines#standardapi-propertydetail-lines) property updates with the new state.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Adds, removes, or updates line items in the cart. The returned promise resolves when the change has been applied by the server, and the [`lines`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-lines#properties-propertydetail-lines) property updates with the new state.\n\nAccepts a single change per call. To make multiple changes, call this method separately for each one.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyDiscountCodeChange", "value": "(change: DiscountCodeChange) => Promise", - "description": "Adds or removes a discount code on the checkout. The returned promise resolves when the change has been applied by the server, and the [`discountCodes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/discounts#standardapi-propertydetail-discountcodes) property updates with the new state.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves discount codes through a network call.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Adds or removes a discount code on the checkout. The returned promise resolves when the change has been applied by the server, and the [`discountCodes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/discounts#properties-propertydetail-discountcodes) property updates with the new state.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves discount codes through a network call.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyGiftCardChange", "value": "(change: GiftCardChange) => Promise", - "description": "Adds or removes a gift card from the checkout. The returned promise resolves when the change has been applied by the server, and the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/gift-cards#standardapi-propertydetail-appliedgiftcards) property updates with the new state.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves gift card codes through a network call.\n\n> Note: This method returns an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Adds or removes a gift card from the checkout. The returned promise resolves when the change has been applied by the server, and the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/gift-cards#properties-propertydetail-appliedgiftcards) property updates with the new state.\n\nUnlike other write operations, gift card changes aren't gated by a cart instruction flag.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves gift card codes through a network call.\n\n> Note: This method returns an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyMetafieldChange", "value": "(change: MetafieldChange) => Promise", - "description": "Creates, updates, or removes a cart metafield on the checkout. On success, the [`metafields`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/metafields#standardapi-propertydetail-metafields) property updates to reflect the change.\n\nCart metafields are copied to order metafields at order creation time if there's a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n\n> Caution: `MetafieldRemoveChange` and `MetafieldUpdateChange` are deprecated. Use cart metafields with `MetafieldRemoveCartChange` and `MetafieldUpdateCartChange` instead. If `MetafieldUpdateChange` writes a metafield with the same namespace and key as a cart metafield that's configured to copy, the cart metafield won't be copied.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Creates, updates, or removes a cart metafield on the checkout. On success, the [`metafields`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/metafields#properties-propertydetail-metafields) property updates to reflect the change.\n\nCart metafields are copied to order metafields at order creation time if there's a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n\n> Caution: `MetafieldRemoveChange` and `MetafieldUpdateChange` are deprecated. Use cart metafields with `MetafieldRemoveCartChange` and `MetafieldUpdateCartChange` instead. If `MetafieldUpdateChange` writes a metafield with the same namespace and key as a cart metafield that's configured to copy, the cart metafield won't be copied.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyNoteChange", "value": "(change: NoteChange) => Promise", - "description": "Sets or removes the buyer's note on the checkout. On success, the [`note`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/note#standardapi-propertydetail-note) property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Sets or removes the buyer's note on the checkout. On success, the [`note`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/note#properties-propertydetail-note) property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyShippingAddressChange", "value": "(change: ShippingAddressUpdateChange) => Promise", - "description": "Updates the buyer's shipping address on the checkout. The provided fields are merged into the existing address without prompting the buyer. On success, the `shippingAddress` property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", + "description": "Updates the buyer's shipping address on the checkout. The provided fields are merged into the existing address without prompting the buyer. On success, the `shippingAddress` property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", "isOptional": true }, { @@ -55225,7 +55349,7 @@ "isPrivate": true } ], - "value": "export interface CheckoutApi {\n /**\n * Updates or removes an attribute on the cart and checkout. On success, the\n * [`attributes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/attributes#standardapi-propertydetail-attributes) property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * @deprecated Use cart metafields instead.\n */\n applyAttributeChange(change: AttributeChange): Promise;\n\n /**\n * Adds, removes, or updates line items in the cart. The returned promise resolves when the change has been applied by the server, and the [`lines`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-lines#standardapi-propertydetail-lines) property updates with the new state.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyCartLinesChange(change: CartLineChange): Promise;\n\n /**\n * Adds or removes a discount code on the checkout. The returned promise resolves when the change has been applied by the server, and the [`discountCodes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/discounts#standardapi-propertydetail-discountcodes) property updates with the new state.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves discount codes through a network call.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyDiscountCodeChange(\n change: DiscountCodeChange,\n ): Promise;\n\n /**\n * Adds or removes a gift card from the checkout. The returned promise resolves when the change has been applied by the server, and the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/gift-cards#standardapi-propertydetail-appliedgiftcards) property updates with the new state.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves gift card codes through a network call.\n *\n * > Note: This method returns an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyGiftCardChange(change: GiftCardChange): Promise;\n\n /**\n * Creates, updates, or removes a cart metafield on the checkout. On success, the\n * [`metafields`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/metafields#standardapi-propertydetail-metafields) property updates to reflect the change.\n *\n * Cart metafields are copied to order metafields at order creation time if there's a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n *\n * > Caution: `MetafieldRemoveChange` and `MetafieldUpdateChange` are deprecated. Use cart metafields with `MetafieldRemoveCartChange` and `MetafieldUpdateCartChange` instead. If `MetafieldUpdateChange` writes a metafield with the same namespace and key as a cart metafield that's configured to copy, the cart metafield won't be copied.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyMetafieldChange(change: MetafieldChange): Promise;\n\n /**\n * Sets or removes the buyer's note on the checkout. On success, the\n * [`note`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/note#standardapi-propertydetail-note)\n * property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyNoteChange(change: NoteChange): Promise;\n\n /**\n * @private\n */\n experimentalIsShopAppStyle?: boolean;\n\n /**\n * Updates the buyer's shipping address on the checkout. The provided fields\n * are merged into the existing address without prompting the buyer. On success,\n * the `shippingAddress` property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyShippingAddressChange?(\n change: ShippingAddressChange,\n ): Promise;\n}" + "value": "export interface CheckoutApi {\n /**\n * Updates or removes an attribute on the cart and checkout. On success, the\n * [`attributes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/attributes#properties-propertydetail-attributes) property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * @deprecated Use cart metafields instead.\n */\n applyAttributeChange(change: AttributeChange): Promise;\n\n /**\n * Adds, removes, or updates line items in the cart. The returned promise resolves when the change has been applied by the server, and the [`lines`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-lines#properties-propertydetail-lines) property updates with the new state.\n *\n * Accepts a single change per call. To make multiple changes, call this\n * method separately for each one.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyCartLinesChange(change: CartLineChange): Promise;\n\n /**\n * Adds or removes a discount code on the checkout. The returned promise resolves when the change has been applied by the server, and the [`discountCodes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/discounts#properties-propertydetail-discountcodes) property updates with the new state.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves discount codes through a network call.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyDiscountCodeChange(\n change: DiscountCodeChange,\n ): Promise;\n\n /**\n * Adds or removes a gift card from the checkout. The returned promise resolves when the change has been applied by the server, and the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/gift-cards#properties-propertydetail-appliedgiftcards) property updates with the new state.\n *\n * Unlike other write operations, gift card changes aren't gated by a cart\n * instruction flag.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves gift card codes through a network call.\n *\n * > Note: This method returns an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyGiftCardChange(change: GiftCardChange): Promise;\n\n /**\n * Creates, updates, or removes a cart metafield on the checkout. On success, the\n * [`metafields`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/metafields#properties-propertydetail-metafields) property updates to reflect the change.\n *\n * Cart metafields are copied to order metafields at order creation time if there's a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n *\n * > Caution: `MetafieldRemoveChange` and `MetafieldUpdateChange` are deprecated. Use cart metafields with `MetafieldRemoveCartChange` and `MetafieldUpdateCartChange` instead. If `MetafieldUpdateChange` writes a metafield with the same namespace and key as a cart metafield that's configured to copy, the cart metafield won't be copied.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyMetafieldChange(change: MetafieldChange): Promise;\n\n /**\n * Sets or removes the buyer's note on the checkout. On success, the\n * [`note`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/note#properties-propertydetail-note)\n * property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyNoteChange(change: NoteChange): Promise;\n\n /**\n * @private\n */\n experimentalIsShopAppStyle?: boolean;\n\n /**\n * Updates the buyer's shipping address on the checkout. The provided fields\n * are merged into the existing address without prompting the buyer. On success,\n * the `shippingAddress` property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyShippingAddressChange?(\n change: ShippingAddressChange,\n ): Promise;\n}" }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -55560,7 +55684,7 @@ "syntaxKind": "PropertySignature", "name": "message", "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer." + "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer.\n\nRender your own localized error text rather than displaying this message to the buyer." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -55570,7 +55694,7 @@ "description": "Indicates that the line item wasn't changed successfully. Refer to the `message` property for details about the error." } ], - "value": "export interface CartLineChangeResultError {\n /**\n * Indicates that the line item wasn't changed successfully. Refer to the `message` property for details about the error.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface CartLineChangeResultError {\n /**\n * Indicates that the line item wasn't changed successfully. Refer to the `message` property for details about the error.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n *\n * Render your own localized error text rather than displaying this message\n * to the buyer.\n */\n message: string;\n}" }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -55750,7 +55874,7 @@ "syntaxKind": "PropertySignature", "name": "message", "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer." + "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer.\n\nRender your own localized error text rather than displaying this message to the buyer." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -55760,7 +55884,7 @@ "description": "Indicates that the gift card change couldn't be applied. Check the `message` property for details." } ], - "value": "export interface GiftCardChangeResultError {\n /**\n * Indicates that the gift card change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface GiftCardChangeResultError {\n /**\n * Indicates that the gift card change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n *\n * Render your own localized error text rather than displaying this message\n * to the buyer.\n */\n message: string;\n}" }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -55925,7 +56049,7 @@ "syntaxKind": "PropertySignature", "name": "message", "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer." + "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer.\n\nRender your own localized error text rather than displaying this message to the buyer." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -55935,7 +56059,7 @@ "description": "Indicates that the metafield change couldn't be applied. Check the `message` property for details." } ], - "value": "export interface MetafieldChangeResultError {\n /**\n * Indicates that the metafield change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface MetafieldChangeResultError {\n /**\n * Indicates that the metafield change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n *\n * Render your own localized error text rather than displaying this message\n * to the buyer.\n */\n message: string;\n}" }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -56013,7 +56137,7 @@ "syntaxKind": "PropertySignature", "name": "message", "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer." + "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer.\n\nRender your own localized error text rather than displaying this message to the buyer." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -56023,7 +56147,7 @@ "description": "Indicates that the note change couldn't be applied. Check the `message` property for details." } ], - "value": "export interface NoteChangeResultError {\n /**\n * Indicates that the note change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface NoteChangeResultError {\n /**\n * Indicates that the note change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n *\n * Render your own localized error text rather than displaying this message\n * to the buyer.\n */\n message: string;\n}" }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -56367,7 +56491,7 @@ "syntaxKind": "PropertySignature", "name": "analytics", "value": "Analytics", - "description": "The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event." + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -56381,7 +56505,7 @@ "syntaxKind": "PropertySignature", "name": "applyTrackingConsentChange", "value": "ApplyTrackingConsentChangeType", - "description": "Enables setting and updating customer privacy consent settings and tracking consent metafields.\n\n> Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent) to be set to `true`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." + "description": "Enables setting and updating customer privacy consent settings and tracking consent metafields.\n\n> Note: Requires the [`collect_buyer_consent` capability](/docs/apps/build/customer-accounts/capabilities#collect-buyer-consent) to be set to `true`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -56402,7 +56526,7 @@ "syntaxKind": "PropertySignature", "name": "availablePaymentOptions", "value": "SubscribableSignalLike", - "description": "All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region." + "description": "All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n\nThe set of payment options can change when the buyer updates their address or cart, so subscribe to changes rather than reading once during initialization. Each option exposes `handle` and `type` only. Provider names, logos, fees, and installment terms aren't available." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -56439,7 +56563,7 @@ "syntaxKind": "PropertySignature", "name": "checkoutToken", "value": "SubscribableSignalLike", - "description": "A stable ID that represents the current checkout.\n\nThe value is `undefined` when the checkout hasn't been created on the server yet.\n\nUse this to correlate checkout sessions across your extension, web pixels, and backend systems.\n\nThis matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data) and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object)." + "description": "A stable ID that represents the current checkout.\n\nThe value is `undefined` when the checkout hasn't been created on the server yet.\n\nUse this to correlate checkout sessions across your extension, web pixels, and backend systems.\n\nThis matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data) and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n\nCan be `undefined`. Handle the `undefined` state before using the value." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -56460,7 +56584,7 @@ "syntaxKind": "PropertySignature", "name": "deliveryGroups", "value": "SubscribableSignalLike", - "description": "The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items." + "description": "The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n\nEmpty until the buyer enters enough address information for Shopify to calculate shipping rates." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -56481,7 +56605,7 @@ "syntaxKind": "PropertySignature", "name": "extension", "value": "Extension", - "description": "The meta information about the extension." + "description": "Metadata about the running extension, including the current target, API version, capabilities, and editor context. Use this to conditionally render content based on where the extension is running." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -56489,7 +56613,7 @@ "name": "extensionPoint", "value": "Target", "description": "The identifier that specifies where in Shopify's UI your code is being injected. This is one of the targets you've included in your extension's configuration file.", - "deprecationMessage": "Deprecated as of version `2023-07`, use `extension.target` instead.", + "deprecationMessage": "Use `extension.target` instead.", "examples": [ { "title": "Example", @@ -56508,14 +56632,14 @@ "syntaxKind": "PropertySignature", "name": "i18n", "value": "I18n", - "description": "Utilities for translating content and formatting values according to the current [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) of the checkout.\n\nRefer to [`localization` examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples) for more information." + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use alongside [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) to build fully localized extensions." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "instructions", "value": "SubscribableSignalLike", - "description": "The cart instructions used to create the checkout and possibly limit extension capabilities.\n\nThese instructions should be checked before performing any actions that might be affected by them.\n\nFor example, if you intend to add a discount code via the `applyDiscountCodeChange` method, check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n\n> Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs aren't available. See the [update guide](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples) for more information." + "description": "The cart instructions used to create the checkout and possibly limit extension capabilities.\n\nThese instructions should be checked before performing any actions that might be affected by them.\n\nFor example, if you intend to add a discount code via the `applyDiscountCodeChange` method, check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n\n> Caution: Check cart instructions before calling select APIs, as > some may not be available. See the > [Cart Instructions API](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples) > for more information." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -56529,7 +56653,7 @@ "syntaxKind": "PropertySignature", "name": "localization", "value": "Localization", - "description": "The details about the location, language, and currency of the customer. For utilities to easily format and translate content based on these details, you can use the [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n) object instead." + "description": "The buyer's language, country, currency, and timezone context. For formatting and translation helpers, use the [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#properties-propertydetail-i18n) object instead." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -56559,21 +56683,21 @@ "syntaxKind": "PropertySignature", "name": "query", "value": ">(query: string, options?: { variables?: Variables; version?: StorefrontApiVersion; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>", - "description": "The method used to query the Storefront GraphQL API with a prefetched token.\n\nRefer to [Storefront API access examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/storefront-api) for more information." + "description": "The method used to query the Storefront GraphQL API with a prefetched token." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "selectedPaymentOptions", "value": "SubscribableSignalLike", - "description": "The payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card)." + "description": "The payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\n\nEach option exposes `handle` and `type` only. Provider names, logos, fees, and installment terms aren't available." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "sessionToken", "value": "SessionToken", - "description": "The session token providing a set of claims as a signed JSON Web Token (JWT).\n\nThe token has a TTL of five minutes.\n\nIf the previous token expires, this value reflects a new session token with a new signature and expiry.\n\nRefer to [session token examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/session-token) for more information." + "description": "The session token providing a set of claims as a signed JSON Web Token (JWT).\n\nThe token has a TTL of five minutes.\n\nIf the previous token expires, this value reflects a new session token with a new signature and expiry.\n\nLearn more about [session tokens](/docs/apps/build/authentication-authorization/session-tokens)." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -56595,14 +56719,14 @@ "syntaxKind": "PropertySignature", "name": "shop", "value": "Shop", - "description": "The shop where the checkout is taking place." + "description": "The store where the checkout is taking place, including the shop name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "storage", "value": "Storage", - "description": "The key-value storage for the extension.\n\nIt uses `localStorage` and should persist across the customer's current checkout session.\n\n> Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n\nData is shared across all activated extension targets of this extension. In versions 2023-07 and earlier, each activated extension target had its own storage." + "description": "Key-value storage that persists across page loads within the current checkout session. Data is shared across all activated targets associated with this extension.\n\n> Caution: Data persistence isn't guaranteed and storage is cleared when the buyer starts a new checkout." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -56624,29 +56748,29 @@ ] } ], - "value": "export interface StandardApi {\n /**\n * The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event.\n */\n analytics: Analytics;\n\n /**\n * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\n */\n appliedGiftCards: SubscribableSignalLike;\n\n /**\n * The cart instructions used to create the checkout and possibly limit extension capabilities.\n *\n * These instructions should be checked before performing any actions that might be affected by them.\n *\n * For example, if you intend to add a discount code via the `applyDiscountCodeChange` method,\n * check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n *\n * > Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs aren't available.\n * See the [update guide](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples) for more information.\n *\n */\n instructions: SubscribableSignalLike;\n\n /**\n * The metafields requested in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration)\n * file. These metafields are updated when there's a change in the merchandise items\n * being purchased by the customer.\n *\n * App owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` isn't supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n appMetafields: SubscribableSignalLike;\n\n /**\n * The custom key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n buyerIdentity?: BuyerIdentity;\n\n /**\n * Provides details on the buyer's progression through the checkout and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/buyer-journey#examples)\n * examples for more information.\n */\n buyerJourney: BuyerJourney;\n\n /**\n * Settings applied to the buyer's checkout.\n */\n checkoutSettings: SubscribableSignalLike;\n\n /**\n * A stable ID that represents the current checkout.\n *\n * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\n *\n * This matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data)\n * and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n */\n checkoutToken: SubscribableSignalLike;\n\n /**\n * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * The meta information about the extension.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n *\n * @deprecated Deprecated as of version `2023-07`, use `extension.target` instead.\n */\n extensionPoint: Target;\n\n /**\n * Utilities for translating content and formatting values according to the current\n * [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization)\n * of the checkout.\n *\n * Refer to [`localization` examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples)\n * for more information.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The details about the location, language, and currency of the customer. For utilities to easily\n * format and translate content based on these details, you can use the\n * [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n)\n * object instead.\n */\n localization: Localization;\n\n /**\n * The metafields that apply to the current checkout.\n *\n * Metafields are stored locally on the client and are applied to the order object after the checkout completes.\n *\n * These metafields are shared by all extensions running on checkout, and\n * persist for as long as the customer is working on this checkout.\n *\n * Once the order is created, you can query these metafields using the\n * [GraphQL Admin API](/docs/admin-api/graphql/reference/orders/order#metafield-2021-01)\n *\n * > Caution:\n * `metafields` is deprecated. Use `appMetafields` with cart metafields instead.\n *\n * @deprecated Use `appMetafields` with cart metafields instead.\n */\n metafields: SubscribableSignalLike;\n\n /**\n * A note left by the customer to the merchant, either in their cart or during checkout.\n *\n * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\n */\n note: SubscribableSignalLike;\n\n /**\n * The method used to query the Storefront GraphQL API with a prefetched token.\n *\n * Refer to [Storefront API access examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/storefront-api) for more information.\n */\n query: >(\n query: string,\n options?: {variables?: Variables; version?: StorefrontApiVersion},\n ) => Promise<{data?: Data; errors?: GraphQLError[]}>;\n\n /**\n * The payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\n */\n selectedPaymentOptions: SubscribableSignalLike;\n\n /**\n * The session token providing a set of claims as a signed JSON Web Token (JWT).\n *\n * The token has a TTL of five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/session-token) for more information.\n */\n sessionToken: SessionToken;\n\n /**\n * The settings matching the settings definition written in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates in real time as a merchant fills in the settings.\n */\n settings: SubscribableSignalLike;\n\n /**\n * The proposed customer shipping address. During the information step, the address\n * updates when the field is committed (on change) rather than every keystroke.\n * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n shippingAddress?: SubscribableSignalLike;\n\n /**\n * The proposed customer billing address. The address updates when the field is\n * committed (on change) rather than every keystroke. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided yet.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n billingAddress?: SubscribableSignalLike;\n\n /** The shop where the checkout is taking place. */\n shop: Shop;\n\n /**\n * The key-value storage for the extension.\n *\n * It uses `localStorage` and should persist across the customer's current checkout session.\n *\n * > Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n *\n * Data is shared across all activated extension targets of this extension. In versions 2023-07 and earlier,\n * each activated extension target had its own storage.\n */\n storage: Storage;\n\n /**\n * The renderer version being used for the extension.\n *\n * @example '2025-10'\n */\n version: Version;\n\n /**\n * Customer privacy consent settings and a flag denoting if consent has previously been collected.\n */\n customerPrivacy: SubscribableSignalLike;\n\n /**\n * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent) to be set to `true`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyTrackingConsentChange: ApplyTrackingConsentChangeType;\n\n /**\n * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" + "value": "export interface StandardApi {\n /**\n * Tracks custom events and sends visitor information to\n * [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events\n * and `visitor()` to submit buyer contact details.\n */\n analytics: Analytics;\n\n /**\n * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\n */\n appliedGiftCards: SubscribableSignalLike;\n\n /**\n * The cart instructions used to create the checkout and possibly limit extension capabilities.\n *\n * These instructions should be checked before performing any actions that might be affected by them.\n *\n * For example, if you intend to add a discount code via the `applyDiscountCodeChange` method,\n * check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n *\n * > Caution: Check cart instructions before calling select APIs, as\n * > some may not be available. See the\n * > [Cart Instructions API](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples)\n * > for more information.\n *\n */\n instructions: SubscribableSignalLike;\n\n /**\n * The metafields requested in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration)\n * file. These metafields are updated when there's a change in the merchandise items\n * being purchased by the customer.\n *\n * App owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` isn't supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n appMetafields: SubscribableSignalLike;\n\n /**\n * The custom key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as\n * credit cards, wallets, and local payment methods. The list depends on\n * the shop's payment configuration and the buyer's region.\n *\n * The set of payment options can change when the buyer updates their\n * address or cart, so subscribe to changes rather than reading once\n * during initialization. Each option exposes `handle` and `type` only.\n * Provider names, logos, fees, and installment terms aren't available.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n buyerIdentity?: BuyerIdentity;\n\n /**\n * Provides details on the buyer's progression through the checkout and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/buyer-journey#examples)\n * examples for more information.\n */\n buyerJourney: BuyerJourney;\n\n /**\n * Settings applied to the buyer's checkout.\n */\n checkoutSettings: SubscribableSignalLike;\n\n /**\n * A stable ID that represents the current checkout.\n *\n * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\n *\n * This matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data)\n * and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n *\n * Can be `undefined`. Handle the `undefined` state before using the value.\n */\n checkoutToken: SubscribableSignalLike;\n\n /**\n * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n *\n * Empty until the buyer enters enough address information for Shopify to\n * calculate shipping rates.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * Metadata about the running extension, including the current target, API version,\n * capabilities, and editor context. Use this to conditionally render content\n * based on where the extension is running.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n *\n * @deprecated Use `extension.target` instead.\n */\n extensionPoint: Target;\n\n /**\n * Utilities for translating strings, formatting currencies, numbers, and dates\n * according to the buyer's locale. Use alongside\n * [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization)\n * to build fully localized extensions.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The buyer's language, country, currency, and timezone context. For\n * formatting and translation helpers, use the\n * [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#properties-propertydetail-i18n)\n * object instead.\n */\n localization: Localization;\n\n /**\n * The metafields that apply to the current checkout.\n *\n * Metafields are stored locally on the client and are applied to the order object after the checkout completes.\n *\n * These metafields are shared by all extensions running on checkout, and\n * persist for as long as the customer is working on this checkout.\n *\n * Once the order is created, you can query these metafields using the\n * [GraphQL Admin API](/docs/admin-api/graphql/reference/orders/order#metafield-2021-01)\n *\n * > Caution:\n * `metafields` is deprecated. Use `appMetafields` with cart metafields instead.\n *\n * @deprecated Use `appMetafields` with cart metafields instead.\n */\n metafields: SubscribableSignalLike;\n\n /**\n * A note left by the customer to the merchant, either in their cart or during checkout.\n *\n * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\n */\n note: SubscribableSignalLike;\n\n /**\n * The method used to query the Storefront GraphQL API with a prefetched token.\n *\n */\n query: >(\n query: string,\n options?: {variables?: Variables; version?: StorefrontApiVersion},\n ) => Promise<{data?: Data; errors?: GraphQLError[]}>;\n\n /**\n * The payment options the buyer has currently selected. This updates as\n * the buyer changes their payment method. The array can contain multiple\n * entries when the buyer splits payment across methods (for example, a\n * gift card and a credit card).\n *\n * Each option exposes `handle` and `type` only. Provider names, logos,\n * fees, and installment terms aren't available.\n */\n selectedPaymentOptions: SubscribableSignalLike;\n\n /**\n * The session token providing a set of claims as a signed JSON Web Token (JWT).\n *\n * The token has a TTL of five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Learn more about [session tokens](/docs/apps/build/authentication-authorization/session-tokens).\n */\n sessionToken: SessionToken;\n\n /**\n * The settings matching the settings definition written in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates in real time as a merchant fills in the settings.\n */\n settings: SubscribableSignalLike;\n\n /**\n * The proposed customer shipping address. During the information step, the address\n * updates when the field is committed (on change) rather than every keystroke.\n * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n shippingAddress?: SubscribableSignalLike;\n\n /**\n * The proposed customer billing address. The address updates when the field is\n * committed (on change) rather than every keystroke. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided yet.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n billingAddress?: SubscribableSignalLike;\n\n /**\n * The store where the checkout is taking place, including the shop name,\n * storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.\n */\n shop: Shop;\n\n /**\n * Key-value storage that persists across page loads within the current checkout\n * session. Data is shared across all activated targets associated with\n * this extension.\n *\n * > Caution: Data persistence isn't guaranteed and storage is cleared when the\n * buyer starts a new checkout.\n */\n storage: Storage;\n\n /**\n * The renderer version being used for the extension.\n *\n * @example '2025-10'\n */\n version: Version;\n\n /**\n * Customer privacy consent settings and a flag denoting if consent has previously been collected.\n */\n customerPrivacy: SubscribableSignalLike;\n\n /**\n * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`collect_buyer_consent` capability](/docs/apps/build/customer-accounts/capabilities#collect-buyer-consent) to be set to `true`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyTrackingConsentChange: ApplyTrackingConsentChangeType;\n\n /**\n * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Analytics", - "description": "", + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "publish", "value": "(name: string, data: Record) => Promise", - "description": "Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing)." + "description": "Publishes a custom event to [Web Pixels](/docs/apps/marketing). Returns `true` when the event is successfully dispatched.\n\nThe Promise resolves to `true` when the event was dispatched. The boolean indicates dispatch confirmation only. It doesn't indicate whether any specific web pixel processed the event." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "visitor", "value": "(data: { email?: string; phone?: string; }) => Promise", - "description": "A method for capturing details about a visitor on the online store." + "description": "Submits buyer contact details for attribution and analytics purposes." } ], - "value": "export interface Analytics {\n /**\n * Publish method to emit analytics events to [Web Pixels](/docs/apps/marketing).\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * A method for capturing details about a visitor on the online store.\n */\n visitor(data: {email?: string; phone?: string}): Promise;\n}" + "value": "export interface Analytics {\n /**\n * Publishes a custom event to [Web Pixels](/docs/apps/marketing).\n * Returns `true` when the event is successfully dispatched.\n *\n * The Promise resolves to `true` when the event was dispatched. The boolean\n * indicates dispatch confirmation only. It doesn't indicate whether any\n * specific web pixel processed the event.\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * Submits buyer contact details for attribution and analytics purposes.\n */\n visitor(data: {email?: string; phone?: string}): Promise;\n}" }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -56687,10 +56811,10 @@ "syntaxKind": "PropertySignature", "name": "type", "value": "'error'", - "description": "Indicates that the visitor information is invalid and wasn't submitted. Examples are using the wrong data type or missing a required property." + "description": "Indicates that the visitor information is invalid and wasn't submitted. Common causes include using the wrong data type or omitting a required property." } ], - "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Examples are using the wrong data type or missing a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Common causes include using the wrong data type or omitting a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -56825,10 +56949,10 @@ "syntaxKind": "PropertySignature", "name": "value", "value": "string | null", - "description": "The new value to store in the metafield. Set to `null` to delete the metafield." + "description": "The new value to store in the metafield. Set to `null` to delete the metafield.\n\nConsent metafield values are strings, not booleans. Pass `null` to delete a tracking consent metafield." } ], - "value": "export interface TrackingConsentMetafieldChange {\n /**\n * The identifier for the tracking consent metafield to update.\n */\n key: string;\n /**\n * The new value to store in the metafield. Set to `null` to delete the metafield.\n */\n value: string | null;\n}" + "value": "export interface TrackingConsentMetafieldChange {\n /**\n * The identifier for the tracking consent metafield to update.\n */\n key: string;\n /**\n * The new value to store in the metafield. Set to `null` to delete the metafield.\n *\n * Consent metafield values are strings, not booleans. Pass `null` to delete\n * a tracking consent metafield.\n */\n value: string | null;\n}" }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -57127,7 +57251,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A globally-unique identifier for the customer in the format `gid://shopify/Customer/`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", + "description": "An identifier for the customer in the format `gid://shopify/Customer/`. This value is unique per shop.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", "examples": [ { "title": "Example", @@ -57180,7 +57304,7 @@ "isPrivate": true } ], - "value": "export interface Customer {\n /**\n * A globally-unique identifier for the customer in the format `gid://shopify/Customer/`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'gid://shopify/Customer/123'\n */\n id: string;\n /**\n * The email address associated with the customer's account. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email?: string;\n /**\n * The phone number associated with the customer's account. The value is `undefined` if no phone number is on file or the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone?: string;\n /**\n * The customer's full name, typically a combination of first and last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n fullName?: string;\n /**\n * The customer's first name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n firstName?: string;\n /**\n * The customer's last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n lastName?: string;\n /**\n * The customer's profile image, such as a Gravatar avatar. Use this to personalize the extension UI for the logged-in buyer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n image: ImageDetails;\n /**\n * Whether the customer has opted in to receiving marketing communications from the merchant, such as email campaigns and promotional offers.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * > Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n *\n * @deprecated Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n */\n acceptsMarketing: boolean;\n /**\n * Whether the customer has opted in to email marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsEmailMarketing: boolean;\n /**\n * Whether the customer has opted in to SMS marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsSmsMarketing: boolean;\n /**\n * The store credit accounts owned by this customer that can be used as payment during checkout. Each account has a balance representing available store credit.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @private\n */\n storeCreditAccounts: StoreCreditAccount[];\n /**\n * The number of orders the customer has previously placed with this shop.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n ordersCount: number;\n}" + "value": "export interface Customer {\n /**\n * An identifier for the customer in the format `gid://shopify/Customer/`. This value is unique per shop.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'gid://shopify/Customer/123'\n */\n id: string;\n /**\n * The email address associated with the customer's account. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email?: string;\n /**\n * The phone number associated with the customer's account. The value is `undefined` if no phone number is on file or the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone?: string;\n /**\n * The customer's full name, typically a combination of first and last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n fullName?: string;\n /**\n * The customer's first name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n firstName?: string;\n /**\n * The customer's last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n lastName?: string;\n /**\n * The customer's profile image, such as a Gravatar avatar. Use this to personalize the extension UI for the logged-in buyer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n image: ImageDetails;\n /**\n * Whether the customer has opted in to receiving marketing communications from the merchant, such as email campaigns and promotional offers.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * > Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n *\n * @deprecated Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n */\n acceptsMarketing: boolean;\n /**\n * Whether the customer has opted in to email marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsEmailMarketing: boolean;\n /**\n * Whether the customer has opted in to SMS marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsSmsMarketing: boolean;\n /**\n * The store credit accounts owned by this customer that can be used as payment during checkout. Each account has a balance representing available store credit.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @private\n */\n storeCreditAccounts: StoreCreditAccount[];\n /**\n * The number of orders the customer has previously placed with this shop.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n ordersCount: number;\n}" }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -57439,11 +57563,11 @@ "syntaxKind": "MethodSignature", "name": "perform", "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", + "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.\n\nRuns after all intercept results are collected. Use it for local state updates such as setting an error flag. By the time it runs, the navigation decision is final, so blocking logic belongs in the intercept handler itself, not here.", "isOptional": true } ], - "value": "interface InterceptorRequestAllow {\n /**\n * Indicates that the interceptor allows the buyer's journey to continue.\n */\n behavior: 'allow';\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" + "value": "interface InterceptorRequestAllow {\n /**\n * Indicates that the interceptor allows the buyer's journey to continue.\n */\n behavior: 'allow';\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n *\n * Runs after all intercept results are collected. Use it for local state\n * updates such as setting an error flag. By the time it runs, the navigation\n * decision is final, so blocking logic belongs in the intercept handler\n * itself, not here.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -57507,7 +57631,7 @@ "syntaxKind": "MethodSignature", "name": "perform", "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", + "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.\n\nRuns after all intercept results are collected. Use it for local state updates such as setting an error flag. By the time it runs, the navigation decision is final, so blocking logic belongs in the intercept handler itself, not here.", "isOptional": true }, { @@ -57518,7 +57642,7 @@ "description": "The reason for blocking the interceptor request. This value isn't presented to the buyer, so it doesn't need to be localized. The value is used only for Shopify's own internal debugging and metrics." } ], - "value": "interface InterceptorRequestBlock {\n /**\n * Indicates that the interceptor blocks the buyer's journey from continuing.\n */\n behavior: 'block';\n\n /**\n * The reason for blocking the interceptor request. This value isn't presented to\n * the buyer, so it doesn't need to be localized. The value is used only for Shopify's\n * own internal debugging and metrics.\n */\n reason: string;\n\n /**\n * Used to pass errors to the checkout UI, outside your extension's UI boundaries.\n */\n errors?: ValidationError[];\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" + "value": "interface InterceptorRequestBlock {\n /**\n * Indicates that the interceptor blocks the buyer's journey from continuing.\n */\n behavior: 'block';\n\n /**\n * The reason for blocking the interceptor request. This value isn't presented to\n * the buyer, so it doesn't need to be localized. The value is used only for Shopify's\n * own internal debugging and metrics.\n */\n reason: string;\n\n /**\n * Used to pass errors to the checkout UI, outside your extension's UI boundaries.\n */\n errors?: ValidationError[];\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n *\n * Runs after all intercept results are collected. Use it for local state\n * updates such as setting an error flag. By the time it runs, the navigation\n * decision is final, so blocking logic belongs in the intercept handler\n * itself, not here.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" }, { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -57739,17 +57863,17 @@ "syntaxKind": "PropertySignature", "name": "totalShippingAmount", "value": "SubscribableSignalLike", - "description": "The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step." + "description": "The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step.\n\n`undefined` until the buyer selects a shipping method (typically after the information step)." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "totalTaxAmount", "value": "SubscribableSignalLike", - "description": "The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet." + "description": "The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet.\n\n`undefined` when taxes haven't been calculated or aren't available for the buyer's region." } ], - "value": "export interface CartCost {\n /**\n * The sum of all line item prices at the current step of checkout, before shipping and taxes are applied. Use this value to display the base cost of the items the buyer purchased.\n */\n subtotalAmount: SubscribableSignalLike;\n\n /**\n * The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step.\n */\n totalShippingAmount: SubscribableSignalLike;\n\n /**\n * The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet.\n */\n totalTaxAmount: SubscribableSignalLike;\n\n /**\n * The minimum total at the current step of checkout. Costs not yet calculated, such as shipping on the information step, aren't included. Gift cards and store credits are excluded from this total.\n */\n totalAmount: SubscribableSignalLike;\n}" + "value": "export interface CartCost {\n /**\n * The sum of all line item prices at the current step of checkout, before shipping and taxes are applied. Use this value to display the base cost of the items the buyer purchased.\n */\n subtotalAmount: SubscribableSignalLike;\n\n /**\n * The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step.\n *\n * `undefined` until the buyer selects a shipping method (typically after the\n * information step).\n */\n totalShippingAmount: SubscribableSignalLike;\n\n /**\n * The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet.\n *\n * `undefined` when taxes haven't been calculated or aren't available for the\n * buyer's region.\n */\n totalTaxAmount: SubscribableSignalLike;\n\n /**\n * The minimum total at the current step of checkout. Costs not yet calculated, such as shipping on the information step, aren't included. Gift cards and store credits are excluded from this total.\n */\n totalAmount: SubscribableSignalLike;\n}" }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -57836,31 +57960,31 @@ "syntaxKind": "PropertySignature", "name": "analytics", "value": "boolean", - "description": "Whether analytics data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Analytics data includes how the shop was used and what interactions occurred." + "description": "Whether analytics data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Analytics data includes how the shop was used and what interactions occurred.\n\nWhether analytics data can be collected right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.analytics`, before calling `shopify.analytics.publish()`." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "marketing", "value": "boolean", - "description": "Whether marketing data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Marketing data includes attribution and targeted advertising preferences." + "description": "Whether marketing data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Marketing data includes attribution and targeted advertising preferences.\n\nWhether marketing data can be collected right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.marketing`, before performing marketing-related data collection." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "preferences", "value": "boolean", - "description": "Whether preference data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Preference data includes language, currency, and sizing choices." + "description": "Whether preference data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Preference data includes language, currency, and sizing choices.\n\nWhether preference data can be collected right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.preferences`, before storing or reading buyer preference data." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "saleOfData", "value": "boolean", - "description": "Whether data can be shared with third parties based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. This typically applies to behavioral advertising data." + "description": "Whether data can be shared with third parties based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. This typically applies to behavioral advertising data.\n\nWhether buyer data can be shared with or sold to third parties right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.saleOfData`, before sharing or selling buyer data with third parties." } ], - "value": "export interface AllowedProcessing {\n /**\n * Whether analytics data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Analytics\n * data includes how the shop was used and what interactions occurred.\n */\n analytics: boolean;\n /**\n * Whether marketing data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Marketing\n * data includes attribution and targeted advertising preferences.\n */\n marketing: boolean;\n /**\n * Whether preference data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Preference\n * data includes language, currency, and sizing choices.\n */\n preferences: boolean;\n /**\n * Whether data can be shared with third parties based on the visitor's\n * consent, the merchant's privacy configuration, and the visitor's region.\n * This typically applies to behavioral advertising data.\n */\n saleOfData: boolean;\n}" + "value": "export interface AllowedProcessing {\n /**\n * Whether analytics data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Analytics\n * data includes how the shop was used and what interactions occurred.\n *\n * Whether analytics data can be collected right now. Combines the buyer's\n * consent, the merchant's privacy configuration, and the buyer's region into\n * a single boolean. Check this flag, not `visitorConsent.analytics`, before\n * calling `shopify.analytics.publish()`.\n */\n analytics: boolean;\n /**\n * Whether marketing data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Marketing\n * data includes attribution and targeted advertising preferences.\n *\n * Whether marketing data can be collected right now. Combines the buyer's\n * consent, the merchant's privacy configuration, and the buyer's region into\n * a single boolean. Check this flag, not `visitorConsent.marketing`, before\n * performing marketing-related data collection.\n */\n marketing: boolean;\n /**\n * Whether preference data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Preference\n * data includes language, currency, and sizing choices.\n *\n * Whether preference data can be collected right now. Combines the buyer's\n * consent, the merchant's privacy configuration, and the buyer's region into\n * a single boolean. Check this flag, not `visitorConsent.preferences`,\n * before storing or reading buyer preference data.\n */\n preferences: boolean;\n /**\n * Whether data can be shared with third parties based on the visitor's\n * consent, the merchant's privacy configuration, and the visitor's region.\n * This typically applies to behavioral advertising data.\n *\n * Whether buyer data can be shared with or sold to third parties right now.\n * Combines the buyer's consent, the merchant's privacy configuration, and\n * the buyer's region into a single boolean. Check this flag, not\n * `visitorConsent.saleOfData`, before sharing or selling buyer data with\n * third parties.\n */\n saleOfData: boolean;\n}" }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -57950,7 +58074,7 @@ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Extension", - "description": "The meta information about an extension target.", + "description": "Metadata about the running extension, including its API version, target, capabilities, and editor context. Use this to read configuration details or conditionally render content based on where the extension is running.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -57976,7 +58100,7 @@ "syntaxKind": "PropertySignature", "name": "capabilities", "value": "SubscribableSignalLike", - "description": "The allowed capabilities of the extension, defined in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n\n* [`api_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#api-access): the extension can access the Storefront API.\n\n* [`network_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access): the extension can make external network calls.\n\n* [`block_progress`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n\n* [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n\n* [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can register customer consent decisions that are honored on Shopify-managed services.\n\n* [`iframe.sources`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#iframe): the extension can embed an external URL in an iframe." + "description": "The allowed capabilities of the extension, defined in your [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -58024,7 +58148,7 @@ "syntaxKind": "PropertySignature", "name": "version", "value": "string", - "description": "The published version of the running extension target.\n\nFor unpublished extensions, the value is `undefined`.", + "description": "The published version of the running extension target.\n\nFor unpublished extensions, the value is `undefined`.\n\nDon't use this property as a stable identifier in development environments. It becomes available only after the extension is published.", "isOptional": true, "examples": [ { @@ -58040,7 +58164,7 @@ ] } ], - "value": "export interface Extension {\n /**\n * The API version that was set in the extension config file.\n *\n * @example '2024-10', '2025-01', '2025-04', '2025-07', '2025-10'\n */\n apiVersion: ApiVersion;\n\n /**\n * The allowed capabilities of the extension, defined\n * in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n *\n * * [`api_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#api-access): the extension can access the Storefront API.\n *\n * * [`network_access`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access): the extension can make external network calls.\n *\n * * [`block_progress`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n *\n * * [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n *\n * * [`collect_buyer_consent.customer_privacy`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can register customer consent decisions that are honored on Shopify-managed services.\n *\n * * [`iframe.sources`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#iframe): the extension can embed an external URL in an iframe.\n */\n capabilities: SubscribableSignalLike;\n\n /**\n * Information about the editor where the extension is being rendered.\n *\n * If the value is undefined, then the extension isn't running in an editor.\n */\n editor?: Editor;\n\n /**\n * A Boolean to show whether your extension is currently rendered to the screen.\n *\n * Shopify might render your extension before it's visible in the UI,\n * typically to pre-render extensions that appear on a later step of the\n * checkout.\n *\n * Your extension might also continue to run after the customer has navigated away\n * from where it was rendered. The extension continues running so that\n * your extension is immediately available to render if the customer navigates back.\n */\n rendered: SubscribableSignalLike;\n\n /**\n * The URL to the script that started the extension target.\n */\n scriptUrl: string;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n */\n target: Target;\n\n /**\n * The published version of the running extension target.\n *\n * For unpublished extensions, the value is `undefined`.\n *\n * @example 3.0.10\n */\n version?: string;\n}" + "value": "export interface Extension {\n /**\n * The API version that was set in the extension config file.\n *\n * @example '2024-10', '2025-01', '2025-04', '2025-07', '2025-10'\n */\n apiVersion: ApiVersion;\n\n /**\n * The allowed capabilities of the extension, defined in your\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n */\n capabilities: SubscribableSignalLike;\n\n /**\n * Information about the editor where the extension is being rendered.\n *\n * If the value is undefined, then the extension isn't running in an editor.\n */\n editor?: Editor;\n\n /**\n * A Boolean to show whether your extension is currently rendered to the screen.\n *\n * Shopify might render your extension before it's visible in the UI,\n * typically to pre-render extensions that appear on a later step of the\n * checkout.\n *\n * Your extension might also continue to run after the customer has navigated away\n * from where it was rendered. The extension continues running so that\n * your extension is immediately available to render if the customer navigates back.\n */\n rendered: SubscribableSignalLike;\n\n /**\n * The URL to the script that started the extension target.\n */\n scriptUrl: string;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n */\n target: Target;\n\n /**\n * The published version of the running extension target.\n *\n * For unpublished extensions, the value is `undefined`.\n *\n * Don't use this property as a stable identifier in development environments.\n * It becomes available only after the extension is published.\n *\n * @example 3.0.10\n */\n version?: string;\n}" }, { "filePath": "src/shared.ts", @@ -58059,7 +58183,7 @@ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Editor", - "description": "", + "description": "Information about the editor environment when an extension is rendered inside the checkout editor. The value is `undefined` when the extension is not rendering in an editor.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -58074,7 +58198,7 @@ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18n", - "description": "", + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use the I18n API alongside the Localization API to build fully localized extensions.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -58110,7 +58234,7 @@ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18nTranslate", - "description": "This returns a translated string matching a key in a locale file.", + "description": "Translates a key from your extension's locale files into a localized string. Supports interpolation with placeholder replacements and pluralization via the special `count` option.", "members": [], "value": "export interface I18nTranslate {\n (\n key: string,\n options?: Record,\n ): ReplacementType extends string | number\n ? string\n : (string | ReplacementType)[];\n}" }, @@ -58278,14 +58402,14 @@ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Localization", - "description": "", + "description": "The buyer's language, country, currency, and timezone context. Use this to adapt your extension to the buyer's region and display localized content.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "country", "value": "SubscribableSignalLike", - "description": "The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown." + "description": "The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n\nDerived from the buyer's shipping address. Returns `undefined` until the buyer enters a shipping address." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -58313,18 +58437,18 @@ "syntaxKind": "PropertySignature", "name": "market", "value": "SubscribableSignalLike", - "description": "The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n\n> Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.", - "deprecationMessage": "Deprecated as of version `2025-04`" + "description": "The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. The market context updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.", + "deprecationMessage": "Merchants now manage which extensions load for each\nmarket, so extensions no longer need to check this value." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "timezone", "value": "SubscribableSignalLike", - "description": "The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time." + "description": "The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time." } ], - "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n *\n * > Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" + "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n *\n * Derived from the buyer's shipping address. Returns `undefined` until the\n * buyer enters a shipping address.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout,\n * carried over from the cart context. Markets group countries and\n * regions with shared pricing, languages, and domains. The market\n * context updates when the buyer changes the country of their\n * shipping address. The value is `undefined` if the market is unknown.\n *\n * @deprecated Merchants now manage which extensions load for each\n * market, so extensions no longer need to check this value.\n */\n market: SubscribableSignalLike;\n}" }, { "filePath": "src/shared.ts", @@ -58525,7 +58649,7 @@ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SessionToken", - "description": "", + "description": "Authenticates requests between your extension and your app backend. Use session tokens to verify the identity of the buyer and the shop context when making server-side API calls. The token is a signed JWT that contains claims such as the customer ID, shop domain, and expiration.\n\nThe `sub` claim in the decoded token is present only when the buyer is logged in and the app has permission to read customer accounts. Absent for anonymous buyers.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -58548,7 +58672,7 @@ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Shop", - "description": "", + "description": "Metadata about the merchant's store, including its name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -58588,30 +58712,30 @@ "syntaxKind": "PropertySignature", "name": "storefrontUrl", "value": "string", - "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n\n> Caution: > As of version `2024-04` this value no longer has a trailing slash.", + "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.", "isOptional": true } ], - "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n *\n * > Caution:\n * > As of version `2024-04` this value no longer has a trailing slash.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom domain.\n */\n myshopifyDomain: string;\n}" + "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom domain.\n */\n myshopifyDomain: string;\n}" }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Storage", - "description": "A key-value storage object for the extension.\n\nStored data is available only to this specific extension and any of its instances.\n\nThe storage backend is implemented with `localStorage` and should persist across the buyer's checkout session. However, data persistence isn't guaranteed.", + "description": "Key-value storage for a specific extension. Use storage to save preferences or cached data that should survive page reloads without requiring a backend call. Stored data is only available to this specific extension. The storage backend is implemented with `localStorage` and data persistence isn't guaranteed.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "delete", "value": "(key: string) => Promise", - "description": "Delete stored data by key." + "description": "Deletes a previously stored value by key." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "read", "value": "(key: string) => Promise", - "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original primitive.\n\nReturns `null` if no stored data exists." + "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original type.\n\nReturns the stored value for the given key, or `null` when no value exists. Doesn't throw on a missing key." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -58621,7 +58745,7 @@ "description": "Write stored data for this key.\n\nThe data must be serializable to JSON." } ], - "value": "export interface Storage {\n /**\n * Read and return a stored value by key.\n *\n * The stored data is deserialized from JSON and returned as\n * its original primitive.\n *\n * Returns `null` if no stored data exists.\n */\n read(key: string): Promise;\n\n /**\n * Write stored data for this key.\n *\n * The data must be serializable to JSON.\n */\n write(key: string, data: any): Promise;\n\n /**\n * Delete stored data by key.\n */\n delete(key: string): Promise;\n}" + "value": "export interface Storage {\n /**\n * Read and return a stored value by key.\n *\n * The stored data is deserialized from JSON and returned as\n * its original type.\n *\n * Returns the stored value for the given key, or `null` when no value\n * exists. Doesn't throw on a missing key.\n */\n read(key: string): Promise;\n\n /**\n * Write stored data for this key.\n *\n * The data must be serializable to JSON.\n */\n write(key: string, data: any): Promise;\n\n /**\n * Deletes a previously stored value by key.\n */\n delete(key: string): Promise;\n}" }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -58905,7 +59029,7 @@ "syntaxKind": "PropertySignature", "name": "number", "value": "string", - "description": "A randomly generated alpha-numeric identifier for the order, distinct from `order.id`. The value is `undefined` for orders that were created before this field was introduced. All recent orders have a number.", + "description": "A randomly generated alpha-numeric identifier for the order, distinct from `order.id`. The value is `undefined` for orders that were created before this field was introduced. All recent orders have a number.\n\nOptional. Might not be present for orders created before 2024.", "isOptional": true }, { @@ -58916,7 +59040,7 @@ "description": "" } ], - "value": "export interface OrderConfirmation {\n order: {\n /**\n * A globally unique identifier for the order. This becomes the\n * [`Order`](/docs/api/admin-graphql/latest/objects/Order) object ID in the\n * GraphQL Admin API after the order is created.\n *\n * @example 'gid://shopify/Order/123'\n */\n id: string;\n };\n /**\n * A randomly generated alpha-numeric identifier for the order, distinct\n * from `order.id`. The value is `undefined` for orders that were created\n * before this field was introduced. All recent orders have a number.\n */\n number?: string;\n\n /**\n * Whether this is the customer's first completed order with this shop. `true` means the buyer hasn't placed an order here before. Use this to show first-purchase messaging or trigger welcome offers.\n */\n isFirstOrder: boolean;\n}" + "value": "export interface OrderConfirmation {\n order: {\n /**\n * A globally unique identifier for the order. This becomes the\n * [`Order`](/docs/api/admin-graphql/latest/objects/Order) object ID in the\n * GraphQL Admin API after the order is created.\n *\n * @example 'gid://shopify/Order/123'\n */\n id: string;\n };\n /**\n * A randomly generated alpha-numeric identifier for the order, distinct\n * from `order.id`. The value is `undefined` for orders that were created\n * before this field was introduced. All recent orders have a number.\n *\n * Optional. Might not be present for orders created before 2024.\n */\n number?: string;\n\n /**\n * Whether this is the customer's first completed order with this shop. `true` means the buyer hasn't placed an order here before. Use this to show first-purchase messaging or trigger welcome offers.\n */\n isFirstOrder: boolean;\n}" }, { "filePath": "src/surfaces/checkout/shared.ts", @@ -59053,7 +59177,7 @@ "syntaxKind": "PropertySignature", "name": "localization", "value": "Localization", - "description": "The details about the location, language, and currency of the customer. For utilities to easily format and translate content based on these details, you can use the [`i18n`](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-i18n) object instead." + "description": "The details about the location, language, and currency of the customer. For utilities to easily format and translate content based on these details, you can use the [`i18n`](/docs/api/checkout-ui-extensions/apis/localization#properties-propertydetail-i18n) object instead." }, { "filePath": "src/surfaces/checkout/api/address-autocomplete/standard.ts", @@ -59075,7 +59199,7 @@ "syntaxKind": "PropertySignature", "name": "sessionToken", "value": "SessionToken", - "description": "The session token providing a set of claims as a signed JSON Web Token (JWT).\n\nThe token has a TTL of 5 minutes.\n\nIf the previous token expires, this value will reflect a new session token with a new signature and expiry.\n\nRefer to [session token examples](/docs/api/checkout-ui-extensions/apis/session-token) for more information." + "description": "The session token providing a set of claims as a signed JSON Web Token (JWT).\n\nThe token has a TTL of 5 minutes.\n\nIf the previous token expires, this value will reflect a new session token with a new signature and expiry.\n\nLearn more about [session tokens](/docs/apps/build/authentication-authorization/session-tokens)." }, { "filePath": "src/surfaces/checkout/api/address-autocomplete/standard.ts", @@ -59126,7 +59250,7 @@ ] } ], - "value": "export interface AddressAutocompleteStandardApi<\n Target extends\n | 'purchase.address-autocomplete.suggest'\n | 'purchase.address-autocomplete.format-suggestion',\n> {\n /**\n * The metafields requested in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration)\n * file. These metafields are updated when there's a change in the merchandise items\n * being purchased by the customer.\n *\n * App owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` is not supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * > Tip:\n * > Cart metafields are only available on carts created via the Storefront API version `2023-04` or later.*\n */\n appMetafields: AppMetafieldEntry[];\n\n /**\n * The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event.\n */\n analytics: Analytics;\n\n /**\n * The custom attributes left by the customer to the merchant, either in their cart or during checkout.\n */\n attributes: Attribute[] | undefined;\n\n /**\n * The proposed customer billing address. The address updates when the field is\n * committed (on change) rather than every keystroke.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n billingAddress?: MailingAddress | undefined;\n\n /**\n * A stable ID that represents the current checkout.\n *\n * This matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data)\n * and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n */\n checkoutToken: CheckoutToken | undefined;\n\n /**\n * The meta information about the extension.\n */\n extension: Extension;\n\n /**\n * Utilities for translating content and formatting values according to the current\n * [`localization`](/docs/api/checkout-ui-extensions/apis/localization)\n * Type 'RunnableExtensionInstance' is not assignable to type 'ExtensionInstance'.\n *\n * Refer to [`localization` examples](/docs/api/checkout-ui-extensions/apis/localization#examples)\n * for more information.\n */\n i18n: I18n;\n\n /**\n * The details about the location, language, and currency of the customer. For utilities to easily\n * format and translate content based on these details, you can use the\n * [`i18n`](/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-i18n)\n * object instead.\n */\n localization: Localization;\n\n /**\n * The metafields that apply to the current checkout.\n *\n * Metafields are stored locally on the client and are applied to the order object after the checkout completes.\n * They are shared by all extensions running on checkout, and\n * persist for as long as the customer is working on this checkout.\n *\n * Once the order is created, you can query these metafields using the\n * [GraphQL Admin API](/docs/admin-api/graphql/reference/orders/order#metafield-2021-01)\n *\n * > Caution:\n * `metafields` is deprecated. Use `appMetafields` with cart metafields instead.\n *\n * @deprecated Use `appMetafields` with cart metafields instead.\n */\n metafields: Metafield[];\n\n /**\n * The method used to query the Storefront GraphQL API with a prefetched token.\n *\n * Refer to [Storefront API access examples](/docs/api/checkout-ui-extensions/apis/storefront-api) for more information.\n */\n query: >(\n query: string,\n options?: {variables?: Variables; version?: StorefrontApiVersion},\n ) => Promise<{data?: Data; errors?: GraphQLError[]}>;\n\n /**\n * The session token providing a set of claims as a signed JSON Web Token (JWT).\n *\n * The token has a TTL of 5 minutes.\n *\n * If the previous token expires, this value will reflect a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/apis/session-token) for more information.\n */\n sessionToken: SessionToken;\n\n /**\n * The settings matching the settings definition written in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/apis/settings#examples) for more information.\n *\n * > Note: The settings are empty when an extension is being installed in the [checkout editor](https://help.shopify.com/en/manual/checkout-settings/checkout-extensibility/checkout-editor).\n\n */\n settings: ExtensionSettings;\n\n /**\n * The proposed customer shipping address. During the information step,\n * the address updates when the field is committed (on change) rather than every keystroke.\n *\n * > Note: An address value is only present if delivery is required. Otherwise, the subscribable value is undefined.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n shippingAddress?: MailingAddress | undefined;\n\n /** The shop where the checkout is taking place. */\n shop: Shop;\n\n /**\n * The key-value storage for the extension.\n *\n * It uses `localStorage` and should persist across the customer's current checkout session.\n *\n * > Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n *\n * Data is shared across all activated extension targets of this extension. In versions 2023-07 and earlier,\n * each activated extension target had its own storage.\n */\n storage: Storage;\n\n /**\n * The runner version being used for the extension.\n *\n * @example 'unstable'\n */\n version: Version;\n}" + "value": "export interface AddressAutocompleteStandardApi<\n Target extends\n | 'purchase.address-autocomplete.suggest'\n | 'purchase.address-autocomplete.format-suggestion',\n> {\n /**\n * The metafields requested in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration)\n * file. These metafields are updated when there's a change in the merchandise items\n * being purchased by the customer.\n *\n * App owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` is not supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * > Tip:\n * > Cart metafields are only available on carts created via the Storefront API version `2023-04` or later.*\n */\n appMetafields: AppMetafieldEntry[];\n\n /**\n * The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event.\n */\n analytics: Analytics;\n\n /**\n * The custom attributes left by the customer to the merchant, either in their cart or during checkout.\n */\n attributes: Attribute[] | undefined;\n\n /**\n * The proposed customer billing address. The address updates when the field is\n * committed (on change) rather than every keystroke.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n billingAddress?: MailingAddress | undefined;\n\n /**\n * A stable ID that represents the current checkout.\n *\n * This matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data)\n * and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n */\n checkoutToken: CheckoutToken | undefined;\n\n /**\n * The meta information about the extension.\n */\n extension: Extension;\n\n /**\n * Utilities for translating content and formatting values according to the current\n * [`localization`](/docs/api/checkout-ui-extensions/apis/localization)\n * Type 'RunnableExtensionInstance' is not assignable to type 'ExtensionInstance'.\n *\n * Refer to [`localization` examples](/docs/api/checkout-ui-extensions/apis/localization#examples)\n * for more information.\n */\n i18n: I18n;\n\n /**\n * The details about the location, language, and currency of the customer. For utilities to easily\n * format and translate content based on these details, you can use the\n * [`i18n`](/docs/api/checkout-ui-extensions/apis/localization#properties-propertydetail-i18n)\n * object instead.\n */\n localization: Localization;\n\n /**\n * The metafields that apply to the current checkout.\n *\n * Metafields are stored locally on the client and are applied to the order object after the checkout completes.\n * They are shared by all extensions running on checkout, and\n * persist for as long as the customer is working on this checkout.\n *\n * Once the order is created, you can query these metafields using the\n * [GraphQL Admin API](/docs/admin-api/graphql/reference/orders/order#metafield-2021-01)\n *\n * > Caution:\n * `metafields` is deprecated. Use `appMetafields` with cart metafields instead.\n *\n * @deprecated Use `appMetafields` with cart metafields instead.\n */\n metafields: Metafield[];\n\n /**\n * The method used to query the Storefront GraphQL API with a prefetched token.\n *\n * Refer to [Storefront API access examples](/docs/api/checkout-ui-extensions/apis/storefront-api) for more information.\n */\n query: >(\n query: string,\n options?: {variables?: Variables; version?: StorefrontApiVersion},\n ) => Promise<{data?: Data; errors?: GraphQLError[]}>;\n\n /**\n * The session token providing a set of claims as a signed JSON Web Token (JWT).\n *\n * The token has a TTL of 5 minutes.\n *\n * If the previous token expires, this value will reflect a new session token with a new signature and expiry.\n *\n * Learn more about [session tokens](/docs/apps/build/authentication-authorization/session-tokens).\n */\n sessionToken: SessionToken;\n\n /**\n * The settings matching the settings definition written in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/apis/settings#examples) for more information.\n *\n * > Note: The settings are empty when an extension is being installed in the [checkout editor](https://help.shopify.com/en/manual/checkout-settings/checkout-extensibility/checkout-editor).\n\n */\n settings: ExtensionSettings;\n\n /**\n * The proposed customer shipping address. During the information step,\n * the address updates when the field is committed (on change) rather than every keystroke.\n *\n * > Note: An address value is only present if delivery is required. Otherwise, the subscribable value is undefined.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n shippingAddress?: MailingAddress | undefined;\n\n /** The shop where the checkout is taking place. */\n shop: Shop;\n\n /**\n * The key-value storage for the extension.\n *\n * It uses `localStorage` and should persist across the customer's current checkout session.\n *\n * > Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n *\n * Data is shared across all activated extension targets of this extension. In versions 2023-07 and earlier,\n * each activated extension target had its own storage.\n */\n storage: Storage;\n\n /**\n * The runner version being used for the extension.\n *\n * @example 'unstable'\n */\n version: Version;\n}" }, { "filePath": "src/surfaces/checkout/api/address-autocomplete/format-suggestion.ts", @@ -59492,10 +59616,10 @@ "syntaxKind": "PropertySignature", "name": "suggestions", "value": "AddressAutocompleteSuggestion[]", - "description": "An array of address autocomplete suggestions to show to the buyer.\n\n> Note: Only the first five suggestions will be displayed to the buyer." + "description": "An array of address autocomplete suggestions to show to the buyer. Checkout displays up to five address suggestions. Return no more than five. Additional suggestions are ignored." } ], - "value": "export interface AddressAutocompleteSuggestOutput {\n /**\n * An array of address autocomplete suggestions to show to the buyer.\n *\n * > Note: Only the first five suggestions will be displayed to the buyer.\n */\n suggestions: AddressAutocompleteSuggestion[];\n}" + "value": "export interface AddressAutocompleteSuggestOutput {\n /**\n * An array of address autocomplete suggestions to show to the buyer.\n * Checkout displays up to five address suggestions. Return no more\n * than five. Additional suggestions are ignored.\n */\n suggestions: AddressAutocompleteSuggestion[];\n}" }, { "filePath": "src/surfaces/checkout/extension-targets.ts", @@ -60253,6 +60377,131 @@ ], "value": "export interface ShopifyGlobal {\n extend(\n target: ExtensionTarget,\n extend: () => ExtensionTargets[ExtensionTarget]['output'],\n ): void;\n reload(): void;\n}" }, + { + "filePath": "src/surfaces/customer-account/api/standard-api/standard-api.ts", + "name": "Navigation", + "description": "Navigates between pages in customer accounts, including other extensions and host pages. Full-page extensions also get access to the current navigation entry and history state.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/customer-account/api/standard-api/standard-api.ts", + "syntaxKind": "MethodSignature", + "name": "addEventListener", + "value": "(type: \"currententrychange\", cb: (event: NavigationCurrentEntryChangeEvent) => void) => void", + "description": "Registers a listener that fires whenever the current navigation entry changes, such as when the buyer navigates to a different page." + }, + { + "filePath": "src/surfaces/customer-account/api/standard-api/standard-api.ts", + "syntaxKind": "PropertySignature", + "name": "currentEntry", + "value": "NavigationHistoryEntry", + "description": "The current navigation history entry, representing the page the buyer is viewing. Only available in full-page extensions." + }, + { + "filePath": "src/surfaces/customer-account/api/standard-api/standard-api.ts", + "syntaxKind": "PropertySignature", + "name": "navigate", + "value": "NavigateFunction", + "description": "Navigates to a URL, updating any provided state in the history entries list. Supports [custom protocols](/docs/api/customer-account-ui-extensions/{API_VERSION}#custom-protocols) for navigating within customer accounts." + }, + { + "filePath": "src/surfaces/customer-account/api/standard-api/standard-api.ts", + "syntaxKind": "MethodSignature", + "name": "removeEventListener", + "value": "(type: \"currententrychange\", cb: (event: NavigationCurrentEntryChangeEvent) => void) => void", + "description": "Removes a previously registered `currententrychange` listener." + }, + { + "filePath": "src/surfaces/customer-account/api/standard-api/standard-api.ts", + "syntaxKind": "MethodSignature", + "name": "updateCurrentEntry", + "value": "(options: NavigationUpdateCurrentEntryOptions) => void", + "description": "Updates the state of the current history entry without triggering a navigation. Use this when the state change is independent of a page transition, such as saving form progress." + } + ], + "value": "export interface Navigation {\n /**\n * Navigates to a URL, updating any provided state in the history entries list. Supports [custom protocols](/docs/api/customer-account-ui-extensions/{API_VERSION}#custom-protocols) for navigating within customer accounts.\n */\n navigate: NavigateFunction;\n /**\n * The current navigation history entry, representing the page the buyer is viewing. Only available in full-page extensions.\n */\n currentEntry: NavigationHistoryEntry;\n /**\n * Updates the state of the current history entry without triggering a navigation. Use this when the state change is independent of a page transition, such as saving form progress.\n */\n updateCurrentEntry(options: NavigationUpdateCurrentEntryOptions): void;\n /**\n * Registers a listener that fires whenever the current navigation entry changes, such as when the buyer navigates to a different page.\n */\n addEventListener(\n type: 'currententrychange',\n cb: (event: NavigationCurrentEntryChangeEvent) => void,\n ): void;\n /**\n * Removes a previously registered `currententrychange` listener.\n */\n removeEventListener(\n type: 'currententrychange',\n cb: (event: NavigationCurrentEntryChangeEvent) => void,\n ): void;\n}" + }, + { + "filePath": "src/surfaces/customer-account/api/standard-api/standard-api.ts", + "name": "NavigationCurrentEntryChangeEvent", + "description": "The event object passed to `currententrychange` listeners when the current navigation entry changes.", + "members": [ + { + "filePath": "src/surfaces/customer-account/api/standard-api/standard-api.ts", + "syntaxKind": "PropertySignature", + "name": "from", + "value": "NavigationHistoryEntry", + "description": "The history entry the buyer navigated away from." + }, + { + "filePath": "src/surfaces/customer-account/api/standard-api/standard-api.ts", + "syntaxKind": "PropertySignature", + "name": "navigationType", + "value": "NavigationTypeString", + "description": "The type of navigation that caused the change: `'push'`, `'replace'`, or `'traverse'`.", + "isOptional": true + } + ], + "value": "export interface NavigationCurrentEntryChangeEvent {\n /**\n * The type of navigation that caused the change: `'push'`, `'replace'`, or `'traverse'`.\n */\n navigationType?: NavigationTypeString;\n /**\n * The history entry the buyer navigated away from.\n */\n from: NavigationHistoryEntry;\n}" + }, + { + "filePath": "src/surfaces/customer-account/api/standard-api/standard-api.ts", + "name": "NavigationHistoryEntry", + "description": "A single entry in the navigation history stack. Each entry has a unique key, a URL, and optional developer-defined state.", + "members": [ + { + "filePath": "src/surfaces/customer-account/api/standard-api/standard-api.ts", + "syntaxKind": "MethodSignature", + "name": "getState", + "value": "() => unknown", + "description": "Returns a clone of the developer-defined state associated with this history entry." + }, + { + "filePath": "src/surfaces/customer-account/api/standard-api/standard-api.ts", + "syntaxKind": "PropertySignature", + "name": "key", + "value": "string", + "description": "A unique, platform-generated identifier for this entry's position in the history stack. This value identifies the slot, not the content." + }, + { + "filePath": "src/surfaces/customer-account/api/standard-api/standard-api.ts", + "syntaxKind": "PropertySignature", + "name": "url", + "value": "string | null", + "description": "The URL associated with this history entry, or `null` if unavailable." + } + ], + "value": "export interface NavigationHistoryEntry {\n /**\n * A unique, platform-generated identifier for this entry's position in the history stack. This value identifies the slot, not the content.\n */\n key: string;\n /**\n * The URL associated with this history entry, or `null` if unavailable.\n */\n url: string | null;\n /**\n * Returns a clone of the developer-defined state associated with this history entry.\n */\n getState(): unknown;\n}" + }, + { + "filePath": "src/surfaces/customer-account/api/standard-api/standard-api.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "NavigationTypeString", + "value": "'push' | 'replace' | 'traverse'", + "description": "An enumerated value representing the type of navigation." + }, + { + "filePath": "src/surfaces/customer-account/api/standard-api/standard-api.ts", + "name": "NavigateFunction", + "description": "A callable function that navigates to a URL within customer accounts. Accepts a destination URL and optional navigation options.", + "members": [], + "value": "export interface NavigateFunction {\n /**\n * Navigates to a specific URL, updating any provided state in the history entries list.\n * @param url The destination URL to navigate to.\n */\n (url: string, options?: NavigationNavigateOptions): void;\n}" + }, + { + "filePath": "src/surfaces/customer-account/api/standard-api/standard-api.ts", + "name": "NavigationUpdateCurrentEntryOptions", + "description": "Options for `Navigation.updateCurrentEntry()`. Use this to update the state of the current history entry without triggering a navigation.", + "members": [ + { + "filePath": "src/surfaces/customer-account/api/standard-api/standard-api.ts", + "syntaxKind": "PropertySignature", + "name": "state", + "value": "unknown", + "description": "Developer-defined state to associate with the current navigation history entry." + } + ], + "value": "export interface NavigationUpdateCurrentEntryOptions {\n /**\n * Developer-defined state to associate with the current navigation history entry.\n */\n state: unknown;\n}" + }, { "filePath": "src/surfaces/customer-account/components/shared.ts", "syntaxKind": "TypeAliasDeclaration", @@ -60369,7 +60618,7 @@ "syntaxKind": "PropertySignature", "name": "initials", "value": "string", - "description": "The initials to display in the avatar when no image is provided or fails to load. Typically one or two characters representing a person's first and last name initials, such as \"JD\" for John Doe.", + "description": "The initials to display in the avatar when no image is provided or fails to load. Typically one or two characters representing a person's first and last name initials, such as \"JD\" for John Doe.\n\nCharacters beyond the first two might be truncated. Special characters, emojis, and non-Latin scripts might not render as expected.", "isOptional": true }, { @@ -60469,7 +60718,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/customer-account/components.ts", @@ -62484,7 +62733,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/customer-account/components.ts", @@ -62813,7 +63062,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/customer-account/components.ts", @@ -64821,7 +65070,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/customer-account/components.ts", @@ -65092,7 +65341,7 @@ "syntaxKind": "PropertySignature", "name": "heading", "value": "string", - "description": "The main page heading", + "description": "The main heading displayed at the top of the page.", "isOptional": true }, { @@ -65108,7 +65357,7 @@ "syntaxKind": "PropertySignature", "name": "subheading", "value": "string", - "description": "The text to be used as subheading.", + "description": "A secondary heading displayed below the main heading for additional context.", "isOptional": true } ] @@ -65140,7 +65389,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/customer-account/components.ts", @@ -66023,7 +66272,7 @@ "syntaxKind": "PropertySignature", "name": "heading", "value": "string", - "description": "The main page heading", + "description": "The main heading displayed at the top of the page.", "isOptional": true }, { @@ -67156,7 +67405,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/customer-account/components.ts", @@ -67338,7 +67587,7 @@ "syntaxKind": "PropertySignature", "name": "subheading", "value": "string", - "description": "The text to be used as subheading.", + "description": "A secondary heading displayed below the main heading for additional context.", "isOptional": true }, { @@ -67427,7 +67676,7 @@ "syntaxKind": "PropertySignature", "name": "breadcrumb-actions", "value": "HTMLElement", - "description": "The breadcrumb actions for the page. Accepts a single button element with restricted properties (see below).", + "description": "A navigation link that lets the customer return to the previous page. Accepts a single [button](/docs/api/{API_NAME}/{API_VERSION}/web-components/actions/button) component. Learn more about [breadcrumb actions](#breadcrumb-actions).", "isOptional": true }, { @@ -67435,7 +67684,7 @@ "syntaxKind": "PropertySignature", "name": "primary-action", "value": "HTMLElement", - "description": "The primary action for the modal. Accepts a single [button](/docs/api/customer-account-ui-extensions/{API_VERSION}/web-components/actions/button) element. Use this for the main confirmation action, such as \"Submit\" or \"Confirm.\"", + "description": "The main call-to-action for the page. Accepts a single [button](/docs/api/{API_NAME}/{API_VERSION}/web-components/actions/button) component. Learn more about [primary actions](#primary-actions).", "isOptional": true }, { @@ -67443,7 +67692,7 @@ "syntaxKind": "PropertySignature", "name": "secondary-actions", "value": "HTMLElement", - "description": "The secondary actions for the modal. Accepts multiple [button](/docs/api/customer-account-ui-extensions/{API_VERSION}/web-components/actions/button) elements. Use this for dismissive actions like \"Cancel\" or alternative actions.", + "description": "Additional actions for the page. Accepts one or more [button](/docs/api/{API_NAME}/{API_VERSION}/web-components/actions/button) components. Learn more about [secondary actions](#secondary-actions).", "isOptional": true } ] @@ -67483,7 +67732,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/customer-account/components.ts", @@ -68403,7 +68652,7 @@ "syntaxKind": "PropertySignature", "name": "initials", "value": "string", - "description": "The initials to display in the avatar when no image is provided or fails to load. Typically one or two characters representing a person's first and last name initials, such as \"JD\" for John Doe.", + "description": "The initials to display in the avatar when no image is provided or fails to load. Typically one or two characters representing a person's first and last name initials, such as \"JD\" for John Doe.\n\nCharacters beyond the first two might be truncated. Special characters, emojis, and non-Latin scripts might not render as expected.", "isOptional": true }, { @@ -69508,7 +69757,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/customer-account/components.ts", @@ -69862,7 +70111,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/customer-account/components.ts", @@ -71871,7 +72120,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/customer-account/components.ts", @@ -72182,7 +72431,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/customer-account/components.ts", @@ -74191,7 +74440,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/customer-account/components.ts", @@ -74480,7 +74729,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityLabel", "value": "string", - "description": "A label used to describe the section that will be announced by assistive technologies.\n\nWhen no `heading` property is provided or included as a child of the section, you **must** provide an `accessibilityLabel` to describe the section. This is important as it allows assistive technologies to provide the right context to users.", + "description": "A label announced by assistive technologies that describes the purpose or contents of the element. Only set this when the element's visible content doesn't provide enough context on its own.", "isOptional": true }, { @@ -74488,7 +74737,7 @@ "syntaxKind": "PropertySignature", "name": "heading", "value": "string", - "description": "A title displayed at the top of the section. When provided, it serves as both a visible heading and the accessible name for the section. If omitted, you must provide an `accessibilityLabel` instead.", + "description": "A title that describes the content of the section.", "isOptional": true }, { @@ -74514,7 +74763,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityLabel", "value": "string", - "description": "A label used to describe the section that will be announced by assistive technologies.\n\nWhen no `heading` property is provided or included as a child of the section, you **must** provide an `accessibilityLabel` to describe the section. This is important as it allows assistive technologies to provide the right context to users.", + "description": "A label announced by assistive technologies that describes the purpose or contents of the element. Only set this when the element's visible content doesn't provide enough context on its own.", "isOptional": true }, { @@ -74536,7 +74785,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/customer-account/components.ts", @@ -75419,7 +75668,7 @@ "syntaxKind": "PropertySignature", "name": "heading", "value": "string", - "description": "A title displayed at the top of the section. When provided, it serves as both a visible heading and the accessible name for the section. If omitted, you must provide an `accessibilityLabel` instead.", + "description": "A title that describes the content of the section.", "isOptional": true }, { @@ -76553,7 +76802,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/customer-account/components.ts", @@ -76816,7 +77065,7 @@ "syntaxKind": "PropertySignature", "name": "primary-action", "value": "HTMLElement", - "description": "The primary action for the section. Accepts a single [button](/docs/api/customer-account-ui-extensions/{API_VERSION}/web-components/actions/button) element. Use this for the main action related to the section's content, such as \"Edit\" or \"Manage.\"", + "description": "The main call-to-action for the section. Accepts a single [button](/docs/api/{API_NAME}/{API_VERSION}/web-components/actions/button) component.", "isOptional": true }, { @@ -76824,7 +77073,7 @@ "syntaxKind": "PropertySignature", "name": "secondary-actions", "value": "HTMLElement", - "description": "The secondary actions for the section. Accepts multiple [button](/docs/api/customer-account-ui-extensions/{API_VERSION}/web-components/actions/button) elements. Use this for supplementary actions like \"Remove\" or \"View details.\"", + "description": "Additional actions for the section. Accepts one or more [button](/docs/api/{API_NAME}/{API_VERSION}/web-components/actions/button) components.", "isOptional": true } ] @@ -76869,7 +77118,7 @@ "syntaxKind": "PropertySignature", "name": "command", "value": "'--auto' | '--show' | '--hide' | '--toggle' | '--copy'", - "description": "Sets the action the `commandFor` should take when this clickable is activated.\n\nSee the documentation of particular components for the actions they support.\n\n- `--auto`: a default action for the target component.\n- `--show`: shows the target component.\n- `--hide`: hides the target component.\n- `--toggle`: toggles the target component.\n- `--copy`: copies the target ClipboardItem.", + "description": "Sets the action the `commandFor` target should take when this component is activated.\n\n- `--auto`: A default action for the target component.\n- `--show`: Shows the target component.\n- `--hide`: Hides the target component.\n- `--toggle`: Toggles the target component.\n- `--copy`: Copies the target clipboard item.\n\nLearn more about the [`command` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).", "isOptional": true, "defaultValue": "'--auto'" }, @@ -76878,7 +77127,7 @@ "syntaxKind": "PropertySignature", "name": "commandFor", "value": "string", - "description": "ID of a component that should respond to activations (e.g. clicks) on this component.\n\nSee `command` for how to control the behavior of the target.", + "description": "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).", "isOptional": true }, { @@ -76938,7 +77187,7 @@ "syntaxKind": "PropertySignature", "name": "type", "value": "'button' | 'submit'", - "description": "The behavior of the button.\n\n- `'submit'` - Used to indicate the component acts as a submit button, meaning it submits the closest form.\n- `'button'` - Used to indicate the component acts as a button, meaning it has no default action.\n- `'reset'` - Used to indicate the component acts as a reset button, meaning it resets the closest form (returning fields to their default values).\n\nThis property is ignored if the component supports `href` or `commandFor`/`command` and one of them is set.", + "description": "The behavior of the button.\n\n- `'submit'`: Submits the nearest containing form.\n- `'button'`: Performs no default action, relying on the `click` event handler for behavior.\n\nThis property is ignored if the component supports `href` or `commandFor`/`command` and one of them is set.", "isOptional": true, "defaultValue": "'button'" }, @@ -76952,7 +77201,7 @@ "defaultValue": "'auto' - the variant is automatically determined by the Button's context" } ], - "value": "interface ButtonProps {\n /**\n * A label that describes the purpose or contents of the Button. It will be read to users using assistive technologies such as screen readers.\n *\n * Use this when using only an icon or the button text is not enough context\n * for users using assistive technologies.\n */\n accessibilityLabel?: string;\n /**\n * ID of a component that should respond to activations (e.g. clicks) on this component.\n *\n * See `command` for how to control the behavior of the target.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#commandfor\n */\n commandFor?: string;\n /**\n * Sets the action the `commandFor` should take when this clickable is activated.\n *\n * See the documentation of particular components for the actions they support.\n *\n * - `--auto`: a default action for the target component.\n * - `--show`: shows the target component.\n * - `--hide`: hides the target component.\n * - `--toggle`: toggles the target component.\n * - `--copy`: copies the target ClipboardItem.\n *\n * @default '--auto'\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command\n */\n command?: '--auto' | '--show' | '--hide' | '--toggle' | '--copy';\n /**\n * Disables the button, disallowing any interaction.\n *\n * @defaultValue false\n */\n disabled?: boolean;\n /**\n * The URL to link to.\n *\n * - If set, it will navigate to the location specified by `href` after executing the `onClick` callback.\n * - If a `commandFor` is set, the `command` will be executed instead of the navigation.\n */\n href?: string;\n /**\n * A unique identifier for the element.\n */\n id?: string;\n /**\n * Replaces content with a loading indicator.\n *\n * @defaultValue false\n */\n loading?: boolean;\n /**\n * Specifies where to display the linked URL.\n * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#target\n *\n * 'auto' - The target is automatically determined based on the origin of the URL. Surfaces can set specific rules on how they handle each URL.\n * It’s expected that the behavior of `auto` is as `_self` except in specific cases.\n * For example, a surface could decide to open cross-origin URLs in a new window (as `_blank`).\n *\n * @default 'auto'\n */\n target?: 'auto' | '_self' | '_blank';\n /**\n * Sets the tone of the Button, based on the intention of the information being conveyed.\n *\n * @default 'auto'\n */\n tone?: 'auto' | 'neutral' | 'critical';\n /**\n * The behavior of the button.\n *\n * - `'submit'` - Used to indicate the component acts as a submit button, meaning it submits the closest form.\n * - `'button'` - Used to indicate the component acts as a button, meaning it has no default action.\n * - `'reset'` - Used to indicate the component acts as a reset button, meaning it resets the closest form (returning fields to their default values).\n *\n * This property is ignored if the component supports `href` or `commandFor`/`command` and one of them is set.\n *\n * @default 'button'\n */\n type?: 'button' | 'submit';\n /**\n * Changes the visual appearance of the Button.\n *\n * @default 'auto' - the variant is automatically determined by the Button's context\n */\n variant?: 'auto' | 'primary' | 'secondary';\n\n /**\n * Callback when the button is activated.\n * This will be called before the action indicated by `type`.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event\n */\n click?: ((event: CallbackEventListener) => void) | null;\n}" + "value": "interface ButtonProps {\n /**\n * A label that describes the purpose or contents of the Button. It will be read to users using assistive technologies such as screen readers.\n *\n * Use this when using only an icon or the button text is not enough context\n * for users using assistive technologies.\n */\n accessibilityLabel?: string;\n /**\n * 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).\n */\n commandFor?: string;\n /**\n * Sets the action the `commandFor` target should take when this component is activated.\n *\n * - `--auto`: A default action for the target component.\n * - `--show`: Shows the target component.\n * - `--hide`: Hides the target component.\n * - `--toggle`: Toggles the target component.\n * - `--copy`: Copies the target clipboard item.\n *\n * Learn more about the [`command` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).\n *\n * @default '--auto'\n */\n command?: '--auto' | '--show' | '--hide' | '--toggle' | '--copy';\n /**\n * Disables the button, disallowing any interaction.\n *\n * @defaultValue false\n */\n disabled?: boolean;\n /**\n * The URL to link to.\n *\n * - If set, it will navigate to the location specified by `href` after executing the `onClick` callback.\n * - If a `commandFor` is set, the `command` will be executed instead of the navigation.\n */\n href?: string;\n /**\n * A unique identifier for the element.\n */\n id?: string;\n /**\n * Replaces content with a loading indicator.\n *\n * @defaultValue false\n */\n loading?: boolean;\n /**\n * Specifies where to display the linked URL.\n * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#target\n *\n * 'auto' - The target is automatically determined based on the origin of the URL. Surfaces can set specific rules on how they handle each URL.\n * It’s expected that the behavior of `auto` is as `_self` except in specific cases.\n * For example, a surface could decide to open cross-origin URLs in a new window (as `_blank`).\n *\n * @default 'auto'\n */\n target?: 'auto' | '_self' | '_blank';\n /**\n * Sets the tone of the Button, based on the intention of the information being conveyed.\n *\n * @default 'auto'\n */\n tone?: 'auto' | 'neutral' | 'critical';\n /**\n * The behavior of the button.\n *\n * - `'submit'`: Submits the nearest containing form.\n * - `'button'`: Performs no default action, relying on the `click` event handler for behavior.\n *\n * This property is ignored if the component supports `href` or `commandFor`/`command` and one of them is set.\n *\n * @default 'button'\n */\n type?: 'button' | 'submit';\n /**\n * Changes the visual appearance of the Button.\n *\n * @default 'auto' - the variant is automatically determined by the Button's context\n */\n variant?: 'auto' | 'primary' | 'secondary';\n\n /**\n * Callback when the button is activated.\n * This will be called before the action indicated by `type`.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event\n */\n click?: ((event: CallbackEventListener) => void) | null;\n}" }, { "filePath": "src/surfaces/customer-account/api/docs.ts", @@ -76965,7 +77214,7 @@ "syntaxKind": "PropertySignature", "name": "appMetafields", "value": "SubscribableSignalLike", - "description": "The [metafields](/docs/apps/build/custom-data/metafields) requested in the [`shopify.extension.toml`](/docs/api/customer-account-ui-extensions/latest#configuration) file. Metafields are custom data fields that store additional information on Shopify resources such as products, variants, customers, and the shop. These metafields are updated when there's a change in the merchandise items being purchased by the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when accessing metafields attached to `customer`, `company`, or `companyLocation` resources." + "description": "The [metafields](/docs/apps/build/custom-data/metafields) requested in the [`shopify.extension.toml`](/docs/apps/build/customer-accounts/metafields#create-the-metafield-definition) file. Metafields are custom data fields that store additional information on Shopify resources such as products, variants, customers, and the shop. These metafields are updated when there's a change in the merchandise items being purchased by the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when accessing metafields attached to `customer`, `company`, or `companyLocation` resources." }, { "filePath": "src/surfaces/customer-account/api/docs.ts", @@ -77005,7 +77254,7 @@ "syntaxKind": "PropertySignature", "name": "buyerIdentity", "value": "OrderStatusBuyerIdentity", - "description": "The buyer who placed the order, including their customer account, email, phone number, and B2B purchasing company. Use this to personalize the **Order status** page or identify B2B orders.", + "description": "The buyer who placed the order, including their customer account, email, phone number, and B2B purchasing company. Use this to personalize the **Order status** page or identify B2B orders.\n\nReflects the customer account at the time the order was placed. Doesn't update if account details change afterward.", "isOptional": true } ], @@ -77217,7 +77466,7 @@ "syntaxKind": "PropertySignature", "name": "checkoutSettings", "value": "SubscribableSignalLike", - "description": "The checkout settings that were active when the buyer placed the order, such as whether order notes and login are enabled." + "description": "The checkout settings that were active when the buyer placed the order, such as whether order notes and login are enabled.\n\nReturns the merchant's checkout configuration at the time of checkout. Doesn't reflect updates made after the order was placed." } ], "value": "export interface Docs_OrderStatus_CheckoutSettingsApi\n extends Pick, 'checkoutSettings'> {}" @@ -77249,7 +77498,7 @@ "syntaxKind": "PropertySignature", "name": "localization", "value": "OrderStatusLocalization", - "description": "The buyer's locale, currency, time zone, country, and market context for the order. Use these values to adapt your extension's content to the buyer's region. For formatted dates, numbers, and translated strings, use the [Localization API](/docs/api/customer-account-ui-extensions/target-apis/platform-apis/localization-api) instead." + "description": "The buyer's locale, currency, time zone, country, and market context for the order. Use these values to adapt your extension's content to the buyer's region. For formatted dates, numbers, and translated strings, use the [Localization API](/docs/api/customer-account-ui-extensions/{API_VERSION}/target-apis/platform-apis/localization-api) instead." } ], "value": "export interface Docs_OrderStatus_LocalizationApi\n extends Pick, 'localization'> {}" @@ -77257,7 +77506,7 @@ { "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", "name": "OrderStatusLocalization", - "description": "", + "description": "Provides raw localization data only. The `i18n` translation and formatting helpers from the Localization API aren't available on order status targets.", "members": [ { "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", @@ -77315,7 +77564,7 @@ "syntaxKind": "PropertySignature", "name": "discountAllocations", "value": "SubscribableSignalLike", - "description": "The cart-level discount allocations applied to the order. A discount allocation represents how a discount is distributed across the order. Each allocation includes the discounted amount and one of the following types:\n\n- `CartCodeDiscountAllocation`: A discount the buyer applied by entering a code at checkout.\n- `CartAutomaticDiscountAllocation`: A discount the merchant configured in Shopify admin to apply automatically.\n- `CartCustomDiscountAllocation`: A discount created programmatically by a [Shopify Function](/docs/apps/build/functions)." + "description": "The cart-level discount allocations applied to the order. A discount allocation represents how a discount is distributed across the order. Each allocation includes the discounted amount and one of the following types:\n\n- `CartCodeDiscountAllocation`: A discount the buyer applied by entering a code at checkout.\n- `CartAutomaticDiscountAllocation`: A discount the merchant configured in Shopify admin to apply automatically.\n- `CartCustomDiscountAllocation`: A discount created programmatically by a [Shopify Function](/docs/apps/build/functions).\n\nReturns order-level discounts only. For per-line discount allocations, read from individual cart lines via the Cart Lines API." }, { "filePath": "src/surfaces/customer-account/api/docs.ts", @@ -77370,7 +77619,7 @@ "syntaxKind": "PropertySignature", "name": "billingAddress", "value": "SubscribableSignalLike", - "description": "The billing address associated with the buyer's payment method for the order. The value is `undefined` if the order doesn't have a billing address on file.", + "description": "The billing address associated with the buyer's payment method for the order. The value is `undefined` if the order doesn't have a billing address on file.\n\nReflects the state at the time the order was placed. Doesn't update if the customer changes their account address afterward.", "isOptional": true }, { @@ -77378,7 +77627,7 @@ "syntaxKind": "PropertySignature", "name": "shippingAddress", "value": "SubscribableSignalLike", - "description": "The shipping address that the buyer provided for the order. This is where physical goods are delivered. The value is `undefined` if the order contains only digital products or if a shipping address wasn't required.", + "description": "The shipping address that the buyer provided for the order. This is where physical goods are delivered. The value is `undefined` if the order contains only digital products or if a shipping address wasn't required.\n\nReflects the state at the time the order was placed. Doesn't update if the customer changes their account address afterward.", "isOptional": true } ], @@ -77411,7 +77660,7 @@ "syntaxKind": "PropertySignature", "name": "requireLogin", "value": "() => Promise", - "description": "Triggers a login prompt if the customer is viewing a pre-authenticated **Order status** page. Use this to require full authentication before displaying sensitive information in your extension." + "description": "Triggers a login prompt if the customer is viewing a pre-authenticated **Order status** page. Use this to require full authentication before displaying sensitive information in your extension.\n\nTriggers a login prompt for pre-authenticated buyers. Doesn't guarantee the buyer completes the login. Handle the dismissal case in your code." } ], "value": "export interface Docs_OrderStatus_RequireLoginApi\n extends Pick, 'requireLogin'> {}" @@ -77427,7 +77676,7 @@ "syntaxKind": "PropertySignature", "name": "authenticationState", "value": "SubscribableSignalLike", - "description": "The buyer's current authentication level on the **Order status** page. Use this to determine whether to display sensitive information or prompt the buyer to log in." + "description": "The buyer's current authentication level on the **Order status** page. Use this to determine whether to display sensitive information or prompt the buyer to log in.\n\nRead-only. The authentication level can't be changed programmatically." } ], "value": "export interface Docs_OrderStatus_AuthenticationStateApi\n extends Pick, 'authenticationState'> {}" @@ -77458,7 +77707,7 @@ { "filePath": "src/surfaces/customer-account/api/docs.ts", "name": "Docs_CartLineItem_CartLinesApi", - "description": "", + "description": "The API object provided to `customer-account.order-status.cart-line-item.render-after` extension targets for interacting with individual cart line items.", "isPublicDocs": true, "members": [ { @@ -77466,7 +77715,7 @@ "syntaxKind": "PropertySignature", "name": "target", "value": "SubscribableSignalLike", - "description": "The cart line the extension is attached to." + "description": "The cart line that this extension is attached to. Use this to read the line item's merchandise, quantity, cost, and attributes." } ], "value": "export interface Docs_CartLineItem_CartLinesApi\n extends Pick {}" @@ -77737,7 +77986,7 @@ "syntaxKind": "PropertySignature", "name": "applyTrackingConsentChange", "value": "ApplyTrackingConsentChangeType", - "description": "Applies updated tracking consent preferences for the buyer, including their decisions for analytics, marketing, and data sale, along with any custom tracking consent [metafields](/docs/apps/build/custom-data/metafields). Returns a promise that resolves with the result of the consent update.\n\n{% include /apps/checkout/privacy-icon.md %} Requires the [`customer_privacy` capability](/docs/api/customer-account-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent) and access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." + "description": "Applies updated tracking consent preferences for the buyer, including their decisions for analytics, marketing, and data sale, along with any custom tracking consent [metafields](/docs/apps/build/custom-data/metafields). Returns a promise that resolves with the result of the consent update.\n\n{% include /apps/checkout/privacy-icon.md %} Requires the [`collect_buyer_consent` capability](/docs/apps/build/customer-accounts/capabilities#collect-buyer-consent) and access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." }, { "filePath": "src/surfaces/customer-account/api/docs.ts", @@ -77829,7 +78078,7 @@ "syntaxKind": "PropertySignature", "name": "applyTrackingConsentChange", "value": "ApplyTrackingConsentChangeType", - "description": "Applies updated tracking consent preferences for the buyer, including their decisions for analytics, marketing, and data sale, along with any custom tracking consent [metafields](/docs/apps/build/custom-data/metafields). Returns a promise that resolves with the result of the consent update.\n\n{% include /apps/checkout/privacy-icon.md %} Requires the [`customer_privacy` capability](/docs/api/customer-account-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent) and access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." + "description": "Applies updated tracking consent preferences for the buyer, including their decisions for analytics, marketing, and data sale, along with any custom tracking consent [metafields](/docs/apps/build/custom-data/metafields). Returns a promise that resolves with the result of the consent update.\n\n{% include /apps/checkout/privacy-icon.md %} Requires the [`collect_buyer_consent` capability](/docs/apps/build/customer-accounts/capabilities#collect-buyer-consent) and access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." }, { "filePath": "src/surfaces/customer-account/api/docs.ts", @@ -77858,7 +78107,7 @@ "name": "extensionPoint", "value": "Target", "description": "The identifier that specifies where in Shopify’s UI your code is being injected. This will be one of the [targets](/docs/api/customer-account-ui-extensions/{API_VERSION}/configuration#targets) you have included in your extension’s configuration file. For more information, refer to the [extension targets overview](/docs/api/customer-account-ui-extensions/{API_VERSION}/extension-targets-overview).", - "deprecationMessage": "Deprecated as of version `2023-07`, use `extension.target` instead.", + "deprecationMessage": "Use `extension.target` instead.", "examples": [ { "title": "Example", @@ -78012,18 +78261,18 @@ "syntaxKind": "PropertySignature", "name": "type", "value": "string", - "description": "The resource type (e.g. `shopify/SubscriptionContract`)." + "description": "The resource type (such as `shopify/SubscriptionContract`)." }, { "filePath": "src/surfaces/customer-account/api/shared.ts", "syntaxKind": "PropertySignature", "name": "value", "value": "string", - "description": "The resource identifier for edit actions (e.g. `gid://shopify/SubscriptionContract/123`).", + "description": "The resource identifier for edit actions (such as `gid://shopify/SubscriptionContract/123`).", "isOptional": true } ], - "value": "export interface IntentQuery extends IntentQueryOptions {\n /**\n * Verb describing the operation to perform on the target resource.\n *\n * Common values include `create` and `open`. The set of\n * allowed verbs is intent-specific; unknown verbs will fail validation.\n */\n action: IntentAction;\n /**\n * The resource type (e.g. `shopify/SubscriptionContract`).\n */\n type: string;\n}" + "value": "export interface IntentQuery extends IntentQueryOptions {\n /**\n * Verb describing the operation to perform on the target resource.\n *\n * Common values include `create` and `open`. The set of\n * allowed verbs is intent-specific; unknown verbs will fail validation.\n */\n action: IntentAction;\n /**\n * The resource type (such as `shopify/SubscriptionContract`).\n */\n type: string;\n}" }, { "filePath": "src/surfaces/customer-account/api/shared.ts", @@ -78141,16 +78390,16 @@ "syntaxKind": "PropertySignature", "name": "value", "value": "string", - "description": "The resource identifier for edit actions (e.g. `gid://shopify/SubscriptionContract/123`).", + "description": "The resource identifier for edit actions (such as `gid://shopify/SubscriptionContract/123`).", "isOptional": true } ], - "value": "export interface IntentQueryOptions {\n /**\n * The resource identifier for edit actions (e.g. `gid://shopify/SubscriptionContract/123`).\n */\n value?: string;\n /**\n * Optional input payload passed to the intent. Used to seed forms or supply parameters. The accepted shape is intent-specific. For example, replacing a payment method on a subscription contract requires `{ field: 'paymentMethod' }`.\n */\n data?: Record;\n}" + "value": "export interface IntentQueryOptions {\n /**\n * The resource identifier for edit actions (such as `gid://shopify/SubscriptionContract/123`).\n */\n value?: string;\n /**\n * Optional input payload passed to the intent. Used to seed forms or supply parameters. The accepted shape is intent-specific. For example, replacing a payment method on a subscription contract requires `{ field: 'paymentMethod' }`.\n */\n data?: Record;\n}" }, { "filePath": "src/surfaces/customer-account/api/docs.ts", "name": "Docs_Page_Button_PrimaryAction", - "description": "Supported props for Buttons used inside Page `primary-action` slot.

`children` only support text.", + "description": "", "isPublicDocs": true, "members": [ { @@ -78158,15 +78407,15 @@ "syntaxKind": "PropertySignature", "name": "accessibilityLabel", "value": "string", - "description": "A label that describes the purpose or contents of the Button. It will be read to users using assistive technologies such as screen readers.\n\nUse this when using only an icon or the button text is not enough context for users using assistive technologies.", + "description": "A label that describes the button's purpose to assistive technologies. Use this when the button text alone doesn't provide enough context.", "isOptional": true }, { "filePath": "src/surfaces/customer-account/api/docs.ts", "syntaxKind": "PropertySignature", "name": "click", - "value": "((event: CallbackEventListener) => void) | null", - "description": "Callback when the button is activated. This will be called before the action indicated by `type`.", + "value": "(event: EventListener & ((event: CallbackEvent<\"s-button\", Event>) => void)) => void", + "description": "A callback that fires when the button is activated, before the action indicated by `type`.", "isOptional": true }, { @@ -78174,7 +78423,7 @@ "syntaxKind": "PropertySignature", "name": "command", "value": "'--auto' | '--show' | '--hide' | '--toggle' | '--copy'", - "description": "Sets the action the `commandFor` should take when this clickable is activated.\n\nSee the documentation of particular components for the actions they support.\n\n- `--auto`: a default action for the target component.\n- `--show`: shows the target component.\n- `--hide`: hides the target component.\n- `--toggle`: toggles the target component.\n- `--copy`: copies the target ClipboardItem.", + "description": "The action the `commandFor` target should take when this button is activated.\n\n- `--auto`: A default action for the target component.\n- `--show`: Shows the target component.\n- `--hide`: Hides the target component.\n- `--toggle`: Toggles the target component.\n- `--copy`: Copies the target ClipboardItem.", "isOptional": true, "defaultValue": "'--auto'" }, @@ -78183,7 +78432,7 @@ "syntaxKind": "PropertySignature", "name": "commandFor", "value": "string", - "description": "ID of a component that should respond to activations (e.g. clicks) on this component.\n\nSee `command` for how to control the behavior of the target.", + "description": "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).", "isOptional": true }, { @@ -78191,7 +78440,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the button, disallowing any interaction.", + "description": "Whether the button is disabled and non-interactive.", "isOptional": true, "defaultValue": "false" }, @@ -78200,7 +78449,7 @@ "syntaxKind": "PropertySignature", "name": "href", "value": "string", - "description": "The URL to link to.\n\n- If set, it will navigate to the location specified by `href` after executing the `onClick` callback.\n- If a `commandFor` is set, the `command` will be executed instead of the navigation.", + "description": "The URL to navigate to when the button is activated. If a `commandFor` is set, the `command` is executed instead of the navigation.", "isOptional": true }, { @@ -78208,17 +78457,17 @@ "syntaxKind": "PropertySignature", "name": "loading", "value": "boolean", - "description": "Replaces content with a loading indicator.", + "description": "Whether to replace the button content with a loading indicator.", "isOptional": true, "defaultValue": "false" } ], - "value": "export interface Docs_Page_Button_PrimaryAction\n extends Pick<\n ButtonProps,\n | 'click'\n | 'loading'\n | 'disabled'\n | 'accessibilityLabel'\n | 'href'\n | 'command'\n | 'commandFor'\n > {}" + "value": "export interface Docs_Page_Button_PrimaryAction\n extends Pick<\n ButtonProps,\n | 'click'\n | 'loading'\n | 'disabled'\n | 'accessibilityLabel'\n | 'href'\n | 'command'\n | 'commandFor'\n > {\n /**\n * A label that describes the button's purpose to assistive technologies. Use this when the button text alone doesn't provide enough context.\n */\n accessibilityLabel?: ButtonProps['accessibilityLabel'];\n /**\n * A callback that fires when the button is activated, before the action indicated by `type`.\n */\n click?: ButtonProps['click'];\n /**\n * The action the `commandFor` target should take when this button is activated.\n *\n * - `--auto`: A default action for the target component.\n * - `--show`: Shows the target component.\n * - `--hide`: Hides the target component.\n * - `--toggle`: Toggles the target component.\n * - `--copy`: Copies the target ClipboardItem.\n *\n * @default '--auto'\n */\n command?: ButtonProps['command'];\n /**\n * 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).\n */\n commandFor?: ButtonProps['commandFor'];\n /**\n * Whether the button is disabled and non-interactive.\n *\n * @default false\n */\n disabled?: ButtonProps['disabled'];\n /**\n * The URL to navigate to when the button is activated. If a `commandFor` is set, the `command` is executed instead of the navigation.\n */\n href?: ButtonProps['href'];\n /**\n * Whether to replace the button content with a loading indicator.\n *\n * @default false\n */\n loading?: ButtonProps['loading'];\n}" }, { "filePath": "src/surfaces/customer-account/api/docs.ts", "name": "Docs_Page_Button_SecondaryAction", - "description": "Supported props for Button used inside Page `secondary-actions` slot.

`children` only support text.", + "description": "", "isPublicDocs": true, "members": [ { @@ -78226,15 +78475,15 @@ "syntaxKind": "PropertySignature", "name": "accessibilityLabel", "value": "string", - "description": "A label that describes the purpose or contents of the Button. It will be read to users using assistive technologies such as screen readers.\n\nUse this when using only an icon or the button text is not enough context for users using assistive technologies.", + "description": "A label that describes the button's purpose to assistive technologies. Use this when the button text alone doesn't provide enough context.", "isOptional": true }, { "filePath": "src/surfaces/customer-account/api/docs.ts", "syntaxKind": "PropertySignature", "name": "click", - "value": "((event: CallbackEventListener) => void) | null", - "description": "Callback when the button is activated. This will be called before the action indicated by `type`.", + "value": "(event: EventListener & ((event: CallbackEvent<\"s-button\", Event>) => void)) => void", + "description": "A callback that fires when the button is activated, before the action indicated by `type`.", "isOptional": true }, { @@ -78242,7 +78491,7 @@ "syntaxKind": "PropertySignature", "name": "command", "value": "'--auto' | '--show' | '--hide' | '--toggle' | '--copy'", - "description": "Sets the action the `commandFor` should take when this clickable is activated.\n\nSee the documentation of particular components for the actions they support.\n\n- `--auto`: a default action for the target component.\n- `--show`: shows the target component.\n- `--hide`: hides the target component.\n- `--toggle`: toggles the target component.\n- `--copy`: copies the target ClipboardItem.", + "description": "The action the `commandFor` target should take when this button is activated.\n\n- `--auto`: A default action for the target component.\n- `--show`: Shows the target component.\n- `--hide`: Hides the target component.\n- `--toggle`: Toggles the target component.\n- `--copy`: Copies the target ClipboardItem.", "isOptional": true, "defaultValue": "'--auto'" }, @@ -78251,7 +78500,7 @@ "syntaxKind": "PropertySignature", "name": "commandFor", "value": "string", - "description": "ID of a component that should respond to activations (e.g. clicks) on this component.\n\nSee `command` for how to control the behavior of the target.", + "description": "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).", "isOptional": true }, { @@ -78259,7 +78508,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the button, disallowing any interaction.", + "description": "Whether the button is disabled and non-interactive.", "isOptional": true, "defaultValue": "false" }, @@ -78268,7 +78517,7 @@ "syntaxKind": "PropertySignature", "name": "href", "value": "string", - "description": "The URL to link to.\n\n- If set, it will navigate to the location specified by `href` after executing the `onClick` callback.\n- If a `commandFor` is set, the `command` will be executed instead of the navigation.", + "description": "The URL to navigate to when the button is activated. If a `commandFor` is set, the `command` is executed instead of the navigation.", "isOptional": true }, { @@ -78276,17 +78525,17 @@ "syntaxKind": "PropertySignature", "name": "loading", "value": "boolean", - "description": "Replaces content with a loading indicator.", + "description": "Whether to replace the button content with a loading indicator.", "isOptional": true, "defaultValue": "false" } ], - "value": "export interface Docs_Page_Button_SecondaryAction\n extends Pick<\n ButtonProps,\n | 'click'\n | 'loading'\n | 'disabled'\n | 'accessibilityLabel'\n | 'href'\n | 'command'\n | 'commandFor'\n > {}" + "value": "export interface Docs_Page_Button_SecondaryAction\n extends Pick<\n ButtonProps,\n | 'click'\n | 'loading'\n | 'disabled'\n | 'accessibilityLabel'\n | 'href'\n | 'command'\n | 'commandFor'\n > {\n /**\n * A label that describes the button's purpose to assistive technologies. Use this when the button text alone doesn't provide enough context.\n */\n accessibilityLabel?: ButtonProps['accessibilityLabel'];\n /**\n * A callback that fires when the button is activated, before the action indicated by `type`.\n */\n click?: ButtonProps['click'];\n /**\n * The action the `commandFor` target should take when this button is activated.\n *\n * - `--auto`: A default action for the target component.\n * - `--show`: Shows the target component.\n * - `--hide`: Hides the target component.\n * - `--toggle`: Toggles the target component.\n * - `--copy`: Copies the target ClipboardItem.\n *\n * @default '--auto'\n */\n command?: ButtonProps['command'];\n /**\n * 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).\n */\n commandFor?: ButtonProps['commandFor'];\n /**\n * Whether the button is disabled and non-interactive.\n *\n * @default false\n */\n disabled?: ButtonProps['disabled'];\n /**\n * The URL to navigate to when the button is activated. If a `commandFor` is set, the `command` is executed instead of the navigation.\n */\n href?: ButtonProps['href'];\n /**\n * Whether to replace the button content with a loading indicator.\n *\n * @default false\n */\n loading?: ButtonProps['loading'];\n}" }, { "filePath": "src/surfaces/customer-account/api/docs.ts", "name": "Docs_Page_Button_BreadcrumbAction", - "description": "Supported props for Button used inside Page `breadcrumb-actions` slot.

`children` are not supported.
Use `accessibilityLabel` instead.", + "description": "", "isPublicDocs": true, "members": [ { @@ -78294,14 +78543,14 @@ "syntaxKind": "PropertySignature", "name": "accessibilityLabel", "value": "string", - "description": "A label used for buyers using assistive technologies. Needed because `children` passed to this component will be discarded." + "description": "A label that describes the breadcrumb's destination to assistive technologies. Required because `children` passed to this button are discarded." }, { "filePath": "src/surfaces/customer-account/api/docs.ts", "syntaxKind": "PropertySignature", "name": "click", - "value": "((event: CallbackEventListener) => void) | null", - "description": "Callback when the button is activated. This will be called before the action indicated by `type`.", + "value": "(event: EventListener & ((event: CallbackEvent<\"s-button\", Event>) => void)) => void", + "description": "A callback that fires when the breadcrumb is activated.", "isOptional": true }, { @@ -78309,11 +78558,11 @@ "syntaxKind": "PropertySignature", "name": "href", "value": "string", - "description": "The URL to link to.\n\n- If set, it will navigate to the location specified by `href` after executing the `onClick` callback.\n- If a `commandFor` is set, the `command` will be executed instead of the navigation.", + "description": "The URL to navigate to when the breadcrumb is activated.", "isOptional": true } ], - "value": "export interface Docs_Page_Button_BreadcrumbAction\n extends Pick {\n /**\n * A label used for buyers using assistive technologies. Needed because `children` passed to this component will be discarded.\n */\n accessibilityLabel: ButtonProps['accessibilityLabel'];\n}" + "value": "export interface Docs_Page_Button_BreadcrumbAction\n extends Pick {\n /**\n * A label that describes the breadcrumb's destination to assistive technologies. Required because `children` passed to this button are discarded.\n */\n accessibilityLabel: ButtonProps['accessibilityLabel'];\n /**\n * A callback that fires when the breadcrumb is activated.\n */\n click?: ButtonProps['click'];\n /**\n * The URL to navigate to when the breadcrumb is activated.\n */\n href?: ButtonProps['href'];\n}" }, { "filePath": "src/surfaces/customer-account/api/docs.ts", @@ -78342,7 +78591,7 @@ "syntaxKind": "PropertySignature", "name": "command", "value": "'--auto' | '--show' | '--hide' | '--toggle' | '--copy'", - "description": "Sets the action the `commandFor` should take when this clickable is activated.\n\nSee the documentation of particular components for the actions they support.\n\n- `--auto`: a default action for the target component.\n- `--show`: shows the target component.\n- `--hide`: hides the target component.\n- `--toggle`: toggles the target component.\n- `--copy`: copies the target ClipboardItem.", + "description": "Sets the action the `commandFor` target should take when this component is activated.\n\n- `--auto`: A default action for the target component.\n- `--show`: Shows the target component.\n- `--hide`: Hides the target component.\n- `--toggle`: Toggles the target component.\n- `--copy`: Copies the target clipboard item.\n\nLearn more about the [`command` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).", "isOptional": true, "defaultValue": "'--auto'" }, @@ -78351,7 +78600,7 @@ "syntaxKind": "PropertySignature", "name": "commandFor", "value": "string", - "description": "ID of a component that should respond to activations (e.g. clicks) on this component.\n\nSee `command` for how to control the behavior of the target.", + "description": "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).", "isOptional": true }, { @@ -78411,7 +78660,7 @@ "syntaxKind": "PropertySignature", "name": "type", "value": "'button' | 'submit'", - "description": "The behavior of the button.\n\n- `'submit'` - Used to indicate the component acts as a submit button, meaning it submits the closest form.\n- `'button'` - Used to indicate the component acts as a button, meaning it has no default action.\n- `'reset'` - Used to indicate the component acts as a reset button, meaning it resets the closest form (returning fields to their default values).\n\nThis property is ignored if the component supports `href` or `commandFor`/`command` and one of them is set.", + "description": "The behavior of the button.\n\n- `'submit'`: Submits the nearest containing form.\n- `'button'`: Performs no default action, relying on the `click` event handler for behavior.\n\nThis property is ignored if the component supports `href` or `commandFor`/`command` and one of them is set.", "isOptional": true, "defaultValue": "'button'" } @@ -78504,7 +78753,7 @@ "syntaxKind": "PropertySignature", "name": "command", "value": "'--auto' | '--show' | '--hide' | '--toggle' | '--copy'", - "description": "Sets the action the `commandFor` should take when this clickable is activated.\n\nSee the documentation of particular components for the actions they support.\n\n- `--auto`: a default action for the target component.\n- `--show`: shows the target component.\n- `--hide`: hides the target component.\n- `--toggle`: toggles the target component.\n- `--copy`: copies the target ClipboardItem.", + "description": "Sets the action the `commandFor` target should take when this component is activated.\n\n- `--auto`: A default action for the target component.\n- `--show`: Shows the target component.\n- `--hide`: Hides the target component.\n- `--toggle`: Toggles the target component.\n- `--copy`: Copies the target clipboard item.\n\nLearn more about the [`command` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).", "isOptional": true, "defaultValue": "'--auto'" }, @@ -78513,7 +78762,7 @@ "syntaxKind": "PropertySignature", "name": "commandFor", "value": "string", - "description": "ID of a component that should respond to activations (e.g. clicks) on this component.\n\nSee `command` for how to control the behavior of the target.", + "description": "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).", "isOptional": true }, { @@ -78548,7 +78797,7 @@ { "filePath": "src/surfaces/checkout/components/Button.ts", "name": "ButtonElementProps", - "description": "Properties for the button component element.", + "description": "", "isPublicDocs": true, "members": [ { @@ -78564,7 +78813,7 @@ "syntaxKind": "PropertySignature", "name": "command", "value": "'--auto' | '--show' | '--hide' | '--toggle' | '--copy'", - "description": "Sets the action the `commandFor` should take when this clickable is activated.\n\nSee the documentation of particular components for the actions they support.\n\n- `--auto`: Performs the default action for the target component.\n- `--show`: Displays the target component.\n- `--hide`: Conceals the target component.\n- `--toggle`: Alternates the target component.\n- `--copy`: Copies the target ClipboardItem.", + "description": "Sets the action the `commandFor` target should take when this component is activated.\n\n- `--auto`: Performs the default action for the target component.\n- `--show`: Displays the target component.\n- `--hide`: Conceals the target component.\n- `--toggle`: Alternates the target component.\n- `--copy`: Copies the target ClipboardItem.\n\nLearn more about the [`command` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).", "isOptional": true, "defaultValue": "'--auto'" }, @@ -78573,7 +78822,7 @@ "syntaxKind": "PropertySignature", "name": "commandFor", "value": "string", - "description": "ID of a component that should respond to activations (such as clicks) on this component.\n\nSee `command` for how to control the behavior of the target.", + "description": "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).\n\nWhen both `commandFor` and `href` are set, `commandFor` takes precedence. The command runs and the link doesn't navigate.", "isOptional": true }, { @@ -78598,7 +78847,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -78650,7 +78899,7 @@ "syntaxKind": "PropertySignature", "name": "type", "value": "'submit' | 'button'", - "description": "The behavioral type of the button component, which determines what action it performs when activated.\n\n- `submit`: Submits the closest form.\n- `button`: Performs no default action when activated.\n- `reset`: Resets the closest form (returning fields to their default values).\n\nThis property is ignored if the component supports `href` or `commandFor`/`command` and one of them is set.", + "description": "The behavioral type of the button component, which determines what action it performs when activated.\n\n- `submit`: Submits the nearest containing form.\n- `button`: Performs no default action, relying on the `click` event handler for behavior.\n\nThis property is ignored if `href` or `commandFor`/`command` is set.", "isOptional": true, "defaultValue": "'button'" }, @@ -78664,7 +78913,7 @@ "defaultValue": "'auto'" } ], - "value": "export interface ButtonElementProps extends Pick {\n target?: Extract;\n tone?: Extract;\n type?: Extract;\n variant?: Extract;\n}" + "value": "export interface ButtonElementProps extends Pick {\n target?: Extract;\n tone?: Extract;\n /**\n * The behavioral type of the button component, which determines what action it performs when activated.\n *\n * - `submit`: Submits the nearest containing form.\n * - `button`: Performs no default action, relying on the `click` event handler for behavior.\n *\n * This property is ignored if `href` or `commandFor`/`command` is set.\n *\n * @default 'button'\n */\n type?: Extract;\n variant?: Extract;\n}" }, { "filePath": "src/surfaces/checkout/components/Button.ts", @@ -78686,7 +78935,7 @@ { "filePath": "src/surfaces/checkout/components/Button.ts", "name": "ButtonElementEvents", - "description": "The button component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", + "description": "", "isPublicDocs": true, "members": [ { @@ -78733,7 +78982,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", @@ -79307,7 +79556,7 @@ "syntaxKind": "PropertySignature", "name": "command", "value": "'--auto' | '--show' | '--hide' | '--toggle' | '--copy'", - "description": "Sets the action the `commandFor` should take when this clickable is activated.\n\nSee the documentation of particular components for the actions they support.\n\n- `--auto`: Performs the default action for the target component.\n- `--show`: Displays the target component.\n- `--hide`: Conceals the target component.\n- `--toggle`: Alternates the target component.\n- `--copy`: Copies the target ClipboardItem.", + "description": "Sets the action the `commandFor` target should take when this component is activated.\n\n- `--auto`: Performs the default action for the target component.\n- `--show`: Displays the target component.\n- `--hide`: Conceals the target component.\n- `--toggle`: Alternates the target component.\n- `--copy`: Copies the target ClipboardItem.\n\nLearn more about the [`command` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).", "isOptional": true, "defaultValue": "'--auto'" }, @@ -79316,7 +79565,7 @@ "syntaxKind": "PropertySignature", "name": "commandFor", "value": "string", - "description": "ID of a component that should respond to activations (such as clicks) on this component.\n\nSee `command` for how to control the behavior of the target.", + "description": "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).\n\nWhen both `commandFor` and `href` are set, `commandFor` takes precedence. The command runs and the link doesn't navigate.", "isOptional": true }, { @@ -79664,7 +79913,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -80802,7 +81051,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", @@ -81058,7 +81307,7 @@ "syntaxKind": "PropertySignature", "name": "type", "value": "'submit' | 'button'", - "description": "The behavioral type of the button component, which determines what action it performs when activated.\n\n- `submit`: Submits the closest form.\n- `button`: Performs no default action when activated.\n- `reset`: Resets the closest form (returning fields to their default values).\n\nThis property is ignored if the component supports `href` or `commandFor`/`command` and one of them is set.", + "description": "The behavioral type of the button component, which determines what action it performs when activated.\n\n- `submit`: Submits the nearest containing form.\n- `button`: Performs no default action, relying on the `click` event handler for behavior.\n\nThis property is ignored if `href` or `commandFor`/`command` is set.", "isOptional": true, "defaultValue": "'button'" }, @@ -81092,7 +81341,7 @@ { "filePath": "src/surfaces/checkout/components/Checkbox.ts", "name": "CheckboxElementProps", - "description": "Properties for the Checkbox component element.", + "description": "", "isPublicDocs": true, "members": [ { @@ -81108,7 +81357,7 @@ "syntaxKind": "PropertySignature", "name": "checked", "value": "boolean", - "description": "Whether the control is active.", + "description": "Whether the control is currently checked.", "isOptional": true, "defaultValue": "false" }, @@ -81117,7 +81366,7 @@ "syntaxKind": "PropertySignature", "name": "command", "value": "'--auto' | '--show' | '--hide' | '--toggle'", - "description": "Sets the action the `commandFor` should take when this clickable is activated.\n\nSee the documentation of particular components for the actions they support.\n\n- `--auto`: Performs the default action for the target component.\n- `--show`: Displays the target component.\n- `--hide`: Conceals the target component.\n- `--toggle`: Alternates the target component.\n- `--copy`: Copies the target ClipboardItem.", + "description": "Sets the action the `commandFor` target should take when this component is activated.\n\n- `--auto`: Performs the default action for the target component.\n- `--show`: Displays the target component.\n- `--hide`: Conceals the target component.\n- `--toggle`: Alternates the target component.\n- `--copy`: Copies the target ClipboardItem.\n\nLearn more about the [`command` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).", "isOptional": true, "defaultValue": "'--auto'" }, @@ -81126,7 +81375,7 @@ "syntaxKind": "PropertySignature", "name": "commandFor", "value": "string", - "description": "ID of a component that should respond to activations (such as clicks) on this component.\n\nSee `command` for how to control the behavior of the target.", + "description": "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).\n\nWhen both `commandFor` and `href` are set, `commandFor` takes precedence. The command runs and the link doesn't navigate.", "isOptional": true }, { @@ -81134,7 +81383,7 @@ "syntaxKind": "PropertySignature", "name": "defaultChecked", "value": "boolean", - "description": "Whether the control is active by default.", + "description": "Whether the control is checked by default.", "isOptional": true, "defaultValue": "false" }, @@ -81143,7 +81392,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the control, disallowing any interaction.", + "description": "Whether the control is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -81152,7 +81401,7 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -81160,7 +81409,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -81168,7 +81417,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Visual content to use as the control label.", + "description": "The visual content to use as the control label. Use a string to provide a simple text label displayed to the user.\n\nIf a `label` slot is also provided, the slot content takes precedence. [Learn more about slots](/docs/api/{API_NAME}/{API_VERSION}/web-components/forms/checkbox#slots-propertydetail-label).", "isOptional": true }, { @@ -81176,7 +81425,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the control that is unique within the nearest containing `Form` component.", + "description": "The name attribute for the control, used to identify its value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -81184,7 +81433,7 @@ "syntaxKind": "PropertySignature", "name": "required", "value": "boolean", - "description": "Whether the field needs a value. This requirement adds semantic value to the field, but it will not cause an error to appear automatically. If you want to present an error when this field is empty, you can do so with the `error` property.", + "description": "Whether the field needs a value. This requirement adds semantic value to the field, but it will not cause an error to appear automatically. If you want to present an error when this field is empty, you can do so with the `error` property.\n\nAdds semantic meaning for accessibility. Doesn't trigger automatic validation or display an error. Implement validation logic yourself and use the `error` prop to show results.", "isOptional": true, "defaultValue": "false" }, @@ -81197,7 +81446,7 @@ "isOptional": true } ], - "value": "export interface CheckboxElementProps extends Pick {\n command?: Extract;\n}" + "value": "export interface CheckboxElementProps extends Pick {\n command?: Extract;\n /**\n * The visual content to use as the control label. Use a string to provide a simple text label displayed to the user.\n *\n * If a `label` slot is also provided, the slot content takes precedence. [Learn more about slots](/docs/api/{API_NAME}/{API_VERSION}/web-components/forms/checkbox#slots-propertydetail-label).\n */\n label?: string;\n}" }, { "filePath": "src/surfaces/checkout/components/Checkbox.ts", @@ -81219,7 +81468,7 @@ { "filePath": "src/surfaces/checkout/components/Checkbox.ts", "name": "CheckboxElementEvents", - "description": "Events for the Checkbox component element.", + "description": "", "isPublicDocs": true, "members": [ { @@ -81227,11 +81476,11 @@ "syntaxKind": "PropertySignature", "name": "change", "value": "CallbackEventListener", - "description": "A callback that is run whenever the control is changed.", + "description": "A callback fired when the checkbox value changes.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", "isOptional": true } ], - "value": "export interface CheckboxElementEvents {\n /**\n * A callback that is run whenever the control is changed.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event\n */\n change?: CallbackEventListener;\n}" + "value": "export interface CheckboxElementEvents {\n /**\n * A callback fired when the checkbox value changes.\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change?: CallbackEventListener;\n}" }, { "filePath": "src/surfaces/checkout/components/Checkbox.ts", @@ -81266,7 +81515,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/Checkbox.ts", @@ -81749,7 +81998,7 @@ "syntaxKind": "PropertySignature", "name": "checked", "value": "boolean", - "description": "Whether the control is active.", + "description": "Whether the control is currently checked.", "isOptional": true, "defaultValue": "false" }, @@ -81849,7 +82098,7 @@ "syntaxKind": "PropertySignature", "name": "command", "value": "'--auto' | '--show' | '--hide' | '--toggle'", - "description": "Sets the action the `commandFor` should take when this clickable is activated.\n\nSee the documentation of particular components for the actions they support.\n\n- `--auto`: Performs the default action for the target component.\n- `--show`: Displays the target component.\n- `--hide`: Conceals the target component.\n- `--toggle`: Alternates the target component.\n- `--copy`: Copies the target ClipboardItem.", + "description": "Sets the action the `commandFor` target should take when this component is activated.\n\n- `--auto`: Performs the default action for the target component.\n- `--show`: Displays the target component.\n- `--hide`: Conceals the target component.\n- `--toggle`: Alternates the target component.\n- `--copy`: Copies the target ClipboardItem.\n\nLearn more about the [`command` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).", "isOptional": true, "defaultValue": "'--auto'" }, @@ -81858,7 +82107,7 @@ "syntaxKind": "PropertySignature", "name": "commandFor", "value": "string", - "description": "ID of a component that should respond to activations (such as clicks) on this component.\n\nSee `command` for how to control the behavior of the target.", + "description": "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).\n\nWhen both `commandFor` and `href` are set, `commandFor` takes precedence. The command runs and the link doesn't navigate.", "isOptional": true }, { @@ -81915,7 +82164,7 @@ "syntaxKind": "PropertySignature", "name": "defaultChecked", "value": "boolean", - "description": "Whether the control is active by default.", + "description": "Whether the control is checked by default.", "isOptional": true, "defaultValue": "false" }, @@ -81931,7 +82180,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the control, disallowing any interaction.", + "description": "Whether the control is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -82045,7 +82294,7 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -82215,7 +82464,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -82314,7 +82563,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Visual content to use as the control label.", + "description": "The visual content to use as the control label. Use a string to provide a simple text label displayed to the user.\n\nIf a `label` slot is also provided, the slot content takes precedence. [Learn more about slots](/docs/api/{API_NAME}/{API_VERSION}/web-components/forms/checkbox#slots-propertydetail-label).", "isOptional": true }, { @@ -82371,7 +82620,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the control that is unique within the nearest containing `Form` component.", + "description": "The name attribute for the control, used to identify its value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -83343,7 +83592,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/Checkbox.ts", @@ -83385,7 +83634,7 @@ "syntaxKind": "PropertySignature", "name": "required", "value": "boolean", - "description": "Whether the field needs a value. This requirement adds semantic value to the field, but it will not cause an error to appear automatically. If you want to present an error when this field is empty, you can do so with the `error` property.", + "description": "Whether the field needs a value. This requirement adds semantic value to the field, but it will not cause an error to appear automatically. If you want to present an error when this field is empty, you can do so with the `error` property.\n\nAdds semantic meaning for accessibility. Doesn't trigger automatic validation or display an error. Implement validation logic yourself and use the `error` prop to show results.", "isOptional": true, "defaultValue": "false" }, @@ -83611,6 +83860,23 @@ ], "value": "export interface CheckboxElement extends CheckboxElementProps, Omit {\n onchange: CheckboxEvents['onChange'];\n}" }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "name": "CheckboxElementSlots", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "label", + "value": "HTMLElement", + "description": "The visual content to use as the control label.\n\nUse an `HTMLElement` as a rich control label composed of elements. Only an `s-text` element is supported with plain text and `s-link` as its only allowed children. Any other elements are stripped while preserving their text content.", + "isOptional": true + } + ], + "value": "export interface CheckboxElementSlots {\n /**\n * The visual content to use as the control label.\n *\n * Use an `HTMLElement` as a rich control label composed of elements. Only an `s-text` element is supported with plain text and `s-link` as its only allowed children. Any other elements are stripped while preserving their text content.\n */\n label?: HTMLElement;\n}" + }, { "filePath": "src/surfaces/checkout/components/Checkbox.ts", "name": "CheckboxProps", @@ -83630,7 +83896,7 @@ "syntaxKind": "PropertySignature", "name": "checked", "value": "boolean", - "description": "Whether the control is active.", + "description": "Whether the control is currently checked.", "isOptional": true, "defaultValue": "false" }, @@ -83639,7 +83905,7 @@ "syntaxKind": "PropertySignature", "name": "command", "value": "'--auto' | '--show' | '--hide' | '--toggle'", - "description": "Sets the action the `commandFor` should take when this clickable is activated.\n\nSee the documentation of particular components for the actions they support.\n\n- `--auto`: Performs the default action for the target component.\n- `--show`: Displays the target component.\n- `--hide`: Conceals the target component.\n- `--toggle`: Alternates the target component.\n- `--copy`: Copies the target ClipboardItem.", + "description": "Sets the action the `commandFor` target should take when this component is activated.\n\n- `--auto`: Performs the default action for the target component.\n- `--show`: Displays the target component.\n- `--hide`: Conceals the target component.\n- `--toggle`: Alternates the target component.\n- `--copy`: Copies the target ClipboardItem.\n\nLearn more about the [`command` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).", "isOptional": true, "defaultValue": "'--auto'" }, @@ -83648,7 +83914,7 @@ "syntaxKind": "PropertySignature", "name": "commandFor", "value": "string", - "description": "ID of a component that should respond to activations (such as clicks) on this component.\n\nSee `command` for how to control the behavior of the target.", + "description": "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).\n\nWhen both `commandFor` and `href` are set, `commandFor` takes precedence. The command runs and the link doesn't navigate.", "isOptional": true }, { @@ -83656,7 +83922,7 @@ "syntaxKind": "PropertySignature", "name": "defaultChecked", "value": "boolean", - "description": "Whether the control is active by default.", + "description": "Whether the control is checked by default.", "isOptional": true, "defaultValue": "false" }, @@ -83665,7 +83931,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the control, disallowing any interaction.", + "description": "Whether the control is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -83674,7 +83940,7 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -83682,7 +83948,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -83690,7 +83956,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Visual content to use as the control label.", + "description": "The visual content to use as the control label. Use a string to provide a simple text label displayed to the user.\n\nIf a `label` slot is also provided, the slot content takes precedence. [Learn more about slots](/docs/api/{API_NAME}/{API_VERSION}/web-components/forms/checkbox#slots-propertydetail-label).", "isOptional": true }, { @@ -83698,7 +83964,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the control that is unique within the nearest containing `Form` component.", + "description": "The name attribute for the control, used to identify its value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -83714,7 +83980,7 @@ "syntaxKind": "PropertySignature", "name": "required", "value": "boolean", - "description": "Whether the field needs a value. This requirement adds semantic value to the field, but it will not cause an error to appear automatically. If you want to present an error when this field is empty, you can do so with the `error` property.", + "description": "Whether the field needs a value. This requirement adds semantic value to the field, but it will not cause an error to appear automatically. If you want to present an error when this field is empty, you can do so with the `error` property.\n\nAdds semantic meaning for accessibility. Doesn't trigger automatic validation or display an error. Implement validation logic yourself and use the `error` prop to show results.", "isOptional": true, "defaultValue": "false" }, @@ -83748,7 +84014,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -83805,7 +84071,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/TextField.ts", @@ -84702,7 +84968,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -85814,7 +86080,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/TextField.ts", @@ -86102,7 +86368,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -86137,7 +86403,7 @@ { "filePath": "src/surfaces/checkout/components/TextField.ts", "name": "TextFieldElementProps", - "description": "Properties for the TextField component element.", + "description": "", "isPublicDocs": true, "members": [ { @@ -86145,7 +86411,7 @@ "syntaxKind": "PropertySignature", "name": "autocomplete", "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", "isOptional": true, "defaultValue": "'on' for everything else" }, @@ -86154,7 +86420,7 @@ "syntaxKind": "PropertySignature", "name": "defaultValue", "value": "string", - "description": "The default value for the field.", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces this value.", "isOptional": true }, { @@ -86162,7 +86428,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -86171,7 +86437,7 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -86188,7 +86454,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -86196,7 +86462,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Content to use as the field label.", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", "isOptional": true }, { @@ -86204,7 +86470,7 @@ "syntaxKind": "PropertySignature", "name": "labelAccessibilityVisibility", "value": "'visible' | 'exclusive'", - "description": "Changes the visibility of the component's label.\n\n- `visible`: the label is visible to all users.\n- `exclusive`: the label is visually hidden but remains in the accessibility tree.", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone.\n- `exclusive`: The label is visually hidden but still announced by screen readers.", "isOptional": true, "defaultValue": "'visible'" }, @@ -86222,7 +86488,7 @@ "syntaxKind": "PropertySignature", "name": "minLength", "value": "number", - "description": "Specifies the min number of characters allowed.", + "description": "Specifies the minimum number of characters allowed.", "isOptional": true, "defaultValue": "0" }, @@ -86231,7 +86497,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -86249,7 +86515,7 @@ "syntaxKind": "PropertySignature", "name": "prefix", "value": "string", - "description": "A value to be displayed immediately before the editable portion of the field.\n\nThis is useful for displaying an implied part of the value, such as \"https://\" or \"+353\".\n\nThis cannot be edited by the user, and it isn't included in the value of the field.\n\nIt may not be displayed until the user has interacted with the input. For example, an inline label may take the place of the prefix until the user focuses the input.", + "description": "A value to be displayed immediately before the editable portion of the field.\n\nThis is useful for displaying an implied part of the value, such as \"https://\" or \"+353\".\n\nThis can't be edited by the user, and it isn't included in the value of the field.\n\nIt may not be displayed until the user has interacted with the input. For example, an inline label may take the place of the prefix until the user focuses the input.", "isOptional": true, "defaultValue": "''" }, @@ -86258,7 +86524,7 @@ "syntaxKind": "PropertySignature", "name": "readOnly", "value": "boolean", - "description": "The field cannot be edited by the user. It is focusable will be announced by screen readers.", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", "isOptional": true, "defaultValue": "false" }, @@ -86276,7 +86542,7 @@ "syntaxKind": "PropertySignature", "name": "suffix", "value": "string", - "description": "A value to be displayed immediately after the editable portion of the field.\n\nThis is useful for displaying an implied part of the value, such as \"@shopify.com\", or \"%\".\n\nThis cannot be edited by the user, and it isn't included in the value of the field.\n\nIt may not be displayed until the user has interacted with the input. For example, an inline label may take the place of the suffix until the user focuses the input.", + "description": "A value to be displayed immediately after the editable portion of the field.\n\nThis is useful for displaying an implied part of the value, such as \"@shopify.com\", or \"%\".\n\nThis can't be edited by the user, and it isn't included in the value of the field.\n\nIt may not be displayed until the user has interacted with the input. For example, an inline label may take the place of the suffix until the user focuses the input.", "isOptional": true, "defaultValue": "''" }, @@ -86326,7 +86592,7 @@ "syntaxKind": "PropertySignature", "name": "onChange", "value": "(event: Event) => void", - "description": "Callback when the user has **finished editing** a field, for example, once they have blurred the field.", + "description": "A callback fired when the user has **finished editing** a field, such as when they blur the field or press Enter.", "isOptional": true }, { @@ -86342,7 +86608,7 @@ "syntaxKind": "PropertySignature", "name": "onInput", "value": "(event: Event) => void", - "description": "Callback when the user makes any changes in the field.", + "description": "A callback fired when the user makes any changes in the field, such as typing a character.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).", "isOptional": true } ], @@ -86351,7 +86617,7 @@ { "filePath": "src/surfaces/checkout/components/TextField.ts", "name": "TextFieldElementEvents", - "description": "Events for the TextField component element.", + "description": "", "isPublicDocs": true, "members": [ { @@ -86359,7 +86625,7 @@ "syntaxKind": "PropertySignature", "name": "blur", "value": "CallbackEventListener", - "description": "A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "description": "<<<<<<< HEAD A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n======= A callback fired when the text field loses focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) \n Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", "isOptional": true }, { @@ -86367,7 +86633,7 @@ "syntaxKind": "PropertySignature", "name": "change", "value": "CallbackEventListener", - "description": "Callback when the user has **finished editing** a field, for example, once they have blurred the field.", + "description": "<<<<<<< HEAD Callback when the user has **finished editing** a field, for example, once they have blurred the field.\n======= A callback fired when the text field value changes.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) \n Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", "isOptional": true }, { @@ -86375,7 +86641,7 @@ "syntaxKind": "PropertySignature", "name": "focus", "value": "CallbackEventListener", - "description": "A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "description": "<<<<<<< HEAD A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n======= A callback fired when the text field receives focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) \n Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", "isOptional": true }, { @@ -86383,16 +86649,16 @@ "syntaxKind": "PropertySignature", "name": "input", "value": "CallbackEventListener", - "description": "Callback when the user makes any changes in the field.", + "description": "A callback fired when the user inputs data into the text field.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).", "isOptional": true } ], - "value": "export interface TextFieldElementEvents {\n /**\n * A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event\n */\n blur?: CallbackEventListener;\n /**\n * Callback when the user has **finished editing** a field, for example, once they have blurred the field.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event\n */\n change?: CallbackEventListener;\n /**\n * A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event\n */\n focus?: CallbackEventListener;\n /**\n * Callback when the user makes any changes in the field.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event\n */\n input?: CallbackEventListener;\n}" + "value": "export interface TextFieldElementEvents {\n /**\n<<<<<<< HEAD\n * A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n=======\n * A callback fired when the text field loses focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality)\n *\n * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur?: CallbackEventListener;\n /**\n<<<<<<< HEAD\n * Callback when the user has **finished editing** a field, for example, once they have blurred the field.\n=======\n * A callback fired when the text field value changes.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality)\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change?: CallbackEventListener;\n /**\n<<<<<<< HEAD\n * A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n=======\n * A callback fired when the text field receives focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality)\n *\n * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus?: CallbackEventListener;\n /**\n * A callback fired when the user inputs data into the text field.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input?: CallbackEventListener;\n}" }, { "filePath": "src/surfaces/checkout/components/TextField.ts", "name": "TextFieldElementSlots", - "description": "Slots for the TextField component element.", + "description": "", "isPublicDocs": true, "members": [ { @@ -86400,11 +86666,11 @@ "syntaxKind": "PropertySignature", "name": "accessory", "value": "HTMLElement", - "description": "Additional content to be displayed in the field. Commonly used to display an icon that activates a tooltip providing more information.", + "description": "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.", "isOptional": true } ], - "value": "export interface TextFieldElementSlots {\n /**\n * Additional content to be displayed in the field.\n * Commonly used to display an icon that activates a tooltip providing more information.\n */\n accessory?: HTMLElement;\n}" + "value": "export interface TextFieldElementSlots {\n /**\n * 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.\n */\n accessory?: HTMLElement;\n}" }, { "filePath": "src/surfaces/checkout/components/TextField.ts", @@ -86431,7 +86697,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/TextField.ts", @@ -86872,7 +87138,7 @@ "syntaxKind": "PropertySignature", "name": "autocomplete", "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", "isOptional": true, "defaultValue": "'on' for everything else" }, @@ -87063,7 +87329,7 @@ "syntaxKind": "PropertySignature", "name": "defaultValue", "value": "string", - "description": "The default value for the field.", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces this value.", "isOptional": true }, { @@ -87078,7 +87344,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -87192,7 +87458,7 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -87370,7 +87636,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -87469,7 +87735,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Content to use as the field label.", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", "isOptional": true }, { @@ -87477,7 +87743,7 @@ "syntaxKind": "PropertySignature", "name": "labelAccessibilityVisibility", "value": "'visible' | 'exclusive'", - "description": "Changes the visibility of the component's label.\n\n- `visible`: the label is visible to all users.\n- `exclusive`: the label is visually hidden but remains in the accessibility tree.", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone.\n- `exclusive`: The label is visually hidden but still announced by screen readers.", "isOptional": true, "defaultValue": "'visible'" }, @@ -87544,7 +87810,7 @@ "syntaxKind": "PropertySignature", "name": "minLength", "value": "number", - "description": "Specifies the min number of characters allowed.", + "description": "Specifies the minimum number of characters allowed.", "isOptional": true, "defaultValue": "0" }, @@ -87553,7 +87819,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -88442,7 +88708,7 @@ "syntaxKind": "PropertySignature", "name": "prefix", "value": "string", - "description": "A value to be displayed immediately before the editable portion of the field.\n\nThis is useful for displaying an implied part of the value, such as \"https://\" or \"+353\".\n\nThis cannot be edited by the user, and it isn't included in the value of the field.\n\nIt may not be displayed until the user has interacted with the input. For example, an inline label may take the place of the prefix until the user focuses the input.", + "description": "A value to be displayed immediately before the editable portion of the field.\n\nThis is useful for displaying an implied part of the value, such as \"https://\" or \"+353\".\n\nThis can't be edited by the user, and it isn't included in the value of the field.\n\nIt may not be displayed until the user has interacted with the input. For example, an inline label may take the place of the prefix until the user focuses the input.", "isOptional": true, "defaultValue": "''" }, @@ -88495,7 +88761,7 @@ "syntaxKind": "PropertySignature", "name": "readOnly", "value": "boolean", - "description": "The field cannot be edited by the user. It is focusable will be announced by screen readers.", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", "isOptional": true, "defaultValue": "false" }, @@ -88546,7 +88812,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/TextField.ts", @@ -88737,7 +89003,7 @@ "syntaxKind": "PropertySignature", "name": "suffix", "value": "string", - "description": "A value to be displayed immediately after the editable portion of the field.\n\nThis is useful for displaying an implied part of the value, such as \"@shopify.com\", or \"%\".\n\nThis cannot be edited by the user, and it isn't included in the value of the field.\n\nIt may not be displayed until the user has interacted with the input. For example, an inline label may take the place of the suffix until the user focuses the input.", + "description": "A value to be displayed immediately after the editable portion of the field.\n\nThis is useful for displaying an implied part of the value, such as \"@shopify.com\", or \"%\".\n\nThis can't be edited by the user, and it isn't included in the value of the field.\n\nIt may not be displayed until the user has interacted with the input. For example, an inline label may take the place of the suffix until the user focuses the input.", "isOptional": true, "defaultValue": "''" }, @@ -88834,7 +89100,7 @@ "syntaxKind": "PropertySignature", "name": "autocomplete", "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", "isOptional": true, "defaultValue": "'on' for everything else" }, @@ -88843,7 +89109,7 @@ "syntaxKind": "PropertySignature", "name": "defaultValue", "value": "string", - "description": "The default value for the field.", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces this value.", "isOptional": true }, { @@ -88851,7 +89117,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -88860,7 +89126,7 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -88876,7 +89142,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -88884,7 +89150,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Content to use as the field label.", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", "isOptional": true }, { @@ -88892,7 +89158,7 @@ "syntaxKind": "PropertySignature", "name": "labelAccessibilityVisibility", "value": "'visible' | 'exclusive'", - "description": "Changes the visibility of the component's label.\n\n- `visible`: the label is visible to all users.\n- `exclusive`: the label is visually hidden but remains in the accessibility tree.", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone.\n- `exclusive`: The label is visually hidden but still announced by screen readers.", "isOptional": true, "defaultValue": "'visible'" }, @@ -88910,7 +89176,7 @@ "syntaxKind": "PropertySignature", "name": "minLength", "value": "number", - "description": "Specifies the min number of characters allowed.", + "description": "Specifies the minimum number of characters allowed.", "isOptional": true, "defaultValue": "0" }, @@ -88919,7 +89185,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -88935,7 +89201,7 @@ "syntaxKind": "PropertySignature", "name": "onChange", "value": "(event: Event) => void", - "description": "Callback when the user has **finished editing** a field, for example, once they have blurred the field.", + "description": "A callback fired when the user has **finished editing** a field, such as when they blur the field or press Enter.", "isOptional": true }, { @@ -88951,7 +89217,7 @@ "syntaxKind": "PropertySignature", "name": "onInput", "value": "(event: Event) => void", - "description": "Callback when the user makes any changes in the field.", + "description": "A callback fired when the user makes any changes in the field, such as typing a character.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).", "isOptional": true }, { @@ -88969,7 +89235,7 @@ "syntaxKind": "PropertySignature", "name": "prefix", "value": "string", - "description": "A value to be displayed immediately before the editable portion of the field.\n\nThis is useful for displaying an implied part of the value, such as \"https://\" or \"+353\".\n\nThis cannot be edited by the user, and it isn't included in the value of the field.\n\nIt may not be displayed until the user has interacted with the input. For example, an inline label may take the place of the prefix until the user focuses the input.", + "description": "A value to be displayed immediately before the editable portion of the field.\n\nThis is useful for displaying an implied part of the value, such as \"https://\" or \"+353\".\n\nThis can't be edited by the user, and it isn't included in the value of the field.\n\nIt may not be displayed until the user has interacted with the input. For example, an inline label may take the place of the prefix until the user focuses the input.", "isOptional": true, "defaultValue": "''" }, @@ -88978,7 +89244,7 @@ "syntaxKind": "PropertySignature", "name": "readOnly", "value": "boolean", - "description": "The field cannot be edited by the user. It is focusable will be announced by screen readers.", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", "isOptional": true, "defaultValue": "false" }, @@ -88996,7 +89262,7 @@ "syntaxKind": "PropertySignature", "name": "suffix", "value": "string", - "description": "A value to be displayed immediately after the editable portion of the field.\n\nThis is useful for displaying an implied part of the value, such as \"@shopify.com\", or \"%\".\n\nThis cannot be edited by the user, and it isn't included in the value of the field.\n\nIt may not be displayed until the user has interacted with the input. For example, an inline label may take the place of the suffix until the user focuses the input.", + "description": "A value to be displayed immediately after the editable portion of the field.\n\nThis is useful for displaying an implied part of the value, such as \"@shopify.com\", or \"%\".\n\nThis can't be edited by the user, and it isn't included in the value of the field.\n\nIt may not be displayed until the user has interacted with the input. For example, an inline label may take the place of the suffix until the user focuses the input.", "isOptional": true, "defaultValue": "''" }, @@ -89014,7 +89280,7 @@ { "filePath": "src/surfaces/checkout/components/Select.ts", "name": "SelectElementProps", - "description": "Properties for the Select component element.", + "description": "", "isPublicDocs": true, "members": [ { @@ -89022,7 +89288,7 @@ "syntaxKind": "PropertySignature", "name": "autocomplete", "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", "isOptional": true, "defaultValue": "'on' for everything else" }, @@ -89031,7 +89297,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -89040,7 +89306,7 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -89048,7 +89314,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -89056,7 +89322,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Content to use as the field label.", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", "isOptional": true }, { @@ -89064,7 +89330,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -89072,7 +89338,7 @@ "syntaxKind": "PropertySignature", "name": "placeholder", "value": "string", - "description": "A short hint that describes the expected value of the field.", + "description": "The placeholder text displayed in the field when it's empty, providing a hint about the expected input format or value.", "isOptional": true }, { @@ -89114,7 +89380,7 @@ "syntaxKind": "PropertySignature", "name": "onChange", "value": "(event: Event) => void", - "description": "Callback when the user has **finished editing** a field, for example, once they have blurred the field.", + "description": "A callback fired when the user has **finished editing** a field, such as when they blur the field or press Enter.", "isOptional": true }, { @@ -89131,7 +89397,7 @@ { "filePath": "src/surfaces/checkout/components/Select.ts", "name": "SelectElementEvents", - "description": "Events for the Select component element.", + "description": "", "isPublicDocs": true, "members": [ { @@ -89139,7 +89405,7 @@ "syntaxKind": "PropertySignature", "name": "blur", "value": "CallbackEventListener", - "description": "A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "description": "<<<<<<< HEAD A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n======= A callback fired when the select loses focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) \n Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", "isOptional": true }, { @@ -89147,7 +89413,7 @@ "syntaxKind": "PropertySignature", "name": "change", "value": "CallbackEventListener", - "description": "Callback when the user has **finished editing** a field, for example, once they have blurred the field.", + "description": "<<<<<<< HEAD Callback when the user has **finished editing** a field, for example, once they have blurred the field.\n======= A callback fired when the select value changes.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) \n Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", "isOptional": true }, { @@ -89155,11 +89421,11 @@ "syntaxKind": "PropertySignature", "name": "focus", "value": "CallbackEventListener", - "description": "A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "description": "<<<<<<< HEAD A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n======= A callback fired when the select receives focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) \n Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", "isOptional": true } ], - "value": "export interface SelectElementEvents {\n /**\n * A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event\n */\n blur?: CallbackEventListener;\n /**\n * Callback when the user has **finished editing** a field, for example, once they have blurred the field.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event\n */\n change?: CallbackEventListener;\n /**\n * A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event\n */\n focus?: CallbackEventListener;\n}" + "value": "export interface SelectElementEvents {\n /**\n<<<<<<< HEAD\n * A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n=======\n * A callback fired when the select loses focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality)\n *\n * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur?: CallbackEventListener;\n /**\n<<<<<<< HEAD\n * Callback when the user has **finished editing** a field, for example, once they have blurred the field.\n=======\n * A callback fired when the select value changes.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality)\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change?: CallbackEventListener;\n /**\n<<<<<<< HEAD\n * A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n=======\n * A callback fired when the select receives focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality)\n *\n * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus?: CallbackEventListener;\n}" }, { "filePath": "src/surfaces/checkout/components/Select.ts", @@ -89186,7 +89452,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/Select.ts", @@ -89627,7 +89893,7 @@ "syntaxKind": "PropertySignature", "name": "autocomplete", "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", "isOptional": true, "defaultValue": "'on' for everything else" }, @@ -89825,7 +90091,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -89939,7 +90205,7 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -90109,7 +90375,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -90208,7 +90474,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Content to use as the field label.", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", "isOptional": true }, { @@ -90265,7 +90531,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -91137,7 +91403,7 @@ "syntaxKind": "PropertySignature", "name": "placeholder", "value": "string", - "description": "A short hint that describes the expected value of the field.", + "description": "The placeholder text displayed in the field when it's empty, providing a hint about the expected input format or value.", "isOptional": true }, { @@ -91245,7 +91511,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/Select.ts", @@ -91524,7 +91790,7 @@ "syntaxKind": "PropertySignature", "name": "autocomplete", "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", "isOptional": true, "defaultValue": "'on' for everything else" }, @@ -91533,7 +91799,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -91542,7 +91808,7 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -91550,7 +91816,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -91558,7 +91824,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Content to use as the field label.", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", "isOptional": true }, { @@ -91566,7 +91832,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -91582,7 +91848,7 @@ "syntaxKind": "PropertySignature", "name": "onChange", "value": "(event: Event) => void", - "description": "Callback when the user has **finished editing** a field, for example, once they have blurred the field.", + "description": "A callback fired when the user has **finished editing** a field, such as when they blur the field or press Enter.", "isOptional": true }, { @@ -91598,7 +91864,7 @@ "syntaxKind": "PropertySignature", "name": "placeholder", "value": "string", - "description": "A short hint that describes the expected value of the field.", + "description": "The placeholder text displayed in the field when it's empty, providing a hint about the expected input format or value.", "isOptional": true }, { @@ -91624,7 +91890,7 @@ { "filePath": "src/surfaces/checkout/components/ClickableChip.ts", "name": "ClickableChipElementProps", - "description": "The clickable chip component displays interactive labels or categories that users can click or remove. Use clickable chip to show filter tags, selected options, or merchant-created labels that users need to interact with or dismiss.\n\nClickable chips support multiple visual variants, optional icons, and can function as both clickable buttons and removable tags for flexible interaction patterns. For non-interactive labels, use [chip](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/typography-and-content/chip).", + "description": "", "isPublicDocs": true, "members": [ { @@ -91632,7 +91898,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityLabel", "value": "string", - "description": "A label that describes the purpose or contents of the chip. It will be read to users using assistive technologies such as screen readers.", + "description": "A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.", "isOptional": true }, { @@ -91640,7 +91906,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the chip, disallowing any interaction.", + "description": "Disables the chip, preventing all user interaction including clicks and removal. Disabled chips are visually dimmed to indicate they are not interactive.", "isOptional": true, "defaultValue": "false" }, @@ -91649,7 +91915,7 @@ "syntaxKind": "PropertySignature", "name": "hidden", "value": "boolean", - "description": "Determines whether the chip is hidden.\n\nIf this property is being set on each framework render (as in 'controlled' usage), and the chip is `removable`, ensure you update app state for this property when the `remove` event fires.\n\nIf the chip is not `removable`, it can still be hidden by setting this property.", + "description": "Determines whether the chip is hidden.\n\nIf this property is being set on each framework render (as in 'controlled' usage), and the chip is `removable`, ensure you update app state for this property when the `remove` event fires.\n\nIf the chip is not `removable`, it can still be hidden by setting this property.\n\nWhen using the `removable` variant, keep `hidden` synced with your app state. If `hidden` isn't updated after the chip is removed, the chip can become permanently hidden.", "isOptional": true, "defaultValue": "false" }, @@ -91666,7 +91932,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -91674,7 +91940,7 @@ "syntaxKind": "PropertySignature", "name": "removable", "value": "boolean", - "description": "Whether the chip is removable.", + "description": "Whether the chip displays a remove button, allowing users to dismiss it. When `true`, clicking the remove button fires the `remove` event.", "isOptional": true, "defaultValue": "false" } @@ -91692,7 +91958,7 @@ "syntaxKind": "PropertySignature", "name": "onAfterHide", "value": "(event: Event) => void", - "description": "Event handler when the chip has fully hidden.\n\nThe `hidden` property will be `true` when this event fires.", + "description": "A callback fired when the chip has fully hidden after a removal animation.\n\nThe `hidden` property will be `true` when this event fires.", "isOptional": true }, { @@ -91700,7 +91966,7 @@ "syntaxKind": "PropertySignature", "name": "onClick", "value": "(event: Event) => void", - "description": "Callback when the chip is clicked.", + "description": "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).", "isOptional": true }, { @@ -91708,7 +91974,7 @@ "syntaxKind": "PropertySignature", "name": "onRemove", "value": "(event: Event) => void", - "description": "Callback when the chip is removed.", + "description": "A callback fired when the chip is removed by the user clicking the remove button.", "isOptional": true } ], @@ -91717,7 +91983,7 @@ { "filePath": "src/surfaces/checkout/components/ClickableChip.ts", "name": "ClickableChipElementEvents", - "description": "The clickable chip component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", + "description": "", "isPublicDocs": true, "members": [ { @@ -91750,7 +92016,7 @@ { "filePath": "src/surfaces/checkout/components/ClickableChip.ts", "name": "ClickableChipElementSlots", - "description": "The clickable chip component supports slots for additional content placement. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", + "description": "", "isPublicDocs": true, "members": [ { @@ -91758,11 +92024,11 @@ "syntaxKind": "PropertySignature", "name": "graphic", "value": "HTMLElement", - "description": "The graphic to display inside of the chip.\n\nOnly `s-icon` element and its `type` attribute are supported.", + "description": "An optional graphic displayed at the start of the chip, such as an icon to visually reinforce the chip's label. Only the `s-icon` element and its `type` attribute are supported.", "isOptional": true } ], - "value": "export interface ClickableChipElementSlots {\n /**\n * The graphic to display inside of the chip.\n *\n * Only `s-icon` element and its `type` attribute are supported.\n */\n graphic?: HTMLElement;\n}" + "value": "export interface ClickableChipElementSlots {\n /**\n * An optional graphic displayed at the start of the chip, such as an icon to visually reinforce the chip's label. Only the `s-icon` element and its `type` attribute are supported.\n */\n graphic?: HTMLElement;\n}" }, { "filePath": "src/surfaces/checkout/components/ClickableChip.ts", @@ -91775,7 +92041,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityLabel", "value": "string", - "description": "A label that describes the purpose or contents of the chip. It will be read to users using assistive technologies such as screen readers.", + "description": "A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.", "isOptional": true }, { @@ -91797,7 +92063,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/ClickableChip.ts", @@ -92427,7 +92693,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the chip, disallowing any interaction.", + "description": "Disables the chip, preventing all user interaction including clicks and removal. Disabled chips are visually dimmed to indicate they are not interactive.", "isOptional": true, "defaultValue": "false" }, @@ -92689,7 +92955,7 @@ "syntaxKind": "PropertySignature", "name": "hidden", "value": "boolean", - "description": "Determines whether the chip is hidden.\n\nIf this property is being set on each framework render (as in 'controlled' usage), and the chip is `removable`, ensure you update app state for this property when the `remove` event fires.\n\nIf the chip is not `removable`, it can still be hidden by setting this property.", + "description": "Determines whether the chip is hidden.\n\nIf this property is being set on each framework render (as in 'controlled' usage), and the chip is `removable`, ensure you update app state for this property when the `remove` event fires.\n\nIf the chip is not `removable`, it can still be hidden by setting this property.\n\nWhen using the `removable` variant, keep `hidden` synced with your app state. If `hidden` isn't updated after the chip is removed, the chip can become permanently hidden.", "isOptional": true, "defaultValue": "false" }, @@ -92713,7 +92979,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -93804,7 +94070,7 @@ "syntaxKind": "PropertySignature", "name": "removable", "value": "boolean", - "description": "Whether the chip is removable.", + "description": "Whether the chip displays a remove button, allowing users to dismiss it. When `true`, clicking the remove button fires the `remove` event.", "isOptional": true, "defaultValue": "false" }, @@ -93848,7 +94114,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/ClickableChip.ts", @@ -94110,7 +94376,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityLabel", "value": "string", - "description": "A label that describes the purpose or contents of the chip. It will be read to users using assistive technologies such as screen readers.", + "description": "A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.", "isOptional": true }, { @@ -94118,7 +94384,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the chip, disallowing any interaction.", + "description": "Disables the chip, preventing all user interaction including clicks and removal. Disabled chips are visually dimmed to indicate they are not interactive.", "isOptional": true, "defaultValue": "false" }, @@ -94127,7 +94393,7 @@ "syntaxKind": "PropertySignature", "name": "hidden", "value": "boolean", - "description": "Determines whether the chip is hidden.\n\nIf this property is being set on each framework render (as in 'controlled' usage), and the chip is `removable`, ensure you update app state for this property when the `remove` event fires.\n\nIf the chip is not `removable`, it can still be hidden by setting this property.", + "description": "Determines whether the chip is hidden.\n\nIf this property is being set on each framework render (as in 'controlled' usage), and the chip is `removable`, ensure you update app state for this property when the `remove` event fires.\n\nIf the chip is not `removable`, it can still be hidden by setting this property.\n\nWhen using the `removable` variant, keep `hidden` synced with your app state. If `hidden` isn't updated after the chip is removed, the chip can become permanently hidden.", "isOptional": true, "defaultValue": "false" }, @@ -94144,7 +94410,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -94152,7 +94418,7 @@ "syntaxKind": "PropertySignature", "name": "onAfterHide", "value": "(event: Event) => void", - "description": "Event handler when the chip has fully hidden.\n\nThe `hidden` property will be `true` when this event fires.", + "description": "A callback fired when the chip has fully hidden after a removal animation.\n\nThe `hidden` property will be `true` when this event fires.", "isOptional": true }, { @@ -94160,7 +94426,7 @@ "syntaxKind": "PropertySignature", "name": "onClick", "value": "(event: Event) => void", - "description": "Callback when the chip is clicked.", + "description": "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).", "isOptional": true }, { @@ -94168,7 +94434,7 @@ "syntaxKind": "PropertySignature", "name": "onRemove", "value": "(event: Event) => void", - "description": "Callback when the chip is removed.", + "description": "A callback fired when the chip is removed by the user clicking the remove button.", "isOptional": true }, { @@ -94176,7 +94442,7 @@ "syntaxKind": "PropertySignature", "name": "removable", "value": "boolean", - "description": "Whether the chip is removable.", + "description": "Whether the chip displays a remove button, allowing users to dismiss it. When `true`, clicking the remove button fires the `remove` event.", "isOptional": true, "defaultValue": "false" } @@ -94186,7 +94452,7 @@ { "filePath": "src/surfaces/checkout/components/Badge.ts", "name": "BadgeElementProps", - "description": "Properties for the Badge component element.", + "description": "", "isPublicDocs": true, "members": [ { @@ -94194,7 +94460,7 @@ "syntaxKind": "PropertySignature", "name": "color", "value": "'base' | 'subdued'", - "description": "Modify the color to be more or less intense.", + "description": "Controls the visual weight and emphasis of the badge.\n\n- `base`: Standard weight with moderate emphasis, suitable for most use cases.\n- `subdued`: Reduced visual weight for less prominent or secondary badges.", "isOptional": true, "defaultValue": "'base'" }, @@ -94203,7 +94469,7 @@ "syntaxKind": "PropertySignature", "name": "icon", "value": "'' | ReducedIconTypes", - "description": "The type of icon to be displayed in the badge.", + "description": "An icon displayed inside the badge to provide additional visual context or reinforce the badge's meaning. Set to an empty string to display no icon.", "isOptional": true, "defaultValue": "''" }, @@ -94212,7 +94478,7 @@ "syntaxKind": "PropertySignature", "name": "iconPosition", "value": "'start' | 'end'", - "description": "The position of the icon in relation to the text.", + "description": "The position of the icon relative to the badge text.\n\n- `start`: Places the icon before the text.\n- `end`: Places the icon after the text.", "isOptional": true }, { @@ -94220,7 +94486,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -94228,7 +94494,7 @@ "syntaxKind": "PropertySignature", "name": "size", "value": "'base' | 'small' | 'small-100'", - "description": "Adjusts the size.", + "description": "The size of the badge.\n\n- `base`: The default size, suitable for most use cases.\n- `small`: A smaller badge for compact layouts.\n- `small-100`: The smallest badge for tight spaces or dense lists.", "isOptional": true, "defaultValue": "'base'" }, @@ -94237,12 +94503,12 @@ "syntaxKind": "PropertySignature", "name": "tone", "value": "'auto' | 'neutral' | 'critical'", - "description": "Sets the tone of the Badge, based on the intention of the information being conveyed.", + "description": "The semantic meaning and color treatment of the badge.\n\n- `auto`: Automatically determined based on context.\n- `neutral`: General information without specific intent.\n- `critical`: Urgent problems or destructive actions.", "isOptional": true, "defaultValue": "'auto'" } ], - "value": "export interface BadgeElementProps extends Pick {\n size?: Extract;\n tone?: Extract;\n color?: Extract;\n icon?: '' | ReducedIconTypes;\n}" + "value": "export interface BadgeElementProps extends Pick {\n /**\n * The size of the badge.\n *\n * - `base`: The default size, suitable for most use cases.\n * - `small`: A smaller badge for compact layouts.\n * - `small-100`: The smallest badge for tight spaces or dense lists.\n *\n * @default 'base'\n */\n size?: Extract;\n /**\n * The semantic meaning and color treatment of the badge.\n *\n * - `auto`: Automatically determined based on context.\n * - `neutral`: General information without specific intent.\n * - `critical`: Urgent problems or destructive actions.\n *\n * @default 'auto'\n */\n tone?: Extract;\n /**\n * Controls the visual weight and emphasis of the badge.\n *\n * - `base`: Standard weight with moderate emphasis, suitable for most use cases.\n * - `subdued`: Reduced visual weight for less prominent or secondary badges.\n *\n * @default 'base'\n */\n color?: Extract;\n /**\n * An icon displayed inside the badge to provide additional visual context or reinforce the badge's meaning. Set to an empty string to display no icon.\n *\n * @default ''\n */\n icon?: '' | ReducedIconTypes;\n /**\n * The position of the icon relative to the badge text.\n *\n * - `start`: Places the icon before the text.\n * - `end`: Places the icon after the text.\n */\n iconPosition?: BadgeProps$1['iconPosition'];\n}" }, { "filePath": "src/surfaces/checkout/components/Badge.ts", @@ -94269,7 +94535,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/Badge.ts", @@ -94843,7 +95109,7 @@ "syntaxKind": "PropertySignature", "name": "color", "value": "'base' | 'subdued'", - "description": "Modify the color to be more or less intense.", + "description": "Controls the visual weight and emphasis of the badge.\n\n- `base`: Standard weight with moderate emphasis, suitable for most use cases.\n- `subdued`: Reduced visual weight for less prominent or secondary badges.", "isOptional": true, "defaultValue": "'base'" }, @@ -95175,15 +95441,16 @@ "syntaxKind": "PropertySignature", "name": "icon", "value": "'' | ReducedIconTypes", - "description": "The type of icon to be displayed in the badge.", - "isOptional": true + "description": "An icon displayed inside the badge to provide additional visual context or reinforce the badge's meaning. Set to an empty string to display no icon.", + "isOptional": true, + "defaultValue": "''" }, { "filePath": "src/surfaces/checkout/components/Badge.ts", "syntaxKind": "PropertySignature", "name": "iconPosition", "value": "'start' | 'end'", - "description": "The position of the icon in relation to the text.", + "description": "The position of the icon relative to the badge text.\n\n- `start`: Places the icon before the text.\n- `end`: Places the icon after the text.", "isOptional": true }, { @@ -95191,7 +95458,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -96303,7 +96570,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/Badge.ts", @@ -96464,7 +96731,7 @@ "syntaxKind": "PropertySignature", "name": "size", "value": "'base' | 'small' | 'small-100'", - "description": "Adjusts the size.", + "description": "The size of the badge.\n\n- `base`: The default size, suitable for most use cases.\n- `small`: A smaller badge for compact layouts.\n- `small-100`: The smallest badge for tight spaces or dense lists.", "isOptional": true, "defaultValue": "'base'" }, @@ -96543,7 +96810,7 @@ "syntaxKind": "PropertySignature", "name": "tone", "value": "'auto' | 'neutral' | 'critical'", - "description": "Sets the tone of the Badge, based on the intention of the information being conveyed.", + "description": "The semantic meaning and color treatment of the badge.\n\n- `auto`: Automatically determined based on context.\n- `neutral`: General information without specific intent.\n- `critical`: Urgent problems or destructive actions.", "isOptional": true, "defaultValue": "'auto'" }, @@ -96583,7 +96850,7 @@ "syntaxKind": "PropertySignature", "name": "color", "value": "'base' | 'subdued'", - "description": "Modify the color to be more or less intense.", + "description": "Controls the visual weight and emphasis of the badge.\n\n- `base`: Standard weight with moderate emphasis, suitable for most use cases.\n- `subdued`: Reduced visual weight for less prominent or secondary badges.", "isOptional": true, "defaultValue": "'base'" }, @@ -96592,15 +96859,16 @@ "syntaxKind": "PropertySignature", "name": "icon", "value": "'' | ReducedIconTypes", - "description": "The type of icon to be displayed in the badge.", - "isOptional": true + "description": "An icon displayed inside the badge to provide additional visual context or reinforce the badge's meaning. Set to an empty string to display no icon.", + "isOptional": true, + "defaultValue": "''" }, { "filePath": "src/surfaces/checkout/components/Badge.ts", "syntaxKind": "PropertySignature", "name": "iconPosition", "value": "'start' | 'end'", - "description": "The position of the icon in relation to the text.", + "description": "The position of the icon relative to the badge text.\n\n- `start`: Places the icon before the text.\n- `end`: Places the icon after the text.", "isOptional": true }, { @@ -96608,7 +96876,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -96616,7 +96884,7 @@ "syntaxKind": "PropertySignature", "name": "size", "value": "'base' | 'small' | 'small-100'", - "description": "Adjusts the size.", + "description": "The size of the badge.\n\n- `base`: The default size, suitable for most use cases.\n- `small`: A smaller badge for compact layouts.\n- `small-100`: The smallest badge for tight spaces or dense lists.", "isOptional": true, "defaultValue": "'base'" }, @@ -96625,7 +96893,7 @@ "syntaxKind": "PropertySignature", "name": "tone", "value": "'auto' | 'neutral' | 'critical'", - "description": "Sets the tone of the Badge, based on the intention of the information being conveyed.", + "description": "The semantic meaning and color treatment of the badge.\n\n- `auto`: Automatically determined based on context.\n- `neutral`: General information without specific intent.\n- `critical`: Urgent problems or destructive actions.", "isOptional": true, "defaultValue": "'auto'" } @@ -96635,7 +96903,7 @@ { "filePath": "src/surfaces/checkout/components/Spinner.ts", "name": "SpinnerElementProps", - "description": "Properties for the Spinner component element.", + "description": "", "isPublicDocs": true, "members": [ { @@ -96643,7 +96911,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityLabel", "value": "string", - "description": "A label that describes the purpose of the progress. When set, it will be announced to users using assistive technologies and will provide them with more context. Providing an `accessibilityLabel` is recommended if there is no accompanying text describing that something is loading.", + "description": "A label that describes the purpose of the spinner for assistive technologies like screen readers. Provide an `accessibilityLabel` when there is no visible text that conveys a loading state.", "isOptional": true }, { @@ -96651,7 +96919,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -96659,12 +96927,12 @@ "syntaxKind": "PropertySignature", "name": "size", "value": "'base' | 'small' | 'small-100' | 'large' | 'large-100'", - "description": "Adjusts the size of the spinner icon.", + "description": "The size of the spinner icon.\n\n- `base`: The default size, suitable for most use cases.\n- `small`: A compact size for secondary loading states.\n- `small-100`: The smallest size for tight spaces or inline indicators.\n- `large`: A larger size for more prominent loading states.\n- `large-100`: The largest size for full-page or section-level loading indicators.", "isOptional": true, "defaultValue": "'base'" } ], - "value": "export interface SpinnerElementProps extends SpinnerProps$1 {\n size?: Extract;\n}" + "value": "export interface SpinnerElementProps extends SpinnerProps$1 {\n /**\n * A label that describes the purpose of the spinner for assistive technologies like screen readers. Provide an `accessibilityLabel` when there is no visible text that conveys a loading state.\n */\n accessibilityLabel?: SpinnerProps$1['accessibilityLabel'];\n /**\n * The size of the spinner icon.\n *\n * - `base`: The default size, suitable for most use cases.\n * - `small`: A compact size for secondary loading states.\n * - `small-100`: The smallest size for tight spaces or inline indicators.\n * - `large`: A larger size for more prominent loading states.\n * - `large-100`: The largest size for full-page or section-level loading indicators.\n *\n * @default 'base'\n */\n size?: Extract;\n}" }, { "filePath": "src/surfaces/checkout/components/Spinner.ts", @@ -96677,7 +96945,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityLabel", "value": "string", - "description": "A label that describes the purpose of the progress. When set, it will be announced to users using assistive technologies and will provide them with more context. Providing an `accessibilityLabel` is recommended if there is no accompanying text describing that something is loading.", + "description": "A label that describes the purpose of the spinner for assistive technologies like screen readers. Provide an `accessibilityLabel` when there is no visible text that conveys a loading state.", "isOptional": true }, { @@ -96699,7 +96967,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/Spinner.ts", @@ -97596,7 +97864,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -98708,7 +98976,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/Spinner.ts", @@ -98869,7 +99137,7 @@ "syntaxKind": "PropertySignature", "name": "size", "value": "'base' | 'small' | 'small-100' | 'large' | 'large-100'", - "description": "Adjusts the size of the spinner icon.", + "description": "The size of the spinner icon.\n\n- `base`: The default size, suitable for most use cases.\n- `small`: A compact size for secondary loading states.\n- `small-100`: The smallest size for tight spaces or inline indicators.\n- `large`: A larger size for more prominent loading states.\n- `large-100`: The largest size for full-page or section-level loading indicators.", "isOptional": true, "defaultValue": "'base'" }, @@ -98979,7 +99247,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityLabel", "value": "string", - "description": "A label that describes the purpose of the progress. When set, it will be announced to users using assistive technologies and will provide them with more context. Providing an `accessibilityLabel` is recommended if there is no accompanying text describing that something is loading.", + "description": "A label that describes the purpose of the spinner for assistive technologies like screen readers. Provide an `accessibilityLabel` when there is no visible text that conveys a loading state.", "isOptional": true }, { @@ -98987,7 +99255,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -98995,7 +99263,7 @@ "syntaxKind": "PropertySignature", "name": "size", "value": "'base' | 'small' | 'small-100' | 'large' | 'large-100'", - "description": "Adjusts the size of the spinner icon.", + "description": "The size of the spinner icon.\n\n- `base`: The default size, suitable for most use cases.\n- `small`: A compact size for secondary loading states.\n- `small-100`: The smallest size for tight spaces or inline indicators.\n- `large`: A larger size for more prominent loading states.\n- `large-100`: The largest size for full-page or section-level loading indicators.", "isOptional": true, "defaultValue": "'base'" } @@ -99005,7 +99273,7 @@ { "filePath": "src/surfaces/checkout/components/Tooltip.ts", "name": "TooltipElementProps", - "description": "Properties for the Tooltip component element.", + "description": "", "isPublicDocs": true, "members": [ { @@ -99013,7 +99281,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true } ], @@ -99030,7 +99298,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true } ], @@ -99039,7 +99307,7 @@ { "filePath": "src/surfaces/checkout/components/Tooltip.ts", "name": "TooltipProps", - "description": "The properties for the tooltip component when it's used in JSX.", + "description": "", "isPublicDocs": true, "members": [ { @@ -99047,7 +99315,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true } ], @@ -99056,7 +99324,7 @@ { "filePath": "src/surfaces/checkout/components/Chip.ts", "name": "ChipElementProps", - "description": "Properties for the Chip component element.", + "description": "", "isPublicDocs": true, "members": [ { @@ -99064,7 +99332,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityLabel", "value": "string", - "description": "A label that describes the purpose or contents of the chip. It will be read to users using assistive technologies such as screen readers.", + "description": "A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.", "isOptional": true }, { @@ -99072,7 +99340,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true } ], @@ -99081,7 +99349,7 @@ { "filePath": "src/surfaces/checkout/components/Chip.ts", "name": "ChipElementSlots", - "description": "Slots for the Chip component element.", + "description": "", "isPublicDocs": true, "members": [ { @@ -99089,11 +99357,11 @@ "syntaxKind": "PropertySignature", "name": "graphic", "value": "HTMLElement", - "description": "The graphic to display inside of the chip.\n\nOnly `s-icon` element and its `type` attribute are supported.", + "description": "An optional graphic displayed at the start of the chip, such as an icon to visually reinforce the chip's label. Only the `s-icon` element and its `type` attribute are supported.", "isOptional": true } ], - "value": "export interface ChipElementSlots {\n /**\n * The graphic to display inside of the chip.\n *\n * Only `s-icon` element and its `type` attribute are supported.\n */\n graphic?: HTMLElement;\n}" + "value": "export interface ChipElementSlots {\n /**\n * An optional graphic displayed at the start of the chip, such as an icon to visually reinforce the chip's label. Only the `s-icon` element and its `type` attribute are supported.\n */\n graphic?: HTMLElement;\n}" }, { "filePath": "src/surfaces/checkout/components/Chip.ts", @@ -99106,7 +99374,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityLabel", "value": "string", - "description": "A label that describes the purpose or contents of the chip. It will be read to users using assistive technologies such as screen readers.", + "description": "A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.", "isOptional": true }, { @@ -99114,7 +99382,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true } ], @@ -99131,7 +99399,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityLabel", "value": "string", - "description": "A label that describes the purpose or contents of the chip. It will be read to users using assistive technologies such as screen readers.", + "description": "A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.", "isOptional": true }, { @@ -99153,7 +99421,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/Chip.ts", @@ -100050,7 +100318,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -101162,7 +101430,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/Chip.ts", @@ -101416,7 +101684,7 @@ { "filePath": "src/surfaces/checkout/components/UnorderedList.ts", "name": "UnorderedListElementProps", - "description": "Properties for the UnorderedList component element.", + "description": "", "isPublicDocs": true, "members": [ { @@ -101424,7 +101692,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true } ], @@ -101455,7 +101723,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/UnorderedList.ts", @@ -102352,7 +102620,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -103464,7 +103732,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/UnorderedList.ts", @@ -103726,7 +103994,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true } ], @@ -103735,7 +104003,7 @@ { "filePath": "src/surfaces/checkout/components/OrderedList.ts", "name": "OrderedListElementProps", - "description": "Properties for the OrderedList component element.", + "description": "", "isPublicDocs": true, "members": [ { @@ -103743,7 +104011,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true } ], @@ -103774,7 +104042,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/OrderedList.ts", @@ -104671,7 +104939,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -105783,7 +106051,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/OrderedList.ts", @@ -106045,7 +106313,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true } ], @@ -106104,7 +106372,7 @@ { "filePath": "src/surfaces/checkout/components/Abbreviation.ts", "name": "AbbreviationElementProps", - "description": "Displays abbreviated text or acronyms, revealing their full meaning or additional context through a tooltip on hover or focus. Use to clarify shortened terms, initialisms, or technical language without interrupting the reading flow.", + "description": "", "isPublicDocs": true, "members": [ { @@ -106112,7 +106380,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -106120,7 +106388,7 @@ "syntaxKind": "PropertySignature", "name": "title", "value": "string", - "description": "Defines the full expansion of the abbreviation or acronym.\n\nHelps user agents and users understand the meaning of the abbreviated text.", + "description": "Defines the full expansion of the abbreviation or acronym, helping user agents and users understand the meaning of the abbreviated text. Learn more about the [abbreviation element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/abbr).", "isOptional": true, "defaultValue": "''" } @@ -106152,7 +106420,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/Abbreviation.ts", @@ -107049,7 +107317,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -108161,7 +108429,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/Abbreviation.ts", @@ -108371,7 +108639,7 @@ "syntaxKind": "PropertySignature", "name": "title", "value": "string", - "description": "Defines the full expansion of the abbreviation or acronym.\n\nHelps user agents and users understand the meaning of the abbreviated text.", + "description": "Defines the full expansion of the abbreviation or acronym, helping user agents and users understand the meaning of the abbreviated text. Learn more about the [abbreviation element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/abbr).", "isOptional": true, "defaultValue": "''" }, @@ -108425,7 +108693,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -108433,7 +108701,7 @@ "syntaxKind": "PropertySignature", "name": "title", "value": "string", - "description": "Defines the full expansion of the abbreviation or acronym.\n\nHelps user agents and users understand the meaning of the abbreviated text.", + "description": "Defines the full expansion of the abbreviation or acronym, helping user agents and users understand the meaning of the abbreviated text. Learn more about the [abbreviation element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/abbr).", "isOptional": true, "defaultValue": "''" } @@ -108445,21 +108713,19 @@ "syntaxKind": "TypeAliasDeclaration", "name": "ToggleState", "value": "'open' | 'closed'", - "description": "", - "isPublicDocs": true + "description": "The visibility state of a toggleable element.\n\n- `open`: The element is visible and showing its content.\n- `closed`: The element is hidden and its content is not visible." }, { "filePath": "src/surfaces/checkout/components/Announcement.ts", "name": "ToggleArgumentsEvent", - "description": "", - "isPublicDocs": true, + "description": "The event data provided to toggle-related callbacks. Contains the previous and next visibility states of the element.", "members": [ { "filePath": "src/surfaces/checkout/components/Announcement.ts", "syntaxKind": "PropertySignature", "name": "newState", "value": "ToggleState", - "description": "", + "description": "The visibility state of the element after the toggle occurred.", "isOptional": true }, { @@ -108467,11 +108733,11 @@ "syntaxKind": "PropertySignature", "name": "oldState", "value": "ToggleState", - "description": "", + "description": "The visibility state of the element before the toggle occurred.", "isOptional": true } ], - "value": "export interface ToggleArgumentsEvent {\n oldState?: ToggleState;\n newState?: ToggleState;\n}" + "value": "export interface ToggleArgumentsEvent {\n /**\n * The visibility state of the element before the toggle occurred.\n */\n oldState?: ToggleState;\n /**\n * The visibility state of the element after the toggle occurred.\n */\n newState?: ToggleState;\n}" }, { "filePath": "src/surfaces/checkout/components/Announcement.ts", @@ -108484,7 +108750,7 @@ "syntaxKind": "PropertySignature", "name": "onAfterToggle", "value": "(event: ToggleEvent$1) => void", - "description": "A callback fired when the element state changes, after any toggle animations have finished.\n\n- If the element transitioned from hidden to showing, the `oldState` property will be set to `closed` and the `newState` property will be set to `open`.\n- If the element transitioned from showing to hidden, the `oldState` property will be set to `open` and the `newState` will be `closed`.\n\nLearn more about [ToggleEvent.newState](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/newState) and [ToggleEvent.oldState](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/oldState).", + "description": "A callback fired when the element state changes, after any toggle animations have finished.\n\n- If the element transitioned from hidden to showing, the `oldState` property will be set to `closed` and the `newState` property will be set to `open`.\n- If the element transitioned from showing to hidden, the `oldState` property will be set to `open` and the `newState` will be `closed`.\n\nLearn more about 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.", "isOptional": true }, { @@ -108500,7 +108766,7 @@ "syntaxKind": "PropertySignature", "name": "onToggle", "value": "(event: ToggleEvent$1) => void", - "description": "A callback fired immediately when the element state changes, before any animations.\n\n- If the element is transitioning from hidden to showing, the `oldState` property will be set to `closed` and the `newState` property will be set to `open`.\n- If the element is transitioning from showing to hidden, then `oldState` property will be set to `open` and the `newState` will be `closed`.\n\nLearn more about the [toggle event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/toggle_event), [ToggleEvent.newState](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/newState), and [ToggleEvent.oldState](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/oldState).", + "description": "A callback fired immediately when the element state changes, before any animations.\n\n- If the element is transitioning from hidden to showing, the `oldState` property will be set to `closed` and the `newState` property will be set to `open`.\n- If the element is transitioning from showing to hidden, then the `oldState` property will be set to `open` and the `newState` will be `closed`.\n\nLearn 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.", "isOptional": true } ], @@ -108509,7 +108775,7 @@ { "filePath": "src/surfaces/checkout/components/Announcement.ts", "name": "AnnouncementElementEvents", - "description": "Learn more about [registering events](/docs/api/checkout-ui-extensions/latest/using-polaris-components#event-handling).", + "description": "", "isPublicDocs": true, "members": [ { @@ -108517,7 +108783,7 @@ "syntaxKind": "PropertySignature", "name": "aftertoggle", "value": "CallbackEventListener", - "description": "Callback fired when the element state changes **after** any animations have finished.\n\n- If the element transitioned from hidden to showing, the `oldState` property will be set to `closed` and the `newState` property will be set to `open`.\n- If the element transitioned from showing to hidden, the `oldState` property will be set to `open` and the `newState` will be `closed`.", + "description": "A callback that fires when the element state changes, after any toggle animations have finished.\n\n- If the element transitioned from hidden to showing, the `oldState` property will be set to `closed` and the `newState` property will be set to `open`.\n- If the element transitioned from showing to hidden, the `oldState` property will be set to `open` and the `newState` will be `closed`.\n\nLearn more about [`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).", "isOptional": true }, { @@ -108525,7 +108791,7 @@ "syntaxKind": "PropertySignature", "name": "dismiss", "value": "CallbackEventListener", - "description": "Callback fired when the announcement is dismissed by the user (either via the built-in dismiss button or programmatically).", + "description": "A callback that fires when the announcement is dismissed by the user clicking the close button or by calling the `dismiss()` method programmatically.", "isOptional": true }, { @@ -108533,11 +108799,11 @@ "syntaxKind": "PropertySignature", "name": "toggle", "value": "CallbackEventListener", - "description": "Callback straight after the element state changes.\n\n- If the element is transitioning from hidden to showing, the `oldState` property will be set to `closed` and the `newState` property will be set to `open`.\n- If the element is transitioning from showing to hidden, then `oldState` property will be set to `open` and the `newState` will be `closed`.", + "description": "A callback that fires immediately when the element state changes, before any animations.\n\n- If the element is transitioning from hidden to showing, the `oldState` property will be set to `closed` and the `newState` property will be set to `open`.\n- If the element is transitioning from showing to hidden, then the `oldState` property will be set to `open` and the `newState` will be `closed`.\n\nLearn more about the [`toggle` event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/toggle_event), [`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).", "isOptional": true } ], - "value": "export interface AnnouncementElementEvents {\n /**\n * Callback fired when the element state changes **after** any animations have finished.\n *\n * - If the element transitioned from hidden to showing, the `oldState` property will be set to `closed` and the\n * `newState` property will be set to `open`.\n * - If the element transitioned from showing to hidden, the `oldState` property will be set to `open` and the\n * `newState` will be `closed`.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/newState\n * @see https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/oldState\n */\n aftertoggle?: CallbackEventListener;\n /**\n * Callback fired when the announcement is dismissed by the user\n * (either via the built-in dismiss button or programmatically).\n */\n dismiss?: CallbackEventListener;\n /**\n * Callback straight after the element state changes.\n *\n * - If the element is transitioning from hidden to showing, the `oldState` property will be set to `closed` and the\n * `newState` property will be set to `open`.\n * - If the element is transitioning from showing to hidden, then `oldState` property will be set to `open` and the\n * `newState` will be `closed`.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/toggle_event\n * @see https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/newState\n * @see https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/oldState\n */\n toggle?: CallbackEventListener;\n}" + "value": "export interface AnnouncementElementEvents {\n /**\n * A callback that fires when the element state changes, after any toggle animations have finished.\n *\n * - If the element transitioned from hidden to showing, the `oldState` property will be set to `closed` and the\n * `newState` property will be set to `open`.\n * - If the element transitioned from showing to hidden, the `oldState` property will be set to `open` and the\n * `newState` will be `closed`.\n *\n * Learn more about [`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).\n */\n aftertoggle?: CallbackEventListener;\n /**\n * A callback that fires when the announcement is dismissed by the user clicking the close button or by calling the `dismiss()` method programmatically.\n */\n dismiss?: CallbackEventListener;\n /**\n * A callback that fires immediately when the element state changes, before any animations.\n *\n * - If the element is transitioning from hidden to showing, the `oldState` property will be set to `closed` and the\n * `newState` property will be set to `open`.\n * - If the element is transitioning from showing to hidden, then the `oldState` property will be set to `open` and the\n * `newState` will be `closed`.\n *\n * Learn more about the [`toggle` event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/toggle_event), [`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).\n */\n toggle?: CallbackEventListener;\n}" }, { "filePath": "src/surfaces/checkout/components/Announcement.ts", @@ -108564,7 +108830,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/Announcement.ts", @@ -109194,7 +109460,7 @@ "syntaxKind": "PropertySignature", "name": "dismiss", "value": "() => void", - "description": "" + "description": "Programmatically dismisses the announcement. This triggers the `dismiss` event callback." }, { "filePath": "src/surfaces/checkout/components/Announcement.ts", @@ -110589,7 +110855,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/Announcement.ts", @@ -110851,7 +111117,7 @@ "syntaxKind": "PropertySignature", "name": "onAfterToggle", "value": "(event: ToggleEvent$1) => void", - "description": "A callback fired when the element state changes, after any toggle animations have finished.\n\n- If the element transitioned from hidden to showing, the `oldState` property will be set to `closed` and the `newState` property will be set to `open`.\n- If the element transitioned from showing to hidden, the `oldState` property will be set to `open` and the `newState` will be `closed`.\n\nLearn more about [ToggleEvent.newState](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/newState) and [ToggleEvent.oldState](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/oldState).", + "description": "A callback fired when the element state changes, after any toggle animations have finished.\n\n- If the element transitioned from hidden to showing, the `oldState` property will be set to `closed` and the `newState` property will be set to `open`.\n- If the element transitioned from showing to hidden, the `oldState` property will be set to `open` and the `newState` will be `closed`.\n\nLearn more about 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.", "isOptional": true }, { @@ -110867,7 +111133,7 @@ "syntaxKind": "PropertySignature", "name": "onToggle", "value": "(event: ToggleEvent$1) => void", - "description": "A callback fired immediately when the element state changes, before any animations.\n\n- If the element is transitioning from hidden to showing, the `oldState` property will be set to `closed` and the `newState` property will be set to `open`.\n- If the element is transitioning from showing to hidden, then `oldState` property will be set to `open` and the `newState` will be `closed`.\n\nLearn more about the [toggle event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/toggle_event), [ToggleEvent.newState](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/newState), and [ToggleEvent.oldState](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/oldState).", + "description": "A callback fired immediately when the element state changes, before any animations.\n\n- If the element is transitioning from hidden to showing, the `oldState` property will be set to `closed` and the `newState` property will be set to `open`.\n- If the element is transitioning from showing to hidden, then the `oldState` property will be set to `open` and the `newState` will be `closed`.\n\nLearn 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.", "isOptional": true } ], @@ -110884,15 +111150,15 @@ "syntaxKind": "PropertySignature", "name": "dismiss", "value": "() => void", - "description": "" + "description": "Programmatically dismisses the announcement. This triggers the `dismiss` event callback." } ], - "value": "export interface AnnouncementMethods {\n dismiss: () => void;\n}" + "value": "export interface AnnouncementMethods {\n /**\n * Programmatically dismisses the announcement. This triggers the `dismiss` event callback.\n */\n dismiss: () => void;\n}" }, { "filePath": "src/surfaces/checkout/components/Announcement.ts", "name": "AnnouncementElementMethods", - "description": "Learn more about [component methods](/docs/api/checkout-ui-extensions/latest/using-polaris-components#methods).", + "description": "", "isPublicDocs": true, "members": [ { @@ -110900,15 +111166,15 @@ "syntaxKind": "PropertySignature", "name": "dismiss", "value": "() => void", - "description": "" + "description": "Programmatically dismisses the announcement. This triggers the `dismiss` event callback." } ], - "value": "export interface AnnouncementElementMethods {\n dismiss: AnnouncementMethods['dismiss'];\n}" + "value": "export interface AnnouncementElementMethods {\n /**\n * Programmatically dismisses the announcement. This triggers the `dismiss` event callback.\n */\n dismiss: AnnouncementMethods['dismiss'];\n}" }, { "filePath": "src/surfaces/checkout/components/Banner.ts", "name": "BannerElementProps", - "description": "The banner component highlights important information or required actions prominently within the interface. Use banner to communicate statuses, provide feedback, draw attention to critical updates, or guide users toward necessary actions.\n\nBanners support multiple tones to convey urgency levels, optional actions for next steps, and can be positioned contextually within sections or page-wide at the top. For inline status indicators on individual items, use [badge](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/feedback-and-status-indicators/badge).", + "description": "", "isPublicDocs": true, "members": [ { @@ -110916,7 +111182,7 @@ "syntaxKind": "PropertySignature", "name": "collapsible", "value": "boolean", - "description": "Makes the content collapsible. A collapsible banner will conceal child elements initially, but allow the user to expand the banner to see them.", + "description": "Whether the banner content can be collapsed and expanded by the user. A collapsible banner conceals child elements initially, allowing the user to expand the banner to reveal them.", "isOptional": true, "defaultValue": "false" }, @@ -110925,7 +111191,7 @@ "syntaxKind": "PropertySignature", "name": "dismissible", "value": "boolean", - "description": "Determines whether the close button of the banner is present.\n\nWhen the close button is pressed, the `dismiss` event will fire, then `hidden` will be true, any animation will complete, and the `afterhide` event will fire.", + "description": "Whether the banner displays a close button that allows users to dismiss it.\n\nWhen the close button is pressed, the `dismiss` event will fire, then `hidden` will be set to `true`, any animation will complete, and the `afterhide` event will fire.", "isOptional": true, "defaultValue": "false" }, @@ -110934,7 +111200,7 @@ "syntaxKind": "PropertySignature", "name": "heading", "value": "string", - "description": "The title of the banner.", + "description": "The heading text displayed at the top of the banner to summarize the message or alert.", "isOptional": true, "defaultValue": "''" }, @@ -110943,7 +111209,7 @@ "syntaxKind": "PropertySignature", "name": "hidden", "value": "boolean", - "description": "Determines whether the banner is hidden.\n\nIf this property is being set on each framework render (as in 'controlled' usage), and the banner is `dismissible`, ensure you update app state for this property when the `dismiss` event fires.\n\nIf the banner is not `dismissible`, it can still be hidden by setting this property.", + "description": "Controls whether the banner is visible or hidden.\n\nWhen using a controlled component pattern and the banner is `dismissible`, update this property to `true` when the `dismiss` event fires.\n\nYou can hide the banner programmatically by setting this to `true` even if it's not `dismissible`.", "isOptional": true, "defaultValue": "false" }, @@ -110952,7 +111218,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -110960,12 +111226,12 @@ "syntaxKind": "PropertySignature", "name": "tone", "value": "'info' | 'auto' | 'success' | 'warning' | 'critical'", - "description": "Sets the tone of the Banner, based on the intention of the information being conveyed.\n\nThe banner is a live region and the type of status will be dictated by the Tone selected.\n\n- `critical` creates an [assertive live region](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/alert_role) that is announced by screen readers immediately.\n- `neutral`, `info`, `success`, `warning` and `caution` creates an [informative live region](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/status_role) that is announced by screen readers after the current message.", + "description": "The semantic meaning and color treatment of the component. The banner is a live region and the type of status is dictated by the tone selected.\n\n- `info`: Informational content or helpful tips.\n- `auto`: Automatically determined based on context.\n- `success`: Positive outcomes or successful states.\n- `warning`: Important warnings about potential issues.\n- `critical`: Urgent problems or destructive actions.\n\nThe `critical` tone creates an [assertive live region](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/alert_role) that is announced by screen readers immediately. The `info`, `success`, and `warning` tones create an [informative live region](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/status_role) that is announced by screen readers after the current message.", "isOptional": true, "defaultValue": "'auto'" } ], - "value": "export interface BannerElementProps extends Pick {\n tone?: Extract;\n}" + "value": "export interface BannerElementProps extends Pick {\n /**\n * Whether the banner content can be collapsed and expanded by the user. A collapsible banner conceals child elements initially, allowing the user to expand the banner to reveal them.\n *\n * @default false\n */\n collapsible?: BannerProps$1['collapsible'];\n /**\n * Whether the banner displays a close button that allows users to dismiss it.\n *\n * When the close button is pressed, the `dismiss` event will fire,\n * then `hidden` will be set to `true`,\n * any animation will complete,\n * and the `afterhide` event will fire.\n *\n * @default false\n */\n dismissible?: BannerProps$1['dismissible'];\n /**\n * The heading text displayed at the top of the banner to summarize the message or alert.\n *\n * @default ''\n */\n heading?: BannerProps$1['heading'];\n /**\n * Controls whether the banner is visible or hidden.\n *\n * When using a controlled component pattern and the banner is `dismissible`,\n * update this property to `true` when the `dismiss` event fires.\n *\n * You can hide the banner programmatically by setting this to `true` even if it's not `dismissible`.\n *\n * @default false\n */\n hidden?: BannerProps$1['hidden'];\n /**\n * The semantic meaning and color treatment of the component. The banner is a live region and the type of status is dictated by the tone selected.\n *\n * - `info`: Informational content or helpful tips.\n * - `auto`: Automatically determined based on context.\n * - `success`: Positive outcomes or successful states.\n * - `warning`: Important warnings about potential issues.\n * - `critical`: Urgent problems or destructive actions.\n *\n * The `critical` tone creates an [assertive live region](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/alert_role) that is announced by screen readers immediately. The `info`, `success`, and `warning` tones create an [informative live region](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/status_role) that is announced by screen readers after the current message.\n *\n * @default 'auto'\n */\n tone?: Extract;\n}" }, { "filePath": "src/surfaces/checkout/components/Banner.ts", @@ -110995,7 +111261,7 @@ { "filePath": "src/surfaces/checkout/components/Banner.ts", "name": "BannerElementEvents", - "description": "Learn more about [registering events](/docs/api/checkout-ui-extensions/latest/using-polaris-components#event-handling).", + "description": "", "isPublicDocs": true, "members": [ { @@ -111003,7 +111269,7 @@ "syntaxKind": "PropertySignature", "name": "afterhide", "value": "CallbackEventListener", - "description": "Event handler when the banner has fully hidden.\n\nThe `hidden` property will be `true` when this event fires.", + "description": "A callback that fires when the banner has fully hidden, including after any hide animations have completed.\n\nThe `hidden` property is `true` when this event fires.", "isOptional": true }, { @@ -111011,11 +111277,11 @@ "syntaxKind": "PropertySignature", "name": "dismiss", "value": "CallbackEventListener", - "description": "Event handler when the banner is dismissed by the user.\n\nThis does not fire when setting `hidden` manually.\n\nThe `hidden` property will be `false` when this event fires.", + "description": "A callback that fires when the banner is dismissed by the user clicking the close button.\n\nThis doesn't fire when setting `hidden` manually.\n\nThe `hidden` property is `false` when this event fires.", "isOptional": true } ], - "value": "export interface BannerElementEvents {\n /**\n * Event handler when the banner has fully hidden.\n *\n * The `hidden` property will be `true` when this event fires.\n *\n * @implementation If implementations animate the hiding of the banner,\n * this event must fire after the banner has fully hidden.\n * We can add an `onHide` event in future if we want to provide a hook for the start of the animation.\n */\n afterhide?: CallbackEventListener;\n /**\n * Event handler when the banner is dismissed by the user.\n *\n * This does not fire when setting `hidden` manually.\n *\n * The `hidden` property will be `false` when this event fires.\n */\n dismiss?: CallbackEventListener;\n}" + "value": "export interface BannerElementEvents {\n /**\n * A callback that fires when the banner has fully hidden, including after any hide animations have completed.\n *\n * The `hidden` property is `true` when this event fires.\n */\n afterhide?: CallbackEventListener;\n /**\n * A callback that fires when the banner is dismissed by the user clicking the close button.\n *\n * This doesn't fire when setting `hidden` manually.\n *\n * The `hidden` property is `false` when this event fires.\n */\n dismiss?: CallbackEventListener;\n}" }, { "filePath": "src/surfaces/checkout/components/Banner.ts", @@ -111042,7 +111308,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/Banner.ts", @@ -111616,7 +111882,7 @@ "syntaxKind": "PropertySignature", "name": "collapsible", "value": "boolean", - "description": "Makes the content collapsible. A collapsible banner will conceal child elements initially, but allow the user to expand the banner to see them.", + "description": "Whether the banner content can be collapsed and expanded by the user. A collapsible banner conceals child elements initially, allowing the user to expand the banner to reveal them.", "isOptional": true, "defaultValue": "false" }, @@ -111681,7 +111947,7 @@ "syntaxKind": "PropertySignature", "name": "dismissible", "value": "boolean", - "description": "Determines whether the close button of the banner is present.\n\nWhen the close button is pressed, the `dismiss` event will fire, then `hidden` will be true, any animation will complete, and the `afterhide` event will fire.", + "description": "Whether the banner displays a close button that allows users to dismiss it.\n\nWhen the close button is pressed, the `dismiss` event will fire, then `hidden` will be set to `true`, any animation will complete, and the `afterhide` event will fire.", "isOptional": true, "defaultValue": "false" }, @@ -111943,7 +112209,7 @@ "syntaxKind": "PropertySignature", "name": "heading", "value": "string", - "description": "The title of the banner.", + "description": "The heading text displayed at the top of the banner to summarize the message or alert.", "isOptional": true, "defaultValue": "''" }, @@ -111952,7 +112218,7 @@ "syntaxKind": "PropertySignature", "name": "hidden", "value": "boolean", - "description": "Determines whether the banner is hidden.\n\nIf this property is being set on each framework render (as in 'controlled' usage), and the banner is `dismissible`, ensure you update app state for this property when the `dismiss` event fires.\n\nIf the banner is not `dismissible`, it can still be hidden by setting this property.", + "description": "Controls whether the banner is visible or hidden.\n\nWhen using a controlled component pattern and the banner is `dismissible`, update this property to `true` when the `dismiss` event fires.\n\nYou can hide the banner programmatically by setting this to `true` even if it's not `dismissible`.", "isOptional": true, "defaultValue": "false" }, @@ -111968,7 +112234,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -113094,7 +113360,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/Banner.ts", @@ -113318,7 +113584,7 @@ "syntaxKind": "PropertySignature", "name": "tone", "value": "'info' | 'auto' | 'success' | 'warning' | 'critical'", - "description": "Sets the tone of the Banner, based on the intention of the information being conveyed.\n\nThe banner is a live region and the type of status will be dictated by the Tone selected.\n\n- `critical` creates an [assertive live region](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/alert_role) that is announced by screen readers immediately.\n- `neutral`, `info`, `success`, `warning` and `caution` creates an [informative live region](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/status_role) that is announced by screen readers after the current message.", + "description": "The semantic meaning and color treatment of the component. The banner is a live region and the type of status is dictated by the tone selected.\n\n- `info`: Informational content or helpful tips.\n- `auto`: Automatically determined based on context.\n- `success`: Positive outcomes or successful states.\n- `warning`: Important warnings about potential issues.\n- `critical`: Urgent problems or destructive actions.\n\nThe `critical` tone creates an [assertive live region](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/alert_role) that is announced by screen readers immediately. The `info`, `success`, and `warning` tones create an [informative live region](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/status_role) that is announced by screen readers after the current message.", "isOptional": true, "defaultValue": "'auto'" }, @@ -113358,7 +113624,7 @@ "syntaxKind": "PropertySignature", "name": "collapsible", "value": "boolean", - "description": "Makes the content collapsible. A collapsible banner will conceal child elements initially, but allow the user to expand the banner to see them.", + "description": "Whether the banner content can be collapsed and expanded by the user. A collapsible banner conceals child elements initially, allowing the user to expand the banner to reveal them.", "isOptional": true, "defaultValue": "false" }, @@ -113367,7 +113633,7 @@ "syntaxKind": "PropertySignature", "name": "dismissible", "value": "boolean", - "description": "Determines whether the close button of the banner is present.\n\nWhen the close button is pressed, the `dismiss` event will fire, then `hidden` will be true, any animation will complete, and the `afterhide` event will fire.", + "description": "Whether the banner displays a close button that allows users to dismiss it.\n\nWhen the close button is pressed, the `dismiss` event will fire, then `hidden` will be set to `true`, any animation will complete, and the `afterhide` event will fire.", "isOptional": true, "defaultValue": "false" }, @@ -113376,7 +113642,7 @@ "syntaxKind": "PropertySignature", "name": "heading", "value": "string", - "description": "The title of the banner.", + "description": "The heading text displayed at the top of the banner to summarize the message or alert.", "isOptional": true, "defaultValue": "''" }, @@ -113385,7 +113651,7 @@ "syntaxKind": "PropertySignature", "name": "hidden", "value": "boolean", - "description": "Determines whether the banner is hidden.\n\nIf this property is being set on each framework render (as in 'controlled' usage), and the banner is `dismissible`, ensure you update app state for this property when the `dismiss` event fires.\n\nIf the banner is not `dismissible`, it can still be hidden by setting this property.", + "description": "Controls whether the banner is visible or hidden.\n\nWhen using a controlled component pattern and the banner is `dismissible`, update this property to `true` when the `dismiss` event fires.\n\nYou can hide the banner programmatically by setting this to `true` even if it's not `dismissible`.", "isOptional": true, "defaultValue": "false" }, @@ -113394,7 +113660,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -113418,7 +113684,7 @@ "syntaxKind": "PropertySignature", "name": "tone", "value": "'info' | 'auto' | 'success' | 'warning' | 'critical'", - "description": "Sets the tone of the Banner, based on the intention of the information being conveyed.\n\nThe banner is a live region and the type of status will be dictated by the Tone selected.\n\n- `critical` creates an [assertive live region](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/alert_role) that is announced by screen readers immediately.\n- `neutral`, `info`, `success`, `warning` and `caution` creates an [informative live region](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/status_role) that is announced by screen readers after the current message.", + "description": "The semantic meaning and color treatment of the component. The banner is a live region and the type of status is dictated by the tone selected.\n\n- `info`: Informational content or helpful tips.\n- `auto`: Automatically determined based on context.\n- `success`: Positive outcomes or successful states.\n- `warning`: Important warnings about potential issues.\n- `critical`: Urgent problems or destructive actions.\n\nThe `critical` tone creates an [assertive live region](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/alert_role) that is announced by screen readers immediately. The `info`, `success`, and `warning` tones create an [informative live region](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/status_role) that is announced by screen readers after the current message.", "isOptional": true, "defaultValue": "'auto'" } @@ -113446,7 +113712,7 @@ "syntaxKind": "TypeAliasDeclaration", "name": "BorderShorthand", "value": "ReducedBorderSizeKeyword | `${ReducedBorderSizeKeyword} ${ReducedColorKeyword}` | `${ReducedBorderSizeKeyword} ${ReducedColorKeyword} ${BorderStyleKeyword}`", - "description": "", + "description": "A shorthand string for specifying border properties. Accepts a size alone (`'base'`), size with color (`'base base'`), or size with color and style (`'base base dashed'`). Omitted values use their defaults.", "isPublicDocs": true }, { @@ -113460,7 +113726,7 @@ { "filePath": "src/surfaces/checkout/components/Box.ts", "name": "BoxElementProps", - "description": "The box component provides a generic, flexible container for custom designs and layouts. Use box to apply styling like backgrounds, padding, borders, or border radius when existing components don't meet your needs, or to nest and group other components.\n\nBox contents maintain their natural size, making it especially useful within layout components that would otherwise stretch their children. For structured layouts, use [stack](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/layout-and-structure/stack) or [grid](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/layout-and-structure/grid).", + "description": "", "isPublicDocs": true, "members": [ { @@ -113485,7 +113751,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityVisibility", "value": "'visible' | 'hidden' | 'exclusive'", - "description": "Changes the visibility of the element.\n\n- `visible`: the element is visible to all users.\n- `hidden`: the element is removed from the accessibility tree but remains visible.\n- `exclusive`: the element is visually hidden but remains in the accessibility tree.", + "description": "Controls how the element is exposed to sighted users and to assistive technologies such as screen readers.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", "isOptional": true, "defaultValue": "'visible'" }, @@ -113494,7 +113760,7 @@ "syntaxKind": "PropertySignature", "name": "background", "value": "'base' | 'subdued' | 'transparent'", - "description": "Adjust the background of the element.\n\n- `'transparent'`: No visible background.\n- `'subdued'`: A subtle, low-emphasis background.\n- `'base'`: The standard background color.\n- `'strong'`: A high-emphasis background for prominence.", + "description": "The background color of the box.\n\n- `base`: The standard background color for general content areas.\n- `subdued`: A muted background for secondary or supporting content.\n- `transparent`: No background color (the default).", "isOptional": true, "defaultValue": "'transparent'" }, @@ -113512,9 +113778,9 @@ "syntaxKind": "PropertySignature", "name": "border", "value": "BorderShorthand", - "description": "Applies a border using shorthand syntax to specify width, color, and style in a single property.\n\nAccepts a size value, optionally followed by a color, optionally followed by a style. Omitted values use defaults: color defaults to `base`, style defaults to `auto`.\n\nIndividual properties (`borderWidth`, `borderStyle`, `borderColor`) can override values set here.", + "description": "A shorthand for setting the border width, color, and style in a single property. Individual border properties (`borderWidth`, `borderStyle`) can override values set here.", "isOptional": true, - "defaultValue": "'none' - equivalent to `none base auto`.", + "defaultValue": "'none'", "examples": [ { "title": "Example", @@ -113533,7 +113799,7 @@ "syntaxKind": "PropertySignature", "name": "borderRadius", "value": "MaybeAllValuesShorthandProperty>", - "description": "Controls the roundedness of the element's corners using the design system's radius scale.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) using flow-relative values:\n- One value: applies to all corners\n- Two values: applies to start corners (top-left & bottom-right) and end corners (top-right & bottom-left) respectively\n- Three values: applies to start-start (top-left), end corners (top-right & bottom-left), and end-end (bottom-right) respectively\n- Four values: applies to start-start (top-left), start-end (top-right), end-end (bottom-right), and end-start (bottom-left) respectively\n\nExamples:\n- `small-100`: All corners have `small-100` radius\n- `small-100 none`: Top-left and bottom-right are `small-100`, top-right and bottom-left are `none`\n- `small-100 none large-100`: Top-left is `small-100`, top-right and bottom-left are `none`, bottom-right is `large-100`\n- `small-100 none large-100 base`: Each corner has its specified radius value", + "description": "The roundedness of the box's corners.\n\n- `none`: Sharp corners with no rounding.\n- `small-100` / `small`: Subtle rounding for compact elements.\n- `base`: Standard rounding for most use cases.\n- `large` / `large-100`: More pronounced rounding for prominent containers.\n- `max`: Maximum rounding, creating a pill or circular shape.\n\nSupports 1-to-4-value shorthand syntax for specifying different radii per corner.", "isOptional": true, "defaultValue": "'none'" }, @@ -113551,7 +113817,7 @@ "syntaxKind": "PropertySignature", "name": "borderWidth", "value": "MaybeAllValuesShorthandProperty | ''", - "description": "Controls the thickness of the border on all sides. When set, this overrides the width value specified in the `border` property.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) for specifying different widths per side:\n- One value: applies to all sides\n- Two values: applies to block sides (top/bottom) and inline sides (left/right) respectively\n- Three values: applies to block-start (top), inline sides (left/right), and block-end (bottom) respectively\n- Four values: applies to block-start (top), inline-end (right), block-end (bottom), and inline-start (left) respectively", + "description": "The thickness of the border on all sides. Supports 1-to-4-value shorthand syntax for specifying different widths per side. Overrides the width value set by `border`.", "isOptional": true, "defaultValue": "'' - meaning no override" }, @@ -113560,7 +113826,7 @@ "syntaxKind": "PropertySignature", "name": "display", "value": "MaybeResponsive<\"auto\" | \"none\">", - "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.", + "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.\n\nLearn more about the [display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display).", "isOptional": true, "defaultValue": "'auto'" }, @@ -113569,7 +113835,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -113690,14 +113956,14 @@ "defaultValue": "'' - meaning no override" } ], - "value": "export interface BoxElementProps extends Pick {\n background?: Extract;\n border?: BorderShorthand;\n borderWidth?: MaybeAllValuesShorthandProperty | '';\n borderRadius?: MaybeAllValuesShorthandProperty>;\n}" + "value": "export interface BoxElementProps extends Pick {\n /**\n * The background color of the box.\n *\n * - `base`: The standard background color for general content areas.\n * - `subdued`: A muted background for secondary or supporting content.\n * - `transparent`: No background color (the default).\n *\n * @default 'transparent'\n */\n background?: Extract;\n /**\n * A shorthand for setting the border width, color, and style in a single property. Individual border properties (`borderWidth`, `borderStyle`) can override values set here.\n *\n * @default 'none'\n */\n border?: BorderShorthand;\n /**\n * The thickness of the border on all sides. Supports 1-to-4-value shorthand syntax for specifying different widths per side. Overrides the width value set by `border`.\n *\n * @default '' - meaning no override\n */\n borderWidth?: MaybeAllValuesShorthandProperty | '';\n /**\n * The roundedness of the box's corners.\n *\n * - `none`: Sharp corners with no rounding.\n * - `small-100` / `small`: Subtle rounding for compact elements.\n * - `base`: Standard rounding for most use cases.\n * - `large` / `large-100`: More pronounced rounding for prominent containers.\n * - `max`: Maximum rounding, creating a pill or circular shape.\n *\n * Supports 1-to-4-value shorthand syntax for specifying different radii per corner.\n *\n * @default 'none'\n */\n borderRadius?: MaybeAllValuesShorthandProperty>;\n}" }, { "filePath": "src/surfaces/checkout/components/components.ts", "syntaxKind": "TypeAliasDeclaration", "name": "AccessibilityRole", "value": "\"main\" | \"header\" | \"footer\" | \"section\" | \"aside\" | \"navigation\" | \"ordered-list\" | \"list-item\" | \"list-item-separator\" | \"unordered-list\" | \"separator\" | \"status\" | \"alert\" | \"generic\" | \"presentation\" | \"none\"", - "description": "", + "description": "The semantic role of a component, used by assistive technologies to convey the element’s purpose to users. Each role maps to a specific HTML element or ARIA role.\n\n- `main`: The primary content of the page.\n- `header`: A page or section header.\n- `footer`: Information such as copyright, navigation links, and privacy statements.\n- `section`: A generic section that should have a heading or `accessibilityLabel`.\n- `aside`: Supporting content related to the main content.\n- `navigation`: A major group of navigation links.\n- `ordered-list`: A list of ordered items.\n- `list-item`: An item inside a list.\n- `list-item-separator`: A divider between list items.\n- `unordered-list`: A list of unordered items.\n- `separator`: A divider that separates sections of content.\n- `status`: A live region with advisory information that is not urgent.\n- `alert`: Important, usually time-sensitive information.\n- `generic`: A nameless container with no semantic meaning (renders a `
`).\n- `presentation`: Strips semantic meaning while keeping visual styling. Synonym for `none`.\n- `none`: Strips semantic meaning while keeping visual styling. Synonym for `presentation`.", "isPublicDocs": true }, { @@ -113760,7 +114026,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityVisibility", "value": "'visible' | 'hidden' | 'exclusive'", - "description": "Changes the visibility of the element.\n\n- `visible`: the element is visible to all users.\n- `hidden`: the element is removed from the accessibility tree but remains visible.\n- `exclusive`: the element is visually hidden but remains in the accessibility tree.", + "description": "Controls how the element is exposed to sighted users and to assistive technologies such as screen readers.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", "isOptional": true, "defaultValue": "'visible'" }, @@ -113769,7 +114035,7 @@ "syntaxKind": "PropertySignature", "name": "background", "value": "'base' | 'subdued' | 'transparent'", - "description": "Adjust the background of the element.\n\n- `'transparent'`: No visible background.\n- `'subdued'`: A subtle, low-emphasis background.\n- `'base'`: The standard background color.\n- `'strong'`: A high-emphasis background for prominence.", + "description": "The background color of the box.\n\n- `base`: The standard background color for general content areas.\n- `subdued`: A muted background for secondary or supporting content.\n- `transparent`: No background color (the default).", "isOptional": true, "defaultValue": "'transparent'" }, @@ -113787,15 +114053,16 @@ "syntaxKind": "PropertySignature", "name": "border", "value": "BorderShorthand", - "description": "Applies a border using shorthand syntax to specify width, color, and style in a single property.\n\nAccepts a size value, optionally followed by a color, optionally followed by a style. Omitted values use defaults: color defaults to `base`, style defaults to `auto`.\n\nIndividual properties (`borderWidth`, `borderStyle`, `borderColor`) can override values set here.", - "isOptional": true + "description": "A shorthand for setting the border width, color, and style in a single property. Individual border properties (`borderWidth`, `borderStyle`) can override values set here.", + "isOptional": true, + "defaultValue": "'none'" }, { "filePath": "src/surfaces/checkout/components/Box.ts", "syntaxKind": "PropertySignature", "name": "borderRadius", "value": "MaybeAllValuesShorthandProperty>", - "description": "Controls the roundedness of the element's corners using the design system's radius scale.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) using flow-relative values:\n- One value: applies to all corners\n- Two values: applies to start corners (top-left & bottom-right) and end corners (top-right & bottom-left) respectively\n- Three values: applies to start-start (top-left), end corners (top-right & bottom-left), and end-end (bottom-right) respectively\n- Four values: applies to start-start (top-left), start-end (top-right), end-end (bottom-right), and end-start (bottom-left) respectively\n\nExamples:\n- `small-100`: All corners have `small-100` radius\n- `small-100 none`: Top-left and bottom-right are `small-100`, top-right and bottom-left are `none`\n- `small-100 none large-100`: Top-left is `small-100`, top-right and bottom-left are `none`, bottom-right is `large-100`\n- `small-100 none large-100 base`: Each corner has its specified radius value", + "description": "The roundedness of the box's corners.\n\n- `none`: Sharp corners with no rounding.\n- `small-100` / `small`: Subtle rounding for compact elements.\n- `base`: Standard rounding for most use cases.\n- `large` / `large-100`: More pronounced rounding for prominent containers.\n- `max`: Maximum rounding, creating a pill or circular shape.\n\nSupports 1-to-4-value shorthand syntax for specifying different radii per corner.", "isOptional": true, "defaultValue": "'none'" }, @@ -113813,15 +114080,16 @@ "syntaxKind": "PropertySignature", "name": "borderWidth", "value": "MaybeAllValuesShorthandProperty | ''", - "description": "Controls the thickness of the border on all sides. When set, this overrides the width value specified in the `border` property.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) for specifying different widths per side:\n- One value: applies to all sides\n- Two values: applies to block sides (top/bottom) and inline sides (left/right) respectively\n- Three values: applies to block-start (top), inline sides (left/right), and block-end (bottom) respectively\n- Four values: applies to block-start (top), inline-end (right), block-end (bottom), and inline-start (left) respectively", - "isOptional": true + "description": "The thickness of the border on all sides. Supports 1-to-4-value shorthand syntax for specifying different widths per side. Overrides the width value set by `border`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" }, { "filePath": "src/surfaces/checkout/components/Box.ts", "syntaxKind": "PropertySignature", "name": "display", "value": "MaybeResponsive<\"auto\" | \"none\">", - "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.", + "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.\n\nLearn more about the [display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display).", "isOptional": true, "defaultValue": "'auto'" }, @@ -113830,7 +114098,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -114005,7 +114273,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityVisibility", "value": "'visible' | 'hidden' | 'exclusive'", - "description": "Changes the visibility of the element.\n\n- `visible`: the element is visible to all users.\n- `hidden`: the element is removed from the accessibility tree but remains visible.\n- `exclusive`: the element is visually hidden but remains in the accessibility tree.", + "description": "Controls how the element is exposed to sighted users and to assistive technologies such as screen readers.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", "isOptional": true, "defaultValue": "'visible'" }, @@ -114028,7 +114296,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/Box.ts", @@ -114483,7 +114751,7 @@ "syntaxKind": "PropertySignature", "name": "background", "value": "'base' | 'subdued' | 'transparent'", - "description": "Adjust the background of the element.\n\n- `'transparent'`: No visible background.\n- `'subdued'`: A subtle, low-emphasis background.\n- `'base'`: The standard background color.\n- `'strong'`: A high-emphasis background for prominence.", + "description": "The background color of the box.\n\n- `base`: The standard background color for general content areas.\n- `subdued`: A muted background for secondary or supporting content.\n- `transparent`: No background color (the default).", "isOptional": true, "defaultValue": "'transparent'" }, @@ -114522,15 +114790,16 @@ "syntaxKind": "PropertySignature", "name": "border", "value": "BorderShorthand", - "description": "Applies a border using shorthand syntax to specify width, color, and style in a single property.\n\nAccepts a size value, optionally followed by a color, optionally followed by a style. Omitted values use defaults: color defaults to `base`, style defaults to `auto`.\n\nIndividual properties (`borderWidth`, `borderStyle`, `borderColor`) can override values set here.", - "isOptional": true + "description": "A shorthand for setting the border width, color, and style in a single property. Individual border properties (`borderWidth`, `borderStyle`) can override values set here.", + "isOptional": true, + "defaultValue": "'none'" }, { "filePath": "src/surfaces/checkout/components/Box.ts", "syntaxKind": "PropertySignature", "name": "borderRadius", "value": "MaybeAllValuesShorthandProperty>", - "description": "Controls the roundedness of the element's corners using the design system's radius scale.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) using flow-relative values:\n- One value: applies to all corners\n- Two values: applies to start corners (top-left & bottom-right) and end corners (top-right & bottom-left) respectively\n- Three values: applies to start-start (top-left), end corners (top-right & bottom-left), and end-end (bottom-right) respectively\n- Four values: applies to start-start (top-left), start-end (top-right), end-end (bottom-right), and end-start (bottom-left) respectively\n\nExamples:\n- `small-100`: All corners have `small-100` radius\n- `small-100 none`: Top-left and bottom-right are `small-100`, top-right and bottom-left are `none`\n- `small-100 none large-100`: Top-left is `small-100`, top-right and bottom-left are `none`, bottom-right is `large-100`\n- `small-100 none large-100 base`: Each corner has its specified radius value", + "description": "The roundedness of the box's corners.\n\n- `none`: Sharp corners with no rounding.\n- `small-100` / `small`: Subtle rounding for compact elements.\n- `base`: Standard rounding for most use cases.\n- `large` / `large-100`: More pronounced rounding for prominent containers.\n- `max`: Maximum rounding, creating a pill or circular shape.\n\nSupports 1-to-4-value shorthand syntax for specifying different radii per corner.", "isOptional": true, "defaultValue": "'none'" }, @@ -114548,8 +114817,9 @@ "syntaxKind": "PropertySignature", "name": "borderWidth", "value": "MaybeAllValuesShorthandProperty | ''", - "description": "Controls the thickness of the border on all sides. When set, this overrides the width value specified in the `border` property.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) for specifying different widths per side:\n- One value: applies to all sides\n- Two values: applies to block sides (top/bottom) and inline sides (left/right) respectively\n- Three values: applies to block-start (top), inline sides (left/right), and block-end (bottom) respectively\n- Four values: applies to block-start (top), inline-end (right), block-end (bottom), and inline-start (left) respectively", - "isOptional": true + "description": "The thickness of the border on all sides. Supports 1-to-4-value shorthand syntax for specifying different widths per side. Overrides the width value set by `border`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" }, { "filePath": "src/surfaces/checkout/components/Box.ts", @@ -114717,7 +114987,7 @@ "syntaxKind": "PropertySignature", "name": "display", "value": "MaybeResponsive<\"auto\" | \"none\">", - "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.", + "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.\n\nLearn more about the [display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display).", "isOptional": true, "defaultValue": "'auto'" }, @@ -114986,7 +115256,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -116215,7 +116485,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/Box.ts", @@ -116469,7 +116739,7 @@ { "filePath": "src/surfaces/checkout/components/Choice.ts", "name": "ChoiceElementProps", - "description": "The choice component creates individual selectable options within a choice list. Use choice to define each option that merchants can select, supporting both single selection (radio buttons) and multiple selection (checkboxes) modes.\n\nChoice components support labels, help text, and custom content through slots, providing flexible option presentation within choice lists.", + "description": "", "isPublicDocs": true, "members": [ { @@ -116485,7 +116755,7 @@ "syntaxKind": "PropertySignature", "name": "defaultSelected", "value": "boolean", - "description": "Whether the control is active by default.", + "description": "Whether the control is selected by default.", "isOptional": true, "defaultValue": "false" }, @@ -116494,7 +116764,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the control, disallowing any interaction.", + "description": "Whether the control is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -116503,7 +116773,7 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "boolean", - "description": "Set to `true` to associate a choice with the error passed to `ChoiceList`", + "description": "Whether this choice is associated with the error state of the parent choice list. When `true`, the choice is visually marked as having an error.", "isOptional": true, "defaultValue": "false" }, @@ -116512,7 +116782,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -116520,7 +116790,7 @@ "syntaxKind": "PropertySignature", "name": "selected", "value": "boolean", - "description": "Whether the control is active.", + "description": "Whether the control is currently selected.", "isOptional": true, "defaultValue": "false" }, @@ -116538,7 +116808,7 @@ { "filePath": "src/surfaces/checkout/components/Choice.ts", "name": "ChoiceElementSlots", - "description": "Learn more about [component slots](/docs/api/checkout-ui-extensions/latest/using-polaris-components#slots).", + "description": "", "isPublicDocs": true, "members": [ { @@ -116601,7 +116871,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/Choice.ts", @@ -117224,7 +117494,7 @@ "syntaxKind": "PropertySignature", "name": "defaultSelected", "value": "boolean", - "description": "Whether the control is active by default.", + "description": "Whether the control is selected by default.", "isOptional": true, "defaultValue": "false" }, @@ -117240,7 +117510,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the control, disallowing any interaction.", + "description": "Whether the control is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -117354,7 +117624,7 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "boolean", - "description": "Set to `true` to associate a choice with the error passed to `ChoiceList`", + "description": "Whether this choice is associated with the error state of the parent choice list. When `true`, the choice is visually marked as having an error.", "isOptional": true, "defaultValue": "false" }, @@ -117525,7 +117795,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -118637,7 +118907,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/Choice.ts", @@ -118742,7 +119012,7 @@ "syntaxKind": "PropertySignature", "name": "selected", "value": "boolean", - "description": "Whether the control is active.", + "description": "Whether the control is currently selected.", "isOptional": true, "defaultValue": "false" }, @@ -118924,7 +119194,7 @@ "syntaxKind": "PropertySignature", "name": "defaultSelected", "value": "boolean", - "description": "Whether the control is active by default.", + "description": "Whether the control is selected by default.", "isOptional": true, "defaultValue": "false" }, @@ -118933,7 +119203,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the control, disallowing any interaction.", + "description": "Whether the control is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -118942,7 +119212,7 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "boolean", - "description": "Set to `true` to associate a choice with the error passed to `ChoiceList`", + "description": "Whether this choice is associated with the error state of the parent choice list. When `true`, the choice is visually marked as having an error.", "isOptional": true, "defaultValue": "false" }, @@ -118951,7 +119221,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -118959,7 +119229,7 @@ "syntaxKind": "PropertySignature", "name": "selected", "value": "boolean", - "description": "Whether the control is active.", + "description": "Whether the control is currently selected.", "isOptional": true, "defaultValue": "false" }, @@ -118977,7 +119247,7 @@ { "filePath": "src/surfaces/checkout/components/ChoiceList.ts", "name": "ChoiceListElementProps", - "description": "The choice list component presents multiple options for single or multiple selections. Use it when merchants need to choose from a defined set of options, such as filtering results or collecting preferences.\n\nThe component supports both single selection (radio button behavior) and multiple selection (checkbox behavior) modes. It includes configurable labels, help text, and validation. For compact dropdown selection with four or more options, use [select](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/forms/select).", + "description": "", "isPublicDocs": true, "members": [ { @@ -118985,7 +119255,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.\n\n`disabled` on any child choices is ignored when this is true.", + "description": "Whether the field is disabled, preventing any user interaction.\n\n`disabled` on any child choices is ignored when this is true.", "isOptional": true, "defaultValue": "false" }, @@ -118994,7 +119264,7 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -119002,7 +119272,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -119010,7 +119280,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Content to use as the field label.", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", "isOptional": true }, { @@ -119018,7 +119288,7 @@ "syntaxKind": "PropertySignature", "name": "labelAccessibilityVisibility", "value": "'visible' | 'exclusive'", - "description": "Changes the visibility of the component's label.\n\n- `visible`: the label is visible to all users.\n- `exclusive`: the label is visually hidden but remains in the accessibility tree.", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone.\n- `exclusive`: The label is visually hidden but still announced by screen readers.", "isOptional": true, "defaultValue": "'visible'" }, @@ -119036,7 +119306,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -119044,7 +119314,7 @@ "syntaxKind": "PropertySignature", "name": "values", "value": "string[]", - "description": "An array of the `value`s of the selected options.\n\nThis is a convenience prop for setting the `selected` prop on child options.", + "description": "An array of `value` attributes for the currently selected options.\n\nThis is a convenience prop for setting the `selected` prop on child options.\n\nForm data captures the selected value strings only. Complex nested content inside choices is for display purposes and isn't included in form submissions.", "isOptional": true }, { @@ -119052,7 +119322,7 @@ "syntaxKind": "PropertySignature", "name": "variant", "value": "'auto' | 'list' | 'inline' | 'block' | 'grid'", - "description": "The variant of the choice grid.\n\n- `auto`: The variant is determined by the context.\n- `list`: The choices are displayed in a list.\n- `inline`: The choices are displayed on the inline axis.\n- `block`: The choices are displayed on the block axis.\n- `grid`: The choices are displayed in a grid.", + "description": "The variant of the choice grid.\n\n- `auto`: The variant is determined by the context.\n- `list`: The choices are displayed in a list.\n- `inline`: The choices are displayed on the inline axis.\n- `block`: The choices are displayed on the block axis.\n- `grid`: The choices are displayed in a grid.\n\nThe selected content slot is supported only in the default (stacked) variant. `inline` and `grid` ignore it.", "isOptional": true, "defaultValue": "'auto'" } @@ -119070,7 +119340,7 @@ "syntaxKind": "PropertySignature", "name": "onChange", "value": "(event: Event) => void", - "description": "Callback when the user has selected option(s).", + "description": "A callback fired when the user has selected one or more options.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", "isOptional": true } ], @@ -119079,7 +119349,7 @@ { "filePath": "src/surfaces/checkout/components/ChoiceList.ts", "name": "ChoiceListElementEvents", - "description": "Learn more about [registering events](/docs/api/checkout-ui-extensions/latest/using-polaris-components#event-handling).", + "description": "", "isPublicDocs": true, "members": [ { @@ -119087,11 +119357,11 @@ "syntaxKind": "PropertySignature", "name": "change", "value": "CallbackEventListener", - "description": "A callback that is run whenever the control is changed.", + "description": "A callback fired when the choice list value changes.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", "isOptional": true } ], - "value": "export interface ChoiceListElementEvents {\n /**\n * A callback that is run whenever the control is changed.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event\n */\n change?: CallbackEventListener;\n}" + "value": "export interface ChoiceListElementEvents {\n /**\n * A callback fired when the choice list value changes.\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change?: CallbackEventListener;\n}" }, { "filePath": "src/surfaces/checkout/components/ChoiceList.ts", @@ -119118,7 +119388,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/ChoiceList.ts", @@ -119748,7 +120018,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.\n\n`disabled` on any child choices is ignored when this is true.", + "description": "Whether the field is disabled, preventing any user interaction.\n\n`disabled` on any child choices is ignored when this is true.", "isOptional": true, "defaultValue": "false" }, @@ -119862,7 +120132,7 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -120032,7 +120302,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -120131,7 +120401,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Content to use as the field label.", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", "isOptional": true }, { @@ -120139,7 +120409,7 @@ "syntaxKind": "PropertySignature", "name": "labelAccessibilityVisibility", "value": "'visible' | 'exclusive'", - "description": "Changes the visibility of the component's label.\n\n- `visible`: the label is visible to all users.\n- `exclusive`: the label is visually hidden but remains in the accessibility tree.", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone.\n- `exclusive`: The label is visually hidden but still announced by screen readers.", "isOptional": true, "defaultValue": "'visible'" }, @@ -120206,7 +120476,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -121178,7 +121448,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/ChoiceList.ts", @@ -121416,7 +121686,7 @@ "syntaxKind": "PropertySignature", "name": "values", "value": "string[]", - "description": "An array of the `value`s of the selected options.\n\nThis is a convenience prop for setting the `selected` prop on child options.", + "description": "An array of `value` attributes for the currently selected options.\n\nThis is a convenience prop for setting the `selected` prop on child options.\n\nForm data captures the selected value strings only. Complex nested content inside choices is for display purposes and isn't included in form submissions.", "isOptional": true }, { @@ -121424,7 +121694,7 @@ "syntaxKind": "PropertySignature", "name": "variant", "value": "'auto' | 'list' | 'inline' | 'block' | 'grid'", - "description": "The variant of the choice grid.\n\n- `auto`: The variant is determined by the context.\n- `list`: The choices are displayed in a list.\n- `inline`: The choices are displayed on the inline axis.\n- `block`: The choices are displayed on the block axis.\n- `grid`: The choices are displayed in a grid.", + "description": "The variant of the choice grid.\n\n- `auto`: The variant is determined by the context.\n- `list`: The choices are displayed in a list.\n- `inline`: The choices are displayed on the inline axis.\n- `block`: The choices are displayed on the block axis.\n- `grid`: The choices are displayed in a grid.\n\nThe selected content slot is supported only in the default (stacked) variant. `inline` and `grid` ignore it.", "isOptional": true, "defaultValue": "'auto'" }, @@ -121457,7 +121727,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.\n\n`disabled` on any child choices is ignored when this is true.", + "description": "Whether the field is disabled, preventing any user interaction.\n\n`disabled` on any child choices is ignored when this is true.", "isOptional": true, "defaultValue": "false" }, @@ -121466,7 +121736,7 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -121474,7 +121744,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -121482,7 +121752,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Content to use as the field label.", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", "isOptional": true }, { @@ -121490,7 +121760,7 @@ "syntaxKind": "PropertySignature", "name": "labelAccessibilityVisibility", "value": "'visible' | 'exclusive'", - "description": "Changes the visibility of the component's label.\n\n- `visible`: the label is visible to all users.\n- `exclusive`: the label is visually hidden but remains in the accessibility tree.", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone.\n- `exclusive`: The label is visually hidden but still announced by screen readers.", "isOptional": true, "defaultValue": "'visible'" }, @@ -121508,7 +121778,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -121516,7 +121786,7 @@ "syntaxKind": "PropertySignature", "name": "onChange", "value": "(event: Event) => void", - "description": "Callback when the user has selected option(s).", + "description": "A callback fired when the user has selected one or more options.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", "isOptional": true }, { @@ -121524,7 +121794,7 @@ "syntaxKind": "PropertySignature", "name": "values", "value": "string[]", - "description": "An array of the `value`s of the selected options.\n\nThis is a convenience prop for setting the `selected` prop on child options.", + "description": "An array of `value` attributes for the currently selected options.\n\nThis is a convenience prop for setting the `selected` prop on child options.\n\nForm data captures the selected value strings only. Complex nested content inside choices is for display purposes and isn't included in form submissions.", "isOptional": true }, { @@ -121532,7 +121802,7 @@ "syntaxKind": "PropertySignature", "name": "variant", "value": "'auto' | 'list' | 'inline' | 'block' | 'grid'", - "description": "The variant of the choice grid.\n\n- `auto`: The variant is determined by the context.\n- `list`: The choices are displayed in a list.\n- `inline`: The choices are displayed on the inline axis.\n- `block`: The choices are displayed on the block axis.\n- `grid`: The choices are displayed in a grid.", + "description": "The variant of the choice grid.\n\n- `auto`: The variant is determined by the context.\n- `list`: The choices are displayed in a list.\n- `inline`: The choices are displayed on the inline axis.\n- `block`: The choices are displayed on the block axis.\n- `grid`: The choices are displayed in a grid.\n\nThe selected content slot is supported only in the default (stacked) variant. `inline` and `grid` ignore it.", "isOptional": true, "defaultValue": "'auto'" } @@ -121558,7 +121828,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityVisibility", "value": "'visible' | 'hidden' | 'exclusive'", - "description": "Changes the visibility of the element.\n\n- `visible`: the element is visible to all users.\n- `hidden`: the element is removed from the accessibility tree but remains visible.\n- `exclusive`: the element is visually hidden but remains in the accessibility tree.", + "description": "Controls how the element is exposed to sighted users and to assistive technologies such as screen readers.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", "isOptional": true, "defaultValue": "'visible'" }, @@ -121633,7 +121903,7 @@ "syntaxKind": "PropertySignature", "name": "command", "value": "'--auto' | '--show' | '--hide' | '--toggle' | '--copy'", - "description": "Sets the action the `commandFor` should take when this clickable is activated.\n\nSee the documentation of particular components for the actions they support.\n\n- `--auto`: Performs the default action for the target component.\n- `--show`: Displays the target component.\n- `--hide`: Conceals the target component.\n- `--toggle`: Alternates the target component.\n- `--copy`: Copies the target ClipboardItem.", + "description": "Sets the action the `commandFor` target should take when this component is activated.\n\n- `--auto`: Performs the default action for the target component.\n- `--show`: Displays the target component.\n- `--hide`: Conceals the target component.\n- `--toggle`: Alternates the target component.\n- `--copy`: Copies the target ClipboardItem.\n\nLearn more about the [`command` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).", "isOptional": true, "defaultValue": "'--auto'" }, @@ -121642,7 +121912,7 @@ "syntaxKind": "PropertySignature", "name": "commandFor", "value": "string", - "description": "ID of a component that should respond to activations (such as clicks) on this component.\n\nSee `command` for how to control the behavior of the target.", + "description": "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).\n\nWhen both `commandFor` and `href` are set, `commandFor` takes precedence. The command runs and the link doesn't navigate.", "isOptional": true }, { @@ -121659,7 +121929,7 @@ "syntaxKind": "PropertySignature", "name": "display", "value": "MaybeResponsive<\"auto\" | \"none\">", - "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.", + "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.\n\nLearn more about the [display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display).", "isOptional": true, "defaultValue": "'auto'" }, @@ -121676,7 +121946,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -121836,12 +122106,12 @@ "syntaxKind": "PropertySignature", "name": "type", "value": "'submit' | 'button'", - "description": "The behavioral type of the button component, which determines what action it performs when activated.\n\n- `submit`: Submits the closest form.\n- `button`: Performs no default action when activated.\n- `reset`: Resets the closest form (returning fields to their default values).\n\nThis property is ignored if the component supports `href` or `commandFor`/`command` and one of them is set.", + "description": "The behavioral type of the clickable component, which determines what action it performs when activated.\n\n- `submit`: Submits the nearest containing form.\n- `button`: Performs no default action, relying on the `click` event handler for behavior.\n\nThis property is ignored if `href` or `commandFor`/`command` is set.", "isOptional": true, "defaultValue": "'button'" } ], - "value": "export interface ClickableElementProps extends Pick {\n background?: Extract;\n border?: BorderShorthand;\n borderWidth?: MaybeAllValuesShorthandProperty | '';\n borderRadius?: MaybeAllValuesShorthandProperty>;\n target?: Extract;\n type?: Extract;\n}" + "value": "export interface ClickableElementProps extends Pick {\n background?: Extract;\n border?: BorderShorthand;\n borderWidth?: MaybeAllValuesShorthandProperty | '';\n borderRadius?: MaybeAllValuesShorthandProperty>;\n target?: Extract;\n /**\n * The behavioral type of the clickable component, which determines what action it performs when activated.\n *\n * - `submit`: Submits the nearest containing form.\n * - `button`: Performs no default action, relying on the `click` event handler for behavior.\n *\n * This property is ignored if `href` or `commandFor`/`command` is set.\n *\n * @default 'button'\n */\n type?: Extract;\n}" }, { "filePath": "src/surfaces/checkout/components/Clickable.ts", @@ -121862,7 +122132,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityVisibility", "value": "'visible' | 'hidden' | 'exclusive'", - "description": "Changes the visibility of the element.\n\n- `visible`: the element is visible to all users.\n- `hidden`: the element is removed from the accessibility tree but remains visible.\n- `exclusive`: the element is visually hidden but remains in the accessibility tree.", + "description": "Controls how the element is exposed to sighted users and to assistive technologies such as screen readers.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", "isOptional": true, "defaultValue": "'visible'" }, @@ -121923,7 +122193,7 @@ "syntaxKind": "PropertySignature", "name": "command", "value": "'--auto' | '--show' | '--hide' | '--toggle' | '--copy'", - "description": "Sets the action the `commandFor` should take when this clickable is activated.\n\nSee the documentation of particular components for the actions they support.\n\n- `--auto`: Performs the default action for the target component.\n- `--show`: Displays the target component.\n- `--hide`: Conceals the target component.\n- `--toggle`: Alternates the target component.\n- `--copy`: Copies the target ClipboardItem.", + "description": "Sets the action the `commandFor` target should take when this component is activated.\n\n- `--auto`: Performs the default action for the target component.\n- `--show`: Displays the target component.\n- `--hide`: Conceals the target component.\n- `--toggle`: Alternates the target component.\n- `--copy`: Copies the target ClipboardItem.\n\nLearn more about the [`command` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).", "isOptional": true, "defaultValue": "'--auto'" }, @@ -121932,7 +122202,7 @@ "syntaxKind": "PropertySignature", "name": "commandFor", "value": "string", - "description": "ID of a component that should respond to activations (such as clicks) on this component.\n\nSee `command` for how to control the behavior of the target.", + "description": "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).\n\nWhen both `commandFor` and `href` are set, `commandFor` takes precedence. The command runs and the link doesn't navigate.", "isOptional": true }, { @@ -121949,7 +122219,7 @@ "syntaxKind": "PropertySignature", "name": "display", "value": "MaybeResponsive<\"auto\" | \"none\">", - "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.", + "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.\n\nLearn more about the [display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display).", "isOptional": true, "defaultValue": "'auto'" }, @@ -121966,7 +122236,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -122150,7 +122420,7 @@ "syntaxKind": "PropertySignature", "name": "type", "value": "'submit' | 'button'", - "description": "The behavioral type of the button component, which determines what action it performs when activated.\n\n- `submit`: Submits the closest form.\n- `button`: Performs no default action when activated.\n- `reset`: Resets the closest form (returning fields to their default values).\n\nThis property is ignored if the component supports `href` or `commandFor`/`command` and one of them is set.", + "description": "The behavioral type of the clickable component, which determines what action it performs when activated.\n\n- `submit`: Submits the nearest containing form.\n- `button`: Performs no default action, relying on the `click` event handler for behavior.\n\nThis property is ignored if `href` or `commandFor`/`command` is set.", "isOptional": true, "defaultValue": "'button'" } @@ -122193,7 +122463,7 @@ { "filePath": "src/surfaces/checkout/components/Clickable.ts", "name": "ClickableElementEvents", - "description": "The clickable component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", + "description": "", "isPublicDocs": true, "members": [ { @@ -122242,7 +122512,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityVisibility", "value": "'visible' | 'hidden' | 'exclusive'", - "description": "Changes the visibility of the element.\n\n- `visible`: the element is visible to all users.\n- `hidden`: the element is removed from the accessibility tree but remains visible.\n- `exclusive`: the element is visually hidden but remains in the accessibility tree.", + "description": "Controls how the element is exposed to sighted users and to assistive technologies such as screen readers.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", "isOptional": true, "defaultValue": "'visible'" }, @@ -122265,7 +122535,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/Clickable.ts", @@ -122891,7 +123161,7 @@ "syntaxKind": "PropertySignature", "name": "command", "value": "'--auto' | '--show' | '--hide' | '--toggle' | '--copy'", - "description": "Sets the action the `commandFor` should take when this clickable is activated.\n\nSee the documentation of particular components for the actions they support.\n\n- `--auto`: Performs the default action for the target component.\n- `--show`: Displays the target component.\n- `--hide`: Conceals the target component.\n- `--toggle`: Alternates the target component.\n- `--copy`: Copies the target ClipboardItem.", + "description": "Sets the action the `commandFor` target should take when this component is activated.\n\n- `--auto`: Performs the default action for the target component.\n- `--show`: Displays the target component.\n- `--hide`: Conceals the target component.\n- `--toggle`: Alternates the target component.\n- `--copy`: Copies the target ClipboardItem.\n\nLearn more about the [`command` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).", "isOptional": true, "defaultValue": "'--auto'" }, @@ -122900,7 +123170,7 @@ "syntaxKind": "PropertySignature", "name": "commandFor", "value": "string", - "description": "ID of a component that should respond to activations (such as clicks) on this component.\n\nSee `command` for how to control the behavior of the target.", + "description": "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).\n\nWhen both `commandFor` and `href` are set, `commandFor` takes precedence. The command runs and the link doesn't navigate.", "isOptional": true }, { @@ -122980,7 +123250,7 @@ "syntaxKind": "PropertySignature", "name": "display", "value": "MaybeResponsive<\"auto\" | \"none\">", - "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.", + "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.\n\nLearn more about the [display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display).", "isOptional": true, "defaultValue": "'auto'" }, @@ -123257,7 +123527,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -124505,7 +124775,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/Clickable.ts", @@ -124752,7 +125022,7 @@ "syntaxKind": "PropertySignature", "name": "type", "value": "'submit' | 'button'", - "description": "The behavioral type of the button component, which determines what action it performs when activated.\n\n- `submit`: Submits the closest form.\n- `button`: Performs no default action when activated.\n- `reset`: Resets the closest form (returning fields to their default values).\n\nThis property is ignored if the component supports `href` or `commandFor`/`command` and one of them is set.", + "description": "The behavioral type of the clickable component, which determines what action it performs when activated.\n\n- `submit`: Submits the nearest containing form.\n- `button`: Performs no default action, relying on the `click` event handler for behavior.\n\nThis property is ignored if `href` or `commandFor`/`command` is set.", "isOptional": true, "defaultValue": "'button'" }, @@ -124777,7 +125047,7 @@ { "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", "name": "ClipboardItemElementProps", - "description": "Enables copying text to the user’s clipboard. Use alongside Button or Link components to let users easily copy content. `` doesn’t render visually.", + "description": "", "isPublicDocs": true, "members": [ { @@ -124785,7 +125055,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -124793,7 +125063,7 @@ "syntaxKind": "PropertySignature", "name": "text", "value": "string", - "description": "Plain text to be written to the clipboard.", + "description": "Plain text to be written to the clipboard.\n\nRich text, HTML, and binary content aren't supported.", "isOptional": true, "defaultValue": "''" } @@ -124828,7 +125098,7 @@ { "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", "name": "ClipboardItemElementEvents", - "description": "The clipboard item component provides event callbacks for handling copy interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", + "description": "", "isPublicDocs": true, "members": [ { @@ -124875,7 +125145,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", @@ -125772,7 +126042,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -126891,7 +127161,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", @@ -127087,7 +127357,7 @@ "syntaxKind": "PropertySignature", "name": "text", "value": "string", - "description": "Plain text to be written to the clipboard.", + "description": "Plain text to be written to the clipboard.\n\nRich text, HTML, and binary content aren't supported.", "isOptional": true, "defaultValue": "''" }, @@ -127162,7 +127432,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -127186,7 +127456,7 @@ "syntaxKind": "PropertySignature", "name": "text", "value": "string", - "description": "Plain text to be written to the clipboard.", + "description": "Plain text to be written to the clipboard.\n\nRich text, HTML, and binary content aren't supported.", "isOptional": true, "defaultValue": "''" } @@ -127196,7 +127466,7 @@ { "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", "name": "ConsentCheckboxElementProps", - "description": "Use buyer consent checkboxes for collecting the buyer’s approval for a given policy.", + "description": "", "isPublicDocs": true, "members": [ { @@ -127212,7 +127482,7 @@ "syntaxKind": "PropertySignature", "name": "checked", "value": "boolean", - "description": "Whether the control is active.", + "description": "Whether the control is currently checked.", "isOptional": true, "defaultValue": "false" }, @@ -127221,7 +127491,7 @@ "syntaxKind": "PropertySignature", "name": "command", "value": "'--auto' | '--show' | '--hide' | '--toggle'", - "description": "Sets the action the `commandFor` should take when this clickable is activated.\n\nSee the documentation of particular components for the actions they support.\n\n- `--auto`: Performs the default action for the target component.\n- `--show`: Displays the target component.\n- `--hide`: Conceals the target component.\n- `--toggle`: Alternates the target component.\n- `--copy`: Copies the target ClipboardItem.", + "description": "Sets the action the `commandFor` target should take when this component is activated.\n\n- `--auto`: Performs the default action for the target component.\n- `--show`: Displays the target component.\n- `--hide`: Conceals the target component.\n- `--toggle`: Alternates the target component.\n- `--copy`: Copies the target ClipboardItem.\n\nLearn more about the [`command` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).", "isOptional": true, "defaultValue": "'--auto'" }, @@ -127230,7 +127500,7 @@ "syntaxKind": "PropertySignature", "name": "commandFor", "value": "string", - "description": "ID of a component that should respond to activations (such as clicks) on this component.\n\nSee `command` for how to control the behavior of the target.", + "description": "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).\n\nWhen both `commandFor` and `href` are set, `commandFor` takes precedence. The command runs and the link doesn't navigate.", "isOptional": true }, { @@ -127238,7 +127508,7 @@ "syntaxKind": "PropertySignature", "name": "defaultChecked", "value": "boolean", - "description": "Whether the control is active by default.", + "description": "Whether the control is checked by default.", "isOptional": true, "defaultValue": "false" }, @@ -127247,7 +127517,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the control, disallowing any interaction.", + "description": "Whether the control is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -127256,7 +127526,7 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -127264,7 +127534,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -127272,7 +127542,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Visual content to use as the control label.", + "description": "The text displayed as the control label, which identifies the purpose of the control to users. This label is associated with the control for accessibility.", "isOptional": true }, { @@ -127280,15 +127550,15 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the control that is unique within the nearest containing `Form` component.", + "description": "The name attribute for the control, used to identify its value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", "syntaxKind": "PropertySignature", "name": "policy", - "value": "ConsentPolicy", - "description": "The policy for which user consent is being collected for.\n\n`sms-marketing`: Represents the policy for SMS marketing consent.", + "value": "'sms-marketing'", + "description": "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.\n\n- `sms-marketing`: Represents the policy for SMS marketing consent.", "isOptional": true }, { @@ -127300,15 +127570,7 @@ "isOptional": true } ], - "value": "export interface ConsentCheckboxElementProps extends Pick {\n command?: Extract;\n}" - }, - { - "filePath": "src/surfaces/checkout/components/components.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "ConsentPolicy", - "value": "\"sms-marketing\"", - "description": "", - "isPublicDocs": true + "value": "export interface ConsentCheckboxElementProps extends Pick {\n command?: Extract;\n /**\n * 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.\n *\n * - `sms-marketing`: Represents the policy for SMS marketing consent.\n */\n policy?: ConsentCheckboxProps$1['policy'];\n}" }, { "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", @@ -127330,7 +127592,7 @@ { "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", "name": "ConsentCheckboxElementEvents", - "description": "Learn more about [registering events](/docs/api/checkout-ui-extensions/latest/using-polaris-components#event-handling).", + "description": "", "isPublicDocs": true, "members": [ { @@ -127338,11 +127600,11 @@ "syntaxKind": "PropertySignature", "name": "change", "value": "CallbackEventListener", - "description": "A callback that is run whenever the control is changed.", + "description": "A callback fired when the consent checkbox value changes.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", "isOptional": true } ], - "value": "export interface ConsentCheckboxElementEvents {\n /**\n * A callback that is run whenever the control is changed.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event\n */\n change?: CallbackEventListener;\n}" + "value": "export interface ConsentCheckboxElementEvents {\n /**\n * A callback fired when the consent checkbox value changes.\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change?: CallbackEventListener;\n}" }, { "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", @@ -127377,7 +127639,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", @@ -127860,7 +128122,7 @@ "syntaxKind": "PropertySignature", "name": "checked", "value": "boolean", - "description": "Whether the control is active.", + "description": "Whether the control is currently checked.", "isOptional": true, "defaultValue": "false" }, @@ -127960,7 +128222,7 @@ "syntaxKind": "PropertySignature", "name": "command", "value": "'--auto' | '--show' | '--hide' | '--toggle'", - "description": "Sets the action the `commandFor` should take when this clickable is activated.\n\nSee the documentation of particular components for the actions they support.\n\n- `--auto`: Performs the default action for the target component.\n- `--show`: Displays the target component.\n- `--hide`: Conceals the target component.\n- `--toggle`: Alternates the target component.\n- `--copy`: Copies the target ClipboardItem.", + "description": "Sets the action the `commandFor` target should take when this component is activated.\n\n- `--auto`: Performs the default action for the target component.\n- `--show`: Displays the target component.\n- `--hide`: Conceals the target component.\n- `--toggle`: Alternates the target component.\n- `--copy`: Copies the target ClipboardItem.\n\nLearn more about the [`command` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).", "isOptional": true, "defaultValue": "'--auto'" }, @@ -127969,7 +128231,7 @@ "syntaxKind": "PropertySignature", "name": "commandFor", "value": "string", - "description": "ID of a component that should respond to activations (such as clicks) on this component.\n\nSee `command` for how to control the behavior of the target.", + "description": "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).\n\nWhen both `commandFor` and `href` are set, `commandFor` takes precedence. The command runs and the link doesn't navigate.", "isOptional": true }, { @@ -128026,7 +128288,7 @@ "syntaxKind": "PropertySignature", "name": "defaultChecked", "value": "boolean", - "description": "Whether the control is active by default.", + "description": "Whether the control is checked by default.", "isOptional": true, "defaultValue": "false" }, @@ -128042,7 +128304,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the control, disallowing any interaction.", + "description": "Whether the control is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -128156,7 +128418,7 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -128326,7 +128588,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -128425,7 +128687,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Visual content to use as the control label.", + "description": "The text displayed as the control label, which identifies the purpose of the control to users. This label is associated with the control for accessibility.", "isOptional": true }, { @@ -128482,7 +128744,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the control that is unique within the nearest containing `Form` component.", + "description": "The name attribute for the control, used to identify its value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -129353,8 +129615,8 @@ "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", "syntaxKind": "PropertySignature", "name": "policy", - "value": "ConsentPolicy", - "description": "The policy for which user consent is being collected for.\n\n`sms-marketing`: Represents the policy for SMS marketing consent.", + "value": "'sms-marketing'", + "description": "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.\n\n- `sms-marketing`: Represents the policy for SMS marketing consent.", "isOptional": true }, { @@ -129462,7 +129724,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", @@ -129740,7 +130002,7 @@ "syntaxKind": "PropertySignature", "name": "checked", "value": "boolean", - "description": "Whether the control is active.", + "description": "Whether the control is currently checked.", "isOptional": true, "defaultValue": "false" }, @@ -129749,7 +130011,7 @@ "syntaxKind": "PropertySignature", "name": "command", "value": "'--auto' | '--show' | '--hide' | '--toggle'", - "description": "Sets the action the `commandFor` should take when this clickable is activated.\n\nSee the documentation of particular components for the actions they support.\n\n- `--auto`: Performs the default action for the target component.\n- `--show`: Displays the target component.\n- `--hide`: Conceals the target component.\n- `--toggle`: Alternates the target component.\n- `--copy`: Copies the target ClipboardItem.", + "description": "Sets the action the `commandFor` target should take when this component is activated.\n\n- `--auto`: Performs the default action for the target component.\n- `--show`: Displays the target component.\n- `--hide`: Conceals the target component.\n- `--toggle`: Alternates the target component.\n- `--copy`: Copies the target ClipboardItem.\n\nLearn more about the [`command` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).", "isOptional": true, "defaultValue": "'--auto'" }, @@ -129758,7 +130020,7 @@ "syntaxKind": "PropertySignature", "name": "commandFor", "value": "string", - "description": "ID of a component that should respond to activations (such as clicks) on this component.\n\nSee `command` for how to control the behavior of the target.", + "description": "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).\n\nWhen both `commandFor` and `href` are set, `commandFor` takes precedence. The command runs and the link doesn't navigate.", "isOptional": true }, { @@ -129766,7 +130028,7 @@ "syntaxKind": "PropertySignature", "name": "defaultChecked", "value": "boolean", - "description": "Whether the control is active by default.", + "description": "Whether the control is checked by default.", "isOptional": true, "defaultValue": "false" }, @@ -129775,7 +130037,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the control, disallowing any interaction.", + "description": "Whether the control is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -129784,7 +130046,7 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -129792,7 +130054,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -129800,7 +130062,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Visual content to use as the control label.", + "description": "The text displayed as the control label, which identifies the purpose of the control to users. This label is associated with the control for accessibility.", "isOptional": true }, { @@ -129808,7 +130070,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the control that is unique within the nearest containing `Form` component.", + "description": "The name attribute for the control, used to identify its value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -129823,8 +130085,8 @@ "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", "syntaxKind": "PropertySignature", "name": "policy", - "value": "ConsentPolicy", - "description": "The policy for which user consent is being collected for.\n\n`sms-marketing`: Represents the policy for SMS marketing consent.", + "value": "'sms-marketing'", + "description": "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.\n\n- `sms-marketing`: Represents the policy for SMS marketing consent.", "isOptional": true }, { @@ -129849,7 +130111,7 @@ "syntaxKind": "PropertySignature", "name": "autocomplete", "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", "isOptional": true, "defaultValue": "'on' for everything else" }, @@ -129858,7 +130120,7 @@ "syntaxKind": "PropertySignature", "name": "defaultValue", "value": "string", - "description": "The default value for the field.", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces this value.", "isOptional": true }, { @@ -129866,7 +130128,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -129875,7 +130137,7 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -129883,7 +130145,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -129891,7 +130153,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Content to use as the field label.", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", "isOptional": true }, { @@ -129899,7 +130161,7 @@ "syntaxKind": "PropertySignature", "name": "labelAccessibilityVisibility", "value": "'visible' | 'exclusive'", - "description": "Changes the visibility of the component's label.\n\n- `visible`: the label is visible to all users.\n- `exclusive`: the label is visually hidden but remains in the accessibility tree.", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone.\n- `exclusive`: The label is visually hidden but still announced by screen readers.", "isOptional": true, "defaultValue": "'visible'" }, @@ -129908,7 +130170,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -129926,7 +130188,7 @@ "syntaxKind": "PropertySignature", "name": "readOnly", "value": "boolean", - "description": "The field cannot be edited by the user. It is focusable will be announced by screen readers.", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", "isOptional": true, "defaultValue": "false" }, @@ -129944,9 +130206,9 @@ "syntaxKind": "PropertySignature", "name": "type", "value": "'mobile' | ''", - "description": "The type of number to collect.\n\nSpecific style may be applied to each type to provide extra guidance to users. Note that no extra validation is performed based on the type.", + "description": "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.\n\nStyling hint for the input keyboard. Doesn't validate the phone number format. Implement validation in your extension and use the `error` prop to show results.", "isOptional": true, - "defaultValue": "'' meaning no specific kind of phone number" + "defaultValue": "''" }, { "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", @@ -129978,7 +130240,7 @@ "syntaxKind": "PropertySignature", "name": "onChange", "value": "(event: Event) => void", - "description": "Callback when the user has **finished editing** a field, for example, once they have blurred the field.", + "description": "A callback fired when the user has **finished editing** a field, such as when they blur the field or press Enter.", "isOptional": true }, { @@ -129994,7 +130256,7 @@ "syntaxKind": "PropertySignature", "name": "onInput", "value": "(event: Event) => void", - "description": "Callback when the user makes any changes in the field.", + "description": "A callback fired when the user makes any changes in the field, such as typing a character.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).", "isOptional": true } ], @@ -130025,7 +130287,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", @@ -130466,7 +130728,7 @@ "syntaxKind": "PropertySignature", "name": "autocomplete", "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", "isOptional": true, "defaultValue": "'on' for everything else" }, @@ -130657,7 +130919,7 @@ "syntaxKind": "PropertySignature", "name": "defaultValue", "value": "string", - "description": "The default value for the field.", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces this value.", "isOptional": true }, { @@ -130672,7 +130934,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -130786,7 +131048,7 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -130956,7 +131218,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -131055,7 +131317,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Content to use as the field label.", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", "isOptional": true }, { @@ -131063,7 +131325,7 @@ "syntaxKind": "PropertySignature", "name": "labelAccessibilityVisibility", "value": "'visible' | 'exclusive'", - "description": "Changes the visibility of the component's label.\n\n- `visible`: the label is visible to all users.\n- `exclusive`: the label is visually hidden but remains in the accessibility tree.", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone.\n- `exclusive`: The label is visually hidden but still announced by screen readers.", "isOptional": true, "defaultValue": "'visible'" }, @@ -131121,7 +131383,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -132054,7 +132316,7 @@ "syntaxKind": "PropertySignature", "name": "readOnly", "value": "boolean", - "description": "The field cannot be edited by the user. It is focusable will be announced by screen readers.", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", "isOptional": true, "defaultValue": "false" }, @@ -132105,7 +132367,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", @@ -132352,9 +132614,9 @@ "syntaxKind": "PropertySignature", "name": "type", "value": "'mobile' | ''", - "description": "The type of number to collect.\n\nSpecific style may be applied to each type to provide extra guidance to users. Note that no extra validation is performed based on the type.", + "description": "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.\n\nStyling hint for the input keyboard. Doesn't validate the phone number format. Implement validation in your extension and use the `error` prop to show results.", "isOptional": true, - "defaultValue": "'' meaning no specific kind of phone number" + "defaultValue": "''" }, { "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", @@ -132393,7 +132655,7 @@ "syntaxKind": "PropertySignature", "name": "autocomplete", "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", "isOptional": true, "defaultValue": "'on' for everything else" }, @@ -132402,7 +132664,7 @@ "syntaxKind": "PropertySignature", "name": "defaultValue", "value": "string", - "description": "The default value for the field.", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces this value.", "isOptional": true }, { @@ -132410,7 +132672,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -132419,7 +132681,7 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -132427,7 +132689,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -132435,7 +132697,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Content to use as the field label.", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", "isOptional": true }, { @@ -132443,7 +132705,7 @@ "syntaxKind": "PropertySignature", "name": "labelAccessibilityVisibility", "value": "'visible' | 'exclusive'", - "description": "Changes the visibility of the component's label.\n\n- `visible`: the label is visible to all users.\n- `exclusive`: the label is visually hidden but remains in the accessibility tree.", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone.\n- `exclusive`: The label is visually hidden but still announced by screen readers.", "isOptional": true, "defaultValue": "'visible'" }, @@ -132452,7 +132714,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -132468,7 +132730,7 @@ "syntaxKind": "PropertySignature", "name": "onChange", "value": "(event: Event) => void", - "description": "Callback when the user has **finished editing** a field, for example, once they have blurred the field.", + "description": "A callback fired when the user has **finished editing** a field, such as when they blur the field or press Enter.", "isOptional": true }, { @@ -132484,7 +132746,7 @@ "syntaxKind": "PropertySignature", "name": "onInput", "value": "(event: Event) => void", - "description": "Callback when the user makes any changes in the field.", + "description": "A callback fired when the user makes any changes in the field, such as typing a character.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).", "isOptional": true }, { @@ -132502,7 +132764,7 @@ "syntaxKind": "PropertySignature", "name": "readOnly", "value": "boolean", - "description": "The field cannot be edited by the user. It is focusable will be announced by screen readers.", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", "isOptional": true, "defaultValue": "false" }, @@ -132520,9 +132782,9 @@ "syntaxKind": "PropertySignature", "name": "type", "value": "'mobile' | ''", - "description": "The type of number to collect.\n\nSpecific style may be applied to each type to provide extra guidance to users. Note that no extra validation is performed based on the type.", + "description": "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.\n\nStyling hint for the input keyboard. Doesn't validate the phone number format. Implement validation in your extension and use the `error` prop to show results.", "isOptional": true, - "defaultValue": "'' meaning no specific kind of phone number" + "defaultValue": "''" }, { "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", @@ -132538,7 +132800,7 @@ { "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", "name": "ConsentPhoneFieldElementProps", - "description": "Display a phone field for customers to sign up for text message marketing, noting that the phone field value will be automatically saved during checkout.", + "description": "", "isPublicDocs": true, "members": [ { @@ -132546,7 +132808,7 @@ "syntaxKind": "PropertySignature", "name": "autocomplete", "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", "isOptional": true, "defaultValue": "'on' for everything else" }, @@ -132555,7 +132817,7 @@ "syntaxKind": "PropertySignature", "name": "defaultValue", "value": "string", - "description": "The default value for the field.", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces this value.", "isOptional": true }, { @@ -132563,7 +132825,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -132572,7 +132834,7 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -132580,7 +132842,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -132588,7 +132850,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Content to use as the field label.", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", "isOptional": true }, { @@ -132596,7 +132858,7 @@ "syntaxKind": "PropertySignature", "name": "labelAccessibilityVisibility", "value": "'visible' | 'exclusive'", - "description": "Changes the visibility of the component's label.\n\n- `visible`: the label is visible to all users.\n- `exclusive`: the label is visually hidden but remains in the accessibility tree.", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone.\n- `exclusive`: The label is visually hidden but still announced by screen readers.", "isOptional": true, "defaultValue": "'visible'" }, @@ -132605,7 +132867,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -132622,8 +132884,8 @@ "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", "syntaxKind": "PropertySignature", "name": "policy", - "value": "ConsentPolicy", - "description": "The policy for which user consent is being collected for.\n\n`sms-marketing`: Represents the policy for SMS marketing consent.", + "value": "'sms-marketing'", + "description": "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.\n\n- `sms-marketing`: Represents the policy for SMS marketing consent.", "isOptional": true }, { @@ -132631,7 +132893,7 @@ "syntaxKind": "PropertySignature", "name": "readOnly", "value": "boolean", - "description": "The field cannot be edited by the user. It is focusable will be announced by screen readers.", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", "isOptional": true, "defaultValue": "false" }, @@ -132649,9 +132911,9 @@ "syntaxKind": "PropertySignature", "name": "type", "value": "'mobile' | ''", - "description": "The type of number to collect.\n\nSpecific style may be applied to each type to provide extra guidance to users. Note that no extra validation is performed based on the type.", + "description": "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.\n\nStyling hint for the input keyboard. Doesn't validate the phone number format. Implement validation in your extension and use the `error` prop to show results.", "isOptional": true, - "defaultValue": "'' meaning no specific kind of phone number" + "defaultValue": "''" }, { "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", @@ -132662,7 +132924,7 @@ "isOptional": true } ], - "value": "export interface ConsentPhoneFieldElementProps extends Pick {\n /**\n * @deprecated Use `label` instead.\n * @private\n */\n placeholder?: string;\n}" + "value": "export interface ConsentPhoneFieldElementProps extends Pick {\n /**\n * @deprecated Use `label` instead.\n * @private\n */\n placeholder?: string;\n /**\n * 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.\n *\n * - `sms-marketing`: Represents the policy for SMS marketing consent.\n */\n policy?: ConsentPhoneFieldProps$1['policy'];\n}" }, { "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", @@ -132683,7 +132945,7 @@ "syntaxKind": "PropertySignature", "name": "onChange", "value": "(event: Event) => void", - "description": "Callback when the user has **finished editing** a field, for example, once they have blurred the field.", + "description": "A callback fired when the user has **finished editing** a field, such as when they blur the field or press Enter.", "isOptional": true }, { @@ -132699,7 +132961,7 @@ "syntaxKind": "PropertySignature", "name": "onInput", "value": "(event: Event) => void", - "description": "Callback when the user makes any changes in the field.", + "description": "A callback fired when the user makes any changes in the field, such as typing a character.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).", "isOptional": true } ], @@ -132708,7 +132970,7 @@ { "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", "name": "ConsentPhoneFieldElementEvents", - "description": "Learn more about [registering events](/docs/api/checkout-ui-extensions/latest/using-polaris-components#event-handling).", + "description": "", "isPublicDocs": true, "members": [ { @@ -132716,7 +132978,7 @@ "syntaxKind": "PropertySignature", "name": "blur", "value": "CallbackEventListener", - "description": "A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "description": "A callback fired when the consent phone field loses focus.\n\nLearn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", "isOptional": true }, { @@ -132724,7 +132986,7 @@ "syntaxKind": "PropertySignature", "name": "change", "value": "CallbackEventListener", - "description": "Callback when the user has **finished editing** a field, for example, once they have blurred the field.", + "description": "A callback fired when the consent phone field value changes.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", "isOptional": true }, { @@ -132732,7 +132994,7 @@ "syntaxKind": "PropertySignature", "name": "focus", "value": "CallbackEventListener", - "description": "A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "description": "A callback fired when the consent phone field receives focus.\n\nLearn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", "isOptional": true }, { @@ -132740,11 +133002,11 @@ "syntaxKind": "PropertySignature", "name": "input", "value": "CallbackEventListener", - "description": "Callback when the user makes any changes in the field.", + "description": "A callback fired when the user inputs data into the consent phone field.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).", "isOptional": true } ], - "value": "export interface ConsentPhoneFieldElementEvents {\n /**\n * A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event\n */\n blur?: CallbackEventListener;\n /**\n * Callback when the user has **finished editing** a field, for example, once they have blurred the field.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event\n */\n change?: CallbackEventListener;\n /**\n * A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event\n */\n focus?: CallbackEventListener;\n /**\n * Callback when the user makes any changes in the field.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event\n */\n input?: CallbackEventListener;\n}" + "value": "export interface ConsentPhoneFieldElementEvents {\n /**\n * A callback fired when the consent phone field loses focus.\n *\n * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur?: CallbackEventListener;\n /**\n * A callback fired when the consent phone field value changes.\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change?: CallbackEventListener;\n /**\n * A callback fired when the consent phone field receives focus.\n *\n * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus?: CallbackEventListener;\n /**\n * A callback fired when the user inputs data into the consent phone field.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input?: CallbackEventListener;\n}" }, { "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", @@ -132757,7 +133019,7 @@ "syntaxKind": "PropertySignature", "name": "autocomplete", "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", "isOptional": true, "defaultValue": "'on' for everything else" }, @@ -132766,7 +133028,7 @@ "syntaxKind": "PropertySignature", "name": "defaultValue", "value": "string", - "description": "The default value for the field.", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces this value.", "isOptional": true }, { @@ -132774,7 +133036,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -132783,7 +133045,7 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -132791,7 +133053,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -132799,7 +133061,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Content to use as the field label.", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", "isOptional": true }, { @@ -132807,7 +133069,7 @@ "syntaxKind": "PropertySignature", "name": "labelAccessibilityVisibility", "value": "'visible' | 'exclusive'", - "description": "Changes the visibility of the component's label.\n\n- `visible`: the label is visible to all users.\n- `exclusive`: the label is visually hidden but remains in the accessibility tree.", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone.\n- `exclusive`: The label is visually hidden but still announced by screen readers.", "isOptional": true, "defaultValue": "'visible'" }, @@ -132816,7 +133078,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -132861,8 +133123,8 @@ "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", "syntaxKind": "PropertySignature", "name": "policy", - "value": "ConsentPolicy", - "description": "The policy for which user consent is being collected for.\n\n`sms-marketing`: Represents the policy for SMS marketing consent.", + "value": "'sms-marketing'", + "description": "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.\n\n- `sms-marketing`: Represents the policy for SMS marketing consent.", "isOptional": true }, { @@ -132870,7 +133132,7 @@ "syntaxKind": "PropertySignature", "name": "readOnly", "value": "boolean", - "description": "The field cannot be edited by the user. It is focusable will be announced by screen readers.", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", "isOptional": true, "defaultValue": "false" }, @@ -132888,9 +133150,9 @@ "syntaxKind": "PropertySignature", "name": "type", "value": "'mobile' | ''", - "description": "The type of number to collect.\n\nSpecific style may be applied to each type to provide extra guidance to users. Note that no extra validation is performed based on the type.", + "description": "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.\n\nStyling hint for the input keyboard. Doesn't validate the phone number format. Implement validation in your extension and use the `error` prop to show results.", "isOptional": true, - "defaultValue": "'' meaning no specific kind of phone number" + "defaultValue": "''" }, { "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", @@ -132906,7 +133168,7 @@ { "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", "name": "ConsentPhoneFieldElementSlots", - "description": "Learn more about [component slots](/docs/api/checkout-ui-extensions/latest/using-polaris-components#slots).", + "description": "", "isPublicDocs": true, "members": [ { @@ -132914,11 +133176,11 @@ "syntaxKind": "PropertySignature", "name": "accessory", "value": "HTMLElement", - "description": "Additional content to be displayed in the field. Commonly used to display an icon that activates a tooltip providing more information.", + "description": "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.", "isOptional": true } ], - "value": "export interface ConsentPhoneFieldElementSlots {\n /**\n * Additional content to be displayed in the field.\n * Commonly used to display an icon that activates a tooltip providing more information.\n */\n accessory?: HTMLElement;\n}" + "value": "export interface ConsentPhoneFieldElementSlots {\n /**\n * 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.\n */\n accessory?: HTMLElement;\n}" }, { "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", @@ -132931,7 +133193,7 @@ "syntaxKind": "PropertySignature", "name": "autocomplete", "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", "isOptional": true, "defaultValue": "'on' for everything else" }, @@ -132940,7 +133202,7 @@ "syntaxKind": "PropertySignature", "name": "defaultValue", "value": "string", - "description": "The default value for the field.", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces this value.", "isOptional": true }, { @@ -132948,7 +133210,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -132957,7 +133219,7 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -132965,7 +133227,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -132973,7 +133235,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Content to use as the field label.", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", "isOptional": true }, { @@ -132981,7 +133243,7 @@ "syntaxKind": "PropertySignature", "name": "labelAccessibilityVisibility", "value": "'visible' | 'exclusive'", - "description": "Changes the visibility of the component's label.\n\n- `visible`: the label is visible to all users.\n- `exclusive`: the label is visually hidden but remains in the accessibility tree.", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone.\n- `exclusive`: The label is visually hidden but still announced by screen readers.", "isOptional": true, "defaultValue": "'visible'" }, @@ -132990,7 +133252,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -133006,7 +133268,7 @@ "syntaxKind": "PropertySignature", "name": "onChange", "value": "(event: Event) => void", - "description": "Callback when the user has **finished editing** a field, for example, once they have blurred the field.", + "description": "A callback fired when the user has **finished editing** a field, such as when they blur the field or press Enter.", "isOptional": true }, { @@ -133022,7 +133284,7 @@ "syntaxKind": "PropertySignature", "name": "onInput", "value": "(event: Event) => void", - "description": "Callback when the user makes any changes in the field.", + "description": "A callback fired when the user makes any changes in the field, such as typing a character.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).", "isOptional": true }, { @@ -133039,8 +133301,8 @@ "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", "syntaxKind": "PropertySignature", "name": "policy", - "value": "ConsentPolicy", - "description": "The policy for which user consent is being collected for.\n\n`sms-marketing`: Represents the policy for SMS marketing consent.", + "value": "'sms-marketing'", + "description": "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.\n\n- `sms-marketing`: Represents the policy for SMS marketing consent.", "isOptional": true }, { @@ -133048,7 +133310,7 @@ "syntaxKind": "PropertySignature", "name": "readOnly", "value": "boolean", - "description": "The field cannot be edited by the user. It is focusable will be announced by screen readers.", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", "isOptional": true, "defaultValue": "false" }, @@ -133066,9 +133328,9 @@ "syntaxKind": "PropertySignature", "name": "type", "value": "'mobile' | ''", - "description": "The type of number to collect.\n\nSpecific style may be applied to each type to provide extra guidance to users. Note that no extra validation is performed based on the type.", + "description": "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.\n\nStyling hint for the input keyboard. Doesn't validate the phone number format. Implement validation in your extension and use the `error` prop to show results.", "isOptional": true, - "defaultValue": "'' meaning no specific kind of phone number" + "defaultValue": "''" }, { "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", @@ -133084,7 +133346,7 @@ { "filePath": "src/surfaces/checkout/components/DateField.ts", "name": "DateFieldElementProps", - "description": "The date field component captures date input with a consistent interface for date selection and proper validation. Use it to collect date information in forms, scheduling interfaces, or data entry workflows.\n\nThe component supports manual text entry. For visual calendar-based selection, consider using [date picker](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/forms/date-picker).", + "description": "", "isPublicDocs": true, "members": [ { @@ -133092,7 +133354,7 @@ "syntaxKind": "PropertySignature", "name": "allow", "value": "string", - "description": "Dates that can be selected.\n\nA comma-separated list of dates, date ranges. Whitespace is allowed after commas.\n\nThe default `''` allows all dates.\n\n- Dates in `YYYY-MM-DD` format allow a single date.\n- Dates in `YYYY-MM` format allow a whole month.\n- Dates in `YYYY` format allow a whole year.\n- Ranges are expressed as `start--end`. - Ranges are inclusive.\n - If either `start` or `end` is omitted, the range is unbounded in that direction.\n - If parts of the date are omitted for `start`, they are assumed to be the minimum possible value.\n So `2024--` is equivalent to `2024-01-01--`.\n - If parts of the date are omitted for `end`, they are assumed to be the maximum possible value.\n So `--2024` is equivalent to `--2024-12-31`.\n - Whitespace is allowed either side of `--`.", + "description": "Restricts which dates the user can select. Accepts a comma-separated list of dates and date ranges. Whitespace is allowed after commas.\n\nThe default `''` allows all dates.\n\n- Dates in `YYYY-MM-DD` format allow a single date.\n- Dates in `YYYY-MM` format allow a whole month.\n- Dates in `YYYY` format allow a whole year.\n- Ranges are expressed as `start--end`. - Ranges are inclusive.\n - If either `start` or `end` is omitted, the range is unbounded in that direction.\n - If parts of the date are omitted for `start`, they are assumed to be the minimum possible value.\n So `2024--` is equivalent to `2024-01-01--`.\n - If parts of the date are omitted for `end`, they are assumed to be the maximum possible value.\n So `--2024` is equivalent to `--2024-12-31`.\n - Whitespace is allowed either side of `--`.\n\nComma-separated list of allowed dates in `YYYY-MM-DD` format.", "isOptional": true, "defaultValue": "\"\"", "examples": [ @@ -133113,7 +133375,7 @@ "syntaxKind": "PropertySignature", "name": "allowDays", "value": "string", - "description": "Days of the week that can be selected. These intersect with the result of `allow` and `disallow`.\n\nA comma-separated list of days. Whitespace is allowed after commas.\n\nThe default `''` has no effect on the result of `allow` and `disallow`.\n\nDays are `sunday`, `monday`, `tuesday`, `wednesday`, `thursday`, `friday`, `saturday`.", + "description": "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.\n\nA comma-separated list of days. Whitespace is allowed after commas.\n\nThe default `''` has no effect on the result of `allow` and `disallow`.\n\nDays are `sunday`, `monday`, `tuesday`, `wednesday`, `thursday`, `friday`, `saturday`.", "isOptional": true, "defaultValue": "\"\"", "examples": [ @@ -133134,7 +133396,7 @@ "syntaxKind": "PropertySignature", "name": "autocomplete", "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", "isOptional": true, "defaultValue": "'on' for everything else" }, @@ -133143,7 +133405,7 @@ "syntaxKind": "PropertySignature", "name": "defaultValue", "value": "string", - "description": "The default value for the field.", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces this value.", "isOptional": true }, { @@ -133159,7 +133421,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -133168,7 +133430,7 @@ "syntaxKind": "PropertySignature", "name": "disallow", "value": "string", - "description": "Dates that cannot be selected. These subtract from `allow`.\n\nA comma-separated list of dates, date ranges. Whitespace is allowed after commas.\n\nThe default `''` has no effect on `allow`.\n\n- Dates in `YYYY-MM-DD` format disallow a single date.\n- Dates in `YYYY-MM` format disallow a whole month.\n- Dates in `YYYY` format disallow a whole year.\n- Ranges are expressed as `start--end`. - Ranges are inclusive.\n - If either `start` or `end` is omitted, the range is unbounded in that direction.\n - If parts of the date are omitted for `start`, they are assumed to be the minimum possible value.\n So `2024--` is equivalent to `2024-01-01--`.\n - If parts of the date are omitted for `end`, they are assumed to be the maximum possible value.\n So `--2024` is equivalent to `--2024-12-31`.\n - Whitespace is allowed either side of `--`.", + "description": "Dates that cannot be selected. These subtract from `allow`.\n\nA comma-separated list of dates, date ranges. Whitespace is allowed after commas.\n\nThe default `''` has no effect on `allow`.\n\n- Dates in `YYYY-MM-DD` format disallow a single date.\n- Dates in `YYYY-MM` format disallow a whole month.\n- Dates in `YYYY` format disallow a whole year.\n- Ranges are expressed as `start--end`. - Ranges are inclusive.\n - If either `start` or `end` is omitted, the range is unbounded in that direction.\n - If parts of the date are omitted for `start`, they are assumed to be the minimum possible value.\n So `2024--` is equivalent to `2024-01-01--`.\n - If parts of the date are omitted for `end`, they are assumed to be the maximum possible value.\n So `--2024` is equivalent to `--2024-12-31`.\n - Whitespace is allowed either side of `--`.\n\nComma-separated list of disallowed dates in `YYYY-MM-DD` format.", "isOptional": true, "defaultValue": "\"\"", "examples": [ @@ -133210,7 +133472,7 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -133218,7 +133480,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -133226,7 +133488,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Content to use as the field label.", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", "isOptional": true }, { @@ -133234,7 +133496,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -133252,7 +133514,7 @@ "syntaxKind": "PropertySignature", "name": "readOnly", "value": "boolean", - "description": "The field cannot be edited by the user. It is focusable will be announced by screen readers.", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", "isOptional": true, "defaultValue": "false" }, @@ -133303,7 +133565,7 @@ "syntaxKind": "PropertySignature", "name": "onChange", "value": "(event: Event) => void", - "description": "Callback when the user has **finished editing** a field, for example, once they have blurred the field.", + "description": "A callback fired when the user has **finished editing** a field, such as when they blur the field or press Enter.", "isOptional": true }, { @@ -133319,7 +133581,7 @@ "syntaxKind": "PropertySignature", "name": "onInput", "value": "(event: Event) => void", - "description": "Callback when the user makes any changes in the field.", + "description": "A callback fired when the user makes any changes in the field, such as typing a character.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).", "isOptional": true }, { @@ -133327,7 +133589,7 @@ "syntaxKind": "PropertySignature", "name": "onInvalid", "value": "(event: Event) => void", - "description": "Callback when the field has an invalid date. This callback will be called, if the date typed is invalid or disabled.\n\nDates that don’t exist or have formatting errors are considered invalid. Some examples of invalid dates are:\n- 2021-02-31: February doesn’t have 31 days\n- 2021-02-00: The day can’t be 00\n\nDisallowed dates are considered invalid.\n\nIt’s important to note that this callback will be called only when the user **finishes editing** the date, and it’s called right after the `onChange` callback. The field is **not** validated on every change to the input. Once the buyer has signalled that 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.", + "description": "Callback when the field has an invalid date. This callback will be called, if the date typed is invalid or disabled.\n\nDates that don’t exist or have formatting errors are considered invalid. Some examples of invalid dates are:\n- 2021-02-31: February doesn’t have 31 days\n- 2021-02-00: The day can’t be 00\n\nDisallowed dates are considered invalid.\n\nThis callback fires only when the user finishes editing the date, right after the `change` callback. The field isn’t validated on every change to the input. Once the user has signalled that 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.", "isOptional": true }, { @@ -133344,7 +133606,7 @@ { "filePath": "src/surfaces/checkout/components/DateField.ts", "name": "DateFieldElementEvents", - "description": "Learn more about [registering events](/docs/api/checkout-ui-extensions/latest/using-polaris-components#event-handling).", + "description": "", "isPublicDocs": true, "members": [ { @@ -133352,7 +133614,7 @@ "syntaxKind": "PropertySignature", "name": "blur", "value": "CallbackEventListener", - "description": "A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "description": "A callback fired when the date field loses focus.\n\nLearn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", "isOptional": true }, { @@ -133360,7 +133622,7 @@ "syntaxKind": "PropertySignature", "name": "change", "value": "CallbackEventListener", - "description": "Callback when the user has **finished editing** a field, for example, once they have blurred the field.", + "description": "A callback fired when the date field value changes.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", "isOptional": true }, { @@ -133368,7 +133630,7 @@ "syntaxKind": "PropertySignature", "name": "focus", "value": "CallbackEventListener", - "description": "A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "description": "A callback fired when the date field receives focus.\n\nLearn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", "isOptional": true }, { @@ -133376,7 +133638,7 @@ "syntaxKind": "PropertySignature", "name": "input", "value": "CallbackEventListener", - "description": "Callback when the user makes any changes in the field.", + "description": "A callback fired when the user inputs data into the date field.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).", "isOptional": true }, { @@ -133384,7 +133646,7 @@ "syntaxKind": "PropertySignature", "name": "invalid", "value": "CallbackEventListener", - "description": "Callback when the user enters an invalid date.", + "description": "A callback fired when the date field value is invalid.\n\nLearn more about the [invalid event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement/invalid_event).", "isOptional": true }, { @@ -133392,11 +133654,11 @@ "syntaxKind": "PropertySignature", "name": "viewChange", "value": "CallbackEventListener", - "description": "Callback when the view changes.", + "description": "A callback fired when the calendar view changes, such as when navigating between months.", "isOptional": true } ], - "value": "export interface DateFieldElementEvents {\n /**\n * A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur?: CallbackEventListener;\n /**\n * Callback when the user has **finished editing** a field, for example, once they have blurred the field.\n */\n change?: CallbackEventListener;\n /**\n * A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus?: CallbackEventListener;\n /**\n * Callback when the user makes any changes in the field.\n */\n input?: CallbackEventListener;\n /**\n * Callback when the user enters an invalid date.\n */\n invalid?: CallbackEventListener;\n /**\n * Callback when the view changes.\n */\n viewChange?: CallbackEventListener;\n}" + "value": "export interface DateFieldElementEvents {\n /**\n * A callback fired when the date field loses focus.\n *\n * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur?: CallbackEventListener;\n /**\n * A callback fired when the date field value changes.\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change?: CallbackEventListener;\n /**\n * A callback fired when the date field receives focus.\n *\n * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus?: CallbackEventListener;\n /**\n * A callback fired when the user inputs data into the date field.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input?: CallbackEventListener;\n /**\n * A callback fired when the date field value is invalid.\n *\n * Learn more about the [invalid event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement/invalid_event).\n */\n invalid?: CallbackEventListener;\n /**\n * A callback fired when the calendar view changes, such as when navigating between months.\n */\n viewChange?: CallbackEventListener;\n}" }, { "filePath": "src/surfaces/checkout/components/DateField.ts", @@ -133423,7 +133685,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/DateField.ts", @@ -133437,7 +133699,7 @@ "syntaxKind": "PropertySignature", "name": "allow", "value": "string", - "description": "Dates that can be selected.\n\nA comma-separated list of dates, date ranges. Whitespace is allowed after commas.\n\nThe default `''` allows all dates.\n\n- Dates in `YYYY-MM-DD` format allow a single date.\n- Dates in `YYYY-MM` format allow a whole month.\n- Dates in `YYYY` format allow a whole year.\n- Ranges are expressed as `start--end`. - Ranges are inclusive.\n - If either `start` or `end` is omitted, the range is unbounded in that direction.\n - If parts of the date are omitted for `start`, they are assumed to be the minimum possible value.\n So `2024--` is equivalent to `2024-01-01--`.\n - If parts of the date are omitted for `end`, they are assumed to be the maximum possible value.\n So `--2024` is equivalent to `--2024-12-31`.\n - Whitespace is allowed either side of `--`.", + "description": "Restricts which dates the user can select. Accepts a comma-separated list of dates and date ranges. Whitespace is allowed after commas.\n\nThe default `''` allows all dates.\n\n- Dates in `YYYY-MM-DD` format allow a single date.\n- Dates in `YYYY-MM` format allow a whole month.\n- Dates in `YYYY` format allow a whole year.\n- Ranges are expressed as `start--end`. - Ranges are inclusive.\n - If either `start` or `end` is omitted, the range is unbounded in that direction.\n - If parts of the date are omitted for `start`, they are assumed to be the minimum possible value.\n So `2024--` is equivalent to `2024-01-01--`.\n - If parts of the date are omitted for `end`, they are assumed to be the maximum possible value.\n So `--2024` is equivalent to `--2024-12-31`.\n - Whitespace is allowed either side of `--`.\n\nComma-separated list of allowed dates in `YYYY-MM-DD` format.", "isOptional": true, "defaultValue": "\"\"", "examples": [ @@ -133458,7 +133720,7 @@ "syntaxKind": "PropertySignature", "name": "allowDays", "value": "string", - "description": "Days of the week that can be selected. These intersect with the result of `allow` and `disallow`.\n\nA comma-separated list of days. Whitespace is allowed after commas.\n\nThe default `''` has no effect on the result of `allow` and `disallow`.\n\nDays are `sunday`, `monday`, `tuesday`, `wednesday`, `thursday`, `friday`, `saturday`.", + "description": "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.\n\nA comma-separated list of days. Whitespace is allowed after commas.\n\nThe default `''` has no effect on the result of `allow` and `disallow`.\n\nDays are `sunday`, `monday`, `tuesday`, `wednesday`, `thursday`, `friday`, `saturday`.", "isOptional": true, "defaultValue": "\"\"", "examples": [ @@ -133906,7 +134168,7 @@ "syntaxKind": "PropertySignature", "name": "autocomplete", "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", "isOptional": true, "defaultValue": "'on' for everything else" }, @@ -134097,7 +134359,7 @@ "syntaxKind": "PropertySignature", "name": "defaultValue", "value": "string", - "description": "The default value for the field.", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces this value.", "isOptional": true }, { @@ -134120,7 +134382,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -134129,7 +134391,7 @@ "syntaxKind": "PropertySignature", "name": "disallow", "value": "string", - "description": "Dates that cannot be selected. These subtract from `allow`.\n\nA comma-separated list of dates, date ranges. Whitespace is allowed after commas.\n\nThe default `''` has no effect on `allow`.\n\n- Dates in `YYYY-MM-DD` format disallow a single date.\n- Dates in `YYYY-MM` format disallow a whole month.\n- Dates in `YYYY` format disallow a whole year.\n- Ranges are expressed as `start--end`. - Ranges are inclusive.\n - If either `start` or `end` is omitted, the range is unbounded in that direction.\n - If parts of the date are omitted for `start`, they are assumed to be the minimum possible value.\n So `2024--` is equivalent to `2024-01-01--`.\n - If parts of the date are omitted for `end`, they are assumed to be the maximum possible value.\n So `--2024` is equivalent to `--2024-12-31`.\n - Whitespace is allowed either side of `--`.", + "description": "Dates that cannot be selected. These subtract from `allow`.\n\nA comma-separated list of dates, date ranges. Whitespace is allowed after commas.\n\nThe default `''` has no effect on `allow`.\n\n- Dates in `YYYY-MM-DD` format disallow a single date.\n- Dates in `YYYY-MM` format disallow a whole month.\n- Dates in `YYYY` format disallow a whole year.\n- Ranges are expressed as `start--end`. - Ranges are inclusive.\n - If either `start` or `end` is omitted, the range is unbounded in that direction.\n - If parts of the date are omitted for `start`, they are assumed to be the minimum possible value.\n So `2024--` is equivalent to `2024-01-01--`.\n - If parts of the date are omitted for `end`, they are assumed to be the maximum possible value.\n So `--2024` is equivalent to `--2024-12-31`.\n - Whitespace is allowed either side of `--`.\n\nComma-separated list of disallowed dates in `YYYY-MM-DD` format.", "isOptional": true, "defaultValue": "\"\"", "examples": [ @@ -134276,7 +134538,7 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -134446,7 +134708,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -134538,7 +134800,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Content to use as the field label.", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", "isOptional": true }, { @@ -134595,7 +134857,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -135535,7 +135797,7 @@ "syntaxKind": "PropertySignature", "name": "readOnly", "value": "boolean", - "description": "The field cannot be edited by the user. It is focusable will be announced by screen readers.", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", "isOptional": true, "defaultValue": "false" }, @@ -135586,7 +135848,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/DateField.ts", @@ -135873,7 +136135,7 @@ "syntaxKind": "PropertySignature", "name": "allow", "value": "string", - "description": "Dates that can be selected.\n\nA comma-separated list of dates, date ranges. Whitespace is allowed after commas.\n\nThe default `''` allows all dates.\n\n- Dates in `YYYY-MM-DD` format allow a single date.\n- Dates in `YYYY-MM` format allow a whole month.\n- Dates in `YYYY` format allow a whole year.\n- Ranges are expressed as `start--end`. - Ranges are inclusive.\n - If either `start` or `end` is omitted, the range is unbounded in that direction.\n - If parts of the date are omitted for `start`, they are assumed to be the minimum possible value.\n So `2024--` is equivalent to `2024-01-01--`.\n - If parts of the date are omitted for `end`, they are assumed to be the maximum possible value.\n So `--2024` is equivalent to `--2024-12-31`.\n - Whitespace is allowed either side of `--`.", + "description": "Restricts which dates the user can select. Accepts a comma-separated list of dates and date ranges. Whitespace is allowed after commas.\n\nThe default `''` allows all dates.\n\n- Dates in `YYYY-MM-DD` format allow a single date.\n- Dates in `YYYY-MM` format allow a whole month.\n- Dates in `YYYY` format allow a whole year.\n- Ranges are expressed as `start--end`. - Ranges are inclusive.\n - If either `start` or `end` is omitted, the range is unbounded in that direction.\n - If parts of the date are omitted for `start`, they are assumed to be the minimum possible value.\n So `2024--` is equivalent to `2024-01-01--`.\n - If parts of the date are omitted for `end`, they are assumed to be the maximum possible value.\n So `--2024` is equivalent to `--2024-12-31`.\n - Whitespace is allowed either side of `--`.\n\nComma-separated list of allowed dates in `YYYY-MM-DD` format.", "isOptional": true, "defaultValue": "\"\"", "examples": [ @@ -135894,7 +136156,7 @@ "syntaxKind": "PropertySignature", "name": "allowDays", "value": "string", - "description": "Days of the week that can be selected. These intersect with the result of `allow` and `disallow`.\n\nA comma-separated list of days. Whitespace is allowed after commas.\n\nThe default `''` has no effect on the result of `allow` and `disallow`.\n\nDays are `sunday`, `monday`, `tuesday`, `wednesday`, `thursday`, `friday`, `saturday`.", + "description": "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.\n\nA comma-separated list of days. Whitespace is allowed after commas.\n\nThe default `''` has no effect on the result of `allow` and `disallow`.\n\nDays are `sunday`, `monday`, `tuesday`, `wednesday`, `thursday`, `friday`, `saturday`.", "isOptional": true, "defaultValue": "\"\"", "examples": [ @@ -135915,7 +136177,7 @@ "syntaxKind": "PropertySignature", "name": "autocomplete", "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", "isOptional": true, "defaultValue": "'on' for everything else" }, @@ -135924,7 +136186,7 @@ "syntaxKind": "PropertySignature", "name": "defaultValue", "value": "string", - "description": "The default value for the field.", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces this value.", "isOptional": true }, { @@ -135940,7 +136202,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -135949,7 +136211,7 @@ "syntaxKind": "PropertySignature", "name": "disallow", "value": "string", - "description": "Dates that cannot be selected. These subtract from `allow`.\n\nA comma-separated list of dates, date ranges. Whitespace is allowed after commas.\n\nThe default `''` has no effect on `allow`.\n\n- Dates in `YYYY-MM-DD` format disallow a single date.\n- Dates in `YYYY-MM` format disallow a whole month.\n- Dates in `YYYY` format disallow a whole year.\n- Ranges are expressed as `start--end`. - Ranges are inclusive.\n - If either `start` or `end` is omitted, the range is unbounded in that direction.\n - If parts of the date are omitted for `start`, they are assumed to be the minimum possible value.\n So `2024--` is equivalent to `2024-01-01--`.\n - If parts of the date are omitted for `end`, they are assumed to be the maximum possible value.\n So `--2024` is equivalent to `--2024-12-31`.\n - Whitespace is allowed either side of `--`.", + "description": "Dates that cannot be selected. These subtract from `allow`.\n\nA comma-separated list of dates, date ranges. Whitespace is allowed after commas.\n\nThe default `''` has no effect on `allow`.\n\n- Dates in `YYYY-MM-DD` format disallow a single date.\n- Dates in `YYYY-MM` format disallow a whole month.\n- Dates in `YYYY` format disallow a whole year.\n- Ranges are expressed as `start--end`. - Ranges are inclusive.\n - If either `start` or `end` is omitted, the range is unbounded in that direction.\n - If parts of the date are omitted for `start`, they are assumed to be the minimum possible value.\n So `2024--` is equivalent to `2024-01-01--`.\n - If parts of the date are omitted for `end`, they are assumed to be the maximum possible value.\n So `--2024` is equivalent to `--2024-12-31`.\n - Whitespace is allowed either side of `--`.\n\nComma-separated list of disallowed dates in `YYYY-MM-DD` format.", "isOptional": true, "defaultValue": "\"\"", "examples": [ @@ -135991,7 +136253,7 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -135999,7 +136261,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -136007,7 +136269,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Content to use as the field label.", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", "isOptional": true }, { @@ -136015,7 +136277,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -136031,7 +136293,7 @@ "syntaxKind": "PropertySignature", "name": "onChange", "value": "(event: Event) => void", - "description": "Callback when the user has **finished editing** a field, for example, once they have blurred the field.", + "description": "A callback fired when the user has **finished editing** a field, such as when they blur the field or press Enter.", "isOptional": true }, { @@ -136047,7 +136309,7 @@ "syntaxKind": "PropertySignature", "name": "onInput", "value": "(event: Event) => void", - "description": "Callback when the user makes any changes in the field.", + "description": "A callback fired when the user makes any changes in the field, such as typing a character.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).", "isOptional": true }, { @@ -136055,7 +136317,7 @@ "syntaxKind": "PropertySignature", "name": "onInvalid", "value": "(event: Event) => void", - "description": "Callback when the field has an invalid date. This callback will be called, if the date typed is invalid or disabled.\n\nDates that don’t exist or have formatting errors are considered invalid. Some examples of invalid dates are:\n- 2021-02-31: February doesn’t have 31 days\n- 2021-02-00: The day can’t be 00\n\nDisallowed dates are considered invalid.\n\nIt’s important to note that this callback will be called only when the user **finishes editing** the date, and it’s called right after the `onChange` callback. The field is **not** validated on every change to the input. Once the buyer has signalled that 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.", + "description": "Callback when the field has an invalid date. This callback will be called, if the date typed is invalid or disabled.\n\nDates that don’t exist or have formatting errors are considered invalid. Some examples of invalid dates are:\n- 2021-02-31: February doesn’t have 31 days\n- 2021-02-00: The day can’t be 00\n\nDisallowed dates are considered invalid.\n\nThis callback fires only when the user finishes editing the date, right after the `change` callback. The field isn’t validated on every change to the input. Once the user has signalled that 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.", "isOptional": true }, { @@ -136081,7 +136343,7 @@ "syntaxKind": "PropertySignature", "name": "readOnly", "value": "boolean", - "description": "The field cannot be edited by the user. It is focusable will be announced by screen readers.", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", "isOptional": true, "defaultValue": "false" }, @@ -136116,7 +136378,7 @@ { "filePath": "src/surfaces/checkout/components/DatePicker.ts", "name": "DatePickerElementProps", - "description": "The date picker component allows merchants to select dates using a calendar interface. Use it when merchants benefit from seeing dates in context of the full month, such as selecting dates relative to today or needing weekday context.\n\nThe component supports single dates, multiple dates, and date ranges. For text date entry, use [date field](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/forms/date-field).", + "description": "", "isPublicDocs": true, "members": [ { @@ -136124,7 +136386,7 @@ "syntaxKind": "PropertySignature", "name": "allow", "value": "string", - "description": "Dates that can be selected.\n\nA comma-separated list of dates, date ranges. Whitespace is allowed after commas.\n\nThe default `''` allows all dates.\n\n- Dates in `YYYY-MM-DD` format allow a single date.\n- Dates in `YYYY-MM` format allow a whole month.\n- Dates in `YYYY` format allow a whole year.\n- Ranges are expressed as `start--end`. - Ranges are inclusive.\n - If either `start` or `end` is omitted, the range is unbounded in that direction.\n - If parts of the date are omitted for `start`, they are assumed to be the minimum possible value.\n So `2024--` is equivalent to `2024-01-01--`.\n - If parts of the date are omitted for `end`, they are assumed to be the maximum possible value.\n So `--2024` is equivalent to `--2024-12-31`.\n - Whitespace is allowed either side of `--`.", + "description": "Restricts which dates the user can select. Accepts a comma-separated list of dates and date ranges. Whitespace is allowed after commas.\n\nThe default `''` allows all dates.\n\n- Dates in `YYYY-MM-DD` format allow a single date.\n- Dates in `YYYY-MM` format allow a whole month.\n- Dates in `YYYY` format allow a whole year.\n- Ranges are expressed as `start--end`. - Ranges are inclusive.\n - If either `start` or `end` is omitted, the range is unbounded in that direction.\n - If parts of the date are omitted for `start`, they are assumed to be the minimum possible value.\n So `2024--` is equivalent to `2024-01-01--`.\n - If parts of the date are omitted for `end`, they are assumed to be the maximum possible value.\n So `--2024` is equivalent to `--2024-12-31`.\n - Whitespace is allowed either side of `--`.\n\nComma-separated list of allowed dates in `YYYY-MM-DD` format.", "isOptional": true, "defaultValue": "\"\"", "examples": [ @@ -136145,7 +136407,7 @@ "syntaxKind": "PropertySignature", "name": "allowDays", "value": "string", - "description": "Days of the week that can be selected. These intersect with the result of `allow` and `disallow`.\n\nA comma-separated list of days. Whitespace is allowed after commas.\n\nThe default `''` has no effect on the result of `allow` and `disallow`.\n\nDays are `sunday`, `monday`, `tuesday`, `wednesday`, `thursday`, `friday`, `saturday`.", + "description": "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.\n\nA comma-separated list of days. Whitespace is allowed after commas.\n\nThe default `''` has no effect on the result of `allow` and `disallow`.\n\nDays are `sunday`, `monday`, `tuesday`, `wednesday`, `thursday`, `friday`, `saturday`.", "isOptional": true, "defaultValue": "\"\"", "examples": [ @@ -136183,7 +136445,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -136192,7 +136454,7 @@ "syntaxKind": "PropertySignature", "name": "disallow", "value": "string", - "description": "Dates that cannot be selected. These subtract from `allow`.\n\nA comma-separated list of dates, date ranges. Whitespace is allowed after commas.\n\nThe default `''` has no effect on `allow`.\n\n- Dates in `YYYY-MM-DD` format disallow a single date.\n- Dates in `YYYY-MM` format disallow a whole month.\n- Dates in `YYYY` format disallow a whole year.\n- Ranges are expressed as `start--end`. - Ranges are inclusive.\n - If either `start` or `end` is omitted, the range is unbounded in that direction.\n - If parts of the date are omitted for `start`, they are assumed to be the minimum possible value.\n So `2024--` is equivalent to `2024-01-01--`.\n - If parts of the date are omitted for `end`, they are assumed to be the maximum possible value.\n So `--2024` is equivalent to `--2024-12-31`.\n - Whitespace is allowed either side of `--`.", + "description": "Dates that cannot be selected. These subtract from `allow`.\n\nA comma-separated list of dates, date ranges. Whitespace is allowed after commas.\n\nThe default `''` has no effect on `allow`.\n\n- Dates in `YYYY-MM-DD` format disallow a single date.\n- Dates in `YYYY-MM` format disallow a whole month.\n- Dates in `YYYY` format disallow a whole year.\n- Ranges are expressed as `start--end`. - Ranges are inclusive.\n - If either `start` or `end` is omitted, the range is unbounded in that direction.\n - If parts of the date are omitted for `start`, they are assumed to be the minimum possible value.\n So `2024--` is equivalent to `2024-01-01--`.\n - If parts of the date are omitted for `end`, they are assumed to be the maximum possible value.\n So `--2024` is equivalent to `--2024-12-31`.\n - Whitespace is allowed either side of `--`.\n\nComma-separated list of disallowed dates in `YYYY-MM-DD` format.", "isOptional": true, "defaultValue": "\"\"", "examples": [ @@ -136234,7 +136496,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -136242,7 +136504,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -136259,7 +136521,7 @@ "syntaxKind": "PropertySignature", "name": "value", "value": "string", - "description": "Current selected value.\n\nThe default means no date is selected.\n\nIf the provided value is invalid, no date is selected.\n\nOtherwise:\n\n- If `type=\"single\"`, this is a date in `YYYY-MM-DD` format.\n- If `type=\"multiple\"`, this is a comma-separated list of dates in `YYYY-MM-DD` format.\n- If `type=\"range\"`, this is a range in `YYYY-MM-DD--YYYY-MM-DD` format. The range is inclusive.", + "description": "Current selected value.\n\nThe default means no date is selected.\n\nIf the provided value is invalid, no date is selected.\n\nOtherwise:\n\n- If `type=\"single\"`, this is a date in `YYYY-MM-DD` format.\n- If `type=\"multiple\"`, this is a comma-separated list of dates in `YYYY-MM-DD` format.\n- If `type=\"range\"`, this is a range in `YYYY-MM-DD--YYYY-MM-DD` format. The range is inclusive.\n\nSingle dates use ISO 8601 format (`YYYY-MM-DD`); ranges use `YYYY-MM-DD--YYYY-MM-DD`. Locale-specific formats aren't supported.", "isOptional": true, "defaultValue": "\"\"" }, @@ -136326,7 +136588,7 @@ { "filePath": "src/surfaces/checkout/components/DatePicker.ts", "name": "DatePickerElementEvents", - "description": "Learn more about [registering events](/docs/api/checkout-ui-extensions/latest/using-polaris-components#event-handling).", + "description": "", "isPublicDocs": true, "members": [ { @@ -136334,7 +136596,7 @@ "syntaxKind": "PropertySignature", "name": "blur", "value": "CallbackEventListener", - "description": "A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "description": "A callback fired when the date picker loses focus.\n\nLearn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", "isOptional": true }, { @@ -136342,7 +136604,7 @@ "syntaxKind": "PropertySignature", "name": "change", "value": "CallbackEventListener", - "description": "Callback when the user has **finished editing** a field, for example, once they have blurred the field.", + "description": "A callback fired when the date picker value changes.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", "isOptional": true }, { @@ -136350,7 +136612,7 @@ "syntaxKind": "PropertySignature", "name": "focus", "value": "CallbackEventListener", - "description": "A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "description": "A callback fired when the date picker receives focus.\n\nLearn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", "isOptional": true }, { @@ -136358,7 +136620,7 @@ "syntaxKind": "PropertySignature", "name": "input", "value": "CallbackEventListener", - "description": "Callback when the user makes any changes in the field.", + "description": "A callback fired when the user inputs data into the date picker.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).", "isOptional": true }, { @@ -136366,11 +136628,11 @@ "syntaxKind": "PropertySignature", "name": "viewChange", "value": "CallbackEventListener", - "description": "Callback when the view changes.", + "description": "A callback fired when the calendar view changes, such as when navigating between months.", "isOptional": true } ], - "value": "export interface DatePickerElementEvents {\n /**\n * A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur?: CallbackEventListener;\n /**\n * Callback when the user has **finished editing** a field, for example, once they have blurred the field.\n */\n change?: CallbackEventListener;\n /**\n * A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus?: CallbackEventListener;\n /**\n * Callback when the user makes any changes in the field.\n */\n input?: CallbackEventListener;\n /**\n * Callback when the view changes.\n */\n viewChange?: CallbackEventListener;\n}" + "value": "export interface DatePickerElementEvents {\n /**\n * A callback fired when the date picker loses focus.\n *\n * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur?: CallbackEventListener;\n /**\n * A callback fired when the date picker value changes.\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change?: CallbackEventListener;\n /**\n * A callback fired when the date picker receives focus.\n *\n * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus?: CallbackEventListener;\n /**\n * A callback fired when the user inputs data into the date picker.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input?: CallbackEventListener;\n /**\n * A callback fired when the calendar view changes, such as when navigating between months.\n */\n viewChange?: CallbackEventListener;\n}" }, { "filePath": "src/surfaces/checkout/components/DatePicker.ts", @@ -136397,7 +136659,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/DatePicker.ts", @@ -136411,7 +136673,7 @@ "syntaxKind": "PropertySignature", "name": "allow", "value": "string", - "description": "Dates that can be selected.\n\nA comma-separated list of dates, date ranges. Whitespace is allowed after commas.\n\nThe default `''` allows all dates.\n\n- Dates in `YYYY-MM-DD` format allow a single date.\n- Dates in `YYYY-MM` format allow a whole month.\n- Dates in `YYYY` format allow a whole year.\n- Ranges are expressed as `start--end`. - Ranges are inclusive.\n - If either `start` or `end` is omitted, the range is unbounded in that direction.\n - If parts of the date are omitted for `start`, they are assumed to be the minimum possible value.\n So `2024--` is equivalent to `2024-01-01--`.\n - If parts of the date are omitted for `end`, they are assumed to be the maximum possible value.\n So `--2024` is equivalent to `--2024-12-31`.\n - Whitespace is allowed either side of `--`.", + "description": "Restricts which dates the user can select. Accepts a comma-separated list of dates and date ranges. Whitespace is allowed after commas.\n\nThe default `''` allows all dates.\n\n- Dates in `YYYY-MM-DD` format allow a single date.\n- Dates in `YYYY-MM` format allow a whole month.\n- Dates in `YYYY` format allow a whole year.\n- Ranges are expressed as `start--end`. - Ranges are inclusive.\n - If either `start` or `end` is omitted, the range is unbounded in that direction.\n - If parts of the date are omitted for `start`, they are assumed to be the minimum possible value.\n So `2024--` is equivalent to `2024-01-01--`.\n - If parts of the date are omitted for `end`, they are assumed to be the maximum possible value.\n So `--2024` is equivalent to `--2024-12-31`.\n - Whitespace is allowed either side of `--`.\n\nComma-separated list of allowed dates in `YYYY-MM-DD` format.", "isOptional": true, "defaultValue": "\"\"", "examples": [ @@ -136432,7 +136694,7 @@ "syntaxKind": "PropertySignature", "name": "allowDays", "value": "string", - "description": "Days of the week that can be selected. These intersect with the result of `allow` and `disallow`.\n\nA comma-separated list of days. Whitespace is allowed after commas.\n\nThe default `''` has no effect on the result of `allow` and `disallow`.\n\nDays are `sunday`, `monday`, `tuesday`, `wednesday`, `thursday`, `friday`, `saturday`.", + "description": "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.\n\nA comma-separated list of days. Whitespace is allowed after commas.\n\nThe default `''` has no effect on the result of `allow` and `disallow`.\n\nDays are `sunday`, `monday`, `tuesday`, `wednesday`, `thursday`, `friday`, `saturday`.", "isOptional": true, "defaultValue": "\"\"", "examples": [ @@ -137086,7 +137348,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -137095,7 +137357,7 @@ "syntaxKind": "PropertySignature", "name": "disallow", "value": "string", - "description": "Dates that cannot be selected. These subtract from `allow`.\n\nA comma-separated list of dates, date ranges. Whitespace is allowed after commas.\n\nThe default `''` has no effect on `allow`.\n\n- Dates in `YYYY-MM-DD` format disallow a single date.\n- Dates in `YYYY-MM` format disallow a whole month.\n- Dates in `YYYY` format disallow a whole year.\n- Ranges are expressed as `start--end`. - Ranges are inclusive.\n - If either `start` or `end` is omitted, the range is unbounded in that direction.\n - If parts of the date are omitted for `start`, they are assumed to be the minimum possible value.\n So `2024--` is equivalent to `2024-01-01--`.\n - If parts of the date are omitted for `end`, they are assumed to be the maximum possible value.\n So `--2024` is equivalent to `--2024-12-31`.\n - Whitespace is allowed either side of `--`.", + "description": "Dates that cannot be selected. These subtract from `allow`.\n\nA comma-separated list of dates, date ranges. Whitespace is allowed after commas.\n\nThe default `''` has no effect on `allow`.\n\n- Dates in `YYYY-MM-DD` format disallow a single date.\n- Dates in `YYYY-MM` format disallow a whole month.\n- Dates in `YYYY` format disallow a whole year.\n- Ranges are expressed as `start--end`. - Ranges are inclusive.\n - If either `start` or `end` is omitted, the range is unbounded in that direction.\n - If parts of the date are omitted for `start`, they are assumed to be the minimum possible value.\n So `2024--` is equivalent to `2024-01-01--`.\n - If parts of the date are omitted for `end`, they are assumed to be the maximum possible value.\n So `--2024` is equivalent to `--2024-12-31`.\n - Whitespace is allowed either side of `--`.\n\nComma-separated list of disallowed dates in `YYYY-MM-DD` format.", "isOptional": true, "defaultValue": "\"\"", "examples": [ @@ -137404,7 +137666,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -137552,7 +137814,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -138531,7 +138793,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/DatePicker.ts", @@ -138778,7 +139040,7 @@ "syntaxKind": "PropertySignature", "name": "value", "value": "string", - "description": "Current selected value.\n\nThe default means no date is selected.\n\nIf the provided value is invalid, no date is selected.\n\nOtherwise:\n\n- If `type=\"single\"`, this is a date in `YYYY-MM-DD` format.\n- If `type=\"multiple\"`, this is a comma-separated list of dates in `YYYY-MM-DD` format.\n- If `type=\"range\"`, this is a range in `YYYY-MM-DD--YYYY-MM-DD` format. The range is inclusive.", + "description": "Current selected value.\n\nThe default means no date is selected.\n\nIf the provided value is invalid, no date is selected.\n\nOtherwise:\n\n- If `type=\"single\"`, this is a date in `YYYY-MM-DD` format.\n- If `type=\"multiple\"`, this is a comma-separated list of dates in `YYYY-MM-DD` format.\n- If `type=\"range\"`, this is a range in `YYYY-MM-DD--YYYY-MM-DD` format. The range is inclusive.\n\nSingle dates use ISO 8601 format (`YYYY-MM-DD`); ranges use `YYYY-MM-DD--YYYY-MM-DD`. Locale-specific formats aren't supported.", "isOptional": true, "defaultValue": "\"\"" }, @@ -138819,7 +139081,7 @@ "syntaxKind": "PropertySignature", "name": "allow", "value": "string", - "description": "Dates that can be selected.\n\nA comma-separated list of dates, date ranges. Whitespace is allowed after commas.\n\nThe default `''` allows all dates.\n\n- Dates in `YYYY-MM-DD` format allow a single date.\n- Dates in `YYYY-MM` format allow a whole month.\n- Dates in `YYYY` format allow a whole year.\n- Ranges are expressed as `start--end`. - Ranges are inclusive.\n - If either `start` or `end` is omitted, the range is unbounded in that direction.\n - If parts of the date are omitted for `start`, they are assumed to be the minimum possible value.\n So `2024--` is equivalent to `2024-01-01--`.\n - If parts of the date are omitted for `end`, they are assumed to be the maximum possible value.\n So `--2024` is equivalent to `--2024-12-31`.\n - Whitespace is allowed either side of `--`.", + "description": "Restricts which dates the user can select. Accepts a comma-separated list of dates and date ranges. Whitespace is allowed after commas.\n\nThe default `''` allows all dates.\n\n- Dates in `YYYY-MM-DD` format allow a single date.\n- Dates in `YYYY-MM` format allow a whole month.\n- Dates in `YYYY` format allow a whole year.\n- Ranges are expressed as `start--end`. - Ranges are inclusive.\n - If either `start` or `end` is omitted, the range is unbounded in that direction.\n - If parts of the date are omitted for `start`, they are assumed to be the minimum possible value.\n So `2024--` is equivalent to `2024-01-01--`.\n - If parts of the date are omitted for `end`, they are assumed to be the maximum possible value.\n So `--2024` is equivalent to `--2024-12-31`.\n - Whitespace is allowed either side of `--`.\n\nComma-separated list of allowed dates in `YYYY-MM-DD` format.", "isOptional": true, "defaultValue": "\"\"", "examples": [ @@ -138840,7 +139102,7 @@ "syntaxKind": "PropertySignature", "name": "allowDays", "value": "string", - "description": "Days of the week that can be selected. These intersect with the result of `allow` and `disallow`.\n\nA comma-separated list of days. Whitespace is allowed after commas.\n\nThe default `''` has no effect on the result of `allow` and `disallow`.\n\nDays are `sunday`, `monday`, `tuesday`, `wednesday`, `thursday`, `friday`, `saturday`.", + "description": "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.\n\nA comma-separated list of days. Whitespace is allowed after commas.\n\nThe default `''` has no effect on the result of `allow` and `disallow`.\n\nDays are `sunday`, `monday`, `tuesday`, `wednesday`, `thursday`, `friday`, `saturday`.", "isOptional": true, "defaultValue": "\"\"", "examples": [ @@ -138878,7 +139140,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -138887,7 +139149,7 @@ "syntaxKind": "PropertySignature", "name": "disallow", "value": "string", - "description": "Dates that cannot be selected. These subtract from `allow`.\n\nA comma-separated list of dates, date ranges. Whitespace is allowed after commas.\n\nThe default `''` has no effect on `allow`.\n\n- Dates in `YYYY-MM-DD` format disallow a single date.\n- Dates in `YYYY-MM` format disallow a whole month.\n- Dates in `YYYY` format disallow a whole year.\n- Ranges are expressed as `start--end`. - Ranges are inclusive.\n - If either `start` or `end` is omitted, the range is unbounded in that direction.\n - If parts of the date are omitted for `start`, they are assumed to be the minimum possible value.\n So `2024--` is equivalent to `2024-01-01--`.\n - If parts of the date are omitted for `end`, they are assumed to be the maximum possible value.\n So `--2024` is equivalent to `--2024-12-31`.\n - Whitespace is allowed either side of `--`.", + "description": "Dates that cannot be selected. These subtract from `allow`.\n\nA comma-separated list of dates, date ranges. Whitespace is allowed after commas.\n\nThe default `''` has no effect on `allow`.\n\n- Dates in `YYYY-MM-DD` format disallow a single date.\n- Dates in `YYYY-MM` format disallow a whole month.\n- Dates in `YYYY` format disallow a whole year.\n- Ranges are expressed as `start--end`. - Ranges are inclusive.\n - If either `start` or `end` is omitted, the range is unbounded in that direction.\n - If parts of the date are omitted for `start`, they are assumed to be the minimum possible value.\n So `2024--` is equivalent to `2024-01-01--`.\n - If parts of the date are omitted for `end`, they are assumed to be the maximum possible value.\n So `--2024` is equivalent to `--2024-12-31`.\n - Whitespace is allowed either side of `--`.\n\nComma-separated list of disallowed dates in `YYYY-MM-DD` format.", "isOptional": true, "defaultValue": "\"\"", "examples": [ @@ -138929,7 +139191,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -138937,7 +139199,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -138994,7 +139256,7 @@ "syntaxKind": "PropertySignature", "name": "value", "value": "string", - "description": "Current selected value.\n\nThe default means no date is selected.\n\nIf the provided value is invalid, no date is selected.\n\nOtherwise:\n\n- If `type=\"single\"`, this is a date in `YYYY-MM-DD` format.\n- If `type=\"multiple\"`, this is a comma-separated list of dates in `YYYY-MM-DD` format.\n- If `type=\"range\"`, this is a range in `YYYY-MM-DD--YYYY-MM-DD` format. The range is inclusive.", + "description": "Current selected value.\n\nThe default means no date is selected.\n\nIf the provided value is invalid, no date is selected.\n\nOtherwise:\n\n- If `type=\"single\"`, this is a date in `YYYY-MM-DD` format.\n- If `type=\"multiple\"`, this is a comma-separated list of dates in `YYYY-MM-DD` format.\n- If `type=\"range\"`, this is a range in `YYYY-MM-DD--YYYY-MM-DD` format. The range is inclusive.\n\nSingle dates use ISO 8601 format (`YYYY-MM-DD`); ranges use `YYYY-MM-DD--YYYY-MM-DD`. Locale-specific formats aren't supported.", "isOptional": true, "defaultValue": "\"\"" }, @@ -139012,7 +139274,7 @@ { "filePath": "src/surfaces/checkout/components/Details.ts", "name": "DetailsElementProps", - "description": "Creates a collapsible content area that can be expanded or collapsed by users. Use with Summary to provide expandable sections for additional information or settings.", + "description": "", "isPublicDocs": true, "members": [ { @@ -139020,7 +139282,7 @@ "syntaxKind": "PropertySignature", "name": "defaultOpen", "value": "boolean", - "description": "Indicates whether the element should be open by default.\n\nThis reflects to the `open` attribute.", + "description": "Whether the element should be open when it first renders. This reflects to the `open` attribute and only takes effect on the initial render.", "isOptional": true, "defaultValue": "false" }, @@ -139029,7 +139291,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -139037,7 +139299,7 @@ "syntaxKind": "PropertySignature", "name": "open", "value": "boolean", - "description": "Whether the element is open.\n\nThis does not reflect to any attribute.", + "description": "Whether the element is currently open. Use this for controlled component patterns where your application manages the open state directly. This does not reflect to any attribute.", "isOptional": true, "defaultValue": "false" }, @@ -139046,7 +139308,7 @@ "syntaxKind": "PropertySignature", "name": "toggleTransition", "value": "'none' | 'auto'", - "description": "Sets the transition between the two states.", + "description": "The transition style used when toggling between open and closed states.\n\n- `none`: Switches states immediately without animation.\n- `auto`: Uses the default animated transition.", "isOptional": true, "defaultValue": "'auto'" } @@ -139064,7 +139326,7 @@ "syntaxKind": "PropertySignature", "name": "onAfterToggle", "value": "(event: ToggleEvent$1) => void", - "description": "A callback fired when the element state changes, after any toggle animations have finished.\n\n- If the element transitioned from hidden to showing, the `oldState` property will be set to `closed` and the `newState` property will be set to `open`.\n- If the element transitioned from showing to hidden, the `oldState` property will be set to `open` and the `newState` will be `closed`.\n\nLearn more about [ToggleEvent.newState](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/newState) and [ToggleEvent.oldState](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/oldState).", + "description": "A callback fired when the element state changes, after any toggle animations have finished.\n\n- If the element transitioned from hidden to showing, the `oldState` property will be set to `closed` and the `newState` property will be set to `open`.\n- If the element transitioned from showing to hidden, the `oldState` property will be set to `open` and the `newState` will be `closed`.\n\nLearn more about 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.", "isOptional": true }, { @@ -139072,7 +139334,7 @@ "syntaxKind": "PropertySignature", "name": "onToggle", "value": "(event: ToggleEvent$1) => void", - "description": "A callback fired immediately when the element state changes, before any animations.\n\n- If the element is transitioning from hidden to showing, the `oldState` property will be set to `closed` and the `newState` property will be set to `open`.\n- If the element is transitioning from showing to hidden, then `oldState` property will be set to `open` and the `newState` will be `closed`.\n\nLearn more about the [toggle event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/toggle_event), [ToggleEvent.newState](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/newState), and [ToggleEvent.oldState](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/oldState).", + "description": "A callback fired immediately when the element state changes, before any animations.\n\n- If the element is transitioning from hidden to showing, the `oldState` property will be set to `closed` and the `newState` property will be set to `open`.\n- If the element is transitioning from showing to hidden, then the `oldState` property will be set to `open` and the `newState` will be `closed`.\n\nLearn 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.", "isOptional": true } ], @@ -139081,7 +139343,7 @@ { "filePath": "src/surfaces/checkout/components/Details.ts", "name": "DetailsElementEvents", - "description": "Learn more about [registering events](/docs/api/checkout-ui-extensions/latest/using-polaris-components#event-handling).", + "description": "", "isPublicDocs": true, "members": [ { @@ -139089,7 +139351,7 @@ "syntaxKind": "PropertySignature", "name": "aftertoggle", "value": "CallbackEventListener", - "description": "Callback fired when the element state changes **after** any animations have finished.\n\n- If the element transitioned from hidden to showing, the `oldState` property will be set to `closed` and the `newState` property will be set to `open`.\n- If the element transitioned from showing to hidden, the `oldState` property will be set to `open` and the `newState` will be `closed`.", + "description": "A callback fired when the element state changes, after any toggle animations have finished.\n\n- If the element transitioned from hidden to showing, the `oldState` property will be set to `closed` and the `newState` property will be set to `open`.\n- If the element transitioned from showing to hidden, the `oldState` property will be set to `open` and the `newState` will be `closed`.\n\nLearn more about 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.", "isOptional": true }, { @@ -139097,11 +139359,11 @@ "syntaxKind": "PropertySignature", "name": "toggle", "value": "CallbackEventListener", - "description": "Callback straight after the element state changes.\n\n- If the element is transitioning from hidden to showing, the `oldState` property will be set to `closed` and the `newState` property will be set to `open`.\n- If the element is transitioning from showing to hidden, then `oldState` property will be set to `open` and the `newState` will be `closed`.", + "description": "A callback fired immediately when the element state changes, before any animations.\n\n- If the element is transitioning from hidden to showing, the `oldState` property will be set to `closed` and the `newState` property will be set to `open`.\n- If the element is transitioning from showing to hidden, then the `oldState` property will be set to `open` and the `newState` will be `closed`.\n\nLearn 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.", "isOptional": true } ], - "value": "export interface DetailsElementEvents {\n /**\n * Callback straight after the element state changes.\n *\n * - If the element is transitioning from hidden to showing, the `oldState` property will be set to `closed` and the\n * `newState` property will be set to `open`.\n * - If the element is transitioning from showing to hidden, then `oldState` property will be set to `open` and the\n * `newState` will be `closed`.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/toggle_event\n * @see https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/newState\n * @see https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/oldState\n */\n toggle?: CallbackEventListener;\n /**\n * Callback fired when the element state changes **after** any animations have finished.\n *\n * - If the element transitioned from hidden to showing, the `oldState` property will be set to `closed` and the\n * `newState` property will be set to `open`.\n * - If the element transitioned from showing to hidden, the `oldState` property will be set to `open` and the\n * `newState` will be `closed`.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/newState\n * @see https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/oldState\n */\n aftertoggle?: CallbackEventListener;\n}" + "value": "export interface DetailsElementEvents {\n /**\n * A callback fired immediately when the element state changes, before any animations.\n *\n * - If the element is transitioning from hidden to showing, the `oldState` property will be set to `closed` and the\n * `newState` property will be set to `open`.\n * - If the element is transitioning from showing to hidden, then the `oldState` property will be set to `open` and the\n * `newState` will be `closed`.\n *\n * 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.\n */\n toggle?: CallbackEventListener;\n /**\n * A callback fired when the element state changes, after any toggle animations have finished.\n *\n * - If the element transitioned from hidden to showing, the `oldState` property will be set to `closed` and the\n * `newState` property will be set to `open`.\n * - If the element transitioned from showing to hidden, the `oldState` property will be set to `open` and the\n * `newState` will be `closed`.\n *\n * Learn more about 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.\n */\n aftertoggle?: CallbackEventListener;\n}" }, { "filePath": "src/surfaces/checkout/components/Details.ts", @@ -139128,7 +139390,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/Details.ts", @@ -141136,7 +141398,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/Details.ts", @@ -141398,7 +141660,7 @@ "syntaxKind": "PropertySignature", "name": "defaultOpen", "value": "boolean", - "description": "Indicates whether the element should be open by default.\n\nThis reflects to the `open` attribute.", + "description": "Whether the element should be open when it first renders. This reflects to the `open` attribute and only takes effect on the initial render.", "isOptional": true, "defaultValue": "false" }, @@ -141407,7 +141669,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -141415,7 +141677,7 @@ "syntaxKind": "PropertySignature", "name": "onAfterToggle", "value": "(event: ToggleEvent$1) => void", - "description": "A callback fired when the element state changes, after any toggle animations have finished.\n\n- If the element transitioned from hidden to showing, the `oldState` property will be set to `closed` and the `newState` property will be set to `open`.\n- If the element transitioned from showing to hidden, the `oldState` property will be set to `open` and the `newState` will be `closed`.\n\nLearn more about [ToggleEvent.newState](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/newState) and [ToggleEvent.oldState](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/oldState).", + "description": "A callback fired when the element state changes, after any toggle animations have finished.\n\n- If the element transitioned from hidden to showing, the `oldState` property will be set to `closed` and the `newState` property will be set to `open`.\n- If the element transitioned from showing to hidden, the `oldState` property will be set to `open` and the `newState` will be `closed`.\n\nLearn more about 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.", "isOptional": true }, { @@ -141423,7 +141685,7 @@ "syntaxKind": "PropertySignature", "name": "onToggle", "value": "(event: ToggleEvent$1) => void", - "description": "A callback fired immediately when the element state changes, before any animations.\n\n- If the element is transitioning from hidden to showing, the `oldState` property will be set to `closed` and the `newState` property will be set to `open`.\n- If the element is transitioning from showing to hidden, then `oldState` property will be set to `open` and the `newState` will be `closed`.\n\nLearn more about the [toggle event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/toggle_event), [ToggleEvent.newState](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/newState), and [ToggleEvent.oldState](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/oldState).", + "description": "A callback fired immediately when the element state changes, before any animations.\n\n- If the element is transitioning from hidden to showing, the `oldState` property will be set to `closed` and the `newState` property will be set to `open`.\n- If the element is transitioning from showing to hidden, then the `oldState` property will be set to `open` and the `newState` will be `closed`.\n\nLearn 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.", "isOptional": true }, { @@ -141431,7 +141693,7 @@ "syntaxKind": "PropertySignature", "name": "open", "value": "boolean", - "description": "Whether the element is open.\n\nThis does not reflect to any attribute.", + "description": "Whether the element is currently open. Use this for controlled component patterns where your application manages the open state directly. This does not reflect to any attribute.", "isOptional": true, "defaultValue": "false" }, @@ -141440,7 +141702,7 @@ "syntaxKind": "PropertySignature", "name": "toggleTransition", "value": "'none' | 'auto'", - "description": "Sets the transition between the two states.", + "description": "The transition style used when toggling between open and closed states.\n\n- `none`: Switches states immediately without animation.\n- `auto`: Uses the default animated transition.", "isOptional": true, "defaultValue": "'auto'" } @@ -141450,7 +141712,7 @@ { "filePath": "src/surfaces/checkout/components/Divider.ts", "name": "DividerElementProps", - "description": "The divider component creates clear visual separation between elements in the interface. Use divider to separate distinct content groups in forms, settings panels, lists, or page sections, helping users scan and understand content organization.\n\nDividers support both horizontal and vertical orientations, along with different visual strengths for varying levels of emphasis. For more structured content grouping with headings, use [section](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/layout-and-structure/section).", + "description": "", "isPublicDocs": true, "members": [ { @@ -141458,7 +141720,7 @@ "syntaxKind": "PropertySignature", "name": "direction", "value": "'inline' | 'block'", - "description": "Specify the direction of the divider. This uses [logical properties](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_logical_properties_and_values).", + "description": "Specify the direction of the divider. This uses [logical properties](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_logical_properties_and_values).\n\nVertical dividers (`'block'` direction) require a parent with a defined height to render visibly.", "isOptional": true, "defaultValue": "'inline'" }, @@ -141467,7 +141729,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true } ], @@ -141498,7 +141760,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/Divider.ts", @@ -142128,7 +142390,7 @@ "syntaxKind": "PropertySignature", "name": "direction", "value": "'inline' | 'block'", - "description": "Specify the direction of the divider. This uses [logical properties](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_logical_properties_and_values).", + "description": "Specify the direction of the divider. This uses [logical properties](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_logical_properties_and_values).\n\nVertical dividers (`'block'` direction) require a parent with a defined height to render visibly.", "isOptional": true, "defaultValue": "'inline'" }, @@ -142404,7 +142666,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -143516,7 +143778,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/Divider.ts", @@ -143778,7 +144040,7 @@ "syntaxKind": "PropertySignature", "name": "direction", "value": "'inline' | 'block'", - "description": "Specify the direction of the divider. This uses [logical properties](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_logical_properties_and_values).", + "description": "Specify the direction of the divider. This uses [logical properties](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_logical_properties_and_values).\n\nVertical dividers (`'block'` direction) require a parent with a defined height to render visibly.", "isOptional": true, "defaultValue": "'inline'" }, @@ -143787,7 +144049,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true } ], @@ -143796,7 +144058,7 @@ { "filePath": "src/surfaces/checkout/components/DropZone.ts", "name": "DropZoneElementProps", - "description": "The drop zone component lets users upload files through drag-and-drop or by clicking to browse. Use for file uploads such as images, documents, or CSV imports.\n\nThe component provides visual feedback during drag operations and supports file type validation through the `accept` property. Rejected files trigger the `droprejected` event for custom error handling.", + "description": "", "isPublicDocs": true, "members": [ { @@ -143821,7 +144083,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -143830,7 +144092,7 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -143838,7 +144100,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -143846,7 +144108,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Content to use as the field label.", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", "isOptional": true }, { @@ -143863,7 +144125,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -143898,7 +144160,7 @@ "syntaxKind": "PropertySignature", "name": "onChange", "value": "(event: Event) => void", - "description": "Callback when the user has **finished selecting** a file or files.", + "description": "A callback fired when the user has finished selecting one or more files.", "isOptional": true }, { @@ -143914,7 +144176,7 @@ "syntaxKind": "PropertySignature", "name": "onInput", "value": "(event: Event) => void", - "description": "Callback when the user makes any changes in the file selection.", + "description": "A callback fired when the user makes any changes to the file selection.", "isOptional": true } ], @@ -143923,7 +144185,7 @@ { "filePath": "src/surfaces/checkout/components/DropZone.ts", "name": "DropZoneElementEvents", - "description": "Learn more about [registering events](/docs/api/checkout-ui-extensions/latest/using-polaris-components#event-handling).", + "description": "", "isPublicDocs": true, "members": [ { @@ -143931,7 +144193,7 @@ "syntaxKind": "PropertySignature", "name": "change", "value": "CallbackEventListener", - "description": "Callback when the user has finished selecting a file or files.", + "description": "A callback fired when the drop zone value changes.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", "isOptional": true }, { @@ -143939,7 +144201,7 @@ "syntaxKind": "PropertySignature", "name": "droprejected", "value": "CallbackEventListener", - "description": "Callback when rejected files are dropped. Files are rejected based on the `accept` prop.", + "description": "A callback fired when files are rejected based on the `accept` prop.", "isOptional": true }, { @@ -143947,11 +144209,11 @@ "syntaxKind": "PropertySignature", "name": "input", "value": "CallbackEventListener", - "description": "Callback when the user makes any changes in the field.", + "description": "A callback fired when the user inputs data into the drop zone.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).", "isOptional": true } ], - "value": "export interface DropZoneElementEvents {\n /**\n * Callback when rejected files are dropped. Files are rejected based on the `accept` prop.\n */\n droprejected?: CallbackEventListener;\n /**\n * Callback when the user makes any changes in the field.\n */\n input?: CallbackEventListener;\n /**\n * Callback when the user has finished selecting a file or files.\n */\n change?: CallbackEventListener;\n}" + "value": "export interface DropZoneElementEvents {\n /**\n * A callback fired when files are rejected based on the `accept` prop.\n */\n droprejected?: CallbackEventListener;\n /**\n * A callback fired when the user inputs data into the drop zone.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input?: CallbackEventListener;\n /**\n * A callback fired when the drop zone value changes.\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change?: CallbackEventListener;\n}" }, { "filePath": "src/surfaces/checkout/components/DropZone.ts", @@ -143995,7 +144257,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/DropZone.ts", @@ -144625,7 +144887,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -144739,7 +145001,7 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -144909,7 +145171,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -145008,7 +145270,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Content to use as the field label.", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", "isOptional": true }, { @@ -145074,7 +145336,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -146053,7 +146315,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/DropZone.ts", @@ -146350,7 +146612,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -146359,7 +146621,7 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -146367,7 +146629,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -146375,7 +146637,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Content to use as the field label.", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", "isOptional": true }, { @@ -146392,7 +146654,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -146400,7 +146662,7 @@ "syntaxKind": "PropertySignature", "name": "onChange", "value": "(event: Event) => void", - "description": "Callback when the user has **finished selecting** a file or files.", + "description": "A callback fired when the user has finished selecting one or more files.", "isOptional": true }, { @@ -146416,7 +146678,7 @@ "syntaxKind": "PropertySignature", "name": "onInput", "value": "(event: Event) => void", - "description": "Callback when the user makes any changes in the file selection.", + "description": "A callback fired when the user makes any changes to the file selection.", "isOptional": true }, { @@ -146443,7 +146705,7 @@ { "filePath": "src/surfaces/checkout/components/EmailField.ts", "name": "EmailFieldElementProps", - "description": "The email field component captures email address input. Use it to collect email information in forms, customer profiles, or contact workflows.\n\nEmail field doesn't perform automatic email validation. Implement your own validation logic, and use the `error` property to display validation results. For general text input, use [text field](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/forms/text-field).", + "description": "", "isPublicDocs": true, "members": [ { @@ -146451,7 +146713,7 @@ "syntaxKind": "PropertySignature", "name": "autocomplete", "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", "isOptional": true, "defaultValue": "'on' for everything else" }, @@ -146460,7 +146722,7 @@ "syntaxKind": "PropertySignature", "name": "defaultValue", "value": "string", - "description": "The default value for the field.", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces this value.", "isOptional": true }, { @@ -146468,7 +146730,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -146477,7 +146739,7 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -146485,7 +146747,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -146493,7 +146755,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Content to use as the field label.", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", "isOptional": true }, { @@ -146501,7 +146763,7 @@ "syntaxKind": "PropertySignature", "name": "labelAccessibilityVisibility", "value": "'visible' | 'exclusive'", - "description": "Changes the visibility of the component's label.\n\n- `visible`: the label is visible to all users.\n- `exclusive`: the label is visually hidden but remains in the accessibility tree.", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone.\n- `exclusive`: The label is visually hidden but still announced by screen readers.", "isOptional": true, "defaultValue": "'visible'" }, @@ -146519,7 +146781,7 @@ "syntaxKind": "PropertySignature", "name": "minLength", "value": "number", - "description": "Specifies the min number of characters allowed.", + "description": "Specifies the minimum number of characters allowed.", "isOptional": true, "defaultValue": "0" }, @@ -146528,7 +146790,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -146546,7 +146808,7 @@ "syntaxKind": "PropertySignature", "name": "readOnly", "value": "boolean", - "description": "The field cannot be edited by the user. It is focusable will be announced by screen readers.", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", "isOptional": true, "defaultValue": "false" }, @@ -146589,7 +146851,7 @@ "syntaxKind": "PropertySignature", "name": "onChange", "value": "(event: Event) => void", - "description": "Callback when the user has **finished editing** a field, for example, once they have blurred the field.", + "description": "A callback fired when the user has **finished editing** a field, such as when they blur the field or press Enter.", "isOptional": true }, { @@ -146605,7 +146867,7 @@ "syntaxKind": "PropertySignature", "name": "onInput", "value": "(event: Event) => void", - "description": "Callback when the user makes any changes in the field.", + "description": "A callback fired when the user makes any changes in the field, such as typing a character.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).", "isOptional": true } ], @@ -146614,7 +146876,7 @@ { "filePath": "src/surfaces/checkout/components/EmailField.ts", "name": "EmailFieldElementEvents", - "description": "Learn more about [registering events](/docs/api/checkout-ui-extensions/latest/using-polaris-components#event-handling).", + "description": "", "isPublicDocs": true, "members": [ { @@ -146622,7 +146884,7 @@ "syntaxKind": "PropertySignature", "name": "blur", "value": "CallbackEventListener", - "description": "A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "description": "<<<<<<< HEAD A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n======= A callback fired when the email field loses focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) \n Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", "isOptional": true }, { @@ -146630,7 +146892,7 @@ "syntaxKind": "PropertySignature", "name": "change", "value": "CallbackEventListener", - "description": "Callback when the user has **finished editing** a field, for example, once they have blurred the field.", + "description": "<<<<<<< HEAD Callback when the user has **finished editing** a field, for example, once they have blurred the field.\n======= A callback fired when the email field value changes.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) \n Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", "isOptional": true }, { @@ -146638,7 +146900,7 @@ "syntaxKind": "PropertySignature", "name": "focus", "value": "CallbackEventListener", - "description": "A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "description": "<<<<<<< HEAD A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n======= A callback fired when the email field receives focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) \n Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", "isOptional": true }, { @@ -146646,16 +146908,16 @@ "syntaxKind": "PropertySignature", "name": "input", "value": "CallbackEventListener", - "description": "Callback when the user makes any changes in the field.", + "description": "A callback fired when the user inputs data into the email field.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).", "isOptional": true } ], - "value": "export interface EmailFieldElementEvents {\n /**\n * A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event\n */\n blur?: CallbackEventListener;\n /**\n * Callback when the user has **finished editing** a field, for example, once they have blurred the field.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event\n */\n change?: CallbackEventListener;\n /**\n * A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event\n */\n focus?: CallbackEventListener;\n /**\n * Callback when the user makes any changes in the field.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event\n */\n input?: CallbackEventListener;\n}" + "value": "export interface EmailFieldElementEvents {\n /**\n<<<<<<< HEAD\n * A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n=======\n * A callback fired when the email field loses focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality)\n *\n * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur?: CallbackEventListener;\n /**\n<<<<<<< HEAD\n * Callback when the user has **finished editing** a field, for example, once they have blurred the field.\n=======\n * A callback fired when the email field value changes.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality)\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change?: CallbackEventListener;\n /**\n<<<<<<< HEAD\n * A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n=======\n * A callback fired when the email field receives focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality)\n *\n * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus?: CallbackEventListener;\n /**\n * A callback fired when the user inputs data into the email field.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input?: CallbackEventListener;\n}" }, { "filePath": "src/surfaces/checkout/components/EmailField.ts", "name": "EmailFieldElementSlots", - "description": "Learn more about [component slots](/docs/api/checkout-ui-extensions/latest/using-polaris-components#slots).", + "description": "", "isPublicDocs": true, "members": [ { @@ -146663,11 +146925,11 @@ "syntaxKind": "PropertySignature", "name": "accessory", "value": "HTMLElement", - "description": "Additional content to be displayed in the field. Commonly used to display an icon that activates a tooltip providing more information.", + "description": "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.", "isOptional": true } ], - "value": "export interface EmailFieldElementSlots {\n /**\n * Additional content to be displayed in the field.\n * Commonly used to display an icon that activates a tooltip providing more information.\n */\n accessory?: HTMLElement;\n}" + "value": "export interface EmailFieldElementSlots {\n /**\n * 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.\n */\n accessory?: HTMLElement;\n}" }, { "filePath": "src/surfaces/checkout/components/EmailField.ts", @@ -146694,7 +146956,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/EmailField.ts", @@ -147135,7 +147397,7 @@ "syntaxKind": "PropertySignature", "name": "autocomplete", "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", "isOptional": true, "defaultValue": "'on' for everything else" }, @@ -147326,7 +147588,7 @@ "syntaxKind": "PropertySignature", "name": "defaultValue", "value": "string", - "description": "The default value for the field.", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces this value.", "isOptional": true }, { @@ -147341,7 +147603,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -147455,7 +147717,7 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -147625,7 +147887,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -147724,7 +147986,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Content to use as the field label.", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", "isOptional": true }, { @@ -147732,7 +147994,7 @@ "syntaxKind": "PropertySignature", "name": "labelAccessibilityVisibility", "value": "'visible' | 'exclusive'", - "description": "Changes the visibility of the component's label.\n\n- `visible`: the label is visible to all users.\n- `exclusive`: the label is visually hidden but remains in the accessibility tree.", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone.\n- `exclusive`: The label is visually hidden but still announced by screen readers.", "isOptional": true, "defaultValue": "'visible'" }, @@ -147799,7 +148061,7 @@ "syntaxKind": "PropertySignature", "name": "minLength", "value": "number", - "description": "Specifies the min number of characters allowed.", + "description": "Specifies the minimum number of characters allowed.", "isOptional": true, "defaultValue": "0" }, @@ -147808,7 +148070,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -148741,7 +149003,7 @@ "syntaxKind": "PropertySignature", "name": "readOnly", "value": "boolean", - "description": "The field cannot be edited by the user. It is focusable will be announced by screen readers.", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", "isOptional": true, "defaultValue": "false" }, @@ -148792,7 +149054,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/EmailField.ts", @@ -149071,7 +149333,7 @@ "syntaxKind": "PropertySignature", "name": "autocomplete", "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", "isOptional": true, "defaultValue": "'on' for everything else" }, @@ -149080,7 +149342,7 @@ "syntaxKind": "PropertySignature", "name": "defaultValue", "value": "string", - "description": "The default value for the field.", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces this value.", "isOptional": true }, { @@ -149088,7 +149350,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -149097,7 +149359,7 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -149105,7 +149367,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -149113,7 +149375,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Content to use as the field label.", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", "isOptional": true }, { @@ -149121,7 +149383,7 @@ "syntaxKind": "PropertySignature", "name": "labelAccessibilityVisibility", "value": "'visible' | 'exclusive'", - "description": "Changes the visibility of the component's label.\n\n- `visible`: the label is visible to all users.\n- `exclusive`: the label is visually hidden but remains in the accessibility tree.", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone.\n- `exclusive`: The label is visually hidden but still announced by screen readers.", "isOptional": true, "defaultValue": "'visible'" }, @@ -149139,7 +149401,7 @@ "syntaxKind": "PropertySignature", "name": "minLength", "value": "number", - "description": "Specifies the min number of characters allowed.", + "description": "Specifies the minimum number of characters allowed.", "isOptional": true, "defaultValue": "0" }, @@ -149148,7 +149410,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -149164,7 +149426,7 @@ "syntaxKind": "PropertySignature", "name": "onChange", "value": "(event: Event) => void", - "description": "Callback when the user has **finished editing** a field, for example, once they have blurred the field.", + "description": "A callback fired when the user has **finished editing** a field, such as when they blur the field or press Enter.", "isOptional": true }, { @@ -149180,7 +149442,7 @@ "syntaxKind": "PropertySignature", "name": "onInput", "value": "(event: Event) => void", - "description": "Callback when the user makes any changes in the field.", + "description": "A callback fired when the user makes any changes in the field, such as typing a character.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).", "isOptional": true }, { @@ -149198,7 +149460,7 @@ "syntaxKind": "PropertySignature", "name": "readOnly", "value": "boolean", - "description": "The field cannot be edited by the user. It is focusable will be announced by screen readers.", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", "isOptional": true, "defaultValue": "false" }, @@ -149225,7 +149487,7 @@ { "filePath": "src/surfaces/checkout/components/Form.ts", "name": "FormElementProps", - "description": "The form component wraps form controls and enables implicit submission, allowing users to submit from any input by pressing **Enter**. Use form to group related input fields and handle form submission through JavaScript event handlers.\n\nUnlike HTML forms, form doesn't automatically submit data using HTTP—you must register a `submit` event to process form data programmatically. For Shopify Functions configuration forms, use [function settings](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/forms/function-settings).", + "description": "", "isPublicDocs": true, "members": [ { @@ -149244,7 +149506,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true } ], @@ -149261,16 +149523,16 @@ "syntaxKind": "PropertySignature", "name": "onSubmit", "value": "() => void", - "description": "A callback that is run when the form is submitted.", + "description": "A callback fired when the form is submitted.", "isOptional": true } ], - "value": "export interface FormEvents extends Pick {\n /**\n * A callback that is run when the form is submitted.\n */\n onSubmit?: () => void;\n}" + "value": "export interface FormEvents extends Pick {\n /**\n * A callback fired when the form is submitted.\n */\n onSubmit?: () => void;\n}" }, { "filePath": "src/surfaces/checkout/components/Form.ts", "name": "FormElementEvents", - "description": "Learn more about [registering events](/docs/api/checkout-ui-extensions/latest/using-polaris-components#event-handling).", + "description": "", "isPublicDocs": true, "members": [ { @@ -149278,11 +149540,11 @@ "syntaxKind": "PropertySignature", "name": "submit", "value": "CallbackEventListener", - "description": "A callback that is run when the form is submitted.", + "description": "A callback fired when the form is submitted.", "isOptional": true } ], - "value": "export interface FormElementEvents {\n /**\n * A callback that is run when the form is submitted.\n */\n submit?: CallbackEventListener;\n}" + "value": "export interface FormElementEvents {\n /**\n * A callback fired when the form is submitted.\n */\n submit?: CallbackEventListener;\n}" }, { "filePath": "src/surfaces/checkout/components/Form.ts", @@ -149309,7 +149571,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/Form.ts", @@ -150217,7 +150479,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -151329,7 +151591,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/Form.ts", @@ -151602,7 +151864,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -151610,7 +151872,7 @@ "syntaxKind": "PropertySignature", "name": "onSubmit", "value": "() => void", - "description": "A callback that is run when the form is submitted.", + "description": "A callback fired when the form is submitted.", "isOptional": true } ], @@ -151621,7 +151883,7 @@ "syntaxKind": "TypeAliasDeclaration", "name": "ReducedAlignContentKeyword", "value": "'center' | 'start' | 'end' | 'normal' | 'space-between' | 'space-around' | 'space-evenly' | 'stretch'", - "description": "", + "description": "The subset of `align-content` values available for the grid component.\n\n- `center`: Packs rows toward the center of the grid.\n- `start`: Packs rows toward the start of the block axis.\n- `end`: Packs rows toward the end of the block axis.\n- `normal`: Default browser behavior.\n- `space-between`: Distributes rows evenly with no space at the edges.\n- `space-around`: Distributes rows evenly with equal space around each.\n- `space-evenly`: Distributes rows with equal space between and at the edges.\n- `stretch`: Stretches rows to fill the available space.", "isPublicDocs": true }, { @@ -151629,7 +151891,7 @@ "syntaxKind": "TypeAliasDeclaration", "name": "ReducedAlignItemsKeyword", "value": "'center' | 'start' | 'end' | 'normal' | 'baseline' | 'stretch'", - "description": "", + "description": "The subset of `align-items` values available for the grid component.\n\n- `center`: Centers items along the block axis.\n- `start`: Aligns items to the start of the block axis.\n- `end`: Aligns items to the end of the block axis.\n- `normal`: Default browser behavior.\n- `baseline`: Aligns items along their text baseline.\n- `stretch`: Stretches items to fill the cell along the block axis.", "isPublicDocs": true }, { @@ -151637,7 +151899,7 @@ "syntaxKind": "TypeAliasDeclaration", "name": "ReducedJustifyContentKeyword", "value": "'center' | 'start' | 'end' | 'normal' | 'space-between' | 'space-around' | 'space-evenly' | 'stretch'", - "description": "", + "description": "The subset of `justify-content` values available for the grid component.\n\n- `center`: Packs columns toward the center of the grid.\n- `start`: Packs columns toward the start of the inline axis.\n- `end`: Packs columns toward the end of the inline axis.\n- `normal`: Default browser behavior.\n- `space-between`: Distributes columns evenly with no space at the edges.\n- `space-around`: Distributes columns evenly with equal space around each.\n- `space-evenly`: Distributes columns with equal space between and at the edges.\n- `stretch`: Stretches columns to fill the available space.", "isPublicDocs": true }, { @@ -151645,13 +151907,13 @@ "syntaxKind": "TypeAliasDeclaration", "name": "ReducedJustifyItemsKeyword", "value": "'center' | 'start' | 'end' | 'normal' | 'baseline' | 'stretch'", - "description": "", + "description": "The subset of `justify-items` values available for the grid component.\n\n- `center`: Centers items along the inline axis.\n- `start`: Aligns items to the start of the inline axis.\n- `end`: Aligns items to the end of the inline axis.\n- `normal`: Default browser behavior.\n- `baseline`: Aligns items along their text baseline.\n- `stretch`: Stretches items to fill the cell along the inline axis.", "isPublicDocs": true }, { "filePath": "src/surfaces/checkout/components/Grid.ts", "name": "GridElementProps", - "description": "The grid component organizes content in a matrix of rows and columns to create responsive page layouts. Use grid to build complex, multi-column layouts that adapt to different screen sizes and maintain consistent alignment.\n\nGrid follows the CSS grid layout pattern and supports flexible column configurations, gap spacing, and alignment properties for precise layout control. For simpler linear layouts (horizontal or vertical), use [stack](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/layout-and-structure/stack).", + "description": "", "isPublicDocs": true, "members": [ { @@ -151676,7 +151938,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityVisibility", "value": "'visible' | 'hidden' | 'exclusive'", - "description": "Changes the visibility of the element.\n\n- `visible`: the element is visible to all users.\n- `hidden`: the element is removed from the accessibility tree but remains visible.\n- `exclusive`: the element is visually hidden but remains in the accessibility tree.", + "description": "Controls how the element is exposed to sighted users and to assistive technologies such as screen readers.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", "isOptional": true, "defaultValue": "'visible'" }, @@ -151685,7 +151947,7 @@ "syntaxKind": "PropertySignature", "name": "alignContent", "value": "MaybeResponsive", - "description": "Aligns the grid along the block (column) axis.\n\nThis overrides the block value of `placeContent`.", + "description": "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.", "isOptional": true, "defaultValue": "'' - meaning no override" }, @@ -151694,7 +151956,7 @@ "syntaxKind": "PropertySignature", "name": "alignItems", "value": "MaybeResponsive", - "description": "Aligns the grid items along the block (column) axis.\n\nThis overrides the block value of `placeItems`.", + "description": "Aligns grid items along the block (column) axis. Set to an empty string to use the default.", "isOptional": true, "defaultValue": "'' - meaning no override" }, @@ -151703,7 +151965,7 @@ "syntaxKind": "PropertySignature", "name": "background", "value": "'base' | 'subdued' | 'transparent'", - "description": "Adjust the background of the element.\n\n- `'transparent'`: No visible background.\n- `'subdued'`: A subtle, low-emphasis background.\n- `'base'`: The standard background color.\n- `'strong'`: A high-emphasis background for prominence.", + "description": "The background color of the grid.\n\n- `base`: The standard background color for general content areas.\n- `subdued`: A muted background for secondary or supporting content.\n- `transparent`: No background color (the default).", "isOptional": true, "defaultValue": "'transparent'" }, @@ -151721,9 +151983,9 @@ "syntaxKind": "PropertySignature", "name": "border", "value": "BorderShorthand", - "description": "Applies a border using shorthand syntax to specify width, color, and style in a single property.\n\nAccepts a size value, optionally followed by a color, optionally followed by a style. Omitted values use defaults: color defaults to `base`, style defaults to `auto`.\n\nIndividual properties (`borderWidth`, `borderStyle`, `borderColor`) can override values set here.", + "description": "A shorthand for setting the border width, color, and style in a single property. Individual border properties (`borderWidth`, `borderStyle`, `borderColor`) can override values set here.", "isOptional": true, - "defaultValue": "'none' - equivalent to `none base auto`.", + "defaultValue": "'none'", "examples": [ { "title": "Example", @@ -151742,7 +152004,7 @@ "syntaxKind": "PropertySignature", "name": "borderColor", "value": "'' | 'base'", - "description": "Controls the color of the border using the design system's color scale.\n\nWhen set, this overrides the color value specified in the `border` property. Choose from `subdued`, `base`, or `strong` to match the visual emphasis needed.", + "description": "The color of the border using the design system's color scale. Overrides the color value set by `border`.", "isOptional": true, "defaultValue": "'' - meaning no override" }, @@ -151751,7 +152013,7 @@ "syntaxKind": "PropertySignature", "name": "borderRadius", "value": "MaybeAllValuesShorthandProperty>", - "description": "Controls the roundedness of the element's corners using the design system's radius scale.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) using flow-relative values:\n- One value: applies to all corners\n- Two values: applies to start corners (top-left & bottom-right) and end corners (top-right & bottom-left) respectively\n- Three values: applies to start-start (top-left), end corners (top-right & bottom-left), and end-end (bottom-right) respectively\n- Four values: applies to start-start (top-left), start-end (top-right), end-end (bottom-right), and end-start (bottom-left) respectively\n\nExamples:\n- `small-100`: All corners have `small-100` radius\n- `small-100 none`: Top-left and bottom-right are `small-100`, top-right and bottom-left are `none`\n- `small-100 none large-100`: Top-left is `small-100`, top-right and bottom-left are `none`, bottom-right is `large-100`\n- `small-100 none large-100 base`: Each corner has its specified radius value", + "description": "The roundedness of the grid's corners.\n\n- `none`: Sharp corners with no rounding.\n- `small-100` / `small`: Subtle rounding for compact elements.\n- `base`: Standard rounding for most use cases.\n- `large` / `large-100`: More pronounced rounding for prominent containers.\n- `max`: Maximum rounding, creating a pill or circular shape.\n\nSupports 1-to-4-value shorthand syntax for specifying different radii per corner.", "isOptional": true, "defaultValue": "'none'" }, @@ -151769,7 +152031,7 @@ "syntaxKind": "PropertySignature", "name": "borderWidth", "value": "MaybeAllValuesShorthandProperty | ''", - "description": "Controls the thickness of the border on all sides. When set, this overrides the width value specified in the `border` property.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) for specifying different widths per side:\n- One value: applies to all sides\n- Two values: applies to block sides (top/bottom) and inline sides (left/right) respectively\n- Three values: applies to block-start (top), inline sides (left/right), and block-end (bottom) respectively\n- Four values: applies to block-start (top), inline-end (right), block-end (bottom), and inline-start (left) respectively", + "description": "The thickness of the border on all sides. Supports 1-to-4-value shorthand syntax for specifying different widths per side. Overrides the width value set by `border`.", "isOptional": true, "defaultValue": "'' - meaning no override" }, @@ -151787,7 +152049,7 @@ "syntaxKind": "PropertySignature", "name": "display", "value": "MaybeResponsive<\"auto\" | \"none\">", - "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.", + "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.\n\nLearn more about the [display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display).", "isOptional": true, "defaultValue": "'auto'" }, @@ -151823,7 +152085,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -151840,7 +152102,7 @@ "syntaxKind": "PropertySignature", "name": "justifyContent", "value": "MaybeResponsive", - "description": "Aligns the grid along the inline (row) axis.\n\nThis overrides the inline value of `placeContent`.", + "description": "Controls how the grid's columns are distributed along the inline (row) axis when there is extra space. Set to an empty string to use the default.", "isOptional": true, "defaultValue": "'' - meaning no override" }, @@ -151849,7 +152111,7 @@ "syntaxKind": "PropertySignature", "name": "justifyItems", "value": "MaybeResponsive", - "description": "Aligns the grid items along the inline (row) axis.\n\nThis overrides the inline value of `placeItems`.", + "description": "Aligns grid items along the inline (row) axis. Set to an empty string to use the default.", "isOptional": true, "defaultValue": "'' - meaning no override" }, @@ -151966,7 +152228,7 @@ "syntaxKind": "PropertySignature", "name": "placeContent", "value": "MaybeResponsive<`${ReducedAlignContentKeyword} ${ReducedJustifyContentKeyword}` | ReducedAlignContentKeyword>", - "description": "A shorthand property for `justify-content` and `align-content`.", + "description": "A shorthand for `justifyContent` and `alignContent` that sets both distribution axes at once.", "isOptional": true, "defaultValue": "'normal normal'" }, @@ -151975,7 +152237,7 @@ "syntaxKind": "PropertySignature", "name": "placeItems", "value": "MaybeResponsive<`${ReducedAlignItemsKeyword} ${ReducedJustifyItemsKeyword}` | ReducedAlignItemsKeyword>", - "description": "A shorthand property for `justify-items` and `align-items`.", + "description": "A shorthand for `justifyItems` and `alignItems` that sets both alignment axes at once.", "isOptional": true, "defaultValue": "'normal normal'" }, @@ -151989,7 +152251,7 @@ "defaultValue": "'' - meaning no override" } ], - "value": "export interface GridElementProps extends Pick {\n alignContent?: MaybeResponsive;\n alignItems?: MaybeResponsive;\n background?: Extract;\n border?: BorderShorthand;\n borderColor?: ReducedColorKeyword | '';\n borderWidth?: MaybeAllValuesShorthandProperty | '';\n borderRadius?: MaybeAllValuesShorthandProperty>;\n justifyContent?: MaybeResponsive;\n justifyItems?: MaybeResponsive;\n placeContent?: MaybeResponsive<`${ReducedAlignContentKeyword} ${ReducedJustifyContentKeyword}` | ReducedAlignContentKeyword>;\n placeItems?: MaybeResponsive<`${ReducedAlignItemsKeyword} ${ReducedJustifyItemsKeyword}` | ReducedAlignItemsKeyword>;\n}" + "value": "export interface GridElementProps extends Pick {\n /**\n * 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.\n *\n * @default '' - meaning no override\n */\n alignContent?: MaybeResponsive;\n /**\n * Aligns grid items along the block (column) axis. Set to an empty string to use the default.\n *\n * @default '' - meaning no override\n */\n alignItems?: MaybeResponsive;\n /**\n * The background color of the grid.\n *\n * - `base`: The standard background color for general content areas.\n * - `subdued`: A muted background for secondary or supporting content.\n * - `transparent`: No background color (the default).\n *\n * @default 'transparent'\n */\n background?: Extract;\n /**\n * A shorthand for setting the border width, color, and style in a single property. Individual border properties (`borderWidth`, `borderStyle`, `borderColor`) can override values set here.\n *\n * @default 'none'\n */\n border?: BorderShorthand;\n /**\n * The color of the border using the design system's color scale. Overrides the color value set by `border`.\n *\n * @default '' - meaning no override\n */\n borderColor?: ReducedColorKeyword | '';\n /**\n * The thickness of the border on all sides. Supports 1-to-4-value shorthand syntax for specifying different widths per side. Overrides the width value set by `border`.\n *\n * @default '' - meaning no override\n */\n borderWidth?: MaybeAllValuesShorthandProperty | '';\n /**\n * The roundedness of the grid's corners.\n *\n * - `none`: Sharp corners with no rounding.\n * - `small-100` / `small`: Subtle rounding for compact elements.\n * - `base`: Standard rounding for most use cases.\n * - `large` / `large-100`: More pronounced rounding for prominent containers.\n * - `max`: Maximum rounding, creating a pill or circular shape.\n *\n * Supports 1-to-4-value shorthand syntax for specifying different radii per corner.\n *\n * @default 'none'\n */\n borderRadius?: MaybeAllValuesShorthandProperty>;\n /**\n * Controls how the grid's columns are distributed along the inline (row) axis when there is extra space. Set to an empty string to use the default.\n *\n * @default '' - meaning no override\n */\n justifyContent?: MaybeResponsive;\n /**\n * Aligns grid items along the inline (row) axis. Set to an empty string to use the default.\n *\n * @default '' - meaning no override\n */\n justifyItems?: MaybeResponsive;\n /**\n * A shorthand for `justifyContent` and `alignContent` that sets both distribution axes at once.\n *\n * @default 'normal normal'\n */\n placeContent?: MaybeResponsive<`${ReducedAlignContentKeyword} ${ReducedJustifyContentKeyword}` | ReducedAlignContentKeyword>;\n /**\n * A shorthand for `justifyItems` and `alignItems` that sets both alignment axes at once.\n *\n * @default 'normal normal'\n */\n placeItems?: MaybeResponsive<`${ReducedAlignItemsKeyword} ${ReducedJustifyItemsKeyword}` | ReducedAlignItemsKeyword>;\n}" }, { "filePath": "src/surfaces/checkout/components/Grid.ts", @@ -152019,7 +152281,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityVisibility", "value": "'visible' | 'hidden' | 'exclusive'", - "description": "Changes the visibility of the element.\n\n- `visible`: the element is visible to all users.\n- `hidden`: the element is removed from the accessibility tree but remains visible.\n- `exclusive`: the element is visually hidden but remains in the accessibility tree.", + "description": "Controls how the element is exposed to sighted users and to assistive technologies such as screen readers.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", "isOptional": true, "defaultValue": "'visible'" }, @@ -152028,23 +152290,25 @@ "syntaxKind": "PropertySignature", "name": "alignContent", "value": "MaybeResponsive", - "description": "Aligns the grid along the block (column) axis.\n\nThis overrides the block value of `placeContent`.", - "isOptional": true + "description": "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.", + "isOptional": true, + "defaultValue": "'' - meaning no override" }, { "filePath": "src/surfaces/checkout/components/Grid.ts", "syntaxKind": "PropertySignature", "name": "alignItems", "value": "MaybeResponsive", - "description": "Aligns the grid items along the block (column) axis.\n\nThis overrides the block value of `placeItems`.", - "isOptional": true + "description": "Aligns grid items along the block (column) axis. Set to an empty string to use the default.", + "isOptional": true, + "defaultValue": "'' - meaning no override" }, { "filePath": "src/surfaces/checkout/components/Grid.ts", "syntaxKind": "PropertySignature", "name": "background", "value": "'base' | 'subdued' | 'transparent'", - "description": "Adjust the background of the element.\n\n- `'transparent'`: No visible background.\n- `'subdued'`: A subtle, low-emphasis background.\n- `'base'`: The standard background color.\n- `'strong'`: A high-emphasis background for prominence.", + "description": "The background color of the grid.\n\n- `base`: The standard background color for general content areas.\n- `subdued`: A muted background for secondary or supporting content.\n- `transparent`: No background color (the default).", "isOptional": true, "defaultValue": "'transparent'" }, @@ -152062,23 +152326,25 @@ "syntaxKind": "PropertySignature", "name": "border", "value": "BorderShorthand", - "description": "Applies a border using shorthand syntax to specify width, color, and style in a single property.\n\nAccepts a size value, optionally followed by a color, optionally followed by a style. Omitted values use defaults: color defaults to `base`, style defaults to `auto`.\n\nIndividual properties (`borderWidth`, `borderStyle`, `borderColor`) can override values set here.", - "isOptional": true + "description": "A shorthand for setting the border width, color, and style in a single property. Individual border properties (`borderWidth`, `borderStyle`, `borderColor`) can override values set here.", + "isOptional": true, + "defaultValue": "'none'" }, { "filePath": "src/surfaces/checkout/components/Grid.ts", "syntaxKind": "PropertySignature", "name": "borderColor", "value": "'' | 'base'", - "description": "Controls the color of the border using the design system's color scale.\n\nWhen set, this overrides the color value specified in the `border` property. Choose from `subdued`, `base`, or `strong` to match the visual emphasis needed.", - "isOptional": true + "description": "The color of the border using the design system's color scale. Overrides the color value set by `border`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" }, { "filePath": "src/surfaces/checkout/components/Grid.ts", "syntaxKind": "PropertySignature", "name": "borderRadius", "value": "MaybeAllValuesShorthandProperty>", - "description": "Controls the roundedness of the element's corners using the design system's radius scale.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) using flow-relative values:\n- One value: applies to all corners\n- Two values: applies to start corners (top-left & bottom-right) and end corners (top-right & bottom-left) respectively\n- Three values: applies to start-start (top-left), end corners (top-right & bottom-left), and end-end (bottom-right) respectively\n- Four values: applies to start-start (top-left), start-end (top-right), end-end (bottom-right), and end-start (bottom-left) respectively\n\nExamples:\n- `small-100`: All corners have `small-100` radius\n- `small-100 none`: Top-left and bottom-right are `small-100`, top-right and bottom-left are `none`\n- `small-100 none large-100`: Top-left is `small-100`, top-right and bottom-left are `none`, bottom-right is `large-100`\n- `small-100 none large-100 base`: Each corner has its specified radius value", + "description": "The roundedness of the grid's corners.\n\n- `none`: Sharp corners with no rounding.\n- `small-100` / `small`: Subtle rounding for compact elements.\n- `base`: Standard rounding for most use cases.\n- `large` / `large-100`: More pronounced rounding for prominent containers.\n- `max`: Maximum rounding, creating a pill or circular shape.\n\nSupports 1-to-4-value shorthand syntax for specifying different radii per corner.", "isOptional": true, "defaultValue": "'none'" }, @@ -152096,8 +152362,9 @@ "syntaxKind": "PropertySignature", "name": "borderWidth", "value": "MaybeAllValuesShorthandProperty | ''", - "description": "Controls the thickness of the border on all sides. When set, this overrides the width value specified in the `border` property.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) for specifying different widths per side:\n- One value: applies to all sides\n- Two values: applies to block sides (top/bottom) and inline sides (left/right) respectively\n- Three values: applies to block-start (top), inline sides (left/right), and block-end (bottom) respectively\n- Four values: applies to block-start (top), inline-end (right), block-end (bottom), and inline-start (left) respectively", - "isOptional": true + "description": "The thickness of the border on all sides. Supports 1-to-4-value shorthand syntax for specifying different widths per side. Overrides the width value set by `border`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" }, { "filePath": "src/surfaces/checkout/components/Grid.ts", @@ -152113,7 +152380,7 @@ "syntaxKind": "PropertySignature", "name": "display", "value": "MaybeResponsive<\"auto\" | \"none\">", - "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.", + "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.\n\nLearn more about the [display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display).", "isOptional": true, "defaultValue": "'auto'" }, @@ -152149,7 +152416,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -152166,16 +152433,18 @@ "syntaxKind": "PropertySignature", "name": "justifyContent", "value": "MaybeResponsive", - "description": "Aligns the grid along the inline (row) axis.\n\nThis overrides the inline value of `placeContent`.", - "isOptional": true + "description": "Controls how the grid's columns are distributed along the inline (row) axis when there is extra space. Set to an empty string to use the default.", + "isOptional": true, + "defaultValue": "'' - meaning no override" }, { "filePath": "src/surfaces/checkout/components/Grid.ts", "syntaxKind": "PropertySignature", "name": "justifyItems", "value": "MaybeResponsive", - "description": "Aligns the grid items along the inline (row) axis.\n\nThis overrides the inline value of `placeItems`.", - "isOptional": true + "description": "Aligns grid items along the inline (row) axis. Set to an empty string to use the default.", + "isOptional": true, + "defaultValue": "'' - meaning no override" }, { "filePath": "src/surfaces/checkout/components/Grid.ts", @@ -152290,16 +152559,18 @@ "syntaxKind": "PropertySignature", "name": "placeContent", "value": "MaybeResponsive<`${ReducedAlignContentKeyword} ${ReducedJustifyContentKeyword}` | ReducedAlignContentKeyword>", - "description": "A shorthand property for `justify-content` and `align-content`.", - "isOptional": true + "description": "A shorthand for `justifyContent` and `alignContent` that sets both distribution axes at once.", + "isOptional": true, + "defaultValue": "'normal normal'" }, { "filePath": "src/surfaces/checkout/components/Grid.ts", "syntaxKind": "PropertySignature", "name": "placeItems", "value": "MaybeResponsive<`${ReducedAlignItemsKeyword} ${ReducedJustifyItemsKeyword}` | ReducedAlignItemsKeyword>", - "description": "A shorthand property for `justify-items` and `align-items`.", - "isOptional": true + "description": "A shorthand for `justifyItems` and `alignItems` that sets both alignment axes at once.", + "isOptional": true, + "defaultValue": "'normal normal'" }, { "filePath": "src/surfaces/checkout/components/Grid.ts", @@ -152349,7 +152620,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityVisibility", "value": "'visible' | 'hidden' | 'exclusive'", - "description": "Changes the visibility of the element.\n\n- `visible`: the element is visible to all users.\n- `hidden`: the element is removed from the accessibility tree but remains visible.\n- `exclusive`: the element is visually hidden but remains in the accessibility tree.", + "description": "Controls how the element is exposed to sighted users and to assistive technologies such as screen readers.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", "isOptional": true, "defaultValue": "'visible'" }, @@ -152372,7 +152643,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/Grid.ts", @@ -152386,16 +152657,18 @@ "syntaxKind": "PropertySignature", "name": "alignContent", "value": "MaybeResponsive", - "description": "Aligns the grid along the block (column) axis.\n\nThis overrides the block value of `placeContent`.", - "isOptional": true + "description": "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.", + "isOptional": true, + "defaultValue": "'' - meaning no override" }, { "filePath": "src/surfaces/checkout/components/Grid.ts", "syntaxKind": "PropertySignature", "name": "alignItems", "value": "MaybeResponsive", - "description": "Aligns the grid items along the block (column) axis.\n\nThis overrides the block value of `placeItems`.", - "isOptional": true + "description": "Aligns grid items along the block (column) axis. Set to an empty string to use the default.", + "isOptional": true, + "defaultValue": "'' - meaning no override" }, { "filePath": "src/surfaces/checkout/components/Grid.ts", @@ -152843,7 +153116,7 @@ "syntaxKind": "PropertySignature", "name": "background", "value": "'base' | 'subdued' | 'transparent'", - "description": "Adjust the background of the element.\n\n- `'transparent'`: No visible background.\n- `'subdued'`: A subtle, low-emphasis background.\n- `'base'`: The standard background color.\n- `'strong'`: A high-emphasis background for prominence.", + "description": "The background color of the grid.\n\n- `base`: The standard background color for general content areas.\n- `subdued`: A muted background for secondary or supporting content.\n- `transparent`: No background color (the default).", "isOptional": true, "defaultValue": "'transparent'" }, @@ -152882,23 +153155,25 @@ "syntaxKind": "PropertySignature", "name": "border", "value": "BorderShorthand", - "description": "Applies a border using shorthand syntax to specify width, color, and style in a single property.\n\nAccepts a size value, optionally followed by a color, optionally followed by a style. Omitted values use defaults: color defaults to `base`, style defaults to `auto`.\n\nIndividual properties (`borderWidth`, `borderStyle`, `borderColor`) can override values set here.", - "isOptional": true + "description": "A shorthand for setting the border width, color, and style in a single property. Individual border properties (`borderWidth`, `borderStyle`, `borderColor`) can override values set here.", + "isOptional": true, + "defaultValue": "'none'" }, { "filePath": "src/surfaces/checkout/components/Grid.ts", "syntaxKind": "PropertySignature", "name": "borderColor", "value": "'' | 'base'", - "description": "Controls the color of the border using the design system's color scale.\n\nWhen set, this overrides the color value specified in the `border` property. Choose from `subdued`, `base`, or `strong` to match the visual emphasis needed.", - "isOptional": true + "description": "The color of the border using the design system's color scale. Overrides the color value set by `border`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" }, { "filePath": "src/surfaces/checkout/components/Grid.ts", "syntaxKind": "PropertySignature", "name": "borderRadius", "value": "MaybeAllValuesShorthandProperty>", - "description": "Controls the roundedness of the element's corners using the design system's radius scale.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) using flow-relative values:\n- One value: applies to all corners\n- Two values: applies to start corners (top-left & bottom-right) and end corners (top-right & bottom-left) respectively\n- Three values: applies to start-start (top-left), end corners (top-right & bottom-left), and end-end (bottom-right) respectively\n- Four values: applies to start-start (top-left), start-end (top-right), end-end (bottom-right), and end-start (bottom-left) respectively\n\nExamples:\n- `small-100`: All corners have `small-100` radius\n- `small-100 none`: Top-left and bottom-right are `small-100`, top-right and bottom-left are `none`\n- `small-100 none large-100`: Top-left is `small-100`, top-right and bottom-left are `none`, bottom-right is `large-100`\n- `small-100 none large-100 base`: Each corner has its specified radius value", + "description": "The roundedness of the grid's corners.\n\n- `none`: Sharp corners with no rounding.\n- `small-100` / `small`: Subtle rounding for compact elements.\n- `base`: Standard rounding for most use cases.\n- `large` / `large-100`: More pronounced rounding for prominent containers.\n- `max`: Maximum rounding, creating a pill or circular shape.\n\nSupports 1-to-4-value shorthand syntax for specifying different radii per corner.", "isOptional": true, "defaultValue": "'none'" }, @@ -152916,8 +153191,9 @@ "syntaxKind": "PropertySignature", "name": "borderWidth", "value": "MaybeAllValuesShorthandProperty | ''", - "description": "Controls the thickness of the border on all sides. When set, this overrides the width value specified in the `border` property.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) for specifying different widths per side:\n- One value: applies to all sides\n- Two values: applies to block sides (top/bottom) and inline sides (left/right) respectively\n- Three values: applies to block-start (top), inline sides (left/right), and block-end (bottom) respectively\n- Four values: applies to block-start (top), inline-end (right), block-end (bottom), and inline-start (left) respectively", - "isOptional": true + "description": "The thickness of the border on all sides. Supports 1-to-4-value shorthand syntax for specifying different widths per side. Overrides the width value set by `border`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" }, { "filePath": "src/surfaces/checkout/components/Grid.ts", @@ -153094,7 +153370,7 @@ "syntaxKind": "PropertySignature", "name": "display", "value": "MaybeResponsive<\"auto\" | \"none\">", - "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.", + "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.\n\nLearn more about the [display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display).", "isOptional": true, "defaultValue": "'auto'" }, @@ -153390,7 +153666,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -153498,16 +153774,18 @@ "syntaxKind": "PropertySignature", "name": "justifyContent", "value": "MaybeResponsive", - "description": "Aligns the grid along the inline (row) axis.\n\nThis overrides the inline value of `placeContent`.", - "isOptional": true + "description": "Controls how the grid's columns are distributed along the inline (row) axis when there is extra space. Set to an empty string to use the default.", + "isOptional": true, + "defaultValue": "'' - meaning no override" }, { "filePath": "src/surfaces/checkout/components/Grid.ts", "syntaxKind": "PropertySignature", "name": "justifyItems", "value": "MaybeResponsive", - "description": "Aligns the grid items along the inline (row) axis.\n\nThis overrides the inline value of `placeItems`.", - "isOptional": true + "description": "Aligns grid items along the inline (row) axis. Set to an empty string to use the default.", + "isOptional": true, + "defaultValue": "'' - meaning no override" }, { "filePath": "src/surfaces/checkout/components/Grid.ts", @@ -154535,16 +154813,18 @@ "syntaxKind": "PropertySignature", "name": "placeContent", "value": "MaybeResponsive<`${ReducedAlignContentKeyword} ${ReducedJustifyContentKeyword}` | ReducedAlignContentKeyword>", - "description": "A shorthand property for `justify-content` and `align-content`.", - "isOptional": true + "description": "A shorthand for `justifyContent` and `alignContent` that sets both distribution axes at once.", + "isOptional": true, + "defaultValue": "'normal normal'" }, { "filePath": "src/surfaces/checkout/components/Grid.ts", "syntaxKind": "PropertySignature", "name": "placeItems", "value": "MaybeResponsive<`${ReducedAlignItemsKeyword} ${ReducedJustifyItemsKeyword}` | ReducedAlignItemsKeyword>", - "description": "A shorthand property for `justify-items` and `align-items`.", - "isOptional": true + "description": "A shorthand for `justifyItems` and `alignItems` that sets both alignment axes at once.", + "isOptional": true, + "defaultValue": "'normal normal'" }, { "filePath": "src/surfaces/checkout/components/Grid.ts", @@ -154651,7 +154931,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/Grid.ts", @@ -154914,7 +155194,7 @@ { "filePath": "src/surfaces/checkout/components/GridItem.ts", "name": "GridItemElementProps", - "description": "The grid item component represents a single cell within a grid layout, allowing you to control how content is positioned and sized within the grid. Use grid item as a child of grid to specify column span, row span, and positioning for individual content areas.\n\nGrid item supports precise placement control through column and row properties, enabling you to create complex layouts where different items occupy varying amounts of space or appear in specific grid positions.", + "description": "", "isPublicDocs": true, "members": [ { @@ -154939,7 +155219,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityVisibility", "value": "'visible' | 'hidden' | 'exclusive'", - "description": "Changes the visibility of the element.\n\n- `visible`: the element is visible to all users.\n- `hidden`: the element is removed from the accessibility tree but remains visible.\n- `exclusive`: the element is visually hidden but remains in the accessibility tree.", + "description": "Controls how the element is exposed to sighted users and to assistive technologies such as screen readers.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", "isOptional": true, "defaultValue": "'visible'" }, @@ -154948,7 +155228,7 @@ "syntaxKind": "PropertySignature", "name": "background", "value": "'base' | 'subdued' | 'transparent'", - "description": "Adjust the background of the element.\n\n- `'transparent'`: No visible background.\n- `'subdued'`: A subtle, low-emphasis background.\n- `'base'`: The standard background color.\n- `'strong'`: A high-emphasis background for prominence.", + "description": "The background color of the grid item.\n\n- `base`: The standard background color for general content areas.\n- `subdued`: A muted background for secondary or supporting content.\n- `transparent`: No background color (the default).", "isOptional": true, "defaultValue": "'transparent'" }, @@ -154966,9 +155246,9 @@ "syntaxKind": "PropertySignature", "name": "border", "value": "BorderShorthand", - "description": "Applies a border using shorthand syntax to specify width, color, and style in a single property.\n\nAccepts a size value, optionally followed by a color, optionally followed by a style. Omitted values use defaults: color defaults to `base`, style defaults to `auto`.\n\nIndividual properties (`borderWidth`, `borderStyle`, `borderColor`) can override values set here.", + "description": "A shorthand for setting the border width, color, and style in a single property. Individual border properties (`borderWidth`, `borderStyle`, `borderColor`) can override values set here.", "isOptional": true, - "defaultValue": "'none' - equivalent to `none base auto`.", + "defaultValue": "'none'", "examples": [ { "title": "Example", @@ -154987,7 +155267,7 @@ "syntaxKind": "PropertySignature", "name": "borderColor", "value": "'' | 'base'", - "description": "Controls the color of the border using the design system's color scale.\n\nWhen set, this overrides the color value specified in the `border` property. Choose from `subdued`, `base`, or `strong` to match the visual emphasis needed.", + "description": "The color of the border using the design system's color scale. Overrides the color value set by `border`.", "isOptional": true, "defaultValue": "'' - meaning no override" }, @@ -154996,7 +155276,7 @@ "syntaxKind": "PropertySignature", "name": "borderRadius", "value": "MaybeAllValuesShorthandProperty>", - "description": "Controls the roundedness of the element's corners using the design system's radius scale.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) using flow-relative values:\n- One value: applies to all corners\n- Two values: applies to start corners (top-left & bottom-right) and end corners (top-right & bottom-left) respectively\n- Three values: applies to start-start (top-left), end corners (top-right & bottom-left), and end-end (bottom-right) respectively\n- Four values: applies to start-start (top-left), start-end (top-right), end-end (bottom-right), and end-start (bottom-left) respectively\n\nExamples:\n- `small-100`: All corners have `small-100` radius\n- `small-100 none`: Top-left and bottom-right are `small-100`, top-right and bottom-left are `none`\n- `small-100 none large-100`: Top-left is `small-100`, top-right and bottom-left are `none`, bottom-right is `large-100`\n- `small-100 none large-100 base`: Each corner has its specified radius value", + "description": "The roundedness of the grid item's corners.\n\n- `none`: Sharp corners with no rounding.\n- `small-100` / `small`: Subtle rounding for compact elements.\n- `base`: Standard rounding for most use cases.\n- `large` / `large-100`: More pronounced rounding for prominent containers.\n- `max`: Maximum rounding, creating a pill or circular shape.\n\nSupports 1-to-4-value shorthand syntax for specifying different radii per corner.", "isOptional": true, "defaultValue": "'none'" }, @@ -155014,7 +155294,7 @@ "syntaxKind": "PropertySignature", "name": "borderWidth", "value": "MaybeAllValuesShorthandProperty | ''", - "description": "Controls the thickness of the border on all sides. When set, this overrides the width value specified in the `border` property.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) for specifying different widths per side:\n- One value: applies to all sides\n- Two values: applies to block sides (top/bottom) and inline sides (left/right) respectively\n- Three values: applies to block-start (top), inline sides (left/right), and block-end (bottom) respectively\n- Four values: applies to block-start (top), inline-end (right), block-end (bottom), and inline-start (left) respectively", + "description": "The thickness of the border on all sides. Supports 1-to-4-value shorthand syntax for specifying different widths per side. Overrides the width value set by `border`.", "isOptional": true, "defaultValue": "'' - meaning no override" }, @@ -155023,7 +155303,7 @@ "syntaxKind": "PropertySignature", "name": "display", "value": "MaybeResponsive<\"auto\" | \"none\">", - "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.", + "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.\n\nLearn more about the [display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display).", "isOptional": true, "defaultValue": "'auto'" }, @@ -155050,7 +155330,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -155171,7 +155451,7 @@ "defaultValue": "'' - meaning no override" } ], - "value": "export interface GridItemElementProps extends Pick {\n background?: Extract;\n border?: BorderShorthand;\n borderColor?: ReducedColorKeyword | '';\n borderWidth?: MaybeAllValuesShorthandProperty | '';\n borderRadius?: MaybeAllValuesShorthandProperty>;\n}" + "value": "export interface GridItemElementProps extends Pick {\n /**\n * The background color of the grid item.\n *\n * - `base`: The standard background color for general content areas.\n * - `subdued`: A muted background for secondary or supporting content.\n * - `transparent`: No background color (the default).\n *\n * @default 'transparent'\n */\n background?: Extract;\n /**\n * A shorthand for setting the border width, color, and style in a single property. Individual border properties (`borderWidth`, `borderStyle`, `borderColor`) can override values set here.\n *\n * @default 'none'\n */\n border?: BorderShorthand;\n /**\n * The color of the border using the design system's color scale. Overrides the color value set by `border`.\n *\n * @default '' - meaning no override\n */\n borderColor?: ReducedColorKeyword | '';\n /**\n * The thickness of the border on all sides. Supports 1-to-4-value shorthand syntax for specifying different widths per side. Overrides the width value set by `border`.\n *\n * @default '' - meaning no override\n */\n borderWidth?: MaybeAllValuesShorthandProperty | '';\n /**\n * The roundedness of the grid item's corners.\n *\n * - `none`: Sharp corners with no rounding.\n * - `small-100` / `small`: Subtle rounding for compact elements.\n * - `base`: Standard rounding for most use cases.\n * - `large` / `large-100`: More pronounced rounding for prominent containers.\n * - `max`: Maximum rounding, creating a pill or circular shape.\n *\n * Supports 1-to-4-value shorthand syntax for specifying different radii per corner.\n *\n * @default 'none'\n */\n borderRadius?: MaybeAllValuesShorthandProperty>;\n}" }, { "filePath": "src/surfaces/checkout/components/GridItem.ts", @@ -155201,7 +155481,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityVisibility", "value": "'visible' | 'hidden' | 'exclusive'", - "description": "Changes the visibility of the element.\n\n- `visible`: the element is visible to all users.\n- `hidden`: the element is removed from the accessibility tree but remains visible.\n- `exclusive`: the element is visually hidden but remains in the accessibility tree.", + "description": "Controls how the element is exposed to sighted users and to assistive technologies such as screen readers.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", "isOptional": true, "defaultValue": "'visible'" }, @@ -155210,7 +155490,7 @@ "syntaxKind": "PropertySignature", "name": "background", "value": "'base' | 'subdued' | 'transparent'", - "description": "Adjust the background of the element.\n\n- `'transparent'`: No visible background.\n- `'subdued'`: A subtle, low-emphasis background.\n- `'base'`: The standard background color.\n- `'strong'`: A high-emphasis background for prominence.", + "description": "The background color of the grid item.\n\n- `base`: The standard background color for general content areas.\n- `subdued`: A muted background for secondary or supporting content.\n- `transparent`: No background color (the default).", "isOptional": true, "defaultValue": "'transparent'" }, @@ -155228,23 +155508,25 @@ "syntaxKind": "PropertySignature", "name": "border", "value": "BorderShorthand", - "description": "Applies a border using shorthand syntax to specify width, color, and style in a single property.\n\nAccepts a size value, optionally followed by a color, optionally followed by a style. Omitted values use defaults: color defaults to `base`, style defaults to `auto`.\n\nIndividual properties (`borderWidth`, `borderStyle`, `borderColor`) can override values set here.", - "isOptional": true + "description": "A shorthand for setting the border width, color, and style in a single property. Individual border properties (`borderWidth`, `borderStyle`, `borderColor`) can override values set here.", + "isOptional": true, + "defaultValue": "'none'" }, { "filePath": "src/surfaces/checkout/components/GridItem.ts", "syntaxKind": "PropertySignature", "name": "borderColor", "value": "'' | 'base'", - "description": "Controls the color of the border using the design system's color scale.\n\nWhen set, this overrides the color value specified in the `border` property. Choose from `subdued`, `base`, or `strong` to match the visual emphasis needed.", - "isOptional": true + "description": "The color of the border using the design system's color scale. Overrides the color value set by `border`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" }, { "filePath": "src/surfaces/checkout/components/GridItem.ts", "syntaxKind": "PropertySignature", "name": "borderRadius", "value": "MaybeAllValuesShorthandProperty>", - "description": "Controls the roundedness of the element's corners using the design system's radius scale.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) using flow-relative values:\n- One value: applies to all corners\n- Two values: applies to start corners (top-left & bottom-right) and end corners (top-right & bottom-left) respectively\n- Three values: applies to start-start (top-left), end corners (top-right & bottom-left), and end-end (bottom-right) respectively\n- Four values: applies to start-start (top-left), start-end (top-right), end-end (bottom-right), and end-start (bottom-left) respectively\n\nExamples:\n- `small-100`: All corners have `small-100` radius\n- `small-100 none`: Top-left and bottom-right are `small-100`, top-right and bottom-left are `none`\n- `small-100 none large-100`: Top-left is `small-100`, top-right and bottom-left are `none`, bottom-right is `large-100`\n- `small-100 none large-100 base`: Each corner has its specified radius value", + "description": "The roundedness of the grid item's corners.\n\n- `none`: Sharp corners with no rounding.\n- `small-100` / `small`: Subtle rounding for compact elements.\n- `base`: Standard rounding for most use cases.\n- `large` / `large-100`: More pronounced rounding for prominent containers.\n- `max`: Maximum rounding, creating a pill or circular shape.\n\nSupports 1-to-4-value shorthand syntax for specifying different radii per corner.", "isOptional": true, "defaultValue": "'none'" }, @@ -155262,15 +155544,16 @@ "syntaxKind": "PropertySignature", "name": "borderWidth", "value": "MaybeAllValuesShorthandProperty | ''", - "description": "Controls the thickness of the border on all sides. When set, this overrides the width value specified in the `border` property.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) for specifying different widths per side:\n- One value: applies to all sides\n- Two values: applies to block sides (top/bottom) and inline sides (left/right) respectively\n- Three values: applies to block-start (top), inline sides (left/right), and block-end (bottom) respectively\n- Four values: applies to block-start (top), inline-end (right), block-end (bottom), and inline-start (left) respectively", - "isOptional": true + "description": "The thickness of the border on all sides. Supports 1-to-4-value shorthand syntax for specifying different widths per side. Overrides the width value set by `border`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" }, { "filePath": "src/surfaces/checkout/components/GridItem.ts", "syntaxKind": "PropertySignature", "name": "display", "value": "MaybeResponsive<\"auto\" | \"none\">", - "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.", + "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.\n\nLearn more about the [display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display).", "isOptional": true, "defaultValue": "'auto'" }, @@ -155297,7 +155580,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -155448,7 +155731,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityVisibility", "value": "'visible' | 'hidden' | 'exclusive'", - "description": "Changes the visibility of the element.\n\n- `visible`: the element is visible to all users.\n- `hidden`: the element is removed from the accessibility tree but remains visible.\n- `exclusive`: the element is visually hidden but remains in the accessibility tree.", + "description": "Controls how the element is exposed to sighted users and to assistive technologies such as screen readers.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", "isOptional": true, "defaultValue": "'visible'" }, @@ -155471,7 +155754,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/GridItem.ts", @@ -155926,7 +156209,7 @@ "syntaxKind": "PropertySignature", "name": "background", "value": "'base' | 'subdued' | 'transparent'", - "description": "Adjust the background of the element.\n\n- `'transparent'`: No visible background.\n- `'subdued'`: A subtle, low-emphasis background.\n- `'base'`: The standard background color.\n- `'strong'`: A high-emphasis background for prominence.", + "description": "The background color of the grid item.\n\n- `base`: The standard background color for general content areas.\n- `subdued`: A muted background for secondary or supporting content.\n- `transparent`: No background color (the default).", "isOptional": true, "defaultValue": "'transparent'" }, @@ -155965,23 +156248,25 @@ "syntaxKind": "PropertySignature", "name": "border", "value": "BorderShorthand", - "description": "Applies a border using shorthand syntax to specify width, color, and style in a single property.\n\nAccepts a size value, optionally followed by a color, optionally followed by a style. Omitted values use defaults: color defaults to `base`, style defaults to `auto`.\n\nIndividual properties (`borderWidth`, `borderStyle`, `borderColor`) can override values set here.", - "isOptional": true + "description": "A shorthand for setting the border width, color, and style in a single property. Individual border properties (`borderWidth`, `borderStyle`, `borderColor`) can override values set here.", + "isOptional": true, + "defaultValue": "'none'" }, { "filePath": "src/surfaces/checkout/components/GridItem.ts", "syntaxKind": "PropertySignature", "name": "borderColor", "value": "'' | 'base'", - "description": "Controls the color of the border using the design system's color scale.\n\nWhen set, this overrides the color value specified in the `border` property. Choose from `subdued`, `base`, or `strong` to match the visual emphasis needed.", - "isOptional": true + "description": "The color of the border using the design system's color scale. Overrides the color value set by `border`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" }, { "filePath": "src/surfaces/checkout/components/GridItem.ts", "syntaxKind": "PropertySignature", "name": "borderRadius", "value": "MaybeAllValuesShorthandProperty>", - "description": "Controls the roundedness of the element's corners using the design system's radius scale.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) using flow-relative values:\n- One value: applies to all corners\n- Two values: applies to start corners (top-left & bottom-right) and end corners (top-right & bottom-left) respectively\n- Three values: applies to start-start (top-left), end corners (top-right & bottom-left), and end-end (bottom-right) respectively\n- Four values: applies to start-start (top-left), start-end (top-right), end-end (bottom-right), and end-start (bottom-left) respectively\n\nExamples:\n- `small-100`: All corners have `small-100` radius\n- `small-100 none`: Top-left and bottom-right are `small-100`, top-right and bottom-left are `none`\n- `small-100 none large-100`: Top-left is `small-100`, top-right and bottom-left are `none`, bottom-right is `large-100`\n- `small-100 none large-100 base`: Each corner has its specified radius value", + "description": "The roundedness of the grid item's corners.\n\n- `none`: Sharp corners with no rounding.\n- `small-100` / `small`: Subtle rounding for compact elements.\n- `base`: Standard rounding for most use cases.\n- `large` / `large-100`: More pronounced rounding for prominent containers.\n- `max`: Maximum rounding, creating a pill or circular shape.\n\nSupports 1-to-4-value shorthand syntax for specifying different radii per corner.", "isOptional": true, "defaultValue": "'none'" }, @@ -155999,8 +156284,9 @@ "syntaxKind": "PropertySignature", "name": "borderWidth", "value": "MaybeAllValuesShorthandProperty | ''", - "description": "Controls the thickness of the border on all sides. When set, this overrides the width value specified in the `border` property.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) for specifying different widths per side:\n- One value: applies to all sides\n- Two values: applies to block sides (top/bottom) and inline sides (left/right) respectively\n- Three values: applies to block-start (top), inline sides (left/right), and block-end (bottom) respectively\n- Four values: applies to block-start (top), inline-end (right), block-end (bottom), and inline-start (left) respectively", - "isOptional": true + "description": "The thickness of the border on all sides. Supports 1-to-4-value shorthand syntax for specifying different widths per side. Overrides the width value set by `border`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" }, { "filePath": "src/surfaces/checkout/components/GridItem.ts", @@ -156168,7 +156454,7 @@ "syntaxKind": "PropertySignature", "name": "display", "value": "MaybeResponsive<\"auto\" | \"none\">", - "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.", + "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.\n\nLearn more about the [display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display).", "isOptional": true, "defaultValue": "'auto'" }, @@ -156455,7 +156741,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -157684,7 +157970,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/GridItem.ts", @@ -157938,7 +158224,7 @@ { "filePath": "src/surfaces/checkout/components/Heading.ts", "name": "HeadingElementProps", - "description": "The heading component renders hierarchical titles to communicate the structure and organization of page content. Use heading to create section titles and content headers that help users understand information hierarchy and navigate content.\n\nHeading levels adjust automatically based on nesting within parent [section](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/layout-and-structure/section) components, ensuring meaningful and accessible page outlines without manual level management.", + "description": "", "isPublicDocs": true, "members": [ { @@ -157955,7 +158241,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true } ], @@ -157995,7 +158281,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/Heading.ts", @@ -158892,7 +159178,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -160004,7 +160290,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/Heading.ts", @@ -160275,7 +160561,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true } ], @@ -160284,7 +160570,7 @@ { "filePath": "src/surfaces/checkout/components/Image.ts", "name": "ImageElementProps", - "description": "The image component embeds images within the interface with control over presentation and loading behavior. Use image to visually illustrate concepts, showcase products, display user content, or support tasks and interactions with visual context.\n\nImages support responsive sizing, alt text for accessibility, aspect ratio control, and loading states for progressive enhancement. For small preview images in lists or tables, use [thumbnail](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/media-and-visuals/thumbnail). For profile images, use [avatar](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/media-and-visuals/avatar).", + "description": "", "isPublicDocs": true, "members": [ { @@ -160367,7 +160653,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -160427,7 +160713,7 @@ { "filePath": "src/surfaces/checkout/components/Image.ts", "name": "ImageProps", - "description": "The properties for the image component when it's used in JSX.", + "description": "", "isPublicDocs": true, "members": [ { @@ -160496,7 +160782,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -160587,7 +160873,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/Image.ts", @@ -161536,7 +161822,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -162675,7 +162961,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/Image.ts", @@ -162953,7 +163239,7 @@ { "filePath": "src/surfaces/checkout/components/Link.ts", "name": "LinkElementProps", - "description": "The link component makes text interactive, allowing users to navigate to other pages or perform specific actions. Use link for navigation, external references, or triggering actions while maintaining standard link semantics and accessibility.\n\nLinks support standard URLs, custom protocols, navigation within Shopify admin pages, and can open in new windows for external destinations. For prominent actions or form submissions, use [button](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/actions/button) instead.", + "description": "", "isPublicDocs": true, "members": [ { @@ -162969,7 +163255,7 @@ "syntaxKind": "PropertySignature", "name": "command", "value": "'--auto' | '--show' | '--hide' | '--toggle' | '--copy'", - "description": "Sets the action the `commandFor` should take when this clickable is activated.\n\nSee the documentation of particular components for the actions they support.\n\n- `--auto`: Performs the default action for the target component.\n- `--show`: Displays the target component.\n- `--hide`: Conceals the target component.\n- `--toggle`: Alternates the target component.\n- `--copy`: Copies the target ClipboardItem.", + "description": "Sets the action the `commandFor` target should take when this component is activated.\n\n- `--auto`: Performs the default action for the target component.\n- `--show`: Displays the target component.\n- `--hide`: Conceals the target component.\n- `--toggle`: Alternates the target component.\n- `--copy`: Copies the target ClipboardItem.\n\nLearn more about the [`command` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).", "isOptional": true, "defaultValue": "'--auto'" }, @@ -162978,7 +163264,7 @@ "syntaxKind": "PropertySignature", "name": "commandFor", "value": "string", - "description": "ID of a component that should respond to activations (such as clicks) on this component.\n\nSee `command` for how to control the behavior of the target.", + "description": "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).\n\nWhen both `commandFor` and `href` are set, `commandFor` takes precedence. The command runs and the link doesn't navigate.", "isOptional": true }, { @@ -162994,7 +163280,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -163054,7 +163340,7 @@ { "filePath": "src/surfaces/checkout/components/Link.ts", "name": "LinkElementEvents", - "description": "The link component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", + "description": "", "isPublicDocs": true, "members": [ { @@ -163101,7 +163387,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/Link.ts", @@ -163675,7 +163961,7 @@ "syntaxKind": "PropertySignature", "name": "command", "value": "'--auto' | '--show' | '--hide' | '--toggle' | '--copy'", - "description": "Sets the action the `commandFor` should take when this clickable is activated.\n\nSee the documentation of particular components for the actions they support.\n\n- `--auto`: Performs the default action for the target component.\n- `--show`: Displays the target component.\n- `--hide`: Conceals the target component.\n- `--toggle`: Alternates the target component.\n- `--copy`: Copies the target ClipboardItem.", + "description": "Sets the action the `commandFor` target should take when this component is activated.\n\n- `--auto`: Performs the default action for the target component.\n- `--show`: Displays the target component.\n- `--hide`: Conceals the target component.\n- `--toggle`: Alternates the target component.\n- `--copy`: Copies the target ClipboardItem.\n\nLearn more about the [`command` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).", "isOptional": true, "defaultValue": "'--auto'" }, @@ -163684,7 +163970,7 @@ "syntaxKind": "PropertySignature", "name": "commandFor", "value": "string", - "description": "ID of a component that should respond to activations (such as clicks) on this component.\n\nSee `command` for how to control the behavior of the target.", + "description": "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).\n\nWhen both `commandFor` and `href` are set, `commandFor` takes precedence. The command runs and the link doesn't navigate.", "isOptional": true }, { @@ -164023,7 +164309,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -165144,7 +165430,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/Link.ts", @@ -165432,7 +165718,7 @@ "syntaxKind": "PropertySignature", "name": "command", "value": "'--auto' | '--show' | '--hide' | '--toggle' | '--copy'", - "description": "Sets the action the `commandFor` should take when this clickable is activated.\n\nSee the documentation of particular components for the actions they support.\n\n- `--auto`: Performs the default action for the target component.\n- `--show`: Displays the target component.\n- `--hide`: Conceals the target component.\n- `--toggle`: Alternates the target component.\n- `--copy`: Copies the target ClipboardItem.", + "description": "Sets the action the `commandFor` target should take when this component is activated.\n\n- `--auto`: Performs the default action for the target component.\n- `--show`: Displays the target component.\n- `--hide`: Conceals the target component.\n- `--toggle`: Alternates the target component.\n- `--copy`: Copies the target ClipboardItem.\n\nLearn more about the [`command` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).", "isOptional": true, "defaultValue": "'--auto'" }, @@ -165441,7 +165727,7 @@ "syntaxKind": "PropertySignature", "name": "commandFor", "value": "string", - "description": "ID of a component that should respond to activations (such as clicks) on this component.\n\nSee `command` for how to control the behavior of the target.", + "description": "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).\n\nWhen both `commandFor` and `href` are set, `commandFor` takes precedence. The command runs and the link doesn't navigate.", "isOptional": true }, { @@ -165457,7 +165743,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -165508,7 +165794,7 @@ { "filePath": "src/surfaces/checkout/components/ListItem.ts", "name": "ListItemElementProps", - "description": "The list item component represents a single entry within an ordered list or unordered list. Use list item to structure individual points, steps, or items within a list, with each item automatically receiving appropriate list markers (bullets or numbers) from its parent list.\n\nList item must be used as a direct child of ordered list or unordered list components. Each list item can contain text, inline formatting, or other components to create rich list content.", + "description": "", "isPublicDocs": true, "members": [ { @@ -165516,7 +165802,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true } ], @@ -165547,7 +165833,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/ListItem.ts", @@ -166444,7 +166730,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -167556,7 +167842,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/ListItem.ts", @@ -167818,7 +168104,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true } ], @@ -167827,7 +168113,7 @@ { "filePath": "src/surfaces/checkout/components/Map.ts", "name": "MapElementProps", - "description": "Use Map to display a map on a page. This component is useful for displaying a map of a location, such as a store or a customer’s address.", + "description": "", "isPublicDocs": true, "members": [ { @@ -167860,7 +168146,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -167959,7 +168245,7 @@ { "filePath": "src/surfaces/checkout/components/Map.ts", "name": "MapEvents", - "description": "The event handlers for the map component.", + "description": "", "isPublicDocs": true, "members": [ { @@ -168634,7 +168920,7 @@ { "filePath": "src/surfaces/checkout/components/Map.ts", "name": "MapElementEvents", - "description": "Learn more about [registering events](/docs/api/checkout-ui-extensions/latest/using-polaris-components#event-handling).", + "description": "", "isPublicDocs": true, "members": [ { @@ -168705,7 +168991,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/Map.ts", @@ -169619,7 +169905,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -170826,7 +171112,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/Map.ts", @@ -171089,7 +171375,7 @@ { "filePath": "src/surfaces/checkout/components/Map.ts", "name": "MapProps", - "description": "The properties for the map component when it's used in JSX.", + "description": "", "isPublicDocs": true, "members": [ { @@ -171122,7 +171408,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -171287,7 +171573,7 @@ "syntaxKind": "PropertySignature", "name": "command", "value": "'--auto' | '--show' | '--hide' | '--toggle'", - "description": "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).\n\n- `--auto`: a default action for the target component.\n- `--show`: shows the target component.\n- `--hide`: hides the target component.\n- `--toggle`: toggles the target component.", + "description": "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).\n\n- `--auto`: a default action for the target component.\n- `--show`: shows the target component.\n- `--hide`: hides the target component.\n- `--toggle`: toggles the target component.", "isOptional": true, "defaultValue": "'--auto'" }, @@ -171296,7 +171582,7 @@ "syntaxKind": "PropertySignature", "name": "commandFor", "value": "string", - "description": "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).", + "description": "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).", "isOptional": true }, { @@ -171327,12 +171613,12 @@ "defaultValue": "0" } ], - "value": "export interface MapMarkerElementProps extends Pick {\n /**\n * 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).\n *\n * - `--auto`: a default action for the target component.\n * - `--show`: shows the target component.\n * - `--hide`: hides the target component.\n * - `--toggle`: toggles the target component.\n *\n * @default '--auto'\n */\n command?: Extract;\n /**\n * 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).\n */\n commandFor?: MapMarkerProps$1['commandFor'];\n}" + "value": "export interface MapMarkerElementProps extends Pick {\n /**\n * 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).\n *\n * - `--auto`: a default action for the target component.\n * - `--show`: shows the target component.\n * - `--hide`: hides the target component.\n * - `--toggle`: toggles the target component.\n *\n * @default '--auto'\n */\n command?: Extract;\n /**\n * 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).\n */\n commandFor?: MapMarkerProps$1['commandFor'];\n}" }, { "filePath": "src/surfaces/checkout/components/MapMarker.ts", "name": "MapMarkerEvents", - "description": "The event handlers for the map marker component.", + "description": "", "isPublicDocs": true, "members": [ { @@ -171366,7 +171652,7 @@ { "filePath": "src/surfaces/checkout/components/MapMarker.ts", "name": "MapMarkerElementSlots", - "description": "The named slots for the map marker component. Slots allow you to insert custom content into specific areas of the marker.", + "description": "", "isPublicDocs": true, "members": [ { @@ -171413,7 +171699,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/MapMarker.ts", @@ -172005,7 +172291,7 @@ "syntaxKind": "PropertySignature", "name": "command", "value": "'--auto' | '--show' | '--hide' | '--toggle'", - "description": "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).\n\n- `--auto`: a default action for the target component.\n- `--show`: shows the target component.\n- `--hide`: hides the target component.\n- `--toggle`: toggles the target component.", + "description": "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).\n\n- `--auto`: a default action for the target component.\n- `--show`: shows the target component.\n- `--hide`: hides the target component.\n- `--toggle`: toggles the target component.", "isOptional": true, "defaultValue": "'--auto'" }, @@ -172014,7 +172300,7 @@ "syntaxKind": "PropertySignature", "name": "commandFor", "value": "string", - "description": "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).", + "description": "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).", "isOptional": true }, { @@ -173476,7 +173762,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/MapMarker.ts", @@ -173730,7 +174016,7 @@ { "filePath": "src/surfaces/checkout/components/MapMarker.ts", "name": "MapMarkerProps", - "description": "The properties for the map marker component when it's used in JSX.", + "description": "", "isPublicDocs": true, "members": [ { @@ -173764,7 +174050,7 @@ "syntaxKind": "PropertySignature", "name": "command", "value": "'--auto' | '--show' | '--hide' | '--toggle'", - "description": "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).\n\n- `--auto`: a default action for the target component.\n- `--show`: shows the target component.\n- `--hide`: hides the target component.\n- `--toggle`: toggles the target component.", + "description": "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).\n\n- `--auto`: a default action for the target component.\n- `--show`: shows the target component.\n- `--hide`: hides the target component.\n- `--toggle`: toggles the target component.", "isOptional": true, "defaultValue": "'--auto'" }, @@ -173773,7 +174059,7 @@ "syntaxKind": "PropertySignature", "name": "commandFor", "value": "string", - "description": "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).", + "description": "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).", "isOptional": true }, { @@ -173817,7 +174103,7 @@ { "filePath": "src/surfaces/checkout/components/Modal.ts", "name": "ModalElementProps", - "description": "The modal component displays content in an overlay. Use to create a distraction-free experience such as a confirmation dialog or a settings panel.\n\nA button triggers the modal using the `commandFor` attribute. Content within the modal scrolls if it exceeds available height.", + "description": "", "isPublicDocs": true, "members": [ { @@ -173841,7 +174127,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -173868,7 +174154,7 @@ { "filePath": "src/surfaces/checkout/components/Modal.ts", "name": "ModalElementSlots", - "description": "Learn more about [component slots](/docs/api/checkout-ui-extensions/latest/using-polaris-components#slots).", + "description": "", "isPublicDocs": true, "members": [ { @@ -173893,7 +174179,7 @@ { "filePath": "src/surfaces/checkout/components/Modal.ts", "name": "ModalEvents", - "description": "The event callbacks for monitoring modal visibility changes.", + "description": "", "isPublicDocs": true, "members": [ { @@ -173934,7 +174220,7 @@ { "filePath": "src/surfaces/checkout/components/Modal.ts", "name": "ModalElementMethods", - "description": "Learn more about [component methods](/docs/api/checkout-ui-extensions/latest/using-polaris-components#methods).", + "description": "", "isPublicDocs": true, "members": [ { @@ -173950,7 +174236,7 @@ { "filePath": "src/surfaces/checkout/components/Modal.ts", "name": "ModalElementEvents", - "description": "Learn more about [registering events](/docs/api/checkout-ui-extensions/latest/using-polaris-components#event-handling).", + "description": "", "isPublicDocs": true, "members": [ { @@ -174021,7 +174307,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/Modal.ts", @@ -174933,7 +175219,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -176082,7 +176368,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/Modal.ts", @@ -176345,7 +176631,7 @@ { "filePath": "src/surfaces/checkout/components/Modal.ts", "name": "ModalProps", - "description": "The properties for the modal component when it's used in JSX.", + "description": "", "isPublicDocs": true, "members": [ { @@ -176369,7 +176655,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -176428,7 +176714,7 @@ { "filePath": "src/surfaces/checkout/components/MoneyField.ts", "name": "MoneyFieldElementProps", - "description": "The money field component collects monetary values from users with built-in currency formatting and validation. Use money field for prices, costs, or financial amounts to provide proper currency symbols, decimal handling, and numeric validation.\n\nMoney fields support currency codes, automatic formatting, and min/max constraints to ensure users enter valid monetary values. For non-currency numeric input, use [number field](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/forms/number-field).", + "description": "", "isPublicDocs": true, "members": [ { @@ -176436,7 +176722,7 @@ "syntaxKind": "PropertySignature", "name": "autocomplete", "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", "isOptional": true, "defaultValue": "'on' for everything else" }, @@ -176445,7 +176731,7 @@ "syntaxKind": "PropertySignature", "name": "defaultValue", "value": "string", - "description": "The default value for the field.", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces this value.", "isOptional": true }, { @@ -176453,7 +176739,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -176462,7 +176748,7 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -176470,7 +176756,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -176478,7 +176764,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Content to use as the field label.", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", "isOptional": true }, { @@ -176486,7 +176772,7 @@ "syntaxKind": "PropertySignature", "name": "labelAccessibilityVisibility", "value": "'visible' | 'exclusive'", - "description": "Changes the visibility of the component's label.\n\n- `visible`: the label is visible to all users.\n- `exclusive`: the label is visually hidden but remains in the accessibility tree.", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone.\n- `exclusive`: The label is visually hidden but still announced by screen readers.", "isOptional": true, "defaultValue": "'visible'" }, @@ -176513,7 +176799,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -176521,7 +176807,7 @@ "syntaxKind": "PropertySignature", "name": "readOnly", "value": "boolean", - "description": "The field cannot be edited by the user. It is focusable will be announced by screen readers.", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", "isOptional": true, "defaultValue": "false" }, @@ -176573,7 +176859,7 @@ "syntaxKind": "PropertySignature", "name": "onChange", "value": "(event: Event) => void", - "description": "Callback when the user has **finished editing** a field, for example, once they have blurred the field.", + "description": "A callback fired when the user has **finished editing** a field, such as when they blur the field or press Enter.", "isOptional": true }, { @@ -176589,7 +176875,7 @@ "syntaxKind": "PropertySignature", "name": "onInput", "value": "(event: Event) => void", - "description": "Callback when the user makes any changes in the field.", + "description": "A callback fired when the user makes any changes in the field, such as typing a character.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).", "isOptional": true } ], @@ -176598,7 +176884,7 @@ { "filePath": "src/surfaces/checkout/components/MoneyField.ts", "name": "MoneyFieldElementEvents", - "description": "Learn more about [registering events](/docs/api/checkout-ui-extensions/latest/using-polaris-components#event-handling).", + "description": "", "isPublicDocs": true, "members": [ { @@ -176606,7 +176892,7 @@ "syntaxKind": "PropertySignature", "name": "blur", "value": "CallbackEventListener", - "description": "A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "description": "<<<<<<< HEAD A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n======= A callback fired when the money field loses focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) \n Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", "isOptional": true }, { @@ -176614,7 +176900,7 @@ "syntaxKind": "PropertySignature", "name": "change", "value": "CallbackEventListener", - "description": "Callback when the user has **finished editing** a field, for example, once they have blurred the field.", + "description": "<<<<<<< HEAD Callback when the user has **finished editing** a field, for example, once they have blurred the field.\n======= A callback fired when the money field value changes.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) \n Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", "isOptional": true }, { @@ -176622,7 +176908,7 @@ "syntaxKind": "PropertySignature", "name": "focus", "value": "CallbackEventListener", - "description": "A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "description": "<<<<<<< HEAD A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n======= A callback fired when the money field receives focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) \n Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", "isOptional": true }, { @@ -176630,11 +176916,11 @@ "syntaxKind": "PropertySignature", "name": "input", "value": "CallbackEventListener", - "description": "Callback when the user makes any changes in the field.", + "description": "A callback fired when the user inputs data into the money field.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).", "isOptional": true } ], - "value": "export interface MoneyFieldElementEvents {\n /**\n * A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event\n */\n blur?: CallbackEventListener;\n /**\n * Callback when the user has **finished editing** a field, for example, once they have blurred the field.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event\n */\n change?: CallbackEventListener;\n /**\n * A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event\n */\n focus?: CallbackEventListener;\n /**\n * Callback when the user makes any changes in the field.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event\n */\n input?: CallbackEventListener;\n}" + "value": "export interface MoneyFieldElementEvents {\n /**\n<<<<<<< HEAD\n * A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n=======\n * A callback fired when the money field loses focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality)\n *\n * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur?: CallbackEventListener;\n /**\n<<<<<<< HEAD\n * Callback when the user has **finished editing** a field, for example, once they have blurred the field.\n=======\n * A callback fired when the money field value changes.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality)\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change?: CallbackEventListener;\n /**\n<<<<<<< HEAD\n * A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n=======\n * A callback fired when the money field receives focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality)\n *\n * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus?: CallbackEventListener;\n /**\n * A callback fired when the user inputs data into the money field.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input?: CallbackEventListener;\n}" }, { "filePath": "src/surfaces/checkout/components/MoneyField.ts", @@ -176647,7 +176933,7 @@ "syntaxKind": "PropertySignature", "name": "autocomplete", "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", "isOptional": true, "defaultValue": "'on' for everything else" }, @@ -176656,7 +176942,7 @@ "syntaxKind": "PropertySignature", "name": "defaultValue", "value": "string", - "description": "The default value for the field.", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces this value.", "isOptional": true }, { @@ -176664,7 +176950,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -176673,7 +176959,7 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -176681,7 +176967,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -176689,7 +176975,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Content to use as the field label.", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", "isOptional": true }, { @@ -176697,7 +176983,7 @@ "syntaxKind": "PropertySignature", "name": "labelAccessibilityVisibility", "value": "'visible' | 'exclusive'", - "description": "Changes the visibility of the component's label.\n\n- `visible`: the label is visible to all users.\n- `exclusive`: the label is visually hidden but remains in the accessibility tree.", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone.\n- `exclusive`: The label is visually hidden but still announced by screen readers.", "isOptional": true, "defaultValue": "'visible'" }, @@ -176724,7 +177010,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -176760,7 +177046,7 @@ "syntaxKind": "PropertySignature", "name": "readOnly", "value": "boolean", - "description": "The field cannot be edited by the user. It is focusable will be announced by screen readers.", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", "isOptional": true, "defaultValue": "false" }, @@ -176804,7 +177090,7 @@ "syntaxKind": "PropertySignature", "name": "autocomplete", "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", "isOptional": true, "defaultValue": "'on' for everything else" }, @@ -176813,7 +177099,7 @@ "syntaxKind": "PropertySignature", "name": "defaultValue", "value": "string", - "description": "The default value for the field.", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces this value.", "isOptional": true }, { @@ -176821,7 +177107,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -176830,7 +177116,7 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -176838,7 +177124,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -176846,7 +177132,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Content to use as the field label.", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", "isOptional": true }, { @@ -176854,7 +177140,7 @@ "syntaxKind": "PropertySignature", "name": "labelAccessibilityVisibility", "value": "'visible' | 'exclusive'", - "description": "Changes the visibility of the component's label.\n\n- `visible`: the label is visible to all users.\n- `exclusive`: the label is visually hidden but remains in the accessibility tree.", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone.\n- `exclusive`: The label is visually hidden but still announced by screen readers.", "isOptional": true, "defaultValue": "'visible'" }, @@ -176881,7 +177167,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -176897,7 +177183,7 @@ "syntaxKind": "PropertySignature", "name": "onChange", "value": "(event: Event) => void", - "description": "Callback when the user has **finished editing** a field, for example, once they have blurred the field.", + "description": "A callback fired when the user has **finished editing** a field, such as when they blur the field or press Enter.", "isOptional": true }, { @@ -176913,7 +177199,7 @@ "syntaxKind": "PropertySignature", "name": "onInput", "value": "(event: Event) => void", - "description": "Callback when the user makes any changes in the field.", + "description": "A callback fired when the user makes any changes in the field, such as typing a character.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).", "isOptional": true }, { @@ -176921,7 +177207,7 @@ "syntaxKind": "PropertySignature", "name": "readOnly", "value": "boolean", - "description": "The field cannot be edited by the user. It is focusable will be announced by screen readers.", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", "isOptional": true, "defaultValue": "false" }, @@ -176957,7 +177243,7 @@ { "filePath": "src/surfaces/checkout/components/NumberField.ts", "name": "NumberFieldElementProps", - "description": "The number field component captures numeric input with built-in number validation. Use it to collect quantities, prices, or other numeric information.\n\nThe component supports min/max constraints and step increments for guided numeric entry. For monetary values with currency formatting, use [money field](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/forms/money-field).", + "description": "", "isPublicDocs": true, "members": [ { @@ -176965,7 +177251,7 @@ "syntaxKind": "PropertySignature", "name": "autocomplete", "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", "isOptional": true, "defaultValue": "'on' for everything else" }, @@ -176983,7 +177269,7 @@ "syntaxKind": "PropertySignature", "name": "defaultValue", "value": "string", - "description": "The default value for the field.", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces this value.", "isOptional": true }, { @@ -176991,7 +177277,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -177000,7 +177286,7 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -177017,7 +177303,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -177034,7 +177320,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Content to use as the field label.", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", "isOptional": true }, { @@ -177042,7 +177328,7 @@ "syntaxKind": "PropertySignature", "name": "labelAccessibilityVisibility", "value": "'visible' | 'exclusive'", - "description": "Changes the visibility of the component's label.\n\n- `visible`: the label is visible to all users.\n- `exclusive`: the label is visually hidden but remains in the accessibility tree.", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone.\n- `exclusive`: The label is visually hidden but still announced by screen readers.", "isOptional": true, "defaultValue": "'visible'" }, @@ -177069,7 +177355,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -177087,7 +177373,7 @@ "syntaxKind": "PropertySignature", "name": "prefix", "value": "string", - "description": "A value to be displayed immediately before the editable portion of the field.\n\nThis is useful for displaying an implied part of the value, such as \"https://\" or \"+353\".\n\nThis cannot be edited by the user, and it isn't included in the value of the field.\n\nIt may not be displayed until the user has interacted with the input. For example, an inline label may take the place of the prefix until the user focuses the input.", + "description": "A value to be displayed immediately before the editable portion of the field.\n\nThis is useful for displaying an implied part of the value, such as \"https://\" or \"+353\".\n\nThis can't be edited by the user, and it isn't included in the value of the field.\n\nIt may not be displayed until the user has interacted with the input. For example, an inline label may take the place of the prefix until the user focuses the input.", "isOptional": true, "defaultValue": "''" }, @@ -177096,7 +177382,7 @@ "syntaxKind": "PropertySignature", "name": "readOnly", "value": "boolean", - "description": "The field cannot be edited by the user. It is focusable will be announced by screen readers.", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", "isOptional": true, "defaultValue": "false" }, @@ -177123,7 +177409,7 @@ "syntaxKind": "PropertySignature", "name": "suffix", "value": "string", - "description": "A value to be displayed immediately after the editable portion of the field.\n\nThis is useful for displaying an implied part of the value, such as \"@shopify.com\", or \"%\".\n\nThis cannot be edited by the user, and it isn't included in the value of the field.\n\nIt may not be displayed until the user has interacted with the input. For example, an inline label may take the place of the suffix until the user focuses the input.", + "description": "A value to be displayed immediately after the editable portion of the field.\n\nThis is useful for displaying an implied part of the value, such as \"@shopify.com\", or \"%\".\n\nThis can't be edited by the user, and it isn't included in the value of the field.\n\nIt may not be displayed until the user has interacted with the input. For example, an inline label may take the place of the suffix until the user focuses the input.", "isOptional": true, "defaultValue": "''" }, @@ -177157,7 +177443,7 @@ "syntaxKind": "PropertySignature", "name": "onChange", "value": "(event: Event) => void", - "description": "Callback when the user has **finished editing** a field, for example, once they have blurred the field.", + "description": "A callback fired when the user has **finished editing** a field, such as when they blur the field or press Enter.", "isOptional": true }, { @@ -177173,7 +177459,7 @@ "syntaxKind": "PropertySignature", "name": "onInput", "value": "(event: Event) => void", - "description": "Callback when the user makes any changes in the field.", + "description": "A callback fired when the user makes any changes in the field, such as typing a character.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).", "isOptional": true } ], @@ -177182,7 +177468,7 @@ { "filePath": "src/surfaces/checkout/components/NumberField.ts", "name": "NumberFieldElementEvents", - "description": "Learn more about [registering events](/docs/api/checkout-ui-extensions/latest/using-polaris-components#event-handling).", + "description": "", "isPublicDocs": true, "members": [ { @@ -177190,7 +177476,7 @@ "syntaxKind": "PropertySignature", "name": "blur", "value": "CallbackEventListener", - "description": "A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "description": "<<<<<<< HEAD A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n======= A callback fired when the number field loses focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) \n Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", "isOptional": true }, { @@ -177198,7 +177484,7 @@ "syntaxKind": "PropertySignature", "name": "change", "value": "CallbackEventListener", - "description": "Callback when the user has **finished editing** a field, for example, once they have blurred the field.", + "description": "<<<<<<< HEAD Callback when the user has **finished editing** a field, for example, once they have blurred the field.\n======= A callback fired when the number field value changes.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) \n Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", "isOptional": true }, { @@ -177206,7 +177492,7 @@ "syntaxKind": "PropertySignature", "name": "focus", "value": "CallbackEventListener", - "description": "A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "description": "<<<<<<< HEAD A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n======= A callback fired when the number field receives focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) \n Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", "isOptional": true }, { @@ -177214,16 +177500,16 @@ "syntaxKind": "PropertySignature", "name": "input", "value": "CallbackEventListener", - "description": "Callback when the user makes any changes in the field.", + "description": "A callback fired when the user inputs data into the number field.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).", "isOptional": true } ], - "value": "export interface NumberFieldElementEvents {\n /**\n * A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event\n */\n blur?: CallbackEventListener;\n /**\n * Callback when the user has **finished editing** a field, for example, once they have blurred the field.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event\n */\n change?: CallbackEventListener;\n /**\n * A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event\n */\n focus?: CallbackEventListener;\n /**\n * Callback when the user makes any changes in the field.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event\n */\n input?: CallbackEventListener;\n}" + "value": "export interface NumberFieldElementEvents {\n /**\n<<<<<<< HEAD\n * A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n=======\n * A callback fired when the number field loses focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality)\n *\n * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur?: CallbackEventListener;\n /**\n<<<<<<< HEAD\n * Callback when the user has **finished editing** a field, for example, once they have blurred the field.\n=======\n * A callback fired when the number field value changes.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality)\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change?: CallbackEventListener;\n /**\n<<<<<<< HEAD\n * A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n=======\n * A callback fired when the number field receives focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality)\n *\n * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus?: CallbackEventListener;\n /**\n * A callback fired when the user inputs data into the number field.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input?: CallbackEventListener;\n}" }, { "filePath": "src/surfaces/checkout/components/NumberField.ts", "name": "NumberFieldElementSlots", - "description": "Learn more about [component slots](/docs/api/checkout-ui-extensions/latest/using-polaris-components#slots).", + "description": "", "isPublicDocs": true, "members": [ { @@ -177231,11 +177517,11 @@ "syntaxKind": "PropertySignature", "name": "accessory", "value": "HTMLElement", - "description": "Additional content to be displayed in the field. Commonly used to display an icon that activates a tooltip providing more information.", + "description": "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.", "isOptional": true } ], - "value": "export interface NumberFieldElementSlots {\n /**\n * Additional content to be displayed in the field.\n * Commonly used to display an icon that activates a tooltip providing more information.\n */\n accessory?: HTMLElement;\n}" + "value": "export interface NumberFieldElementSlots {\n /**\n * 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.\n */\n accessory?: HTMLElement;\n}" }, { "filePath": "src/surfaces/checkout/components/NumberField.ts", @@ -177262,7 +177548,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/NumberField.ts", @@ -177703,7 +177989,7 @@ "syntaxKind": "PropertySignature", "name": "autocomplete", "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", "isOptional": true, "defaultValue": "'on' for everything else" }, @@ -177903,7 +178189,7 @@ "syntaxKind": "PropertySignature", "name": "defaultValue", "value": "string", - "description": "The default value for the field.", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces this value.", "isOptional": true }, { @@ -177918,7 +178204,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -178032,7 +178318,7 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -178210,7 +178496,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -178311,7 +178597,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Content to use as the field label.", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", "isOptional": true }, { @@ -178319,7 +178605,7 @@ "syntaxKind": "PropertySignature", "name": "labelAccessibilityVisibility", "value": "'visible' | 'exclusive'", - "description": "Changes the visibility of the component's label.\n\n- `visible`: the label is visible to all users.\n- `exclusive`: the label is visually hidden but remains in the accessibility tree.", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone.\n- `exclusive`: The label is visually hidden but still announced by screen readers.", "isOptional": true, "defaultValue": "'visible'" }, @@ -178395,7 +178681,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -179284,7 +179570,7 @@ "syntaxKind": "PropertySignature", "name": "prefix", "value": "string", - "description": "A value to be displayed immediately before the editable portion of the field.\n\nThis is useful for displaying an implied part of the value, such as \"https://\" or \"+353\".\n\nThis cannot be edited by the user, and it isn't included in the value of the field.\n\nIt may not be displayed until the user has interacted with the input. For example, an inline label may take the place of the prefix until the user focuses the input.", + "description": "A value to be displayed immediately before the editable portion of the field.\n\nThis is useful for displaying an implied part of the value, such as \"https://\" or \"+353\".\n\nThis can't be edited by the user, and it isn't included in the value of the field.\n\nIt may not be displayed until the user has interacted with the input. For example, an inline label may take the place of the prefix until the user focuses the input.", "isOptional": true, "defaultValue": "''" }, @@ -179337,7 +179623,7 @@ "syntaxKind": "PropertySignature", "name": "readOnly", "value": "boolean", - "description": "The field cannot be edited by the user. It is focusable will be announced by screen readers.", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", "isOptional": true, "defaultValue": "false" }, @@ -179388,7 +179674,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/NumberField.ts", @@ -179588,7 +179874,7 @@ "syntaxKind": "PropertySignature", "name": "suffix", "value": "string", - "description": "A value to be displayed immediately after the editable portion of the field.\n\nThis is useful for displaying an implied part of the value, such as \"@shopify.com\", or \"%\".\n\nThis cannot be edited by the user, and it isn't included in the value of the field.\n\nIt may not be displayed until the user has interacted with the input. For example, an inline label may take the place of the suffix until the user focuses the input.", + "description": "A value to be displayed immediately after the editable portion of the field.\n\nThis is useful for displaying an implied part of the value, such as \"@shopify.com\", or \"%\".\n\nThis can't be edited by the user, and it isn't included in the value of the field.\n\nIt may not be displayed until the user has interacted with the input. For example, an inline label may take the place of the suffix until the user focuses the input.", "isOptional": true, "defaultValue": "''" }, @@ -179685,7 +179971,7 @@ "syntaxKind": "PropertySignature", "name": "autocomplete", "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", "isOptional": true, "defaultValue": "'on' for everything else" }, @@ -179703,7 +179989,7 @@ "syntaxKind": "PropertySignature", "name": "defaultValue", "value": "string", - "description": "The default value for the field.", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces this value.", "isOptional": true }, { @@ -179711,7 +179997,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -179720,7 +180006,7 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -179736,7 +180022,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -179753,7 +180039,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Content to use as the field label.", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", "isOptional": true }, { @@ -179761,7 +180047,7 @@ "syntaxKind": "PropertySignature", "name": "labelAccessibilityVisibility", "value": "'visible' | 'exclusive'", - "description": "Changes the visibility of the component's label.\n\n- `visible`: the label is visible to all users.\n- `exclusive`: the label is visually hidden but remains in the accessibility tree.", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone.\n- `exclusive`: The label is visually hidden but still announced by screen readers.", "isOptional": true, "defaultValue": "'visible'" }, @@ -179788,7 +180074,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -179804,7 +180090,7 @@ "syntaxKind": "PropertySignature", "name": "onChange", "value": "(event: Event) => void", - "description": "Callback when the user has **finished editing** a field, for example, once they have blurred the field.", + "description": "A callback fired when the user has **finished editing** a field, such as when they blur the field or press Enter.", "isOptional": true }, { @@ -179820,7 +180106,7 @@ "syntaxKind": "PropertySignature", "name": "onInput", "value": "(event: Event) => void", - "description": "Callback when the user makes any changes in the field.", + "description": "A callback fired when the user makes any changes in the field, such as typing a character.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).", "isOptional": true }, { @@ -179838,7 +180124,7 @@ "syntaxKind": "PropertySignature", "name": "prefix", "value": "string", - "description": "A value to be displayed immediately before the editable portion of the field.\n\nThis is useful for displaying an implied part of the value, such as \"https://\" or \"+353\".\n\nThis cannot be edited by the user, and it isn't included in the value of the field.\n\nIt may not be displayed until the user has interacted with the input. For example, an inline label may take the place of the prefix until the user focuses the input.", + "description": "A value to be displayed immediately before the editable portion of the field.\n\nThis is useful for displaying an implied part of the value, such as \"https://\" or \"+353\".\n\nThis can't be edited by the user, and it isn't included in the value of the field.\n\nIt may not be displayed until the user has interacted with the input. For example, an inline label may take the place of the prefix until the user focuses the input.", "isOptional": true, "defaultValue": "''" }, @@ -179847,7 +180133,7 @@ "syntaxKind": "PropertySignature", "name": "readOnly", "value": "boolean", - "description": "The field cannot be edited by the user. It is focusable will be announced by screen readers.", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", "isOptional": true, "defaultValue": "false" }, @@ -179874,7 +180160,7 @@ "syntaxKind": "PropertySignature", "name": "suffix", "value": "string", - "description": "A value to be displayed immediately after the editable portion of the field.\n\nThis is useful for displaying an implied part of the value, such as \"@shopify.com\", or \"%\".\n\nThis cannot be edited by the user, and it isn't included in the value of the field.\n\nIt may not be displayed until the user has interacted with the input. For example, an inline label may take the place of the suffix until the user focuses the input.", + "description": "A value to be displayed immediately after the editable portion of the field.\n\nThis is useful for displaying an implied part of the value, such as \"@shopify.com\", or \"%\".\n\nThis can't be edited by the user, and it isn't included in the value of the field.\n\nIt may not be displayed until the user has interacted with the input. For example, an inline label may take the place of the suffix until the user focuses the input.", "isOptional": true, "defaultValue": "''" }, @@ -179892,7 +180178,7 @@ { "filePath": "src/surfaces/checkout/components/Option.ts", "name": "OptionElementProps", - "description": "Represents a single option within a select component. Use only as a child of `s-select` components.", + "description": "", "isPublicDocs": true, "members": [ { @@ -179908,7 +180194,7 @@ "syntaxKind": "PropertySignature", "name": "defaultSelected", "value": "boolean", - "description": "Whether the control is active by default.", + "description": "Whether the control is selected by default.", "isOptional": true, "defaultValue": "false" }, @@ -179917,7 +180203,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the control, disallowing any interaction.", + "description": "Whether the control is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -179926,7 +180212,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -179934,7 +180220,7 @@ "syntaxKind": "PropertySignature", "name": "selected", "value": "boolean", - "description": "Whether the control is active.", + "description": "Whether the control is currently selected.", "isOptional": true, "defaultValue": "false" }, @@ -179982,7 +180268,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/Option.ts", @@ -180605,7 +180891,7 @@ "syntaxKind": "PropertySignature", "name": "defaultSelected", "value": "boolean", - "description": "Whether the control is active by default.", + "description": "Whether the control is selected by default.", "isOptional": true, "defaultValue": "false" }, @@ -180621,7 +180907,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the control, disallowing any interaction.", + "description": "Whether the control is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -180897,7 +181183,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -182009,7 +182295,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/Option.ts", @@ -182114,7 +182400,7 @@ "syntaxKind": "PropertySignature", "name": "selected", "value": "boolean", - "description": "Whether the control is active.", + "description": "Whether the control is currently selected.", "isOptional": true, "defaultValue": "false" }, @@ -182296,7 +182582,7 @@ "syntaxKind": "PropertySignature", "name": "defaultSelected", "value": "boolean", - "description": "Whether the control is active by default.", + "description": "Whether the control is selected by default.", "isOptional": true, "defaultValue": "false" }, @@ -182305,7 +182591,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the control, disallowing any interaction.", + "description": "Whether the control is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -182314,7 +182600,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -182322,7 +182608,7 @@ "syntaxKind": "PropertySignature", "name": "selected", "value": "boolean", - "description": "Whether the control is active.", + "description": "Whether the control is currently selected.", "isOptional": true, "defaultValue": "false" }, @@ -182340,7 +182626,7 @@ { "filePath": "src/surfaces/checkout/components/Paragraph.ts", "name": "ParagraphElementProps", - "description": "The paragraph component displays blocks of text content and can contain inline elements like buttons, links, or emphasized text. Use paragraph to present standalone blocks of readable content, descriptions, or explanatory text.\n\nParagraphs support alignment options and can wrap inline components to create rich, formatted content blocks. For inline text styling, use [text](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/typography-and-content/text).", + "description": "", "isPublicDocs": true, "members": [ { @@ -182348,7 +182634,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityVisibility", "value": "'visible' | 'hidden' | 'exclusive'", - "description": "Changes the visibility of the element.\n\n- `visible`: the element is visible to all users.\n- `hidden`: the element is removed from the accessibility tree but remains visible.\n- `exclusive`: the element is visually hidden but remains in the accessibility tree.", + "description": "Controls how the element is exposed to sighted users and to assistive technologies such as screen readers.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", "isOptional": true, "defaultValue": "'visible'" }, @@ -182357,7 +182643,7 @@ "syntaxKind": "PropertySignature", "name": "color", "value": "'base' | 'subdued'", - "description": "Modify the color to be more or less intense.", + "description": "The color emphasis level that controls visual intensity.\n\n- `subdued`: Deemphasized color for secondary text, supporting labels, and less critical interface elements.\n- `base`: Primary color for body text, standard UI elements, and general content with good readability.\n- `strong`: Emphasized color for headings, key labels, and interactive elements that need prominence.", "isOptional": true, "defaultValue": "'base'" }, @@ -182366,7 +182652,7 @@ "syntaxKind": "PropertySignature", "name": "dir", "value": "'ltr' | 'rtl' | 'auto' | ''", - "description": "Indicates the directionality of the element’s text.\n\n- `ltr`: languages written from left to right (such as English)\n- `rtl`: languages written from right to left (such as Arabic)\n- `auto`: the user agent determines the direction based on the content\n- `''`: direction is inherited from parent elements (equivalent to not setting the attribute)", + "description": "Indicates the directionality of the element’s text.\n\n- `ltr`: The languages written from left to right (such as English).\n- `rtl`: The languages written from right to left (such as Arabic).\n- `auto`: The user agent determines the direction based on the content.\n- `\"\"`: The direction is inherited from parent elements (equivalent to not setting the attribute).\n\nLearn more about the [dir attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/dir).", "isOptional": true, "defaultValue": "''" }, @@ -182375,7 +182661,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -182383,16 +182669,25 @@ "syntaxKind": "PropertySignature", "name": "lang", "value": "string", - "description": "The language of the button's text content. Use this when the button text is in a different language than the rest of the page, so assistive technologies can invoke the correct pronunciation. [Reference of values](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry) (`Subtag` label)\n\nIt is recommended to combine it with the `dir` attribute to ensure the text is rendered correctly if the surrounding content’s direction is different.", + "description": "Indicate the text language. Useful when the text is in a different language than the rest of the page. It will allow assistive technologies such as screen readers to invoke the correct pronunciation. [Reference of values](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry) (\"subtag\" label)\n\nIt is recommended to combine it with the `dir` attribute to ensure the text is rendered correctly if the surrounding content’s direction is different.", "isOptional": true, "defaultValue": "''" }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "textAlign", + "value": "'start' | 'end' | 'center' | 'auto'", + "description": "Sets the alignment of the text.", + "isOptional": true, + "defaultValue": "'auto'" + }, { "filePath": "src/surfaces/checkout/components/Paragraph.ts", "syntaxKind": "PropertySignature", "name": "tone", "value": "'info' | 'auto' | 'neutral' | 'success' | 'warning' | 'critical' | 'custom'", - "description": "Sets the tone of the component, based on the intention of the information being conveyed.", + "description": "The semantic meaning and color treatment of the component.\n\n- `auto`: Automatically determined based on context.\n- `neutral`: General information without specific intent.\n- `info`: Informational content or helpful tips.\n- `success`: Positive outcomes or successful states.\n- `warning`: Important warnings about potential issues.\n- `critical`: Urgent problems or destructive actions.\n- `custom`: Custom styling controlled by your theme.", "isOptional": true, "defaultValue": "'auto'" }, @@ -182401,12 +182696,12 @@ "syntaxKind": "PropertySignature", "name": "type", "value": "ParagraphType", - "description": "Provide semantic meaning and default styling to the paragraph.\n\nOther presentation properties on `s-paragraph` override the default styling.", + "description": "The semantic type and styling treatment for the paragraph content.\n\nOther presentation properties on `s-paragraph` override the default styling.", "isOptional": true, "defaultValue": "'paragraph'" } ], - "value": "export interface ParagraphElementProps extends Pick {\n color?: Extract;\n tone?: Extract;\n}" + "value": "export interface ParagraphElementProps extends Pick {\n color?: Extract;\n tone?: Extract;\n /**\n * Sets the alignment of the text.\n * @see https://developer.mozilla.org/en-US/docs/Web/CSS/text-align\n *\n * @default 'auto'\n */\n textAlign?: 'start' | 'end' | 'center' | 'auto';\n}" }, { "filePath": "src/surfaces/checkout/components/components.ts", @@ -182427,7 +182722,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityVisibility", "value": "'visible' | 'hidden' | 'exclusive'", - "description": "Changes the visibility of the element.\n\n- `visible`: the element is visible to all users.\n- `hidden`: the element is removed from the accessibility tree but remains visible.\n- `exclusive`: the element is visually hidden but remains in the accessibility tree.", + "description": "Controls how the element is exposed to sighted users and to assistive technologies such as screen readers.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", "isOptional": true, "defaultValue": "'visible'" }, @@ -182450,7 +182745,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/Paragraph.ts", @@ -183024,7 +183319,7 @@ "syntaxKind": "PropertySignature", "name": "color", "value": "'base' | 'subdued'", - "description": "Modify the color to be more or less intense.", + "description": "The color emphasis level that controls visual intensity.\n\n- `subdued`: Deemphasized color for secondary text, supporting labels, and less critical interface elements.\n- `base`: Primary color for body text, standard UI elements, and general content with good readability.\n- `strong`: Emphasized color for headings, key labels, and interactive elements that need prominence.", "isOptional": true, "defaultValue": "'base'" }, @@ -183082,7 +183377,7 @@ "syntaxKind": "PropertySignature", "name": "dir", "value": "'ltr' | 'rtl' | 'auto' | ''", - "description": "Indicates the directionality of the element’s text.\n\n- `ltr`: languages written from left to right (such as English)\n- `rtl`: languages written from right to left (such as Arabic)\n- `auto`: the user agent determines the direction based on the content\n- `''`: direction is inherited from parent elements (equivalent to not setting the attribute)", + "description": "Indicates the directionality of the element’s text.\n\n- `ltr`: The languages written from left to right (such as English).\n- `rtl`: The languages written from right to left (such as Arabic).\n- `auto`: The user agent determines the direction based on the content.\n- `\"\"`: The direction is inherited from parent elements (equivalent to not setting the attribute).\n\nLearn more about the [dir attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/dir).", "isOptional": true, "defaultValue": "''" }, @@ -183358,7 +183653,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -183457,7 +183752,7 @@ "syntaxKind": "PropertySignature", "name": "lang", "value": "string", - "description": "The language of the button's text content. Use this when the button text is in a different language than the rest of the page, so assistive technologies can invoke the correct pronunciation. [Reference of values](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry) (`Subtag` label)\n\nIt is recommended to combine it with the `dir` attribute to ensure the text is rendered correctly if the surrounding content’s direction is different.", + "description": "Indicate the text language. Useful when the text is in a different language than the rest of the page. It will allow assistive technologies such as screen readers to invoke the correct pronunciation. [Reference of values](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry) (\"subtag\" label)\n\nIt is recommended to combine it with the `dir` attribute to ensure the text is rendered correctly if the surrounding content’s direction is different.", "isOptional": true, "defaultValue": "''" }, @@ -184472,7 +184767,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/Paragraph.ts", @@ -184670,6 +184965,15 @@ "value": "3", "description": "node is a Text node." }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "textAlign", + "value": "'start' | 'end' | 'center' | 'auto'", + "description": "Sets the alignment of the text.", + "isOptional": true, + "defaultValue": "'auto'" + }, { "filePath": "src/surfaces/checkout/components/Paragraph.ts", "syntaxKind": "GetAccessor", @@ -184703,7 +185007,7 @@ "syntaxKind": "PropertySignature", "name": "tone", "value": "'info' | 'auto' | 'neutral' | 'success' | 'warning' | 'critical' | 'custom'", - "description": "Sets the tone of the component, based on the intention of the information being conveyed.", + "description": "The semantic meaning and color treatment of the component.\n\n- `auto`: Automatically determined based on context.\n- `neutral`: General information without specific intent.\n- `info`: Informational content or helpful tips.\n- `success`: Positive outcomes or successful states.\n- `warning`: Important warnings about potential issues.\n- `critical`: Urgent problems or destructive actions.\n- `custom`: Custom styling controlled by your theme.", "isOptional": true, "defaultValue": "'auto'" }, @@ -184719,7 +185023,7 @@ "syntaxKind": "PropertySignature", "name": "type", "value": "ParagraphType", - "description": "Provide semantic meaning and default styling to the paragraph.\n\nOther presentation properties on `s-paragraph` override the default styling.", + "description": "The semantic type and styling treatment for the paragraph content.\n\nOther presentation properties on `s-paragraph` override the default styling.", "isOptional": true, "defaultValue": "'paragraph'" }, @@ -184752,7 +185056,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityVisibility", "value": "'visible' | 'hidden' | 'exclusive'", - "description": "Changes the visibility of the element.\n\n- `visible`: the element is visible to all users.\n- `hidden`: the element is removed from the accessibility tree but remains visible.\n- `exclusive`: the element is visually hidden but remains in the accessibility tree.", + "description": "Controls how the element is exposed to sighted users and to assistive technologies such as screen readers.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", "isOptional": true, "defaultValue": "'visible'" }, @@ -184761,7 +185065,7 @@ "syntaxKind": "PropertySignature", "name": "color", "value": "'base' | 'subdued'", - "description": "Modify the color to be more or less intense.", + "description": "The color emphasis level that controls visual intensity.\n\n- `subdued`: Deemphasized color for secondary text, supporting labels, and less critical interface elements.\n- `base`: Primary color for body text, standard UI elements, and general content with good readability.\n- `strong`: Emphasized color for headings, key labels, and interactive elements that need prominence.", "isOptional": true, "defaultValue": "'base'" }, @@ -184770,7 +185074,7 @@ "syntaxKind": "PropertySignature", "name": "dir", "value": "'ltr' | 'rtl' | 'auto' | ''", - "description": "Indicates the directionality of the element’s text.\n\n- `ltr`: languages written from left to right (such as English)\n- `rtl`: languages written from right to left (such as Arabic)\n- `auto`: the user agent determines the direction based on the content\n- `''`: direction is inherited from parent elements (equivalent to not setting the attribute)", + "description": "Indicates the directionality of the element’s text.\n\n- `ltr`: The languages written from left to right (such as English).\n- `rtl`: The languages written from right to left (such as Arabic).\n- `auto`: The user agent determines the direction based on the content.\n- `\"\"`: The direction is inherited from parent elements (equivalent to not setting the attribute).\n\nLearn more about the [dir attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/dir).", "isOptional": true, "defaultValue": "''" }, @@ -184779,7 +185083,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -184787,16 +185091,25 @@ "syntaxKind": "PropertySignature", "name": "lang", "value": "string", - "description": "The language of the button's text content. Use this when the button text is in a different language than the rest of the page, so assistive technologies can invoke the correct pronunciation. [Reference of values](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry) (`Subtag` label)\n\nIt is recommended to combine it with the `dir` attribute to ensure the text is rendered correctly if the surrounding content’s direction is different.", + "description": "Indicate the text language. Useful when the text is in a different language than the rest of the page. It will allow assistive technologies such as screen readers to invoke the correct pronunciation. [Reference of values](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry) (\"subtag\" label)\n\nIt is recommended to combine it with the `dir` attribute to ensure the text is rendered correctly if the surrounding content’s direction is different.", "isOptional": true, "defaultValue": "''" }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "textAlign", + "value": "'start' | 'end' | 'center' | 'auto'", + "description": "Sets the alignment of the text.", + "isOptional": true, + "defaultValue": "'auto'" + }, { "filePath": "src/surfaces/checkout/components/Paragraph.ts", "syntaxKind": "PropertySignature", "name": "tone", "value": "'info' | 'auto' | 'neutral' | 'success' | 'warning' | 'critical' | 'custom'", - "description": "Sets the tone of the component, based on the intention of the information being conveyed.", + "description": "The semantic meaning and color treatment of the component.\n\n- `auto`: Automatically determined based on context.\n- `neutral`: General information without specific intent.\n- `info`: Informational content or helpful tips.\n- `success`: Positive outcomes or successful states.\n- `warning`: Important warnings about potential issues.\n- `critical`: Urgent problems or destructive actions.\n- `custom`: Custom styling controlled by your theme.", "isOptional": true, "defaultValue": "'auto'" }, @@ -184805,7 +185118,7 @@ "syntaxKind": "PropertySignature", "name": "type", "value": "ParagraphType", - "description": "Provide semantic meaning and default styling to the paragraph.\n\nOther presentation properties on `s-paragraph` override the default styling.", + "description": "The semantic type and styling treatment for the paragraph content.\n\nOther presentation properties on `s-paragraph` override the default styling.", "isOptional": true, "defaultValue": "'paragraph'" } @@ -184815,7 +185128,7 @@ { "filePath": "src/surfaces/checkout/components/PasswordField.ts", "name": "PasswordFieldElementProps", - "description": "The password field component securely collects sensitive information from users. Use password field for password entry, where input characters are automatically masked for privacy.\n\nPassword fields support validation, help text, and accessibility features to create secure and user-friendly authentication experiences. For general text input, use [text field](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/forms/text-field).", + "description": "", "isPublicDocs": true, "members": [ { @@ -184823,7 +185136,7 @@ "syntaxKind": "PropertySignature", "name": "autocomplete", "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", "isOptional": true, "defaultValue": "'on' for everything else" }, @@ -184832,7 +185145,7 @@ "syntaxKind": "PropertySignature", "name": "defaultValue", "value": "string", - "description": "The default value for the field.", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces this value.", "isOptional": true }, { @@ -184840,7 +185153,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -184849,7 +185162,7 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -184857,7 +185170,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -184865,7 +185178,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Content to use as the field label.", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", "isOptional": true }, { @@ -184873,7 +185186,7 @@ "syntaxKind": "PropertySignature", "name": "labelAccessibilityVisibility", "value": "'visible' | 'exclusive'", - "description": "Changes the visibility of the component's label.\n\n- `visible`: the label is visible to all users.\n- `exclusive`: the label is visually hidden but remains in the accessibility tree.", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone.\n- `exclusive`: The label is visually hidden but still announced by screen readers.", "isOptional": true, "defaultValue": "'visible'" }, @@ -184891,7 +185204,7 @@ "syntaxKind": "PropertySignature", "name": "minLength", "value": "number", - "description": "Specifies the min number of characters allowed.", + "description": "Specifies the minimum number of characters allowed.", "isOptional": true, "defaultValue": "0" }, @@ -184900,7 +185213,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -184908,7 +185221,7 @@ "syntaxKind": "PropertySignature", "name": "readOnly", "value": "boolean", - "description": "The field cannot be edited by the user. It is focusable will be announced by screen readers.", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", "isOptional": true, "defaultValue": "false" }, @@ -184951,7 +185264,7 @@ "syntaxKind": "PropertySignature", "name": "onChange", "value": "(event: Event) => void", - "description": "Callback when the user has **finished editing** a field, for example, once they have blurred the field.", + "description": "A callback fired when the user has **finished editing** a field, such as when they blur the field or press Enter.", "isOptional": true }, { @@ -184967,7 +185280,7 @@ "syntaxKind": "PropertySignature", "name": "onInput", "value": "(event: Event) => void", - "description": "Callback when the user makes any changes in the field.", + "description": "A callback fired when the user makes any changes in the field, such as typing a character.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).", "isOptional": true } ], @@ -184976,7 +185289,7 @@ { "filePath": "src/surfaces/checkout/components/PasswordField.ts", "name": "PasswordFieldElementEvents", - "description": "Learn more about [registering events](/docs/api/checkout-ui-extensions/latest/using-polaris-components#event-handling).", + "description": "", "isPublicDocs": true, "members": [ { @@ -184984,7 +185297,7 @@ "syntaxKind": "PropertySignature", "name": "blur", "value": "CallbackEventListener", - "description": "A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "description": "<<<<<<< HEAD A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n======= A callback fired when the password field loses focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) \n Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", "isOptional": true }, { @@ -184992,7 +185305,7 @@ "syntaxKind": "PropertySignature", "name": "change", "value": "CallbackEventListener", - "description": "Callback when the user has **finished editing** a field, for example, once they have blurred the field.", + "description": "<<<<<<< HEAD Callback when the user has **finished editing** a field, for example, once they have blurred the field.\n======= A callback fired when the password field value changes.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) \n Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", "isOptional": true }, { @@ -185000,7 +185313,7 @@ "syntaxKind": "PropertySignature", "name": "focus", "value": "CallbackEventListener", - "description": "A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "description": "<<<<<<< HEAD A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n======= A callback fired when the password field receives focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) \n Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", "isOptional": true }, { @@ -185008,16 +185321,16 @@ "syntaxKind": "PropertySignature", "name": "input", "value": "CallbackEventListener", - "description": "Callback when the user makes any changes in the field.", + "description": "A callback fired when the user inputs data into the password field.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).", "isOptional": true } ], - "value": "export interface PasswordFieldElementEvents {\n /**\n * A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event\n */\n blur?: CallbackEventListener;\n /**\n * Callback when the user has **finished editing** a field, for example, once they have blurred the field.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event\n */\n change?: CallbackEventListener;\n /**\n * A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event\n */\n focus?: CallbackEventListener;\n /**\n * Callback when the user makes any changes in the field.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event\n */\n input?: CallbackEventListener;\n}" + "value": "export interface PasswordFieldElementEvents {\n /**\n<<<<<<< HEAD\n * A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n=======\n * A callback fired when the password field loses focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality)\n *\n * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur?: CallbackEventListener;\n /**\n<<<<<<< HEAD\n * Callback when the user has **finished editing** a field, for example, once they have blurred the field.\n=======\n * A callback fired when the password field value changes.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality)\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change?: CallbackEventListener;\n /**\n<<<<<<< HEAD\n * A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n=======\n * A callback fired when the password field receives focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality)\n *\n * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus?: CallbackEventListener;\n /**\n * A callback fired when the user inputs data into the password field.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input?: CallbackEventListener;\n}" }, { "filePath": "src/surfaces/checkout/components/PasswordField.ts", "name": "PasswordFieldElementSlots", - "description": "Learn more about [component slots](/docs/api/checkout-ui-extensions/latest/using-polaris-components#slots).", + "description": "", "isPublicDocs": true, "members": [ { @@ -185025,11 +185338,11 @@ "syntaxKind": "PropertySignature", "name": "accessory", "value": "HTMLElement", - "description": "Additional content to be displayed in the field. Commonly used to display an icon that activates a tooltip providing more information.", + "description": "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.", "isOptional": true } ], - "value": "export interface PasswordFieldElementSlots {\n /**\n * Additional content to be displayed in the field.\n * Commonly used to display an icon that activates a tooltip providing more information.\n */\n accessory?: HTMLElement;\n}" + "value": "export interface PasswordFieldElementSlots {\n /**\n * 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.\n */\n accessory?: HTMLElement;\n}" }, { "filePath": "src/surfaces/checkout/components/PasswordField.ts", @@ -185056,7 +185369,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/PasswordField.ts", @@ -185497,7 +185810,7 @@ "syntaxKind": "PropertySignature", "name": "autocomplete", "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", "isOptional": true, "defaultValue": "'on' for everything else" }, @@ -185688,7 +186001,7 @@ "syntaxKind": "PropertySignature", "name": "defaultValue", "value": "string", - "description": "The default value for the field.", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces this value.", "isOptional": true }, { @@ -185703,7 +186016,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -185817,7 +186130,7 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -185987,7 +186300,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -186079,7 +186392,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Content to use as the field label.", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", "isOptional": true }, { @@ -186087,7 +186400,7 @@ "syntaxKind": "PropertySignature", "name": "labelAccessibilityVisibility", "value": "'visible' | 'exclusive'", - "description": "Changes the visibility of the component's label.\n\n- `visible`: the label is visible to all users.\n- `exclusive`: the label is visually hidden but remains in the accessibility tree.", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone.\n- `exclusive`: The label is visually hidden but still announced by screen readers.", "isOptional": true, "defaultValue": "'visible'" }, @@ -186154,7 +186467,7 @@ "syntaxKind": "PropertySignature", "name": "minLength", "value": "number", - "description": "Specifies the min number of characters allowed.", + "description": "Specifies the minimum number of characters allowed.", "isOptional": true, "defaultValue": "0" }, @@ -186163,7 +186476,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -186376,7 +186689,7 @@ "syntaxKind": "PropertySignature", "name": "onChange", "value": "(event: Event) => void", - "description": "Callback when the user has **finished editing** a field, for example, once they have blurred the field.", + "description": "A callback fired when the user has **finished editing** a field, such as when they blur the field or press Enter.", "isOptional": true }, { @@ -186574,7 +186887,7 @@ "syntaxKind": "PropertySignature", "name": "onInput", "value": "(event: Event) => void", - "description": "Callback when the user makes any changes in the field.", + "description": "A callback fired when the user makes any changes in the field, such as typing a character.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).", "isOptional": true }, { @@ -187118,7 +187431,7 @@ "syntaxKind": "PropertySignature", "name": "readOnly", "value": "boolean", - "description": "The field cannot be edited by the user. It is focusable will be announced by screen readers.", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", "isOptional": true, "defaultValue": "false" }, @@ -187169,7 +187482,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/PasswordField.ts", @@ -187448,7 +187761,7 @@ "syntaxKind": "PropertySignature", "name": "autocomplete", "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", "isOptional": true, "defaultValue": "'on' for everything else" }, @@ -187457,7 +187770,7 @@ "syntaxKind": "PropertySignature", "name": "defaultValue", "value": "string", - "description": "The default value for the field.", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces this value.", "isOptional": true }, { @@ -187465,7 +187778,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -187474,7 +187787,7 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -187482,7 +187795,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -187490,7 +187803,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Content to use as the field label.", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", "isOptional": true }, { @@ -187498,7 +187811,7 @@ "syntaxKind": "PropertySignature", "name": "labelAccessibilityVisibility", "value": "'visible' | 'exclusive'", - "description": "Changes the visibility of the component's label.\n\n- `visible`: the label is visible to all users.\n- `exclusive`: the label is visually hidden but remains in the accessibility tree.", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone.\n- `exclusive`: The label is visually hidden but still announced by screen readers.", "isOptional": true, "defaultValue": "'visible'" }, @@ -187516,7 +187829,7 @@ "syntaxKind": "PropertySignature", "name": "minLength", "value": "number", - "description": "Specifies the min number of characters allowed.", + "description": "Specifies the minimum number of characters allowed.", "isOptional": true, "defaultValue": "0" }, @@ -187525,7 +187838,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -187541,7 +187854,7 @@ "syntaxKind": "PropertySignature", "name": "onChange", "value": "(event: Event) => void", - "description": "Callback when the user has **finished editing** a field, for example, once they have blurred the field.", + "description": "A callback fired when the user has **finished editing** a field, such as when they blur the field or press Enter.", "isOptional": true }, { @@ -187557,7 +187870,7 @@ "syntaxKind": "PropertySignature", "name": "onInput", "value": "(event: Event) => void", - "description": "Callback when the user makes any changes in the field.", + "description": "A callback fired when the user makes any changes in the field, such as typing a character.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).", "isOptional": true }, { @@ -187565,7 +187878,7 @@ "syntaxKind": "PropertySignature", "name": "readOnly", "value": "boolean", - "description": "The field cannot be edited by the user. It is focusable will be announced by screen readers.", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", "isOptional": true, "defaultValue": "false" }, @@ -187592,7 +187905,7 @@ { "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", "name": "PaymentIconElementProps", - "description": "Displays icons representing payment methods. Use to visually communicate available or saved payment options clearly", + "description": "", "isPublicDocs": true, "members": [ { @@ -187608,7 +187921,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -187672,7 +187985,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", @@ -188569,7 +188882,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -189681,7 +189994,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", @@ -189944,7 +190257,7 @@ { "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", "name": "PaymentIconProps", - "description": "The properties for the payment icon component when it's used in JSX.", + "description": "", "isPublicDocs": true, "members": [ { @@ -189960,7 +190273,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -189978,7 +190291,7 @@ { "filePath": "src/surfaces/checkout/components/PhoneField.ts", "name": "PhoneFieldElementEvents", - "description": "Learn more about [registering events](/docs/api/checkout-ui-extensions/latest/using-polaris-components#event-handling).", + "description": "", "isPublicDocs": true, "members": [ { @@ -189986,7 +190299,7 @@ "syntaxKind": "PropertySignature", "name": "blur", "value": "CallbackEventListener", - "description": "A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "description": "<<<<<<< HEAD A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n======= A callback fired when the phone field loses focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) \n Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", "isOptional": true }, { @@ -189994,7 +190307,7 @@ "syntaxKind": "PropertySignature", "name": "change", "value": "CallbackEventListener", - "description": "Callback when the user has **finished editing** a field, for example, once they have blurred the field.", + "description": "<<<<<<< HEAD Callback when the user has **finished editing** a field, for example, once they have blurred the field.\n======= A callback fired when the phone field value changes.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) \n Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", "isOptional": true }, { @@ -190002,7 +190315,7 @@ "syntaxKind": "PropertySignature", "name": "focus", "value": "CallbackEventListener", - "description": "A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "description": "<<<<<<< HEAD A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n======= A callback fired when the phone field receives focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) \n Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", "isOptional": true }, { @@ -190010,16 +190323,16 @@ "syntaxKind": "PropertySignature", "name": "input", "value": "CallbackEventListener", - "description": "Callback when the user makes any changes in the field.", + "description": "A callback fired when the user inputs data into the phone field.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).", "isOptional": true } ], - "value": "export interface PhoneFieldElementEvents {\n /**\n * A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event\n */\n blur?: CallbackEventListener;\n /**\n * Callback when the user has **finished editing** a field, for example, once they have blurred the field.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event\n */\n change?: CallbackEventListener;\n /**\n * A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event\n */\n focus?: CallbackEventListener;\n /**\n * Callback when the user makes any changes in the field.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event\n */\n input?: CallbackEventListener;\n}" + "value": "export interface PhoneFieldElementEvents {\n /**\n<<<<<<< HEAD\n * A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n=======\n * A callback fired when the phone field loses focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality)\n *\n * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur?: CallbackEventListener;\n /**\n<<<<<<< HEAD\n * Callback when the user has **finished editing** a field, for example, once they have blurred the field.\n=======\n * A callback fired when the phone field value changes.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality)\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change?: CallbackEventListener;\n /**\n<<<<<<< HEAD\n * A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n=======\n * A callback fired when the phone field receives focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality)\n *\n * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus?: CallbackEventListener;\n /**\n * A callback fired when the user inputs data into the phone field.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input?: CallbackEventListener;\n}" }, { "filePath": "src/surfaces/checkout/components/PhoneField.ts", "name": "PhoneFieldElementSlots", - "description": "Learn more about [component slots](/docs/api/checkout-ui-extensions/latest/using-polaris-components#slots).", + "description": "", "isPublicDocs": true, "members": [ { @@ -190027,16 +190340,16 @@ "syntaxKind": "PropertySignature", "name": "accessory", "value": "HTMLElement", - "description": "Additional content to be displayed in the field. Commonly used to display an icon that activates a tooltip providing more information.", + "description": "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.", "isOptional": true } ], - "value": "export interface PhoneFieldElementSlots {\n /**\n * Additional content to be displayed in the field.\n * Commonly used to display an icon that activates a tooltip providing more information.\n */\n accessory?: HTMLElement;\n}" + "value": "export interface PhoneFieldElementSlots {\n /**\n * 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.\n */\n accessory?: HTMLElement;\n}" }, { "filePath": "src/surfaces/checkout/components/Popover.ts", "name": "PopoverElementProps", - "description": "The popover component displays contextual content in an overlay triggered by a button using the [`commandFor`](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/button#commandfor) attribute. Use for secondary actions, settings, or information that doesn't require a full modal.\n\nFor interactions that need more space or user focus, such as confirmations or complex forms, use [modal](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/overlays/modal) instead.", + "description": "", "isPublicDocs": true, "members": [ { @@ -190053,7 +190366,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -190107,7 +190420,7 @@ { "filePath": "src/surfaces/checkout/components/Popover.ts", "name": "PopoverEvents", - "description": "The event callbacks for monitoring popover visibility changes.", + "description": "", "isPublicDocs": true, "members": [ { @@ -190132,7 +190445,7 @@ { "filePath": "src/surfaces/checkout/components/Popover.ts", "name": "PopoverElementEvents", - "description": "Learn more about [registering events](/docs/api/checkout-ui-extensions/latest/using-polaris-components#event-handling).", + "description": "", "isPublicDocs": true, "members": [ { @@ -190179,7 +190492,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/Popover.ts", @@ -191085,7 +191398,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -192256,7 +192569,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/Popover.ts", @@ -192510,7 +192823,7 @@ { "filePath": "src/surfaces/checkout/components/Popover.ts", "name": "PopoverProps", - "description": "The properties for the popover component when it's used in JSX.", + "description": "", "isPublicDocs": true, "members": [ { @@ -192527,7 +192840,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -192597,7 +192910,7 @@ { "filePath": "src/surfaces/checkout/components/PressButton.ts", "name": "PressButtonElementProps", - "description": "Allows users to toggle between active/inactive states. Use to represent a persistent on/off or selected/unselected status.", + "description": "", "isPublicDocs": true, "members": [ { @@ -192631,7 +192944,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -192708,7 +193021,7 @@ { "filePath": "src/surfaces/checkout/components/PressButton.ts", "name": "PressButtonElementEvents", - "description": "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).", + "description": "", "isPublicDocs": true, "members": [ { @@ -192771,7 +193084,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/PressButton.ts", @@ -193679,7 +193992,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -194819,7 +195132,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/PressButton.ts", @@ -195107,7 +195420,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -195175,7 +195488,7 @@ { "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", "name": "ProductThumbnailElementProps", - "description": "Use ProductThumbnail to display a product thumbnail", + "description": "", "isPublicDocs": true, "members": [ { @@ -195256,7 +195569,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", @@ -197266,7 +197579,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", @@ -197561,7 +197874,7 @@ { "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", "name": "ProductThumbnailProps", - "description": "The properties for the product thumbnail component when it's used in JSX.", + "description": "", "isPublicDocs": true, "members": [ { @@ -197620,7 +197933,7 @@ { "filePath": "src/surfaces/checkout/components/Progress.ts", "name": "ProgressElementProps", - "description": "Displays an indicator showing the completion status of a task. Use to visually communicate progress in either determinate (known percentage) or indeterminate (unknown duration) states.", + "description": "", "isPublicDocs": true, "members": [ { @@ -197628,7 +197941,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityLabel", "value": "string", - "description": "A label that describes the purpose of the progress. When set, it will be announced to users using assistive technologies and will provide them with more context.\n\nUse it to provide context of what is progressing.", + "description": "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\".", "isOptional": true }, { @@ -197636,7 +197949,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -197644,7 +197957,7 @@ "syntaxKind": "PropertySignature", "name": "max", "value": "number", - "description": "This attribute describes how much work the task indicated by the progress element requires.\n\nThe `max` attribute, if present, must have a value greater than 0 and be a valid floating point number.", + "description": "The total amount of work the task requires. Must be a value greater than `0` and a valid floating point number.\n\nLearn more about the [max attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/progress#max).", "isOptional": true, "defaultValue": "1" }, @@ -197653,7 +197966,7 @@ "syntaxKind": "PropertySignature", "name": "tone", "value": "'auto' | 'critical'", - "description": "Sets the tone of the progress, based on the intention of the information being conveyed.", + "description": "The semantic meaning and color treatment of the progress indicator.\n\n- `auto`: Automatically determined based on context.\n- `critical`: Indicates an urgent or error state requiring immediate attention.", "isOptional": true, "defaultValue": "'auto'" }, @@ -197662,11 +197975,11 @@ "syntaxKind": "PropertySignature", "name": "value", "value": "number", - "description": "Specifies how much of the task has been completed.\n\nIt must be a valid floating point number between 0 and `max`, or between 0 and 1 if `max` is omitted. If there is no value attribute, the progress bar is indeterminate; this indicates that an activity is ongoing with no indication of how long it is expected to take.", + "description": "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.\n\nLearn more about the [value attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/progress#value).", "isOptional": true } ], - "value": "export interface ProgressElementProps extends Pick {\n tone?: Extract;\n}" + "value": "export interface ProgressElementProps extends Pick {\n /**\n * 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\".\n */\n accessibilityLabel?: ProgressProps$1['accessibilityLabel'];\n /**\n * The total amount of work the task requires. Must be a value greater than `0` and a valid floating point number.\n *\n * Learn more about the [max attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/progress#max).\n *\n * @default 1\n */\n max?: ProgressProps$1['max'];\n /**\n * The semantic meaning and color treatment of the progress indicator.\n *\n * - `auto`: Automatically determined based on context.\n * - `critical`: Indicates an urgent or error state requiring immediate attention.\n *\n * @default 'auto'\n */\n tone?: Extract;\n /**\n * 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.\n *\n * Learn more about the [value attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/progress#value).\n */\n value?: ProgressProps$1['value'];\n}" }, { "filePath": "src/surfaces/checkout/components/Progress.ts", @@ -197679,7 +197992,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityLabel", "value": "string", - "description": "A label that describes the purpose of the progress. When set, it will be announced to users using assistive technologies and will provide them with more context.\n\nUse it to provide context of what is progressing.", + "description": "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\".", "isOptional": true }, { @@ -197701,7 +198014,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/Progress.ts", @@ -198598,7 +198911,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -198746,7 +199059,7 @@ "syntaxKind": "PropertySignature", "name": "max", "value": "number", - "description": "This attribute describes how much work the task indicated by the progress element requires.\n\nThe `max` attribute, if present, must have a value greater than 0 and be a valid floating point number.", + "description": "The total amount of work the task requires. Must be a value greater than `0` and a valid floating point number.\n\nLearn more about the [max attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/progress#max).", "isOptional": true, "defaultValue": "1" }, @@ -199719,7 +200032,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/Progress.ts", @@ -199950,7 +200263,7 @@ "syntaxKind": "PropertySignature", "name": "tone", "value": "'auto' | 'critical'", - "description": "Sets the tone of the progress, based on the intention of the information being conveyed.", + "description": "The semantic meaning and color treatment of the progress indicator.\n\n- `auto`: Automatically determined based on context.\n- `critical`: Indicates an urgent or error state requiring immediate attention.", "isOptional": true, "defaultValue": "'auto'" }, @@ -199966,7 +200279,7 @@ "syntaxKind": "PropertySignature", "name": "value", "value": "number", - "description": "Specifies how much of the task has been completed.\n\nIt must be a valid floating point number between 0 and `max`, or between 0 and 1 if `max` is omitted. If there is no value attribute, the progress bar is indeterminate; this indicates that an activity is ongoing with no indication of how long it is expected to take.", + "description": "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.\n\nLearn more about the [value attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/progress#value).", "isOptional": true }, { @@ -199998,7 +200311,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityLabel", "value": "string", - "description": "A label that describes the purpose of the progress. When set, it will be announced to users using assistive technologies and will provide them with more context.\n\nUse it to provide context of what is progressing.", + "description": "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\".", "isOptional": true }, { @@ -200006,7 +200319,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -200014,7 +200327,7 @@ "syntaxKind": "PropertySignature", "name": "max", "value": "number", - "description": "This attribute describes how much work the task indicated by the progress element requires.\n\nThe `max` attribute, if present, must have a value greater than 0 and be a valid floating point number.", + "description": "The total amount of work the task requires. Must be a value greater than `0` and a valid floating point number.\n\nLearn more about the [max attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/progress#max).", "isOptional": true, "defaultValue": "1" }, @@ -200023,7 +200336,7 @@ "syntaxKind": "PropertySignature", "name": "tone", "value": "'auto' | 'critical'", - "description": "Sets the tone of the progress, based on the intention of the information being conveyed.", + "description": "The semantic meaning and color treatment of the progress indicator.\n\n- `auto`: Automatically determined based on context.\n- `critical`: Indicates an urgent or error state requiring immediate attention.", "isOptional": true, "defaultValue": "'auto'" }, @@ -200032,7 +200345,7 @@ "syntaxKind": "PropertySignature", "name": "value", "value": "number", - "description": "Specifies how much of the task has been completed.\n\nIt must be a valid floating point number between 0 and `max`, or between 0 and 1 if `max` is omitted. If there is no value attribute, the progress bar is indeterminate; this indicates that an activity is ongoing with no indication of how long it is expected to take.", + "description": "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.\n\nLearn more about the [value attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/progress#value).", "isOptional": true } ], @@ -200041,7 +200354,7 @@ { "filePath": "src/surfaces/checkout/components/QRCode.ts", "name": "QRCodeElementProps", - "description": "Displays a scannable QR code representing data such as URLs or text. Use to let users quickly access information by scanning with a smartphone or other device.", + "description": "", "isPublicDocs": true, "members": [ { @@ -200075,7 +200388,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -200109,7 +200422,7 @@ { "filePath": "src/surfaces/checkout/components/QRCode.ts", "name": "QRCodeEvents", - "description": "The event handlers for the QR code component.", + "description": "", "isPublicDocs": true, "members": [ { @@ -200126,7 +200439,7 @@ { "filePath": "src/surfaces/checkout/components/QRCode.ts", "name": "QRCodeElementEvents", - "description": "Learn more about [registering events](/docs/api/checkout-ui-extensions/latest/using-polaris-components#event-handling).", + "description": "", "isPublicDocs": true, "members": [ { @@ -200174,7 +200487,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/QRCode.ts", @@ -201088,7 +201401,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -202216,7 +202529,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/QRCode.ts", @@ -202479,7 +202792,7 @@ { "filePath": "src/surfaces/checkout/components/QRCode.ts", "name": "QRCodeProps", - "description": "The properties for the QR code component when it's used in JSX.", + "description": "", "isPublicDocs": true, "members": [ { @@ -202513,7 +202826,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -202547,7 +202860,7 @@ { "filePath": "src/surfaces/checkout/components/QueryContainer.ts", "name": "QueryContainerElementProps", - "description": "The query container component establishes a container query context for responsive design. Use query container to define an element as a containment context, enabling child components or styles to adapt based on the container's size rather than viewport width.\n\nQuery containers support modern responsive patterns where components respond to their container dimensions, creating more flexible and reusable layouts.", + "description": "", "isPublicDocs": true, "members": [ { @@ -202564,7 +202877,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true } ], @@ -202595,7 +202908,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/QueryContainer.ts", @@ -203501,7 +203814,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -204613,7 +204926,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/QueryContainer.ts", @@ -204884,7 +205197,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true } ], @@ -204893,7 +205206,7 @@ { "filePath": "src/surfaces/checkout/components/ScrollBox.ts", "name": "ScrollBoxElementProps", - "description": "Provides a scrollable container for long content that exceeds the available space. Use to display lists, order summaries, or other lengthy content while maintaining a constrained layout.", + "description": "", "isPublicDocs": true, "members": [ { @@ -204918,7 +205231,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityVisibility", "value": "'visible' | 'hidden' | 'exclusive'", - "description": "Changes the visibility of the element.\n\n- `visible`: the element is visible to all users.\n- `hidden`: the element is removed from the accessibility tree but remains visible.\n- `exclusive`: the element is visually hidden but remains in the accessibility tree.", + "description": "Controls how the element is exposed to sighted users and to assistive technologies such as screen readers.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", "isOptional": true, "defaultValue": "'visible'" }, @@ -204927,7 +205240,7 @@ "syntaxKind": "PropertySignature", "name": "background", "value": "'base' | 'subdued' | 'transparent'", - "description": "Adjust the background of the element.\n\n- `'transparent'`: No visible background.\n- `'subdued'`: A subtle, low-emphasis background.\n- `'base'`: The standard background color.\n- `'strong'`: A high-emphasis background for prominence.", + "description": "The background color of the scroll box.\n\n- `base`: The standard background color for general content areas.\n- `subdued`: A muted background for secondary or supporting content.\n- `transparent`: No background color (the default).", "isOptional": true, "defaultValue": "'transparent'" }, @@ -204945,9 +205258,9 @@ "syntaxKind": "PropertySignature", "name": "border", "value": "BorderShorthand", - "description": "Applies a border using shorthand syntax to specify width, color, and style in a single property.\n\nAccepts a size value, optionally followed by a color, optionally followed by a style. Omitted values use defaults: color defaults to `base`, style defaults to `auto`.\n\nIndividual properties (`borderWidth`, `borderStyle`, `borderColor`) can override values set here.", + "description": "A shorthand for setting the border width, color, and style in a single property. Individual border properties (`borderWidth`, `borderStyle`, `borderColor`) can override values set here.", "isOptional": true, - "defaultValue": "'none' - equivalent to `none base auto`.", + "defaultValue": "'none'", "examples": [ { "title": "Example", @@ -204966,7 +205279,7 @@ "syntaxKind": "PropertySignature", "name": "borderColor", "value": "'' | 'base'", - "description": "Controls the color of the border using the design system's color scale.\n\nWhen set, this overrides the color value specified in the `border` property. Choose from `subdued`, `base`, or `strong` to match the visual emphasis needed.", + "description": "The color of the border using the design system's color scale. Overrides the color value set by `border`.", "isOptional": true, "defaultValue": "'' - meaning no override" }, @@ -204975,7 +205288,7 @@ "syntaxKind": "PropertySignature", "name": "borderRadius", "value": "MaybeAllValuesShorthandProperty>", - "description": "Controls the roundedness of the element's corners using the design system's radius scale.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) using flow-relative values:\n- One value: applies to all corners\n- Two values: applies to start corners (top-left & bottom-right) and end corners (top-right & bottom-left) respectively\n- Three values: applies to start-start (top-left), end corners (top-right & bottom-left), and end-end (bottom-right) respectively\n- Four values: applies to start-start (top-left), start-end (top-right), end-end (bottom-right), and end-start (bottom-left) respectively\n\nExamples:\n- `small-100`: All corners have `small-100` radius\n- `small-100 none`: Top-left and bottom-right are `small-100`, top-right and bottom-left are `none`\n- `small-100 none large-100`: Top-left is `small-100`, top-right and bottom-left are `none`, bottom-right is `large-100`\n- `small-100 none large-100 base`: Each corner has its specified radius value", + "description": "The roundedness of the scroll box's corners.\n\n- `none`: Sharp corners with no rounding.\n- `small-100` / `small`: Subtle rounding for compact elements.\n- `base`: Standard rounding for most use cases.\n- `large` / `large-100`: More pronounced rounding for prominent containers.\n- `max`: Maximum rounding, creating a pill or circular shape.\n\nSupports 1-to-4-value shorthand syntax for specifying different radii per corner.", "isOptional": true, "defaultValue": "'none'" }, @@ -204993,7 +205306,7 @@ "syntaxKind": "PropertySignature", "name": "borderWidth", "value": "MaybeAllValuesShorthandProperty | ''", - "description": "Controls the thickness of the border on all sides. When set, this overrides the width value specified in the `border` property.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) for specifying different widths per side:\n- One value: applies to all sides\n- Two values: applies to block sides (top/bottom) and inline sides (left/right) respectively\n- Three values: applies to block-start (top), inline sides (left/right), and block-end (bottom) respectively\n- Four values: applies to block-start (top), inline-end (right), block-end (bottom), and inline-start (left) respectively", + "description": "The thickness of the border on all sides. Supports 1-to-4-value shorthand syntax for specifying different widths per side. Overrides the width value set by `border`.", "isOptional": true, "defaultValue": "'' - meaning no override" }, @@ -205002,7 +205315,7 @@ "syntaxKind": "PropertySignature", "name": "display", "value": "MaybeResponsive<\"auto\" | \"none\">", - "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.", + "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.\n\nLearn more about the [display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display).", "isOptional": true, "defaultValue": "'auto'" }, @@ -205011,7 +205324,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -205132,7 +205445,7 @@ "defaultValue": "'' - meaning no override" } ], - "value": "export interface ScrollBoxElementProps extends Pick {\n background?: Extract;\n border?: BorderShorthand;\n borderColor?: ReducedColorKeyword | '';\n borderRadius?: MaybeAllValuesShorthandProperty>;\n borderWidth?: MaybeAllValuesShorthandProperty | '';\n}" + "value": "export interface ScrollBoxElementProps extends Pick {\n /**\n * The background color of the scroll box.\n *\n * - `base`: The standard background color for general content areas.\n * - `subdued`: A muted background for secondary or supporting content.\n * - `transparent`: No background color (the default).\n *\n * @default 'transparent'\n */\n background?: Extract;\n /**\n * A shorthand for setting the border width, color, and style in a single property. Individual border properties (`borderWidth`, `borderStyle`, `borderColor`) can override values set here.\n *\n * @default 'none'\n */\n border?: BorderShorthand;\n /**\n * The color of the border using the design system's color scale. Overrides the color value set by `border`.\n *\n * @default '' - meaning no override\n */\n borderColor?: ReducedColorKeyword | '';\n /**\n * The roundedness of the scroll box's corners.\n *\n * - `none`: Sharp corners with no rounding.\n * - `small-100` / `small`: Subtle rounding for compact elements.\n * - `base`: Standard rounding for most use cases.\n * - `large` / `large-100`: More pronounced rounding for prominent containers.\n * - `max`: Maximum rounding, creating a pill or circular shape.\n *\n * Supports 1-to-4-value shorthand syntax for specifying different radii per corner.\n *\n * @default 'none'\n */\n borderRadius?: MaybeAllValuesShorthandProperty>;\n /**\n * The thickness of the border on all sides. Supports 1-to-4-value shorthand syntax for specifying different widths per side. Overrides the width value set by `border`.\n *\n * @default '' - meaning no override\n */\n borderWidth?: MaybeAllValuesShorthandProperty | '';\n}" }, { "filePath": "src/surfaces/checkout/components/ScrollBox.ts", @@ -205162,7 +205475,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityVisibility", "value": "'visible' | 'hidden' | 'exclusive'", - "description": "Changes the visibility of the element.\n\n- `visible`: the element is visible to all users.\n- `hidden`: the element is removed from the accessibility tree but remains visible.\n- `exclusive`: the element is visually hidden but remains in the accessibility tree.", + "description": "Controls how the element is exposed to sighted users and to assistive technologies such as screen readers.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", "isOptional": true, "defaultValue": "'visible'" }, @@ -205171,7 +205484,7 @@ "syntaxKind": "PropertySignature", "name": "background", "value": "'base' | 'subdued' | 'transparent'", - "description": "Adjust the background of the element.\n\n- `'transparent'`: No visible background.\n- `'subdued'`: A subtle, low-emphasis background.\n- `'base'`: The standard background color.\n- `'strong'`: A high-emphasis background for prominence.", + "description": "The background color of the scroll box.\n\n- `base`: The standard background color for general content areas.\n- `subdued`: A muted background for secondary or supporting content.\n- `transparent`: No background color (the default).", "isOptional": true, "defaultValue": "'transparent'" }, @@ -205189,23 +205502,25 @@ "syntaxKind": "PropertySignature", "name": "border", "value": "BorderShorthand", - "description": "Applies a border using shorthand syntax to specify width, color, and style in a single property.\n\nAccepts a size value, optionally followed by a color, optionally followed by a style. Omitted values use defaults: color defaults to `base`, style defaults to `auto`.\n\nIndividual properties (`borderWidth`, `borderStyle`, `borderColor`) can override values set here.", - "isOptional": true + "description": "A shorthand for setting the border width, color, and style in a single property. Individual border properties (`borderWidth`, `borderStyle`, `borderColor`) can override values set here.", + "isOptional": true, + "defaultValue": "'none'" }, { "filePath": "src/surfaces/checkout/components/ScrollBox.ts", "syntaxKind": "PropertySignature", "name": "borderColor", "value": "'' | 'base'", - "description": "Controls the color of the border using the design system's color scale.\n\nWhen set, this overrides the color value specified in the `border` property. Choose from `subdued`, `base`, or `strong` to match the visual emphasis needed.", - "isOptional": true + "description": "The color of the border using the design system's color scale. Overrides the color value set by `border`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" }, { "filePath": "src/surfaces/checkout/components/ScrollBox.ts", "syntaxKind": "PropertySignature", "name": "borderRadius", "value": "MaybeAllValuesShorthandProperty>", - "description": "Controls the roundedness of the element's corners using the design system's radius scale.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) using flow-relative values:\n- One value: applies to all corners\n- Two values: applies to start corners (top-left & bottom-right) and end corners (top-right & bottom-left) respectively\n- Three values: applies to start-start (top-left), end corners (top-right & bottom-left), and end-end (bottom-right) respectively\n- Four values: applies to start-start (top-left), start-end (top-right), end-end (bottom-right), and end-start (bottom-left) respectively\n\nExamples:\n- `small-100`: All corners have `small-100` radius\n- `small-100 none`: Top-left and bottom-right are `small-100`, top-right and bottom-left are `none`\n- `small-100 none large-100`: Top-left is `small-100`, top-right and bottom-left are `none`, bottom-right is `large-100`\n- `small-100 none large-100 base`: Each corner has its specified radius value", + "description": "The roundedness of the scroll box's corners.\n\n- `none`: Sharp corners with no rounding.\n- `small-100` / `small`: Subtle rounding for compact elements.\n- `base`: Standard rounding for most use cases.\n- `large` / `large-100`: More pronounced rounding for prominent containers.\n- `max`: Maximum rounding, creating a pill or circular shape.\n\nSupports 1-to-4-value shorthand syntax for specifying different radii per corner.", "isOptional": true, "defaultValue": "'none'" }, @@ -205223,15 +205538,16 @@ "syntaxKind": "PropertySignature", "name": "borderWidth", "value": "MaybeAllValuesShorthandProperty | ''", - "description": "Controls the thickness of the border on all sides. When set, this overrides the width value specified in the `border` property.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) for specifying different widths per side:\n- One value: applies to all sides\n- Two values: applies to block sides (top/bottom) and inline sides (left/right) respectively\n- Three values: applies to block-start (top), inline sides (left/right), and block-end (bottom) respectively\n- Four values: applies to block-start (top), inline-end (right), block-end (bottom), and inline-start (left) respectively", - "isOptional": true + "description": "The thickness of the border on all sides. Supports 1-to-4-value shorthand syntax for specifying different widths per side. Overrides the width value set by `border`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" }, { "filePath": "src/surfaces/checkout/components/ScrollBox.ts", "syntaxKind": "PropertySignature", "name": "display", "value": "MaybeResponsive<\"auto\" | \"none\">", - "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.", + "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.\n\nLearn more about the [display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display).", "isOptional": true, "defaultValue": "'auto'" }, @@ -205240,7 +205556,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -205399,7 +205715,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityVisibility", "value": "'visible' | 'hidden' | 'exclusive'", - "description": "Changes the visibility of the element.\n\n- `visible`: the element is visible to all users.\n- `hidden`: the element is removed from the accessibility tree but remains visible.\n- `exclusive`: the element is visually hidden but remains in the accessibility tree.", + "description": "Controls how the element is exposed to sighted users and to assistive technologies such as screen readers.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", "isOptional": true, "defaultValue": "'visible'" }, @@ -205422,7 +205738,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/ScrollBox.ts", @@ -205877,7 +206193,7 @@ "syntaxKind": "PropertySignature", "name": "background", "value": "'base' | 'subdued' | 'transparent'", - "description": "Adjust the background of the element.\n\n- `'transparent'`: No visible background.\n- `'subdued'`: A subtle, low-emphasis background.\n- `'base'`: The standard background color.\n- `'strong'`: A high-emphasis background for prominence.", + "description": "The background color of the scroll box.\n\n- `base`: The standard background color for general content areas.\n- `subdued`: A muted background for secondary or supporting content.\n- `transparent`: No background color (the default).", "isOptional": true, "defaultValue": "'transparent'" }, @@ -205916,23 +206232,25 @@ "syntaxKind": "PropertySignature", "name": "border", "value": "BorderShorthand", - "description": "Applies a border using shorthand syntax to specify width, color, and style in a single property.\n\nAccepts a size value, optionally followed by a color, optionally followed by a style. Omitted values use defaults: color defaults to `base`, style defaults to `auto`.\n\nIndividual properties (`borderWidth`, `borderStyle`, `borderColor`) can override values set here.", - "isOptional": true + "description": "A shorthand for setting the border width, color, and style in a single property. Individual border properties (`borderWidth`, `borderStyle`, `borderColor`) can override values set here.", + "isOptional": true, + "defaultValue": "'none'" }, { "filePath": "src/surfaces/checkout/components/ScrollBox.ts", "syntaxKind": "PropertySignature", "name": "borderColor", "value": "'' | 'base'", - "description": "Controls the color of the border using the design system's color scale.\n\nWhen set, this overrides the color value specified in the `border` property. Choose from `subdued`, `base`, or `strong` to match the visual emphasis needed.", - "isOptional": true + "description": "The color of the border using the design system's color scale. Overrides the color value set by `border`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" }, { "filePath": "src/surfaces/checkout/components/ScrollBox.ts", "syntaxKind": "PropertySignature", "name": "borderRadius", "value": "MaybeAllValuesShorthandProperty>", - "description": "Controls the roundedness of the element's corners using the design system's radius scale.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) using flow-relative values:\n- One value: applies to all corners\n- Two values: applies to start corners (top-left & bottom-right) and end corners (top-right & bottom-left) respectively\n- Three values: applies to start-start (top-left), end corners (top-right & bottom-left), and end-end (bottom-right) respectively\n- Four values: applies to start-start (top-left), start-end (top-right), end-end (bottom-right), and end-start (bottom-left) respectively\n\nExamples:\n- `small-100`: All corners have `small-100` radius\n- `small-100 none`: Top-left and bottom-right are `small-100`, top-right and bottom-left are `none`\n- `small-100 none large-100`: Top-left is `small-100`, top-right and bottom-left are `none`, bottom-right is `large-100`\n- `small-100 none large-100 base`: Each corner has its specified radius value", + "description": "The roundedness of the scroll box's corners.\n\n- `none`: Sharp corners with no rounding.\n- `small-100` / `small`: Subtle rounding for compact elements.\n- `base`: Standard rounding for most use cases.\n- `large` / `large-100`: More pronounced rounding for prominent containers.\n- `max`: Maximum rounding, creating a pill or circular shape.\n\nSupports 1-to-4-value shorthand syntax for specifying different radii per corner.", "isOptional": true, "defaultValue": "'none'" }, @@ -205950,8 +206268,9 @@ "syntaxKind": "PropertySignature", "name": "borderWidth", "value": "MaybeAllValuesShorthandProperty | ''", - "description": "Controls the thickness of the border on all sides. When set, this overrides the width value specified in the `border` property.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) for specifying different widths per side:\n- One value: applies to all sides\n- Two values: applies to block sides (top/bottom) and inline sides (left/right) respectively\n- Three values: applies to block-start (top), inline sides (left/right), and block-end (bottom) respectively\n- Four values: applies to block-start (top), inline-end (right), block-end (bottom), and inline-start (left) respectively", - "isOptional": true + "description": "The thickness of the border on all sides. Supports 1-to-4-value shorthand syntax for specifying different widths per side. Overrides the width value set by `border`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" }, { "filePath": "src/surfaces/checkout/components/ScrollBox.ts", @@ -206119,7 +206438,7 @@ "syntaxKind": "PropertySignature", "name": "display", "value": "MaybeResponsive<\"auto\" | \"none\">", - "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.", + "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.\n\nLearn more about the [display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display).", "isOptional": true, "defaultValue": "'auto'" }, @@ -206388,7 +206707,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -207617,7 +207936,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/ScrollBox.ts", @@ -207895,7 +208214,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true } ], @@ -207934,7 +208253,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/Section.ts", @@ -208839,7 +209158,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -209951,7 +210270,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/Section.ts", @@ -210229,7 +210548,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true } ], @@ -210238,7 +210557,7 @@ { "filePath": "src/surfaces/checkout/components/Sheet.ts", "name": "SheetElementProps", - "description": "The Sheet component displays essential information for customers at the bottom of the screen, appearing above other elements. Use it sparingly to avoid distracting customers during checkout. This component requires access to [Customer Privacy API](/docs/api/checkout-ui-extensions/latest/configuration#collect-buyer-consent) to be rendered.\n\nThe library automatically applies the [WAI-ARIA Dialog pattern](https://www.w3.org/WAI/ARIA/apg/patterns/dialog-modal/) to both the activator and the sheet content.", + "description": "", "isPublicDocs": true, "members": [ { @@ -210271,7 +210590,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true } ], @@ -210280,7 +210599,7 @@ { "filePath": "src/surfaces/checkout/components/Sheet.ts", "name": "SheetEvents", - "description": "The event callbacks for monitoring sheet visibility changes.", + "description": "", "isPublicDocs": true, "members": [ { @@ -210321,7 +210640,7 @@ { "filePath": "src/surfaces/checkout/components/Sheet.ts", "name": "SheetElementEvents", - "description": "Learn more about [registering events](/docs/api/checkout-ui-extensions/latest/using-polaris-components#event-handling).", + "description": "", "isPublicDocs": true, "members": [ { @@ -210362,7 +210681,7 @@ { "filePath": "src/surfaces/checkout/components/Sheet.ts", "name": "SheetElementSlots", - "description": "Learn more about [component slots](/docs/api/checkout-ui-extensions/latest/using-polaris-components#slots).", + "description": "", "isPublicDocs": true, "members": [ { @@ -210387,7 +210706,7 @@ { "filePath": "src/surfaces/checkout/components/Sheet.ts", "name": "SheetElementMethods", - "description": "Learn more about [component methods](/docs/api/checkout-ui-extensions/latest/using-polaris-components#methods).", + "description": "", "isPublicDocs": true, "members": [ { @@ -210433,7 +210752,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/Sheet.ts", @@ -211368,7 +211687,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -212508,7 +212827,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/Sheet.ts", @@ -212762,7 +213081,7 @@ { "filePath": "src/surfaces/checkout/components/Sheet.ts", "name": "SheetProps", - "description": "The properties for the sheet component when it's used in JSX.", + "description": "", "isPublicDocs": true, "members": [ { @@ -212795,7 +213114,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -212836,7 +213155,7 @@ { "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", "name": "SkeletonParagraphElementProps", - "description": "Displays a placeholder representation of text content while it loads. Use to improve perceived performance by showing users where text will appear.", + "description": "", "isPublicDocs": true, "members": [ { @@ -212853,7 +213172,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true } ], @@ -212884,7 +213203,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", @@ -213790,7 +214109,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -214902,7 +215221,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", @@ -215173,7 +215492,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true } ], @@ -215182,7 +215501,7 @@ { "filePath": "src/surfaces/checkout/components/Stack.ts", "name": "StackElementProps", - "description": "The stack component organizes elements horizontally or vertically along the block or inline axis. Use stack to structure layouts, group related components, control spacing between elements, or create flexible arrangements that adapt to content.\n\nStacks support gap spacing, alignment, wrapping, and distribution properties to create consistent, responsive layouts without custom CSS. For complex multi-column layouts with precise grid positioning, use [grid](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/layout-and-structure/grid).", + "description": "", "isPublicDocs": true, "members": [ { @@ -215198,7 +215517,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityRole", "value": "'aside' | 'footer' | 'header' | 'main' | 'section' | 'status' | 'none' | 'navigation' | 'ordered-list' | 'list-item' | 'list-item-separator' | 'unordered-list' | 'separator' | 'alert' | 'generic'", - "description": "Sets the semantic meaning of the component’s content. When set, the role will be used by assistive technologies to help users navigate the page.", + "description": "The semantic meaning of the stack's content, used by assistive technologies.\n\n- `aside`: Supporting content related to the main content.\n- `footer`: Information such as copyright, navigation links, and privacy statements.\n- `header`: A page or section header.\n- `main`: The primary content of the page.\n- `section`: A generic section that should have a heading or `accessibilityLabel`.\n- `status`: A live region with advisory information that is not urgent.\n- `none`: Strips semantic meaning while keeping visual styling.\n- `navigation`: A major group of navigation links.\n- `ordered-list`: A list of ordered items.\n- `list-item`: An item inside a list.\n- `list-item-separator`: A divider between list items.\n- `unordered-list`: A list of unordered items.\n- `separator`: A divider that separates sections of content.\n- `alert`: Important, usually time-sensitive information.\n- `generic`: A nameless container with no semantic meaning (renders a `
`).", "isOptional": true, "defaultValue": "'generic'" }, @@ -215207,7 +215526,7 @@ "syntaxKind": "PropertySignature", "name": "alignContent", "value": "MaybeResponsive>", - "description": "Aligns the Stack along the cross axis.", + "description": "Controls how lines of content are distributed along the cross axis when there is extra space.\n\n- `normal`: Default browser behavior.\n- `space-between`: Distributes lines evenly with no space at the edges.\n- `space-around`: Distributes lines evenly with equal space around each.\n- `space-evenly`: Distributes lines with equal space between and at the edges.\n- `stretch`: Stretches lines to fill the available space.\n- `center`: Packs lines toward the center.\n- `start`: Packs lines toward the start of the cross axis.\n- `end`: Packs lines toward the end of the cross axis.", "isOptional": true, "defaultValue": "'normal'" }, @@ -215216,7 +215535,7 @@ "syntaxKind": "PropertySignature", "name": "alignItems", "value": "MaybeResponsive>", - "description": "Aligns the Stack's children along the cross axis.", + "description": "Controls how child elements are aligned along the cross axis.\n\n- `normal`: Default browser behavior.\n- `stretch`: Stretches children to fill the cross axis.\n- `center`: Centers children along the cross axis.\n- `start`: Aligns children to the start of the cross axis.\n- `end`: Aligns children to the end of the cross axis.", "isOptional": true, "defaultValue": "'normal'" }, @@ -215225,7 +215544,7 @@ "syntaxKind": "PropertySignature", "name": "background", "value": "'base' | 'subdued' | 'transparent'", - "description": "Adjust the background of the element.\n\n- `'transparent'`: No visible background.\n- `'subdued'`: A subtle, low-emphasis background.\n- `'base'`: The standard background color.\n- `'strong'`: A high-emphasis background for prominence.", + "description": "The background color of the stack.\n\n- `base`: The standard background color for general content areas.\n- `subdued`: A muted background for secondary or supporting content.\n- `transparent`: No background color (the default).", "isOptional": true, "defaultValue": "'transparent'" }, @@ -215243,9 +215562,9 @@ "syntaxKind": "PropertySignature", "name": "border", "value": "BorderShorthand", - "description": "Applies a border using shorthand syntax to specify width, color, and style in a single property.\n\nAccepts a size value, optionally followed by a color, optionally followed by a style. Omitted values use defaults: color defaults to `base`, style defaults to `auto`.\n\nIndividual properties (`borderWidth`, `borderStyle`, `borderColor`) can override values set here.", + "description": "A shorthand for setting the border width, color, and style in a single property. Individual border properties (`borderWidth`, `borderStyle`) can override values set here.", "isOptional": true, - "defaultValue": "'none' - equivalent to `none base auto`.", + "defaultValue": "'none'", "examples": [ { "title": "Example", @@ -215264,7 +215583,7 @@ "syntaxKind": "PropertySignature", "name": "borderRadius", "value": "MaybeAllValuesShorthandProperty>", - "description": "Controls the roundedness of the element's corners using the design system's radius scale.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) using flow-relative values:\n- One value: applies to all corners\n- Two values: applies to start corners (top-left & bottom-right) and end corners (top-right & bottom-left) respectively\n- Three values: applies to start-start (top-left), end corners (top-right & bottom-left), and end-end (bottom-right) respectively\n- Four values: applies to start-start (top-left), start-end (top-right), end-end (bottom-right), and end-start (bottom-left) respectively\n\nExamples:\n- `small-100`: All corners have `small-100` radius\n- `small-100 none`: Top-left and bottom-right are `small-100`, top-right and bottom-left are `none`\n- `small-100 none large-100`: Top-left is `small-100`, top-right and bottom-left are `none`, bottom-right is `large-100`\n- `small-100 none large-100 base`: Each corner has its specified radius value", + "description": "The roundedness of the stack's corners.\n\n- `none`: Sharp corners with no rounding.\n- `small-100` / `small`: Subtle rounding for compact elements.\n- `base`: Standard rounding for most use cases.\n- `large` / `large-100`: More pronounced rounding for prominent containers.\n- `max`: Maximum rounding, creating a pill or circular shape.\n\nSupports 1-to-4-value shorthand syntax for specifying different radii per corner.", "isOptional": true, "defaultValue": "'none'" }, @@ -215282,7 +215601,7 @@ "syntaxKind": "PropertySignature", "name": "borderWidth", "value": "MaybeAllValuesShorthandProperty | ''", - "description": "Controls the thickness of the border on all sides. When set, this overrides the width value specified in the `border` property.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) for specifying different widths per side:\n- One value: applies to all sides\n- Two values: applies to block sides (top/bottom) and inline sides (left/right) respectively\n- Three values: applies to block-start (top), inline sides (left/right), and block-end (bottom) respectively\n- Four values: applies to block-start (top), inline-end (right), block-end (bottom), and inline-start (left) respectively", + "description": "The thickness of the border on all sides. Supports 1-to-4-value shorthand syntax for specifying different widths per side. Overrides the width value set by `border`.", "isOptional": true, "defaultValue": "'' - meaning no override" }, @@ -215309,7 +215628,7 @@ "syntaxKind": "PropertySignature", "name": "display", "value": "MaybeResponsive<\"auto\" | \"none\">", - "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.", + "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.\n\nLearn more about the [display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display).", "isOptional": true, "defaultValue": "'auto'" }, @@ -215327,7 +215646,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -215344,7 +215663,7 @@ "syntaxKind": "PropertySignature", "name": "justifyContent", "value": "MaybeResponsive>", - "description": "Aligns the Stack along the main axis.", + "description": "Controls how child elements are distributed along the main axis.\n\n- `normal`: Default browser behavior.\n- `space-between`: Distributes children evenly with no space at the edges.\n- `space-around`: Distributes children evenly with equal space around each.\n- `space-evenly`: Distributes children with equal space between and at the edges.\n- `stretch`: Stretches children to fill the available space.\n- `center`: Packs children toward the center.\n- `start`: Packs children toward the start of the main axis.\n- `end`: Packs children toward the end of the main axis.", "isOptional": true, "defaultValue": "'normal'" }, @@ -215466,7 +215785,7 @@ "defaultValue": "'' - meaning no override" } ], - "value": "export interface StackElementProps extends Pick {\n accessibilityRole?: Extract;\n background?: Extract;\n border?: BorderShorthand;\n borderWidth?: MaybeAllValuesShorthandProperty | '';\n borderRadius?: MaybeAllValuesShorthandProperty>;\n alignContent?: MaybeResponsive>;\n alignItems?: MaybeResponsive>;\n justifyContent?: MaybeResponsive>;\n}" + "value": "export interface StackElementProps extends Pick {\n /**\n * The semantic meaning of the stack's content, used by assistive technologies.\n *\n * - `aside`: Supporting content related to the main content.\n * - `footer`: Information such as copyright, navigation links, and privacy statements.\n * - `header`: A page or section header.\n * - `main`: The primary content of the page.\n * - `section`: A generic section that should have a heading or `accessibilityLabel`.\n * - `status`: A live region with advisory information that is not urgent.\n * - `none`: Strips semantic meaning while keeping visual styling.\n * - `navigation`: A major group of navigation links.\n * - `ordered-list`: A list of ordered items.\n * - `list-item`: An item inside a list.\n * - `list-item-separator`: A divider between list items.\n * - `unordered-list`: A list of unordered items.\n * - `separator`: A divider that separates sections of content.\n * - `alert`: Important, usually time-sensitive information.\n * - `generic`: A nameless container with no semantic meaning (renders a `
`).\n *\n * @default 'generic'\n */\n accessibilityRole?: Extract;\n /**\n * The background color of the stack.\n *\n * - `base`: The standard background color for general content areas.\n * - `subdued`: A muted background for secondary or supporting content.\n * - `transparent`: No background color (the default).\n *\n * @default 'transparent'\n */\n background?: Extract;\n /**\n * A shorthand for setting the border width, color, and style in a single property. Individual border properties (`borderWidth`, `borderStyle`) can override values set here.\n *\n * @default 'none'\n */\n border?: BorderShorthand;\n /**\n * The thickness of the border on all sides. Supports 1-to-4-value shorthand syntax for specifying different widths per side. Overrides the width value set by `border`.\n *\n * @default '' - meaning no override\n */\n borderWidth?: MaybeAllValuesShorthandProperty | '';\n /**\n * The roundedness of the stack's corners.\n *\n * - `none`: Sharp corners with no rounding.\n * - `small-100` / `small`: Subtle rounding for compact elements.\n * - `base`: Standard rounding for most use cases.\n * - `large` / `large-100`: More pronounced rounding for prominent containers.\n * - `max`: Maximum rounding, creating a pill or circular shape.\n *\n * Supports 1-to-4-value shorthand syntax for specifying different radii per corner.\n *\n * @default 'none'\n */\n borderRadius?: MaybeAllValuesShorthandProperty>;\n /**\n * Controls how lines of content are distributed along the cross axis when there is extra space.\n *\n * - `normal`: Default browser behavior.\n * - `space-between`: Distributes lines evenly with no space at the edges.\n * - `space-around`: Distributes lines evenly with equal space around each.\n * - `space-evenly`: Distributes lines with equal space between and at the edges.\n * - `stretch`: Stretches lines to fill the available space.\n * - `center`: Packs lines toward the center.\n * - `start`: Packs lines toward the start of the cross axis.\n * - `end`: Packs lines toward the end of the cross axis.\n *\n * @default 'normal'\n */\n alignContent?: MaybeResponsive>;\n /**\n * Controls how child elements are aligned along the cross axis.\n *\n * - `normal`: Default browser behavior.\n * - `stretch`: Stretches children to fill the cross axis.\n * - `center`: Centers children along the cross axis.\n * - `start`: Aligns children to the start of the cross axis.\n * - `end`: Aligns children to the end of the cross axis.\n *\n * @default 'normal'\n */\n alignItems?: MaybeResponsive>;\n /**\n * Controls how child elements are distributed along the main axis.\n *\n * - `normal`: Default browser behavior.\n * - `space-between`: Distributes children evenly with no space at the edges.\n * - `space-around`: Distributes children evenly with equal space around each.\n * - `space-evenly`: Distributes children with equal space between and at the edges.\n * - `stretch`: Stretches children to fill the available space.\n * - `center`: Packs children toward the center.\n * - `start`: Packs children toward the start of the main axis.\n * - `end`: Packs children toward the end of the main axis.\n *\n * @default 'normal'\n */\n justifyContent?: MaybeResponsive>;\n}" }, { "filePath": "src/surfaces/checkout/components/Stack.ts", @@ -215487,7 +215806,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityRole", "value": "'aside' | 'footer' | 'header' | 'main' | 'section' | 'status' | 'none' | 'navigation' | 'ordered-list' | 'list-item' | 'list-item-separator' | 'unordered-list' | 'separator' | 'alert' | 'generic'", - "description": "Sets the semantic meaning of the component’s content. When set, the role will be used by assistive technologies to help users navigate the page.", + "description": "The semantic meaning of the stack's content, used by assistive technologies.\n\n- `aside`: Supporting content related to the main content.\n- `footer`: Information such as copyright, navigation links, and privacy statements.\n- `header`: A page or section header.\n- `main`: The primary content of the page.\n- `section`: A generic section that should have a heading or `accessibilityLabel`.\n- `status`: A live region with advisory information that is not urgent.\n- `none`: Strips semantic meaning while keeping visual styling.\n- `navigation`: A major group of navigation links.\n- `ordered-list`: A list of ordered items.\n- `list-item`: An item inside a list.\n- `list-item-separator`: A divider between list items.\n- `unordered-list`: A list of unordered items.\n- `separator`: A divider that separates sections of content.\n- `alert`: Important, usually time-sensitive information.\n- `generic`: A nameless container with no semantic meaning (renders a `
`).", "isOptional": true, "defaultValue": "'generic'" }, @@ -215496,7 +215815,7 @@ "syntaxKind": "PropertySignature", "name": "alignContent", "value": "MaybeResponsive>", - "description": "Aligns the Stack along the cross axis.", + "description": "Controls how lines of content are distributed along the cross axis when there is extra space.\n\n- `normal`: Default browser behavior.\n- `space-between`: Distributes lines evenly with no space at the edges.\n- `space-around`: Distributes lines evenly with equal space around each.\n- `space-evenly`: Distributes lines with equal space between and at the edges.\n- `stretch`: Stretches lines to fill the available space.\n- `center`: Packs lines toward the center.\n- `start`: Packs lines toward the start of the cross axis.\n- `end`: Packs lines toward the end of the cross axis.", "isOptional": true, "defaultValue": "'normal'" }, @@ -215505,7 +215824,7 @@ "syntaxKind": "PropertySignature", "name": "alignItems", "value": "MaybeResponsive>", - "description": "Aligns the Stack's children along the cross axis.", + "description": "Controls how child elements are aligned along the cross axis.\n\n- `normal`: Default browser behavior.\n- `stretch`: Stretches children to fill the cross axis.\n- `center`: Centers children along the cross axis.\n- `start`: Aligns children to the start of the cross axis.\n- `end`: Aligns children to the end of the cross axis.", "isOptional": true, "defaultValue": "'normal'" }, @@ -215514,7 +215833,7 @@ "syntaxKind": "PropertySignature", "name": "background", "value": "'base' | 'subdued' | 'transparent'", - "description": "Adjust the background of the element.\n\n- `'transparent'`: No visible background.\n- `'subdued'`: A subtle, low-emphasis background.\n- `'base'`: The standard background color.\n- `'strong'`: A high-emphasis background for prominence.", + "description": "The background color of the stack.\n\n- `base`: The standard background color for general content areas.\n- `subdued`: A muted background for secondary or supporting content.\n- `transparent`: No background color (the default).", "isOptional": true, "defaultValue": "'transparent'" }, @@ -215532,15 +215851,16 @@ "syntaxKind": "PropertySignature", "name": "border", "value": "BorderShorthand", - "description": "Applies a border using shorthand syntax to specify width, color, and style in a single property.\n\nAccepts a size value, optionally followed by a color, optionally followed by a style. Omitted values use defaults: color defaults to `base`, style defaults to `auto`.\n\nIndividual properties (`borderWidth`, `borderStyle`, `borderColor`) can override values set here.", - "isOptional": true + "description": "A shorthand for setting the border width, color, and style in a single property. Individual border properties (`borderWidth`, `borderStyle`) can override values set here.", + "isOptional": true, + "defaultValue": "'none'" }, { "filePath": "src/surfaces/checkout/components/Stack.ts", "syntaxKind": "PropertySignature", "name": "borderRadius", "value": "MaybeAllValuesShorthandProperty>", - "description": "Controls the roundedness of the element's corners using the design system's radius scale.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) using flow-relative values:\n- One value: applies to all corners\n- Two values: applies to start corners (top-left & bottom-right) and end corners (top-right & bottom-left) respectively\n- Three values: applies to start-start (top-left), end corners (top-right & bottom-left), and end-end (bottom-right) respectively\n- Four values: applies to start-start (top-left), start-end (top-right), end-end (bottom-right), and end-start (bottom-left) respectively\n\nExamples:\n- `small-100`: All corners have `small-100` radius\n- `small-100 none`: Top-left and bottom-right are `small-100`, top-right and bottom-left are `none`\n- `small-100 none large-100`: Top-left is `small-100`, top-right and bottom-left are `none`, bottom-right is `large-100`\n- `small-100 none large-100 base`: Each corner has its specified radius value", + "description": "The roundedness of the stack's corners.\n\n- `none`: Sharp corners with no rounding.\n- `small-100` / `small`: Subtle rounding for compact elements.\n- `base`: Standard rounding for most use cases.\n- `large` / `large-100`: More pronounced rounding for prominent containers.\n- `max`: Maximum rounding, creating a pill or circular shape.\n\nSupports 1-to-4-value shorthand syntax for specifying different radii per corner.", "isOptional": true, "defaultValue": "'none'" }, @@ -215558,8 +215878,9 @@ "syntaxKind": "PropertySignature", "name": "borderWidth", "value": "MaybeAllValuesShorthandProperty | ''", - "description": "Controls the thickness of the border on all sides. When set, this overrides the width value specified in the `border` property.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) for specifying different widths per side:\n- One value: applies to all sides\n- Two values: applies to block sides (top/bottom) and inline sides (left/right) respectively\n- Three values: applies to block-start (top), inline sides (left/right), and block-end (bottom) respectively\n- Four values: applies to block-start (top), inline-end (right), block-end (bottom), and inline-start (left) respectively", - "isOptional": true + "description": "The thickness of the border on all sides. Supports 1-to-4-value shorthand syntax for specifying different widths per side. Overrides the width value set by `border`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" }, { "filePath": "src/surfaces/checkout/components/Stack.ts", @@ -215584,7 +215905,7 @@ "syntaxKind": "PropertySignature", "name": "display", "value": "MaybeResponsive<\"auto\" | \"none\">", - "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.", + "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.\n\nLearn more about the [display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display).", "isOptional": true, "defaultValue": "'auto'" }, @@ -215602,7 +215923,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -215619,7 +215940,7 @@ "syntaxKind": "PropertySignature", "name": "justifyContent", "value": "MaybeResponsive>", - "description": "Aligns the Stack along the main axis.", + "description": "Controls how child elements are distributed along the main axis.\n\n- `normal`: Default browser behavior.\n- `space-between`: Distributes children evenly with no space at the edges.\n- `space-around`: Distributes children evenly with equal space around each.\n- `space-evenly`: Distributes children with equal space between and at the edges.\n- `stretch`: Stretches children to fill the available space.\n- `center`: Packs children toward the center.\n- `start`: Packs children toward the start of the main axis.\n- `end`: Packs children toward the end of the main axis.", "isOptional": true, "defaultValue": "'normal'" }, @@ -215762,7 +216083,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityRole", "value": "'aside' | 'footer' | 'header' | 'main' | 'section' | 'status' | 'none' | 'navigation' | 'ordered-list' | 'list-item' | 'list-item-separator' | 'unordered-list' | 'separator' | 'alert' | 'generic'", - "description": "Sets the semantic meaning of the component’s content. When set, the role will be used by assistive technologies to help users navigate the page.", + "description": "The semantic meaning of the stack's content, used by assistive technologies.\n\n- `aside`: Supporting content related to the main content.\n- `footer`: Information such as copyright, navigation links, and privacy statements.\n- `header`: A page or section header.\n- `main`: The primary content of the page.\n- `section`: A generic section that should have a heading or `accessibilityLabel`.\n- `status`: A live region with advisory information that is not urgent.\n- `none`: Strips semantic meaning while keeping visual styling.\n- `navigation`: A major group of navigation links.\n- `ordered-list`: A list of ordered items.\n- `list-item`: An item inside a list.\n- `list-item-separator`: A divider between list items.\n- `unordered-list`: A list of unordered items.\n- `separator`: A divider that separates sections of content.\n- `alert`: Important, usually time-sensitive information.\n- `generic`: A nameless container with no semantic meaning (renders a `
`).", "isOptional": true, "defaultValue": "'generic'" }, @@ -215785,7 +216106,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/Stack.ts", @@ -215799,7 +216120,7 @@ "syntaxKind": "PropertySignature", "name": "alignContent", "value": "MaybeResponsive>", - "description": "Aligns the Stack along the cross axis.", + "description": "Controls how lines of content are distributed along the cross axis when there is extra space.\n\n- `normal`: Default browser behavior.\n- `space-between`: Distributes lines evenly with no space at the edges.\n- `space-around`: Distributes lines evenly with equal space around each.\n- `space-evenly`: Distributes lines with equal space between and at the edges.\n- `stretch`: Stretches lines to fill the available space.\n- `center`: Packs lines toward the center.\n- `start`: Packs lines toward the start of the cross axis.\n- `end`: Packs lines toward the end of the cross axis.", "isOptional": true, "defaultValue": "'normal'" }, @@ -215808,7 +216129,7 @@ "syntaxKind": "PropertySignature", "name": "alignItems", "value": "MaybeResponsive>", - "description": "Aligns the Stack's children along the cross axis.", + "description": "Controls how child elements are aligned along the cross axis.\n\n- `normal`: Default browser behavior.\n- `stretch`: Stretches children to fill the cross axis.\n- `center`: Centers children along the cross axis.\n- `start`: Aligns children to the start of the cross axis.\n- `end`: Aligns children to the end of the cross axis.", "isOptional": true, "defaultValue": "'normal'" }, @@ -216258,7 +216579,7 @@ "syntaxKind": "PropertySignature", "name": "background", "value": "'base' | 'subdued' | 'transparent'", - "description": "Adjust the background of the element.\n\n- `'transparent'`: No visible background.\n- `'subdued'`: A subtle, low-emphasis background.\n- `'base'`: The standard background color.\n- `'strong'`: A high-emphasis background for prominence.", + "description": "The background color of the stack.\n\n- `base`: The standard background color for general content areas.\n- `subdued`: A muted background for secondary or supporting content.\n- `transparent`: No background color (the default).", "isOptional": true, "defaultValue": "'transparent'" }, @@ -216297,15 +216618,16 @@ "syntaxKind": "PropertySignature", "name": "border", "value": "BorderShorthand", - "description": "Applies a border using shorthand syntax to specify width, color, and style in a single property.\n\nAccepts a size value, optionally followed by a color, optionally followed by a style. Omitted values use defaults: color defaults to `base`, style defaults to `auto`.\n\nIndividual properties (`borderWidth`, `borderStyle`, `borderColor`) can override values set here.", - "isOptional": true + "description": "A shorthand for setting the border width, color, and style in a single property. Individual border properties (`borderWidth`, `borderStyle`) can override values set here.", + "isOptional": true, + "defaultValue": "'none'" }, { "filePath": "src/surfaces/checkout/components/Stack.ts", "syntaxKind": "PropertySignature", "name": "borderRadius", "value": "MaybeAllValuesShorthandProperty>", - "description": "Controls the roundedness of the element's corners using the design system's radius scale.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) using flow-relative values:\n- One value: applies to all corners\n- Two values: applies to start corners (top-left & bottom-right) and end corners (top-right & bottom-left) respectively\n- Three values: applies to start-start (top-left), end corners (top-right & bottom-left), and end-end (bottom-right) respectively\n- Four values: applies to start-start (top-left), start-end (top-right), end-end (bottom-right), and end-start (bottom-left) respectively\n\nExamples:\n- `small-100`: All corners have `small-100` radius\n- `small-100 none`: Top-left and bottom-right are `small-100`, top-right and bottom-left are `none`\n- `small-100 none large-100`: Top-left is `small-100`, top-right and bottom-left are `none`, bottom-right is `large-100`\n- `small-100 none large-100 base`: Each corner has its specified radius value", + "description": "The roundedness of the stack's corners.\n\n- `none`: Sharp corners with no rounding.\n- `small-100` / `small`: Subtle rounding for compact elements.\n- `base`: Standard rounding for most use cases.\n- `large` / `large-100`: More pronounced rounding for prominent containers.\n- `max`: Maximum rounding, creating a pill or circular shape.\n\nSupports 1-to-4-value shorthand syntax for specifying different radii per corner.", "isOptional": true, "defaultValue": "'none'" }, @@ -216323,8 +216645,9 @@ "syntaxKind": "PropertySignature", "name": "borderWidth", "value": "MaybeAllValuesShorthandProperty | ''", - "description": "Controls the thickness of the border on all sides. When set, this overrides the width value specified in the `border` property.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) for specifying different widths per side:\n- One value: applies to all sides\n- Two values: applies to block sides (top/bottom) and inline sides (left/right) respectively\n- Three values: applies to block-start (top), inline sides (left/right), and block-end (bottom) respectively\n- Four values: applies to block-start (top), inline-end (right), block-end (bottom), and inline-start (left) respectively", - "isOptional": true + "description": "The thickness of the border on all sides. Supports 1-to-4-value shorthand syntax for specifying different widths per side. Overrides the width value set by `border`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" }, { "filePath": "src/surfaces/checkout/components/Stack.ts", @@ -216510,7 +216833,7 @@ "syntaxKind": "PropertySignature", "name": "display", "value": "MaybeResponsive<\"auto\" | \"none\">", - "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.", + "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.\n\nLearn more about the [display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display).", "isOptional": true, "defaultValue": "'auto'" }, @@ -216788,7 +217111,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -216896,7 +217219,7 @@ "syntaxKind": "PropertySignature", "name": "justifyContent", "value": "MaybeResponsive>", - "description": "Aligns the Stack along the main axis.", + "description": "Controls how child elements are distributed along the main axis.\n\n- `normal`: Default browser behavior.\n- `space-between`: Distributes children evenly with no space at the edges.\n- `space-around`: Distributes children evenly with equal space around each.\n- `space-evenly`: Distributes children with equal space between and at the edges.\n- `stretch`: Stretches children to fill the available space.\n- `center`: Packs children toward the center.\n- `start`: Packs children toward the start of the main axis.\n- `end`: Packs children toward the end of the main axis.", "isOptional": true, "defaultValue": "'normal'" }, @@ -218026,7 +218349,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/Stack.ts", @@ -218289,7 +218612,7 @@ { "filePath": "src/surfaces/checkout/components/Summary.ts", "name": "SummaryElementProps", - "description": "Provides a clickable label for collapsible Details content. Use to create clear, accessible disclosure controls that show or hide additional information.", + "description": "", "isPublicDocs": true, "members": [ { @@ -218297,7 +218620,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true } ], @@ -218328,7 +218651,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/Summary.ts", @@ -219225,7 +219548,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -220337,7 +220660,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/Summary.ts", @@ -220599,7 +220922,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true } ], @@ -220608,7 +220931,7 @@ { "filePath": "src/surfaces/checkout/components/Switch.ts", "name": "SwitchElementProps", - "description": "The switch component provides a clear way for users to toggle options or settings on and off. Use switch for binary controls that take effect immediately, like enabling features, activating settings, or controlling visibility.\n\nSwitches provide instant visual feedback and are ideal for settings that don't require a save action to apply changes. For selections that require explicit submission, use [checkbox](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/forms/checkbox) instead.", + "description": "", "isPublicDocs": true, "members": [ { @@ -220624,7 +220947,7 @@ "syntaxKind": "PropertySignature", "name": "checked", "value": "boolean", - "description": "Whether the control is active.", + "description": "Whether the control is currently checked.", "isOptional": true, "defaultValue": "false" }, @@ -220633,7 +220956,7 @@ "syntaxKind": "PropertySignature", "name": "command", "value": "'--auto' | '--show' | '--hide' | '--toggle'", - "description": "Sets the action the `commandFor` should take when this clickable is activated.\n\nSee the documentation of particular components for the actions they support.\n\n- `--auto`: Performs the default action for the target component.\n- `--show`: Displays the target component.\n- `--hide`: Conceals the target component.\n- `--toggle`: Alternates the target component.\n- `--copy`: Copies the target ClipboardItem.", + "description": "Sets the action the `commandFor` target should take when this component is activated.\n\n- `--auto`: Performs the default action for the target component.\n- `--show`: Displays the target component.\n- `--hide`: Conceals the target component.\n- `--toggle`: Alternates the target component.\n- `--copy`: Copies the target ClipboardItem.\n\nLearn more about the [`command` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).", "isOptional": true, "defaultValue": "'--auto'" }, @@ -220642,7 +220965,7 @@ "syntaxKind": "PropertySignature", "name": "commandFor", "value": "string", - "description": "ID of a component that should respond to activations (such as clicks) on this component.\n\nSee `command` for how to control the behavior of the target.", + "description": "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).\n\nWhen both `commandFor` and `href` are set, `commandFor` takes precedence. The command runs and the link doesn't navigate.", "isOptional": true }, { @@ -220650,7 +220973,7 @@ "syntaxKind": "PropertySignature", "name": "defaultChecked", "value": "boolean", - "description": "Whether the control is active by default.", + "description": "Whether the control is checked by default.", "isOptional": true, "defaultValue": "false" }, @@ -220659,7 +220982,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the control, disallowing any interaction.", + "description": "Whether the control is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -220668,7 +220991,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -220676,7 +220999,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Visual content to use as the control label.", + "description": "The text displayed as the control label, which identifies the purpose of the control to users. This label is associated with the control for accessibility.", "isOptional": true }, { @@ -220684,7 +221007,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the control that is unique within the nearest containing `Form` component.", + "description": "The name attribute for the control, used to identify its value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -220718,7 +221041,7 @@ { "filePath": "src/surfaces/checkout/components/Switch.ts", "name": "SwitchElementEvents", - "description": "Learn more about [registering events](/docs/api/checkout-ui-extensions/latest/using-polaris-components#event-handling).", + "description": "", "isPublicDocs": true, "members": [ { @@ -220726,11 +221049,11 @@ "syntaxKind": "PropertySignature", "name": "change", "value": "CallbackEventListener", - "description": "A callback that is run whenever the control is changed.", + "description": "A callback fired when the switch value changes.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", "isOptional": true } ], - "value": "export interface SwitchElementEvents {\n /**\n * A callback that is run whenever the control is changed.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event\n */\n change?: CallbackEventListener;\n}" + "value": "export interface SwitchElementEvents {\n /**\n * A callback fired when the switch value changes.\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change?: CallbackEventListener;\n}" }, { "filePath": "src/surfaces/checkout/components/Switch.ts", @@ -220765,7 +221088,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/Switch.ts", @@ -221248,7 +221571,7 @@ "syntaxKind": "PropertySignature", "name": "checked", "value": "boolean", - "description": "Whether the control is active.", + "description": "Whether the control is currently checked.", "isOptional": true, "defaultValue": "false" }, @@ -221348,7 +221671,7 @@ "syntaxKind": "PropertySignature", "name": "command", "value": "'--auto' | '--show' | '--hide' | '--toggle'", - "description": "Sets the action the `commandFor` should take when this clickable is activated.\n\nSee the documentation of particular components for the actions they support.\n\n- `--auto`: Performs the default action for the target component.\n- `--show`: Displays the target component.\n- `--hide`: Conceals the target component.\n- `--toggle`: Alternates the target component.\n- `--copy`: Copies the target ClipboardItem.", + "description": "Sets the action the `commandFor` target should take when this component is activated.\n\n- `--auto`: Performs the default action for the target component.\n- `--show`: Displays the target component.\n- `--hide`: Conceals the target component.\n- `--toggle`: Alternates the target component.\n- `--copy`: Copies the target ClipboardItem.\n\nLearn more about the [`command` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).", "isOptional": true, "defaultValue": "'--auto'" }, @@ -221357,7 +221680,7 @@ "syntaxKind": "PropertySignature", "name": "commandFor", "value": "string", - "description": "ID of a component that should respond to activations (such as clicks) on this component.\n\nSee `command` for how to control the behavior of the target.", + "description": "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).\n\nWhen both `commandFor` and `href` are set, `commandFor` takes precedence. The command runs and the link doesn't navigate.", "isOptional": true }, { @@ -221414,7 +221737,7 @@ "syntaxKind": "PropertySignature", "name": "defaultChecked", "value": "boolean", - "description": "Whether the control is active by default.", + "description": "Whether the control is checked by default.", "isOptional": true, "defaultValue": "false" }, @@ -221430,7 +221753,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the control, disallowing any interaction.", + "description": "Whether the control is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -221706,7 +222029,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -221805,7 +222128,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Visual content to use as the control label.", + "description": "The text displayed as the control label, which identifies the purpose of the control to users. This label is associated with the control for accessibility.", "isOptional": true }, { @@ -221862,7 +222185,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the control that is unique within the nearest containing `Form` component.", + "description": "The name attribute for the control, used to identify its value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -222834,7 +223157,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/Switch.ts", @@ -223112,7 +223435,7 @@ "syntaxKind": "PropertySignature", "name": "checked", "value": "boolean", - "description": "Whether the control is active.", + "description": "Whether the control is currently checked.", "isOptional": true, "defaultValue": "false" }, @@ -223121,7 +223444,7 @@ "syntaxKind": "PropertySignature", "name": "command", "value": "'--auto' | '--show' | '--hide' | '--toggle'", - "description": "Sets the action the `commandFor` should take when this clickable is activated.\n\nSee the documentation of particular components for the actions they support.\n\n- `--auto`: Performs the default action for the target component.\n- `--show`: Displays the target component.\n- `--hide`: Conceals the target component.\n- `--toggle`: Alternates the target component.\n- `--copy`: Copies the target ClipboardItem.", + "description": "Sets the action the `commandFor` target should take when this component is activated.\n\n- `--auto`: Performs the default action for the target component.\n- `--show`: Displays the target component.\n- `--hide`: Conceals the target component.\n- `--toggle`: Alternates the target component.\n- `--copy`: Copies the target ClipboardItem.\n\nLearn more about the [`command` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).", "isOptional": true, "defaultValue": "'--auto'" }, @@ -223130,7 +223453,7 @@ "syntaxKind": "PropertySignature", "name": "commandFor", "value": "string", - "description": "ID of a component that should respond to activations (such as clicks) on this component.\n\nSee `command` for how to control the behavior of the target.", + "description": "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).\n\nWhen both `commandFor` and `href` are set, `commandFor` takes precedence. The command runs and the link doesn't navigate.", "isOptional": true }, { @@ -223138,7 +223461,7 @@ "syntaxKind": "PropertySignature", "name": "defaultChecked", "value": "boolean", - "description": "Whether the control is active by default.", + "description": "Whether the control is checked by default.", "isOptional": true, "defaultValue": "false" }, @@ -223147,7 +223470,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the control, disallowing any interaction.", + "description": "Whether the control is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -223156,7 +223479,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -223164,7 +223487,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Visual content to use as the control label.", + "description": "The text displayed as the control label, which identifies the purpose of the control to users. This label is associated with the control for accessibility.", "isOptional": true }, { @@ -223172,7 +223495,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the control that is unique within the nearest containing `Form` component.", + "description": "The name attribute for the control, used to identify its value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -223197,7 +223520,7 @@ { "filePath": "src/surfaces/checkout/components/Text.ts", "name": "TextElementProps", - "description": "The text component displays inline text with specific visual styles or tones. Use text to emphasize or differentiate words or phrases within paragraphs or other block-level components, applying weight, color, or semantic styling.\n\nText supports multiple visual variants, alignment options, and line clamping for flexible inline typography control. For block-level text content, use [paragraph](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/typography-and-content/paragraph).", + "description": "", "isPublicDocs": true, "members": [ { @@ -223205,7 +223528,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityVisibility", "value": "'visible' | 'hidden' | 'exclusive'", - "description": "Changes the visibility of the element.\n\n- `visible`: the element is visible to all users.\n- `hidden`: the element is removed from the accessibility tree but remains visible.\n- `exclusive`: the element is visually hidden but remains in the accessibility tree.", + "description": "Controls how the element is exposed to sighted users and to assistive technologies such as screen readers.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", "isOptional": true, "defaultValue": "'visible'" }, @@ -223214,7 +223537,7 @@ "syntaxKind": "PropertySignature", "name": "color", "value": "'base' | 'subdued'", - "description": "Modify the color to be more or less intense.", + "description": "The color emphasis level that controls visual intensity.\n\n- `subdued`: Deemphasized color for secondary text, supporting labels, and less critical interface elements.\n- `base`: Primary color for body text, standard UI elements, and general content with good readability.\n- `strong`: Emphasized color for headings, key labels, and interactive elements that need prominence.", "isOptional": true, "defaultValue": "'base'" }, @@ -223223,7 +223546,7 @@ "syntaxKind": "PropertySignature", "name": "dir", "value": "'ltr' | 'rtl' | 'auto' | ''", - "description": "Indicates the directionality of the element’s text.\n\n- `ltr`: languages written from left to right (such as English)\n- `rtl`: languages written from right to left (such as Arabic)\n- `auto`: the user agent determines the direction based on the content\n- `''`: direction is inherited from parent elements (equivalent to not setting the attribute)", + "description": "Indicates the directionality of the element’s text.\n\n- `ltr`: The languages written from left to right (such as English).\n- `rtl`: The languages written from right to left (such as Arabic).\n- `auto`: The user agent determines the direction based on the content.\n- `\"\"`: The direction is inherited from parent elements (equivalent to not setting the attribute).\n\nLearn more about the [dir attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/dir).", "isOptional": true, "defaultValue": "''" }, @@ -223232,7 +223555,7 @@ "syntaxKind": "PropertySignature", "name": "display", "value": "MaybeResponsive<\"auto\" | \"none\">", - "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.", + "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.\n\nLearn more about the [display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display).", "isOptional": true, "defaultValue": "'auto'" }, @@ -223241,7 +223564,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -223249,7 +223572,7 @@ "syntaxKind": "PropertySignature", "name": "lang", "value": "string", - "description": "The language of the button's text content. Use this when the button text is in a different language than the rest of the page, so assistive technologies can invoke the correct pronunciation. [Reference of values](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry) (`Subtag` label)\n\nIt is recommended to combine it with the `dir` attribute to ensure the text is rendered correctly if the surrounding content’s direction is different.", + "description": "Indicate the text language. Useful when the text is in a different language than the rest of the page. It will allow assistive technologies such as screen readers to invoke the correct pronunciation. [Reference of values](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry) (\"subtag\" label)\n\nIt is recommended to combine it with the `dir` attribute to ensure the text is rendered correctly if the surrounding content’s direction is different.", "isOptional": true, "defaultValue": "''" }, @@ -223258,7 +223581,7 @@ "syntaxKind": "PropertySignature", "name": "tone", "value": "'info' | 'auto' | 'neutral' | 'success' | 'warning' | 'critical' | 'custom'", - "description": "Sets the tone of the component, based on the intention of the information being conveyed.", + "description": "The semantic meaning and color treatment of the component.\n\n- `auto`: Automatically determined based on context.\n- `neutral`: General information without specific intent.\n- `info`: Informational content or helpful tips.\n- `success`: Positive outcomes or successful states.\n- `warning`: Important warnings about potential issues.\n- `critical`: Urgent problems or destructive actions.\n- `custom`: Custom styling controlled by your theme.", "isOptional": true, "defaultValue": "'auto'" }, @@ -223267,12 +223590,12 @@ "syntaxKind": "PropertySignature", "name": "type", "value": "'address' | 'mark' | 'small' | 'strong' | 'generic' | 'redundant' | 'emphasis' | 'offset'", - "description": "Provide semantic meaning and default styling to the text.\n\nOther presentation properties on Text override the default styling.", + "description": "The semantic type and styling treatment for the text content.\n\nOther presentation properties on `s-text` override the default styling.\n\n- `address`: A semantic type that indicates the text is contact information. Typically used for addresses.\n- `redundant`: A semantic type that indicates the text is no longer accurate or no longer relevant.\n- `mark`: A semantic type that indicates the text is marked or highlighted.\n- `emphasis`: A semantic type that indicates emphatic stress.\n- `offset`: A semantic type that indicates an offset from the normal prose.\n- `strong`: A semantic type that indicates strong importance, seriousness, or urgency.\n- `small`: A semantic type that indicates less important text.\n- `generic`: No additional semantics or styling is applied.", "isOptional": true, "defaultValue": "'generic'" } ], - "value": "export interface TextElementProps extends Pick {\n color?: Extract;\n tone?: Extract;\n type?: Extract;\n}" + "value": "export interface TextElementProps extends Pick {\n color?: Extract;\n tone?: Extract;\n /**\n * The semantic type and styling treatment for the text content.\n *\n * Other presentation properties on `s-text` override the default styling.\n *\n * - `address`: A semantic type that indicates the text is contact information. Typically used for addresses.\n * - `redundant`: A semantic type that indicates the text is no longer accurate or no longer relevant.\n * - `mark`: A semantic type that indicates the text is marked or highlighted.\n * - `emphasis`: A semantic type that indicates emphatic stress.\n * - `offset`: A semantic type that indicates an offset from the normal prose.\n * - `strong`: A semantic type that indicates strong importance, seriousness, or urgency.\n * - `small`: A semantic type that indicates less important text.\n * - `generic`: No additional semantics or styling is applied.\n *\n * @default 'generic'\n */\n type?: Extract;\n}" }, { "filePath": "src/surfaces/checkout/components/Text.ts", @@ -223285,7 +223608,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityVisibility", "value": "'visible' | 'hidden' | 'exclusive'", - "description": "Changes the visibility of the element.\n\n- `visible`: the element is visible to all users.\n- `hidden`: the element is removed from the accessibility tree but remains visible.\n- `exclusive`: the element is visually hidden but remains in the accessibility tree.", + "description": "Controls how the element is exposed to sighted users and to assistive technologies such as screen readers.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", "isOptional": true, "defaultValue": "'visible'" }, @@ -223308,7 +223631,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/Text.ts", @@ -223882,7 +224205,7 @@ "syntaxKind": "PropertySignature", "name": "color", "value": "'base' | 'subdued'", - "description": "Modify the color to be more or less intense.", + "description": "The color emphasis level that controls visual intensity.\n\n- `subdued`: Deemphasized color for secondary text, supporting labels, and less critical interface elements.\n- `base`: Primary color for body text, standard UI elements, and general content with good readability.\n- `strong`: Emphasized color for headings, key labels, and interactive elements that need prominence.", "isOptional": true, "defaultValue": "'base'" }, @@ -223940,7 +224263,7 @@ "syntaxKind": "PropertySignature", "name": "dir", "value": "'ltr' | 'rtl' | 'auto' | ''", - "description": "Indicates the directionality of the element’s text.\n\n- `ltr`: languages written from left to right (such as English)\n- `rtl`: languages written from right to left (such as Arabic)\n- `auto`: the user agent determines the direction based on the content\n- `''`: direction is inherited from parent elements (equivalent to not setting the attribute)", + "description": "Indicates the directionality of the element’s text.\n\n- `ltr`: The languages written from left to right (such as English).\n- `rtl`: The languages written from right to left (such as Arabic).\n- `auto`: The user agent determines the direction based on the content.\n- `\"\"`: The direction is inherited from parent elements (equivalent to not setting the attribute).\n\nLearn more about the [dir attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/dir).", "isOptional": true, "defaultValue": "''" }, @@ -223956,7 +224279,7 @@ "syntaxKind": "PropertySignature", "name": "display", "value": "MaybeResponsive<\"auto\" | \"none\">", - "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.", + "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.\n\nLearn more about the [display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display).", "isOptional": true, "defaultValue": "'auto'" }, @@ -224225,7 +224548,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -224324,7 +224647,7 @@ "syntaxKind": "PropertySignature", "name": "lang", "value": "string", - "description": "The language of the button's text content. Use this when the button text is in a different language than the rest of the page, so assistive technologies can invoke the correct pronunciation. [Reference of values](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry) (`Subtag` label)\n\nIt is recommended to combine it with the `dir` attribute to ensure the text is rendered correctly if the surrounding content’s direction is different.", + "description": "Indicate the text language. Useful when the text is in a different language than the rest of the page. It will allow assistive technologies such as screen readers to invoke the correct pronunciation. [Reference of values](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry) (\"subtag\" label)\n\nIt is recommended to combine it with the `dir` attribute to ensure the text is rendered correctly if the surrounding content’s direction is different.", "isOptional": true, "defaultValue": "''" }, @@ -225339,7 +225662,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/Text.ts", @@ -225570,7 +225893,7 @@ "syntaxKind": "PropertySignature", "name": "tone", "value": "'info' | 'auto' | 'neutral' | 'success' | 'warning' | 'critical' | 'custom'", - "description": "Sets the tone of the component, based on the intention of the information being conveyed.", + "description": "The semantic meaning and color treatment of the component.\n\n- `auto`: Automatically determined based on context.\n- `neutral`: General information without specific intent.\n- `info`: Informational content or helpful tips.\n- `success`: Positive outcomes or successful states.\n- `warning`: Important warnings about potential issues.\n- `critical`: Urgent problems or destructive actions.\n- `custom`: Custom styling controlled by your theme.", "isOptional": true, "defaultValue": "'auto'" }, @@ -225586,7 +225909,7 @@ "syntaxKind": "PropertySignature", "name": "type", "value": "'address' | 'mark' | 'small' | 'strong' | 'generic' | 'redundant' | 'emphasis' | 'offset'", - "description": "Provide semantic meaning and default styling to the text.\n\nOther presentation properties on Text override the default styling.", + "description": "The semantic type and styling treatment for the text content.\n\nOther presentation properties on `s-text` override the default styling.\n\n- `address`: A semantic type that indicates the text is contact information. Typically used for addresses.\n- `redundant`: A semantic type that indicates the text is no longer accurate or no longer relevant.\n- `mark`: A semantic type that indicates the text is marked or highlighted.\n- `emphasis`: A semantic type that indicates emphatic stress.\n- `offset`: A semantic type that indicates an offset from the normal prose.\n- `strong`: A semantic type that indicates strong importance, seriousness, or urgency.\n- `small`: A semantic type that indicates less important text.\n- `generic`: No additional semantics or styling is applied.", "isOptional": true, "defaultValue": "'generic'" }, @@ -225619,7 +225942,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityVisibility", "value": "'visible' | 'hidden' | 'exclusive'", - "description": "Changes the visibility of the element.\n\n- `visible`: the element is visible to all users.\n- `hidden`: the element is removed from the accessibility tree but remains visible.\n- `exclusive`: the element is visually hidden but remains in the accessibility tree.", + "description": "Controls how the element is exposed to sighted users and to assistive technologies such as screen readers.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", "isOptional": true, "defaultValue": "'visible'" }, @@ -225628,7 +225951,7 @@ "syntaxKind": "PropertySignature", "name": "color", "value": "'base' | 'subdued'", - "description": "Modify the color to be more or less intense.", + "description": "The color emphasis level that controls visual intensity.\n\n- `subdued`: Deemphasized color for secondary text, supporting labels, and less critical interface elements.\n- `base`: Primary color for body text, standard UI elements, and general content with good readability.\n- `strong`: Emphasized color for headings, key labels, and interactive elements that need prominence.", "isOptional": true, "defaultValue": "'base'" }, @@ -225637,7 +225960,7 @@ "syntaxKind": "PropertySignature", "name": "dir", "value": "'ltr' | 'rtl' | 'auto' | ''", - "description": "Indicates the directionality of the element’s text.\n\n- `ltr`: languages written from left to right (such as English)\n- `rtl`: languages written from right to left (such as Arabic)\n- `auto`: the user agent determines the direction based on the content\n- `''`: direction is inherited from parent elements (equivalent to not setting the attribute)", + "description": "Indicates the directionality of the element’s text.\n\n- `ltr`: The languages written from left to right (such as English).\n- `rtl`: The languages written from right to left (such as Arabic).\n- `auto`: The user agent determines the direction based on the content.\n- `\"\"`: The direction is inherited from parent elements (equivalent to not setting the attribute).\n\nLearn more about the [dir attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/dir).", "isOptional": true, "defaultValue": "''" }, @@ -225646,7 +225969,7 @@ "syntaxKind": "PropertySignature", "name": "display", "value": "MaybeResponsive<\"auto\" | \"none\">", - "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.", + "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.\n\nLearn more about the [display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display).", "isOptional": true, "defaultValue": "'auto'" }, @@ -225655,7 +225978,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -225663,7 +225986,7 @@ "syntaxKind": "PropertySignature", "name": "lang", "value": "string", - "description": "The language of the button's text content. Use this when the button text is in a different language than the rest of the page, so assistive technologies can invoke the correct pronunciation. [Reference of values](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry) (`Subtag` label)\n\nIt is recommended to combine it with the `dir` attribute to ensure the text is rendered correctly if the surrounding content’s direction is different.", + "description": "Indicate the text language. Useful when the text is in a different language than the rest of the page. It will allow assistive technologies such as screen readers to invoke the correct pronunciation. [Reference of values](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry) (\"subtag\" label)\n\nIt is recommended to combine it with the `dir` attribute to ensure the text is rendered correctly if the surrounding content’s direction is different.", "isOptional": true, "defaultValue": "''" }, @@ -225672,7 +225995,7 @@ "syntaxKind": "PropertySignature", "name": "tone", "value": "'info' | 'auto' | 'neutral' | 'success' | 'warning' | 'critical' | 'custom'", - "description": "Sets the tone of the component, based on the intention of the information being conveyed.", + "description": "The semantic meaning and color treatment of the component.\n\n- `auto`: Automatically determined based on context.\n- `neutral`: General information without specific intent.\n- `info`: Informational content or helpful tips.\n- `success`: Positive outcomes or successful states.\n- `warning`: Important warnings about potential issues.\n- `critical`: Urgent problems or destructive actions.\n- `custom`: Custom styling controlled by your theme.", "isOptional": true, "defaultValue": "'auto'" }, @@ -225681,7 +226004,7 @@ "syntaxKind": "PropertySignature", "name": "type", "value": "'address' | 'mark' | 'small' | 'strong' | 'generic' | 'redundant' | 'emphasis' | 'offset'", - "description": "Provide semantic meaning and default styling to the text.\n\nOther presentation properties on Text override the default styling.", + "description": "The semantic type and styling treatment for the text content.\n\nOther presentation properties on `s-text` override the default styling.\n\n- `address`: A semantic type that indicates the text is contact information. Typically used for addresses.\n- `redundant`: A semantic type that indicates the text is no longer accurate or no longer relevant.\n- `mark`: A semantic type that indicates the text is marked or highlighted.\n- `emphasis`: A semantic type that indicates emphatic stress.\n- `offset`: A semantic type that indicates an offset from the normal prose.\n- `strong`: A semantic type that indicates strong importance, seriousness, or urgency.\n- `small`: A semantic type that indicates less important text.\n- `generic`: No additional semantics or styling is applied.", "isOptional": true, "defaultValue": "'generic'" } @@ -225691,7 +226014,7 @@ { "filePath": "src/surfaces/checkout/components/TextArea.ts", "name": "TextAreaElementProps", - "description": "The text area component captures multi-line text input. Use it to collect descriptions, notes, comments, or other extended text content.\n\nThe component supports configurable height, character limits, and validation. For single-line text input, use [text field](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/forms/text-field).", + "description": "", "isPublicDocs": true, "members": [ { @@ -225699,7 +226022,7 @@ "syntaxKind": "PropertySignature", "name": "autocomplete", "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", "isOptional": true, "defaultValue": "'on' for everything else" }, @@ -225708,7 +226031,7 @@ "syntaxKind": "PropertySignature", "name": "defaultValue", "value": "string", - "description": "The default value for the field.", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces this value.", "isOptional": true }, { @@ -225716,7 +226039,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -225725,7 +226048,7 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -225733,7 +226056,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -225741,7 +226064,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Content to use as the field label.", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", "isOptional": true }, { @@ -225749,7 +226072,7 @@ "syntaxKind": "PropertySignature", "name": "labelAccessibilityVisibility", "value": "'visible' | 'exclusive'", - "description": "Changes the visibility of the component's label.\n\n- `visible`: the label is visible to all users.\n- `exclusive`: the label is visually hidden but remains in the accessibility tree.", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone.\n- `exclusive`: The label is visually hidden but still announced by screen readers.", "isOptional": true, "defaultValue": "'visible'" }, @@ -225767,7 +226090,7 @@ "syntaxKind": "PropertySignature", "name": "minLength", "value": "number", - "description": "Specifies the min number of characters allowed.", + "description": "Specifies the minimum number of characters allowed.", "isOptional": true, "defaultValue": "0" }, @@ -225776,7 +226099,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -225794,7 +226117,7 @@ "syntaxKind": "PropertySignature", "name": "readOnly", "value": "boolean", - "description": "The field cannot be edited by the user. It is focusable will be announced by screen readers.", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", "isOptional": true, "defaultValue": "false" }, @@ -225846,7 +226169,7 @@ "syntaxKind": "PropertySignature", "name": "onChange", "value": "(event: Event) => void", - "description": "Callback when the user has **finished editing** a field, for example, once they have blurred the field.", + "description": "A callback fired when the user has **finished editing** a field, such as when they blur the field or press Enter.", "isOptional": true }, { @@ -225862,7 +226185,7 @@ "syntaxKind": "PropertySignature", "name": "onInput", "value": "(event: Event) => void", - "description": "Callback when the user makes any changes in the field.", + "description": "A callback fired when the user makes any changes in the field, such as typing a character.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).", "isOptional": true } ], @@ -225871,7 +226194,7 @@ { "filePath": "src/surfaces/checkout/components/TextArea.ts", "name": "TextAreaElementEvents", - "description": "Learn more about [registering events](/docs/api/checkout-ui-extensions/latest/using-polaris-components#event-handling).", + "description": "", "isPublicDocs": true, "members": [ { @@ -225879,7 +226202,7 @@ "syntaxKind": "PropertySignature", "name": "blur", "value": "CallbackEventListener", - "description": "A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "description": "<<<<<<< HEAD A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n======= A callback fired when the text area loses focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) \n Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", "isOptional": true }, { @@ -225887,7 +226210,7 @@ "syntaxKind": "PropertySignature", "name": "change", "value": "CallbackEventListener", - "description": "Callback when the user has **finished editing** a field, for example, once they have blurred the field.", + "description": "<<<<<<< HEAD Callback when the user has **finished editing** a field, for example, once they have blurred the field.\n======= A callback fired when the text area value changes.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) \n Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", "isOptional": true }, { @@ -225895,7 +226218,7 @@ "syntaxKind": "PropertySignature", "name": "focus", "value": "CallbackEventListener", - "description": "A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "description": "<<<<<<< HEAD A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n======= A callback fired when the text area receives focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) \n Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", "isOptional": true }, { @@ -225903,11 +226226,11 @@ "syntaxKind": "PropertySignature", "name": "input", "value": "CallbackEventListener", - "description": "Callback when the user makes any changes in the field.", + "description": "A callback fired when the user inputs data into the text area.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).", "isOptional": true } ], - "value": "export interface TextAreaElementEvents {\n /**\n * A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event\n */\n blur?: CallbackEventListener;\n /**\n * Callback when the user has **finished editing** a field, for example, once they have blurred the field.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event\n */\n change?: CallbackEventListener;\n /**\n * A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event\n */\n focus?: CallbackEventListener;\n /**\n * Callback when the user makes any changes in the field.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event\n */\n input?: CallbackEventListener;\n}" + "value": "export interface TextAreaElementEvents {\n /**\n<<<<<<< HEAD\n * A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n=======\n * A callback fired when the text area loses focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality)\n *\n * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur?: CallbackEventListener;\n /**\n<<<<<<< HEAD\n * Callback when the user has **finished editing** a field, for example, once they have blurred the field.\n=======\n * A callback fired when the text area value changes.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality)\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change?: CallbackEventListener;\n /**\n<<<<<<< HEAD\n * A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n=======\n * A callback fired when the text area receives focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality)\n *\n * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus?: CallbackEventListener;\n /**\n * A callback fired when the user inputs data into the text area.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input?: CallbackEventListener;\n}" }, { "filePath": "src/surfaces/checkout/components/TextArea.ts", @@ -225934,7 +226257,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/TextArea.ts", @@ -226375,7 +226698,7 @@ "syntaxKind": "PropertySignature", "name": "autocomplete", "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", "isOptional": true, "defaultValue": "'on' for everything else" }, @@ -226566,7 +226889,7 @@ "syntaxKind": "PropertySignature", "name": "defaultValue", "value": "string", - "description": "The default value for the field.", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces this value.", "isOptional": true }, { @@ -226581,7 +226904,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -226695,7 +227018,7 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -226865,7 +227188,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -226964,7 +227287,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Content to use as the field label.", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", "isOptional": true }, { @@ -226972,7 +227295,7 @@ "syntaxKind": "PropertySignature", "name": "labelAccessibilityVisibility", "value": "'visible' | 'exclusive'", - "description": "Changes the visibility of the component's label.\n\n- `visible`: the label is visible to all users.\n- `exclusive`: the label is visually hidden but remains in the accessibility tree.", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone.\n- `exclusive`: The label is visually hidden but still announced by screen readers.", "isOptional": true, "defaultValue": "'visible'" }, @@ -227039,7 +227362,7 @@ "syntaxKind": "PropertySignature", "name": "minLength", "value": "number", - "description": "Specifies the min number of characters allowed.", + "description": "Specifies the minimum number of characters allowed.", "isOptional": true, "defaultValue": "0" }, @@ -227048,7 +227371,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -227988,7 +228311,7 @@ "syntaxKind": "PropertySignature", "name": "readOnly", "value": "boolean", - "description": "The field cannot be edited by the user. It is focusable will be announced by screen readers.", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", "isOptional": true, "defaultValue": "false" }, @@ -228039,7 +228362,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/TextArea.ts", @@ -228327,7 +228650,7 @@ "syntaxKind": "PropertySignature", "name": "autocomplete", "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", "isOptional": true, "defaultValue": "'on' for everything else" }, @@ -228336,7 +228659,7 @@ "syntaxKind": "PropertySignature", "name": "defaultValue", "value": "string", - "description": "The default value for the field.", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces this value.", "isOptional": true }, { @@ -228344,7 +228667,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -228353,7 +228676,7 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -228361,7 +228684,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -228369,7 +228692,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Content to use as the field label.", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", "isOptional": true }, { @@ -228377,7 +228700,7 @@ "syntaxKind": "PropertySignature", "name": "labelAccessibilityVisibility", "value": "'visible' | 'exclusive'", - "description": "Changes the visibility of the component's label.\n\n- `visible`: the label is visible to all users.\n- `exclusive`: the label is visually hidden but remains in the accessibility tree.", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone.\n- `exclusive`: The label is visually hidden but still announced by screen readers.", "isOptional": true, "defaultValue": "'visible'" }, @@ -228395,7 +228718,7 @@ "syntaxKind": "PropertySignature", "name": "minLength", "value": "number", - "description": "Specifies the min number of characters allowed.", + "description": "Specifies the minimum number of characters allowed.", "isOptional": true, "defaultValue": "0" }, @@ -228404,7 +228727,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -228420,7 +228743,7 @@ "syntaxKind": "PropertySignature", "name": "onChange", "value": "(event: Event) => void", - "description": "Callback when the user has **finished editing** a field, for example, once they have blurred the field.", + "description": "A callback fired when the user has **finished editing** a field, such as when they blur the field or press Enter.", "isOptional": true }, { @@ -228436,7 +228759,7 @@ "syntaxKind": "PropertySignature", "name": "onInput", "value": "(event: Event) => void", - "description": "Callback when the user makes any changes in the field.", + "description": "A callback fired when the user makes any changes in the field, such as typing a character.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).", "isOptional": true }, { @@ -228454,7 +228777,7 @@ "syntaxKind": "PropertySignature", "name": "readOnly", "value": "boolean", - "description": "The field cannot be edited by the user. It is focusable will be announced by screen readers.", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", "isOptional": true, "defaultValue": "false" }, @@ -228490,7 +228813,7 @@ { "filePath": "src/surfaces/checkout/components/Time.ts", "name": "TimeElementProps", - "description": "Represents a specific point or duration in time. Use to display dates, times, or durations clearly and consistently. May include a machine-readable `datetime` attribute for improved accessibility and functionality.", + "description": "", "isPublicDocs": true, "members": [ { @@ -228498,7 +228821,7 @@ "syntaxKind": "PropertySignature", "name": "dateTime", "value": "string", - "description": "Set the time and/or date of the element.\n\nIt must be a [valid date string](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/time#valid_datetime_values).", + "description": "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.\n\nThe 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`.", "isOptional": true, "defaultValue": "''" }, @@ -228507,7 +228830,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true } ], @@ -228538,7 +228861,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/Time.ts", @@ -229161,7 +229484,7 @@ "syntaxKind": "PropertySignature", "name": "dateTime", "value": "string", - "description": "Set the time and/or date of the element.\n\nIt must be a [valid date string](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/time#valid_datetime_values).", + "description": "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.\n\nThe 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`.", "isOptional": true, "defaultValue": "''" }, @@ -229444,7 +229767,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -230556,7 +230879,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/Time.ts", @@ -230818,7 +231141,7 @@ "syntaxKind": "PropertySignature", "name": "dateTime", "value": "string", - "description": "Set the time and/or date of the element.\n\nIt must be a [valid date string](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/time#valid_datetime_values).", + "description": "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.\n\nThe 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`.", "isOptional": true, "defaultValue": "''" }, @@ -230827,7 +231150,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true } ], @@ -230836,7 +231159,7 @@ { "filePath": "src/surfaces/checkout/components/UrlField.ts", "name": "URLFieldElementProps", - "description": "The URL field component collects URLs from users with built-in formatting and validation. Use URL field for website addresses, link destinations, or any URL input to provide URL-specific keyboard layouts and automatic validation.\n\nURL fields support protocol prefixing, validation, and help text to guide users toward entering properly formatted web addresses. For general text input, use [text field](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/forms/text-field).", + "description": "", "isPublicDocs": true, "members": [ { @@ -230844,7 +231167,7 @@ "syntaxKind": "PropertySignature", "name": "autocomplete", "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", "isOptional": true, "defaultValue": "'on' for everything else" }, @@ -230853,7 +231176,7 @@ "syntaxKind": "PropertySignature", "name": "defaultValue", "value": "string", - "description": "The default value for the field.", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces this value.", "isOptional": true }, { @@ -230861,7 +231184,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -230870,7 +231193,7 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -230878,7 +231201,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -230886,7 +231209,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Content to use as the field label.", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", "isOptional": true }, { @@ -230894,7 +231217,7 @@ "syntaxKind": "PropertySignature", "name": "labelAccessibilityVisibility", "value": "'visible' | 'exclusive'", - "description": "Changes the visibility of the component's label.\n\n- `visible`: the label is visible to all users.\n- `exclusive`: the label is visually hidden but remains in the accessibility tree.", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone.\n- `exclusive`: The label is visually hidden but still announced by screen readers.", "isOptional": true, "defaultValue": "'visible'" }, @@ -230912,7 +231235,7 @@ "syntaxKind": "PropertySignature", "name": "minLength", "value": "number", - "description": "Specifies the min number of characters allowed.", + "description": "Specifies the minimum number of characters allowed.", "isOptional": true, "defaultValue": "0" }, @@ -230921,7 +231244,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -230929,7 +231252,7 @@ "syntaxKind": "PropertySignature", "name": "readOnly", "value": "boolean", - "description": "The field cannot be edited by the user. It is focusable will be announced by screen readers.", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", "isOptional": true, "defaultValue": "false" }, @@ -230972,7 +231295,7 @@ "syntaxKind": "PropertySignature", "name": "onChange", "value": "(event: Event) => void", - "description": "Callback when the user has **finished editing** a field, for example, once they have blurred the field.", + "description": "A callback fired when the user has **finished editing** a field, such as when they blur the field or press Enter.", "isOptional": true }, { @@ -230988,7 +231311,7 @@ "syntaxKind": "PropertySignature", "name": "onInput", "value": "(event: Event) => void", - "description": "Callback when the user makes any changes in the field.", + "description": "A callback fired when the user makes any changes in the field, such as typing a character.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).", "isOptional": true } ], @@ -230997,7 +231320,7 @@ { "filePath": "src/surfaces/checkout/components/UrlField.ts", "name": "URLFieldElementEvents", - "description": "Learn more about [registering events](/docs/api/checkout-ui-extensions/latest/using-polaris-components#event-handling).", + "description": "", "isPublicDocs": true, "members": [ { @@ -231005,7 +231328,7 @@ "syntaxKind": "PropertySignature", "name": "blur", "value": "CallbackEventListener", - "description": "A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "description": "A callback fired when the URL field loses focus.\n\nLearn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", "isOptional": true }, { @@ -231013,7 +231336,7 @@ "syntaxKind": "PropertySignature", "name": "change", "value": "CallbackEventListener", - "description": "Callback when the user has **finished editing** a field, for example, once they have blurred the field.", + "description": "A callback fired when the URL field value changes.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", "isOptional": true }, { @@ -231021,7 +231344,7 @@ "syntaxKind": "PropertySignature", "name": "focus", "value": "CallbackEventListener", - "description": "A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "description": "A callback fired when the URL field receives focus.\n\nLearn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", "isOptional": true }, { @@ -231029,16 +231352,16 @@ "syntaxKind": "PropertySignature", "name": "input", "value": "CallbackEventListener", - "description": "Callback when the user makes any changes in the field.", + "description": "A callback fired when the user inputs data into the URL field.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).", "isOptional": true } ], - "value": "export interface URLFieldElementEvents {\n /**\n * A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event\n */\n blur?: CallbackEventListener;\n /**\n * Callback when the user has **finished editing** a field, for example, once they have blurred the field.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event\n */\n change?: CallbackEventListener;\n /**\n * A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event\n */\n focus?: CallbackEventListener;\n /**\n * Callback when the user makes any changes in the field.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event\n */\n input?: CallbackEventListener;\n}" + "value": "export interface URLFieldElementEvents {\n /**\n * A callback fired when the URL field loses focus.\n *\n * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur?: CallbackEventListener;\n /**\n * A callback fired when the URL field value changes.\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change?: CallbackEventListener;\n /**\n * A callback fired when the URL field receives focus.\n *\n * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus?: CallbackEventListener;\n /**\n * A callback fired when the user inputs data into the URL field.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input?: CallbackEventListener;\n}" }, { "filePath": "src/surfaces/checkout/components/UrlField.ts", "name": "URLFieldElementSlots", - "description": "Learn more about [component slots](/docs/api/checkout-ui-extensions/latest/using-polaris-components#slots).", + "description": "", "isPublicDocs": true, "members": [ { @@ -231046,11 +231369,11 @@ "syntaxKind": "PropertySignature", "name": "accessory", "value": "HTMLElement", - "description": "Additional content to be displayed in the field. Commonly used to display an icon that activates a tooltip providing more information.", + "description": "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.", "isOptional": true } ], - "value": "export interface URLFieldElementSlots {\n /**\n * Additional content to be displayed in the field.\n * Commonly used to display an icon that activates a tooltip providing more information.\n */\n accessory?: HTMLElement;\n}" + "value": "export interface URLFieldElementSlots {\n /**\n * 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.\n */\n accessory?: HTMLElement;\n}" }, { "filePath": "src/surfaces/checkout/components/UrlField.ts", @@ -231077,7 +231400,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/UrlField.ts", @@ -231518,7 +231841,7 @@ "syntaxKind": "PropertySignature", "name": "autocomplete", "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", "isOptional": true, "defaultValue": "'on' for everything else" }, @@ -231709,7 +232032,7 @@ "syntaxKind": "PropertySignature", "name": "defaultValue", "value": "string", - "description": "The default value for the field.", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces this value.", "isOptional": true }, { @@ -231724,7 +232047,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -231838,7 +232161,7 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -232008,7 +232331,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -232107,7 +232430,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Content to use as the field label.", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", "isOptional": true }, { @@ -232115,7 +232438,7 @@ "syntaxKind": "PropertySignature", "name": "labelAccessibilityVisibility", "value": "'visible' | 'exclusive'", - "description": "Changes the visibility of the component's label.\n\n- `visible`: the label is visible to all users.\n- `exclusive`: the label is visually hidden but remains in the accessibility tree.", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone.\n- `exclusive`: The label is visually hidden but still announced by screen readers.", "isOptional": true, "defaultValue": "'visible'" }, @@ -232182,7 +232505,7 @@ "syntaxKind": "PropertySignature", "name": "minLength", "value": "number", - "description": "Specifies the min number of characters allowed.", + "description": "Specifies the minimum number of characters allowed.", "isOptional": true, "defaultValue": "0" }, @@ -232191,7 +232514,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -233114,7 +233437,7 @@ "syntaxKind": "PropertySignature", "name": "readOnly", "value": "boolean", - "description": "The field cannot be edited by the user. It is focusable will be announced by screen readers.", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", "isOptional": true, "defaultValue": "false" }, @@ -233165,7 +233488,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/UrlField.ts", @@ -233444,7 +233767,7 @@ "syntaxKind": "PropertySignature", "name": "autocomplete", "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", "isOptional": true, "defaultValue": "'on' for everything else" }, @@ -233453,7 +233776,7 @@ "syntaxKind": "PropertySignature", "name": "defaultValue", "value": "string", - "description": "The default value for the field.", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces this value.", "isOptional": true }, { @@ -233461,7 +233784,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -233470,7 +233793,7 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -233478,7 +233801,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -233486,7 +233809,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Content to use as the field label.", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", "isOptional": true }, { @@ -233494,7 +233817,7 @@ "syntaxKind": "PropertySignature", "name": "labelAccessibilityVisibility", "value": "'visible' | 'exclusive'", - "description": "Changes the visibility of the component's label.\n\n- `visible`: the label is visible to all users.\n- `exclusive`: the label is visually hidden but remains in the accessibility tree.", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone.\n- `exclusive`: The label is visually hidden but still announced by screen readers.", "isOptional": true, "defaultValue": "'visible'" }, @@ -233512,7 +233835,7 @@ "syntaxKind": "PropertySignature", "name": "minLength", "value": "number", - "description": "Specifies the min number of characters allowed.", + "description": "Specifies the minimum number of characters allowed.", "isOptional": true, "defaultValue": "0" }, @@ -233521,7 +233844,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -233537,7 +233860,7 @@ "syntaxKind": "PropertySignature", "name": "onChange", "value": "(event: Event) => void", - "description": "Callback when the user has **finished editing** a field, for example, once they have blurred the field.", + "description": "A callback fired when the user has **finished editing** a field, such as when they blur the field or press Enter.", "isOptional": true }, { @@ -233553,7 +233876,7 @@ "syntaxKind": "PropertySignature", "name": "onInput", "value": "(event: Event) => void", - "description": "Callback when the user makes any changes in the field.", + "description": "A callback fired when the user makes any changes in the field, such as typing a character.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).", "isOptional": true }, { @@ -233561,7 +233884,7 @@ "syntaxKind": "PropertySignature", "name": "readOnly", "value": "boolean", - "description": "The field cannot be edited by the user. It is focusable will be announced by screen readers.", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", "isOptional": true, "defaultValue": "false" }, @@ -233742,7 +234065,7 @@ "syntaxKind": "PropertySignature", "name": "onAfterToggle", "value": "(event: ToggleEvent$1) => void", - "description": "A callback fired when the element state changes, after any toggle animations have finished.\n\n- If the element transitioned from hidden to showing, the `oldState` property will be set to `closed` and the `newState` property will be set to `open`.\n- If the element transitioned from showing to hidden, the `oldState` property will be set to `open` and the `newState` will be `closed`.\n\nLearn more about [ToggleEvent.newState](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/newState) and [ToggleEvent.oldState](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/oldState).", + "description": "A callback fired when the element state changes, after any toggle animations have finished.\n\n- If the element transitioned from hidden to showing, the `oldState` property will be set to `closed` and the `newState` property will be set to `open`.\n- If the element transitioned from showing to hidden, the `oldState` property will be set to `open` and the `newState` will be `closed`.\n\nLearn more about [`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).", "isOptional": true }, { @@ -233750,11 +234073,11 @@ "syntaxKind": "PropertySignature", "name": "onToggle", "value": "(event: ToggleEvent$1) => void", - "description": "A callback fired immediately when the element state changes, before any animations.\n\n- If the element is transitioning from hidden to showing, the `oldState` property will be set to `closed` and the `newState` property will be set to `open`.\n- If the element is transitioning from showing to hidden, then `oldState` property will be set to `open` and the `newState` will be `closed`.\n\nLearn more about the [toggle event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/toggle_event), [ToggleEvent.newState](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/newState), and [ToggleEvent.oldState](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/oldState).", + "description": "A callback fired immediately when the element state changes, before any animations.\n\n- If the element is transitioning from hidden to showing, the `oldState` property will be set to `closed` and the `newState` property will be set to `open`.\n- If the element is transitioning from showing to hidden, then the `oldState` property will be set to `open` and the `newState` will be `closed`.\n\nLearn more about the [`toggle` event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/toggle_event), [`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).", "isOptional": true } ], - "value": "export interface ToggleEventProps {\n\t/**\n\t * A callback fired when the element state changes, after any toggle animations have finished.\n\t *\n\t * - If the element transitioned from hidden to showing, the `oldState` property will be set to `closed` and the\n\t * `newState` property will be set to `open`.\n\t * - If the element transitioned from showing to hidden, the `oldState` property will be set to `open` and the\n\t * `newState` will be `closed`.\n\t *\n\t * Learn more about [ToggleEvent.newState](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/newState) and [ToggleEvent.oldState](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/oldState).\n\t */\n\tonAfterToggle?: (event: ToggleEvent$1) => void;\n\t/**\n\t * A callback fired immediately when the element state changes, before any animations.\n\t *\n\t * - If the element is transitioning from hidden to showing, the `oldState` property will be set to `closed` and the\n\t * `newState` property will be set to `open`.\n\t * - If the element is transitioning from showing to hidden, then `oldState` property will be set to `open` and the\n\t * `newState` will be `closed`.\n\t *\n\t * Learn more about the [toggle event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/toggle_event), [ToggleEvent.newState](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/newState), and [ToggleEvent.oldState](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/oldState).\n\t */\n\tonToggle?: (event: ToggleEvent$1) => void;\n}" + "value": "export interface ToggleEventProps {\n\t/**\n\t * A callback fired when the element state changes, after any toggle animations have finished.\n\t *\n\t * - If the element transitioned from hidden to showing, the `oldState` property will be set to `closed` and the\n\t * `newState` property will be set to `open`.\n\t * - If the element transitioned from showing to hidden, the `oldState` property will be set to `open` and the\n\t * `newState` will be `closed`.\n\t *\n\t * Learn more about [`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).\n\t */\n\tonAfterToggle?: (event: ToggleEvent$1) => void;\n\t/**\n\t * A callback fired immediately when the element state changes, before any animations.\n\t *\n\t * - If the element is transitioning from hidden to showing, the `oldState` property will be set to `closed` and the\n\t * `newState` property will be set to `open`.\n\t * - If the element is transitioning from showing to hidden, then the `oldState` property will be set to `open` and the\n\t * `newState` will be `closed`.\n\t *\n\t * Learn more about the [`toggle` event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/toggle_event), [`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).\n\t */\n\tonToggle?: (event: ToggleEvent$1) => void;\n}" }, { "filePath": "src/surfaces/checkout/components/components.ts", @@ -234026,12 +234349,12 @@ "syntaxKind": "PropertySignature", "name": "accessibilityRole", "value": "AccessibilityRole", - "description": "Sets the semantic meaning of the component’s content. When set, the role will be used by assistive technologies to help users navigate the page.", + "description": "The semantic meaning of the component’s content. When set, assistive technologies use this role to help users navigate the page.", "isOptional": true, "defaultValue": "'generic'" } ], - "value": "export interface AccessibilityRoleProps {\n\t/**\n\t * Sets the semantic meaning of the component’s content. When set,\n\t * the role will be used by assistive technologies to help users\n\t * navigate the page.\n\t *\n\t * @implementation Although, in HTML hosts, this property changes the element used,\n\t * changing this property must not impact the visual styling of inside or outside of the box.\n\t *\n\t * @default 'generic'\n\t */\n\taccessibilityRole?: AccessibilityRole;\n}" + "value": "export interface AccessibilityRoleProps {\n\t/**\n\t * The semantic meaning of the component’s content. When set, assistive technologies use this role to help users navigate the page.\n\t *\n\t * @default 'generic'\n\t */\n\taccessibilityRole?: AccessibilityRole;\n}" }, { "filePath": "src/surfaces/checkout/components/components.ts", @@ -234297,12 +234620,12 @@ "syntaxKind": "PropertySignature", "name": "overflow", "value": "'hidden' | 'visible'", - "description": "Sets the overflow behavior of the element.\n\n- `hidden`: clips the content when it is larger than the element’s container. The element will not be scrollable and the users will not be able to access the clipped content by dragging or using a scroll wheel on a mouse.\n- `visible`: the content that extends beyond the element’s container is visible.", + "description": "The overflow behavior of the element.\n\n- `visible`: Content that extends beyond the container is visible.\n- `hidden`: Content that extends beyond the container is clipped and not scrollable.", "isOptional": true, "defaultValue": "'visible'" } ], - "value": "export interface OverflowProps {\n\t/**\n\t * Sets the overflow behavior of the element.\n\t *\n\t * - `hidden`: clips the content when it is larger than the element’s container.\n\t * The element will not be scrollable and the users will not be able\n\t * to access the clipped content by dragging or using a scroll wheel on a mouse.\n\t * - `visible`: the content that extends beyond the element’s container is visible.\n\t *\n\t * @default 'visible'\n\t */\n\toverflow?: \"hidden\" | \"visible\";\n}" + "value": "export interface OverflowProps {\n\t/**\n\t * The overflow behavior of the element.\n\t *\n\t * - `visible`: Content that extends beyond the container is visible.\n\t * - `hidden`: Content that extends beyond the container is clipped and not scrollable.\n\t *\n\t * @default 'visible'\n\t */\n\toverflow?: \"hidden\" | \"visible\";\n}" }, { "filePath": "src/surfaces/checkout/components/components.ts", @@ -234469,7 +234792,7 @@ "syntaxKind": "PropertySignature", "name": "overflow", "value": "'hidden' | 'visible'", - "description": "Sets the overflow behavior of the element.\n\n- `hidden`: clips the content when it is larger than the element’s container. The element will not be scrollable and the users will not be able to access the clipped content by dragging or using a scroll wheel on a mouse.\n- `visible`: the content that extends beyond the element’s container is visible.", + "description": "The overflow behavior of the element.\n\n- `visible`: Content that extends beyond the container is visible.\n- `hidden`: Content that extends beyond the container is clipped and not scrollable.", "isOptional": true, "defaultValue": "'visible'" }, @@ -234558,7 +234881,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityRole", "value": "AccessibilityRole", - "description": "Sets the semantic meaning of the component’s content. When set, the role will be used by assistive technologies to help users navigate the page.", + "description": "The semantic meaning of the component’s content. When set, assistive technologies use this role to help users navigate the page.", "isOptional": true, "defaultValue": "'generic'" }, @@ -234713,7 +235036,7 @@ "syntaxKind": "PropertySignature", "name": "overflow", "value": "'hidden' | 'visible'", - "description": "Sets the overflow behavior of the element.\n\n- `hidden`: clips the content when it is larger than the element’s container. The element will not be scrollable and the users will not be able to access the clipped content by dragging or using a scroll wheel on a mouse.\n- `visible`: the content that extends beyond the element’s container is visible.", + "description": "The overflow behavior of the element.\n\n- `visible`: Content that extends beyond the container is visible.\n- `hidden`: Content that extends beyond the container is clipped and not scrollable.", "isOptional": true, "defaultValue": "'visible'" }, @@ -234794,7 +235117,7 @@ "syntaxKind": "PropertySignature", "name": "command", "value": "'--auto' | '--show' | '--hide' | '--toggle' | '--copy'", - "description": "Sets the action the `commandFor` should take when this clickable is activated.\n\nSee the documentation of particular components for the actions they support.\n\n- `--auto`: a default action for the target component.\n- `--show`: shows the target component.\n- `--hide`: hides the target component.\n- `--toggle`: toggles the target component.\n- `--copy`: copies the target ClipboardItem.", + "description": "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).\n\nSee the documentation of particular components for the actions they support.\n\n- `--auto`: a default action for the target component.\n- `--show`: shows the target component.\n- `--hide`: hides the target component.\n- `--toggle`: toggles the target component.\n- `--copy`: copies the target ClipboardItem.", "isOptional": true, "defaultValue": "'--auto'" }, @@ -234803,7 +235126,7 @@ "syntaxKind": "PropertySignature", "name": "commandFor", "value": "string", - "description": "ID of a component that should respond to activations (such as clicks) on this component.\n\nSee `command` for how to control the behavior of the target.", + "description": "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).", "isOptional": true }, { @@ -234820,7 +235143,7 @@ "syntaxKind": "PropertySignature", "name": "interestFor", "value": "string", - "description": "The ID of the component to show when users hover over or focus on this component. Pair with a target component that supports interest-based interactions. Learn more about the [interestFor attribute](https://open-ui.org/components/interest-invokers.explainer/#the-pitch-in-code).", + "description": "The ID of the component to show when users hover over or focus on this component. Use this to connect interactive components to popovers or tooltips that provide additional context or information.", "isOptional": true }, { @@ -234879,7 +235202,7 @@ "syntaxKind": "PropertySignature", "name": "command", "value": "'--auto' | '--show' | '--hide' | '--toggle' | '--copy'", - "description": "Sets the action the `commandFor` should take when this clickable is activated.\n\nSee the documentation of particular components for the actions they support.\n\n- `--auto`: a default action for the target component.\n- `--show`: shows the target component.\n- `--hide`: hides the target component.\n- `--toggle`: toggles the target component.\n- `--copy`: copies the target ClipboardItem.", + "description": "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).\n\nSee the documentation of particular components for the actions they support.\n\n- `--auto`: a default action for the target component.\n- `--show`: shows the target component.\n- `--hide`: hides the target component.\n- `--toggle`: toggles the target component.\n- `--copy`: copies the target ClipboardItem.", "isOptional": true, "defaultValue": "'--auto'" }, @@ -234888,7 +235211,7 @@ "syntaxKind": "PropertySignature", "name": "commandFor", "value": "string", - "description": "ID of a component that should respond to activations (such as clicks) on this component.\n\nSee `command` for how to control the behavior of the target.", + "description": "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).", "isOptional": true }, { @@ -234912,7 +235235,7 @@ "syntaxKind": "PropertySignature", "name": "interestFor", "value": "string", - "description": "The ID of the component to show when users hover over or focus on this component. Pair with a target component that supports interest-based interactions. Learn more about the [interestFor attribute](https://open-ui.org/components/interest-invokers.explainer/#the-pitch-in-code).", + "description": "The ID of the component to show when users hover over or focus on this component. Use this to connect interactive components to popovers or tooltips that provide additional context or information.", "isOptional": true }, { @@ -234962,7 +235285,7 @@ "syntaxKind": "PropertySignature", "name": "command", "value": "'--auto' | '--show' | '--hide' | '--toggle' | '--copy'", - "description": "Sets the action the `commandFor` should take when this clickable is activated.\n\nSee the documentation of particular components for the actions they support.\n\n- `--auto`: a default action for the target component.\n- `--show`: shows the target component.\n- `--hide`: hides the target component.\n- `--toggle`: toggles the target component.\n- `--copy`: copies the target ClipboardItem.", + "description": "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).\n\nSee the documentation of particular components for the actions they support.\n\n- `--auto`: a default action for the target component.\n- `--show`: shows the target component.\n- `--hide`: hides the target component.\n- `--toggle`: toggles the target component.\n- `--copy`: copies the target ClipboardItem.", "isOptional": true, "defaultValue": "'--auto'" }, @@ -234971,7 +235294,7 @@ "syntaxKind": "PropertySignature", "name": "commandFor", "value": "string", - "description": "ID of a component that should respond to activations (such as clicks) on this component.\n\nSee `command` for how to control the behavior of the target.", + "description": "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).", "isOptional": true }, { @@ -234979,11 +235302,11 @@ "syntaxKind": "PropertySignature", "name": "interestFor", "value": "string", - "description": "The ID of the component to show when users hover over or focus on this component. Pair with a target component that supports interest-based interactions. Learn more about the [interestFor attribute](https://open-ui.org/components/interest-invokers.explainer/#the-pitch-in-code).", + "description": "The ID of the component to show when users hover over or focus on this component. Use this to connect interactive components to popovers or tooltips that provide additional context or information.", "isOptional": true } ], - "value": "export interface InteractionProps {\n\t/**\n\t * ID of a component that should respond to activations (such as clicks) on this component.\n\t *\n\t * See `command` for how to control the behavior of the target.\n\t *\n\t * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#commandfor\n\t */\n\tcommandFor?: string;\n\t/**\n\t * Sets the action the `commandFor` should take when this clickable is activated.\n\t *\n\t * See the documentation of particular components for the actions they support.\n\t *\n\t * - `--auto`: a default action for the target component.\n\t * - `--show`: shows the target component.\n\t * - `--hide`: hides the target component.\n\t * - `--toggle`: toggles the target component.\n\t * - `--copy`: copies the target ClipboardItem.\n\t *\n\t * @default '--auto'\n\t *\n\t * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command\n\t */\n\tcommand?: \"--auto\" | \"--show\" | \"--hide\" | \"--toggle\" | \"--copy\";\n\t/**\n\t * The ID of the component to show when users hover over or focus on this component. Pair with a target component that supports interest-based interactions. Learn more about the [interestFor attribute](https://open-ui.org/components/interest-invokers.explainer/#the-pitch-in-code).\n\t */\n\tinterestFor?: string;\n}" + "value": "export interface InteractionProps {\n\t/**\n\t * 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).\n\t */\n\tcommandFor?: string;\n\t/**\n\t * 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).\n\t *\n\t * See the documentation of particular components for the actions they support.\n\t *\n\t * - `--auto`: a default action for the target component.\n\t * - `--show`: shows the target component.\n\t * - `--hide`: hides the target component.\n\t * - `--toggle`: toggles the target component.\n\t * - `--copy`: copies the target ClipboardItem.\n\t *\n\t * @default '--auto'\n\t */\n\tcommand?: \"--auto\" | \"--show\" | \"--hide\" | \"--toggle\" | \"--copy\";\n\t/**\n\t * The ID of the component to show when users hover over or focus on this component. Use this to connect interactive components to popovers or tooltips that provide additional context or information.\n\t */\n\tinterestFor?: string;\n}" }, { "filePath": "src/surfaces/checkout/components/components.ts", @@ -234996,7 +235319,7 @@ "syntaxKind": "PropertySignature", "name": "command", "value": "'--auto' | '--show' | '--hide' | '--toggle' | '--copy'", - "description": "Sets the action the `commandFor` should take when this clickable is activated.\n\nSee the documentation of particular components for the actions they support.\n\n- `--auto`: a default action for the target component.\n- `--show`: shows the target component.\n- `--hide`: hides the target component.\n- `--toggle`: toggles the target component.\n- `--copy`: copies the target ClipboardItem.", + "description": "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).\n\nSee the documentation of particular components for the actions they support.\n\n- `--auto`: a default action for the target component.\n- `--show`: shows the target component.\n- `--hide`: hides the target component.\n- `--toggle`: toggles the target component.\n- `--copy`: copies the target ClipboardItem.", "isOptional": true, "defaultValue": "'--auto'" }, @@ -235005,7 +235328,7 @@ "syntaxKind": "PropertySignature", "name": "commandFor", "value": "string", - "description": "ID of a component that should respond to activations (such as clicks) on this component.\n\nSee `command` for how to control the behavior of the target.", + "description": "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).", "isOptional": true }, { @@ -235038,7 +235361,7 @@ "syntaxKind": "PropertySignature", "name": "interestFor", "value": "string", - "description": "The ID of the component to show when users hover over or focus on this component. Pair with a target component that supports interest-based interactions. Learn more about the [interestFor attribute](https://open-ui.org/components/interest-invokers.explainer/#the-pitch-in-code).", + "description": "The ID of the component to show when users hover over or focus on this component. Use this to connect interactive components to popovers or tooltips that provide additional context or information.", "isOptional": true }, { @@ -235223,11 +235546,11 @@ "syntaxKind": "PropertySignature", "name": "values", "value": "string[]", - "description": "An array of the `value`s of the selected options.\n\nThis is a convenience prop for setting the `selected` prop on child options.", + "description": "An array of `value` attributes for the currently selected options.\n\nThis is a convenience prop for setting the `selected` prop on child options.", "isOptional": true } ], - "value": "export interface MultipleInputProps extends BaseInputProps {\n\t/**\n\t * Callback when the user has selected option(s).\n\t *\n\t * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event\n\t */\n\tonChange?: (event: Event) => void;\n\t/**\n\t * Callback when the user has selected option(s).\n\t *\n\t * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event\n\t */\n\tonInput?: (event: Event) => void;\n\t/**\n\t * An array of the `value`s of the selected options.\n\t *\n\t * This is a convenience prop for setting the `selected` prop on child options.\n\t */\n\tvalues?: string[];\n}" + "value": "export interface MultipleInputProps extends BaseInputProps {\n\t/**\n\t * Callback when the user has selected option(s).\n\t *\n\t * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event\n\t */\n\tonChange?: (event: Event) => void;\n\t/**\n\t * Callback when the user has selected option(s).\n\t *\n\t * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event\n\t */\n\tonInput?: (event: Event) => void;\n\t/**\n\t * An array of `value` attributes for the currently selected options.\n\t *\n\t * This is a convenience prop for setting the `selected` prop on child options.\n\t */\n\tvalues?: string[];\n}" }, { "filePath": "src/surfaces/checkout/components/components.ts", @@ -235853,7 +236176,7 @@ "syntaxKind": "PropertySignature", "name": "command", "value": "'--auto' | '--show' | '--hide' | '--toggle' | '--copy'", - "description": "Sets the action the `commandFor` should take when this clickable is activated.\n\nSee the documentation of particular components for the actions they support.\n\n- `--auto`: a default action for the target component.\n- `--show`: shows the target component.\n- `--hide`: hides the target component.\n- `--toggle`: toggles the target component.\n- `--copy`: copies the target ClipboardItem.", + "description": "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).\n\nSee the documentation of particular components for the actions they support.\n\n- `--auto`: a default action for the target component.\n- `--show`: shows the target component.\n- `--hide`: hides the target component.\n- `--toggle`: toggles the target component.\n- `--copy`: copies the target ClipboardItem.", "isOptional": true, "defaultValue": "'--auto'" }, @@ -235862,7 +236185,7 @@ "syntaxKind": "PropertySignature", "name": "commandFor", "value": "string", - "description": "ID of a component that should respond to activations (such as clicks) on this component.\n\nSee `command` for how to control the behavior of the target.", + "description": "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).", "isOptional": true }, { @@ -235888,7 +236211,7 @@ "syntaxKind": "PropertySignature", "name": "interestFor", "value": "string", - "description": "The ID of the component to show when users hover over or focus on this component. Pair with a target component that supports interest-based interactions. Learn more about the [interestFor attribute](https://open-ui.org/components/interest-invokers.explainer/#the-pitch-in-code).", + "description": "The ID of the component to show when users hover over or focus on this component. Use this to connect interactive components to popovers or tooltips that provide additional context or information.", "isOptional": true }, { @@ -235993,6 +236316,14 @@ "description": "", "isPublicDocs": true }, + { + "filePath": "src/surfaces/checkout/components/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "ConsentPolicy", + "value": "\"sms-marketing\"", + "description": "", + "isPublicDocs": true + }, { "filePath": "src/surfaces/checkout/components/components.ts", "syntaxKind": "TypeAliasDeclaration", diff --git a/packages/ui-extensions/docs/surfaces/customer-account/generated/customer_account_ui_extensions/2026-01/generated_docs_data_v2.json b/packages/ui-extensions/docs/surfaces/customer-account/generated/customer_account_ui_extensions/2026-01/generated_docs_data_v2.json index c8beb53ad8..249524eefd 100644 --- a/packages/ui-extensions/docs/surfaces/customer-account/generated/customer_account_ui_extensions/2026-01/generated_docs_data_v2.json +++ b/packages/ui-extensions/docs/surfaces/customer-account/generated/customer_account_ui_extensions/2026-01/generated_docs_data_v2.json @@ -45,10 +45,10 @@ "syntaxKind": "PropertySignature", "name": "target", "value": "SubscribableSignalLike", - "description": "The cart line that this extension is attached to. Use this to read the line item's merchandise, quantity, cost, and attributes.\n\n> Note: Until version `2023-04`, this property was a `ReadonlySignalLike`." + "description": "The cart line that this extension is attached to. Use this to read the line item's merchandise, quantity, cost, and attributes.\n\nAvailable only on the corresponding item target. Shipping option item targets expose shipping option properties; pickup location item targets expose pickup location properties.\n\n> Note: Until version `2023-04`, this property was a `ReadonlySignalLike`." } ], - "value": "export interface CartLineItemApi {\n /**\n * The cart line that this extension is attached to. Use this to read the\n * line item's merchandise, quantity, cost, and attributes.\n *\n * > Note: Until version `2023-04`, this property was a `ReadonlySignalLike`.\n */\n target: SubscribableSignalLike;\n}" + "value": "export interface CartLineItemApi {\n /**\n * The cart line that this extension is attached to. Use this to read the\n * line item's merchandise, quantity, cost, and attributes.\n *\n * Available only on the corresponding item target. Shipping option item\n * targets expose shipping option properties; pickup location item targets\n * expose pickup location properties.\n *\n * > Note: Until version `2023-04`, this property was a `ReadonlySignalLike`.\n */\n target: SubscribableSignalLike;\n}" } }, "SubscribableSignalLike": { @@ -199,7 +199,7 @@ "syntaxKind": "PropertySignature", "name": "value", "value": "string", - "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.", + "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.\n\nAttribute values are always strings. To store structured data, serialize it to JSON and parse it when reading.", "examples": [ { "title": "Example", @@ -214,7 +214,7 @@ ] } ], - "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" + "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * Attribute values are always strings. To store structured data, serialize\n * it to JSON and parse it when reading.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" } }, "CartLineCost": { @@ -735,10 +735,10 @@ "syntaxKind": "PropertySignature", "name": "isLocationFormVisible", "value": "SubscribableSignalLike", - "description": "Whether the location search form is currently visible to the buyer. Use this to conditionally render UI that depends on the buyer actively searching for pickup points." + "description": "Reflects which view was active when the extension loaded. When the buyer moves to the next view, the extension restarts with the current value rather than updating in place." } ], - "value": "export interface PickupPointListApi {\n /**\n * Whether the location search form is currently visible to the buyer.\n * Use this to conditionally render UI that depends on the buyer actively\n * searching for pickup points.\n */\n isLocationFormVisible: SubscribableSignalLike;\n}" + "value": "export interface PickupPointListApi {\n /**\n * Reflects which view was active when the extension loaded. When the\n * buyer moves to the next view, the extension restarts with the\n * current value rather than updating in place.\n */\n isLocationFormVisible: SubscribableSignalLike;\n}" } }, "PickupLocationItemApi": { @@ -753,17 +753,17 @@ "syntaxKind": "PropertySignature", "name": "isTargetSelected", "value": "SubscribableSignalLike", - "description": "Whether the buyer has selected the target pickup location. When `true`, the target location is the buyer's active choice. When `false`, the buyer has chosen a different pickup location." + "description": "Whether the buyer has selected the target pickup location. When `true`, the target location is the buyer's active choice. When `false`, the buyer has chosen a different pickup location.\n\nAvailable only on the corresponding item target. Shipping option item targets expose shipping option properties; pickup location item targets expose pickup location properties." }, { "filePath": "src/surfaces/checkout/api/pickup/pickup-location-item.ts", "syntaxKind": "PropertySignature", "name": "target", "value": "SubscribableSignalLike", - "description": "The pickup location that this extension is attached to. Use this to read the location's name, address, and other details." + "description": "The pickup location that this extension is attached to. Use this to read the location's name, address, and other details.\n\nAvailable only on the corresponding item target. Shipping option item targets expose shipping option properties; pickup location item targets expose pickup location properties." } ], - "value": "export interface PickupLocationItemApi {\n /**\n * The pickup location that this extension is attached to. Use this to read the location's name, address, and other details.\n */\n target: SubscribableSignalLike;\n\n /**\n * Whether the buyer has selected the target pickup location. When `true`, the target location is the buyer's active choice. When `false`, the buyer has chosen a different pickup location.\n */\n isTargetSelected: SubscribableSignalLike;\n}" + "value": "export interface PickupLocationItemApi {\n /**\n * The pickup location that this extension is attached to. Use this to read the location's name, address, and other details.\n *\n * Available only on the corresponding item target. Shipping option item\n * targets expose shipping option properties; pickup location item targets\n * expose pickup location properties.\n */\n target: SubscribableSignalLike;\n\n /**\n * Whether the buyer has selected the target pickup location. When `true`, the target location is the buyer's active choice. When `false`, the buyer has chosen a different pickup location.\n *\n * Available only on the corresponding item target. Shipping option item\n * targets expose shipping option properties; pickup location item targets\n * expose pickup location properties.\n */\n isTargetSelected: SubscribableSignalLike;\n}" } }, "PickupLocationOption": { @@ -1183,7 +1183,7 @@ "syntaxKind": "PropertySignature", "name": "isTargetSelected", "value": "SubscribableSignalLike", - "description": "Whether the buyer has selected the target shipping option. When `true`, the target option is the buyer's active choice. When `false`, the buyer has chosen a different shipping option." + "description": "Whether the buyer has selected the target shipping option. When `true`, the target option is the buyer's active choice. When `false`, the buyer has chosen a different shipping option.\n\nAvailable only on the corresponding item target. Shipping option item targets expose shipping option properties; pickup location item targets expose pickup location properties." }, { "filePath": "src/surfaces/checkout/api/shipping/shipping-option-item.ts", @@ -1197,10 +1197,10 @@ "syntaxKind": "PropertySignature", "name": "target", "value": "SubscribableSignalLike", - "description": "The shipping option that this extension is attached to. Use this to read the option's cost, carrier, delivery estimate, and other details." + "description": "The shipping option that this extension is attached to. Use this to read the option's cost, carrier, delivery estimate, and other details.\n\nAvailable only on the corresponding item target. Shipping option item targets expose shipping option properties; pickup location item targets expose pickup location properties." } ], - "value": "export interface ShippingOptionItemApi {\n /**\n * The shipping option that this extension is attached to. Use this to read the option's cost, carrier, delivery estimate, and other details.\n */\n target: SubscribableSignalLike;\n\n /**\n * Whether the buyer has selected the target shipping option. When `true`, the target option is the buyer's active choice. When `false`, the buyer has chosen a different shipping option.\n */\n isTargetSelected: SubscribableSignalLike;\n\n /**\n * The render mode of this shipping option, indicating how the extension is displayed in the checkout UI.\n */\n renderMode: ShippingOptionItemRenderMode;\n}" + "value": "export interface ShippingOptionItemApi {\n /**\n * The shipping option that this extension is attached to. Use this to read the option's cost, carrier, delivery estimate, and other details.\n *\n * Available only on the corresponding item target. Shipping option item\n * targets expose shipping option properties; pickup location item targets\n * expose pickup location properties.\n */\n target: SubscribableSignalLike;\n\n /**\n * Whether the buyer has selected the target shipping option. When `true`, the target option is the buyer's active choice. When `false`, the buyer has chosen a different shipping option.\n *\n * Available only on the corresponding item target. Shipping option item\n * targets expose shipping option properties; pickup location item targets\n * expose pickup location properties.\n */\n isTargetSelected: SubscribableSignalLike;\n\n /**\n * The render mode of this shipping option, indicating how the extension is displayed in the checkout UI.\n */\n renderMode: ShippingOptionItemRenderMode;\n}" } }, "ShippingOptionItemRenderMode": { @@ -2255,7 +2255,7 @@ "syntaxKind": "MethodSignature", "name": "applyAttributeChange", "value": "(change: AttributeChange) => Promise", - "description": "Updates or removes an attribute on the cart and checkout. On success, the [`attributes`](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/attributes#standardapi-propertydetail-attributes) property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.", + "description": "Updates or removes an attribute on the cart and checkout. On success, the [`attributes`](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/attributes#properties-propertydetail-attributes) property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.", "deprecationMessage": "Use cart metafields instead." }, { @@ -2263,42 +2263,42 @@ "syntaxKind": "MethodSignature", "name": "applyCartLinesChange", "value": "(change: CartLineChange) => Promise", - "description": "Adds, removes, or updates line items in the cart. The returned promise resolves when the change has been applied by the server, and the [`lines`](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-lines#standardapi-propertydetail-lines) property updates with the new state.\n\n> Note: This method returns an error if the [cart instruction](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Adds, removes, or updates line items in the cart. The returned promise resolves when the change has been applied by the server, and the [`lines`](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-lines#properties-propertydetail-lines) property updates with the new state.\n\nAccepts a single change per call. To make multiple changes, call this method separately for each one.\n\n> Note: This method returns an error if the [cart instruction](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyDiscountCodeChange", "value": "(change: DiscountCodeChange) => Promise", - "description": "Adds or removes a discount code on the checkout. The returned promise resolves when the change has been applied by the server, and the [`discountCodes`](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/discounts#standardapi-propertydetail-discountcodes) property updates with the new state.\n\n> Caution: > See [security considerations](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves discount codes through a network call.\n\n> Note: This method returns an error if the [cart instruction](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Adds or removes a discount code on the checkout. The returned promise resolves when the change has been applied by the server, and the [`discountCodes`](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/discounts#properties-propertydetail-discountcodes) property updates with the new state.\n\n> Caution: > See [security considerations](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves discount codes through a network call.\n\n> Note: This method returns an error if the [cart instruction](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyGiftCardChange", "value": "(change: GiftCardChange) => Promise", - "description": "Adds or removes a gift card from the checkout. The returned promise resolves when the change has been applied by the server, and the [`appliedGiftCards`](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/gift-cards#standardapi-propertydetail-appliedgiftcards) property updates with the new state.\n\n> Caution: > See [security considerations](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves gift card codes through a network call.\n\n> Note: This method returns an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Adds or removes a gift card from the checkout. The returned promise resolves when the change has been applied by the server, and the [`appliedGiftCards`](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/gift-cards#properties-propertydetail-appliedgiftcards) property updates with the new state.\n\nUnlike other write operations, gift card changes aren't gated by a cart instruction flag.\n\n> Caution: > See [security considerations](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves gift card codes through a network call.\n\n> Note: This method returns an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyMetafieldChange", "value": "(change: MetafieldChange) => Promise", - "description": "Creates, updates, or removes a cart metafield on the checkout. On success, the [`metafields`](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/metafields#standardapi-propertydetail-metafields) property updates to reflect the change.\n\nCart metafields are copied to order metafields at order creation time if there's a matching order metafield definition with the [`cart to order copyable`](https://shopify.dev/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n\n> Caution: `MetafieldRemoveChange` and `MetafieldUpdateChange` are deprecated. Use cart metafields with `MetafieldRemoveCartChange` and `MetafieldUpdateCartChange` instead. If `MetafieldUpdateChange` writes a metafield with the same namespace and key as a cart metafield that's configured to copy, the cart metafield won't be copied.\n\n> Note: This method returns an error if the [cart instruction](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Creates, updates, or removes a cart metafield on the checkout. On success, the [`metafields`](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/metafields#properties-propertydetail-metafields) property updates to reflect the change.\n\nCart metafields are copied to order metafields at order creation time if there's a matching order metafield definition with the [`cart to order copyable`](https://shopify.dev/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n\n> Caution: `MetafieldRemoveChange` and `MetafieldUpdateChange` are deprecated. Use cart metafields with `MetafieldRemoveCartChange` and `MetafieldUpdateCartChange` instead. If `MetafieldUpdateChange` writes a metafield with the same namespace and key as a cart metafield that's configured to copy, the cart metafield won't be copied.\n\n> Note: This method returns an error if the [cart instruction](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyNoteChange", "value": "(change: NoteChange) => Promise", - "description": "Sets or removes the buyer's note on the checkout. On success, the [`note`](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/note#standardapi-propertydetail-note) property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + "description": "Sets or removes the buyer's note on the checkout. On success, the [`note`](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/note#properties-propertydetail-note) property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "syntaxKind": "MethodSignature", "name": "applyShippingAddressChange", "value": "(change: ShippingAddressUpdateChange) => Promise", - "description": "Updates the buyer's shipping address on the checkout. The provided fields are merged into the existing address without prompting the buyer. On success, the `shippingAddress` property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).", + "description": "Updates the buyer's shipping address on the checkout. The provided fields are merged into the existing address without prompting the buyer. On success, the `shippingAddress` property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).", "isOptional": true }, { @@ -2311,7 +2311,7 @@ "isPrivate": true } ], - "value": "export interface CheckoutApi {\n /**\n * Updates or removes an attribute on the cart and checkout. On success, the\n * [`attributes`](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/attributes#standardapi-propertydetail-attributes) property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * @deprecated Use cart metafields instead.\n */\n applyAttributeChange(change: AttributeChange): Promise;\n\n /**\n * Adds, removes, or updates line items in the cart. The returned promise resolves when the change has been applied by the server, and the [`lines`](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-lines#standardapi-propertydetail-lines) property updates with the new state.\n *\n * > Note: This method returns an error if the [cart instruction](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyCartLinesChange(change: CartLineChange): Promise;\n\n /**\n * Adds or removes a discount code on the checkout. The returned promise resolves when the change has been applied by the server, and the [`discountCodes`](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/discounts#standardapi-propertydetail-discountcodes) property updates with the new state.\n *\n * > Caution:\n * > See [security considerations](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves discount codes through a network call.\n *\n * > Note: This method returns an error if the [cart instruction](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyDiscountCodeChange(\n change: DiscountCodeChange,\n ): Promise;\n\n /**\n * Adds or removes a gift card from the checkout. The returned promise resolves when the change has been applied by the server, and the [`appliedGiftCards`](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/gift-cards#standardapi-propertydetail-appliedgiftcards) property updates with the new state.\n *\n * > Caution:\n * > See [security considerations](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves gift card codes through a network call.\n *\n * > Note: This method returns an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyGiftCardChange(change: GiftCardChange): Promise;\n\n /**\n * Creates, updates, or removes a cart metafield on the checkout. On success, the\n * [`metafields`](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/metafields#standardapi-propertydetail-metafields) property updates to reflect the change.\n *\n * Cart metafields are copied to order metafields at order creation time if there's a matching order metafield definition with the [`cart to order copyable`](https://shopify.dev/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n *\n * > Caution: `MetafieldRemoveChange` and `MetafieldUpdateChange` are deprecated. Use cart metafields with `MetafieldRemoveCartChange` and `MetafieldUpdateCartChange` instead. If `MetafieldUpdateChange` writes a metafield with the same namespace and key as a cart metafield that's configured to copy, the cart metafield won't be copied.\n *\n * > Note: This method returns an error if the [cart instruction](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyMetafieldChange(change: MetafieldChange): Promise;\n\n /**\n * Sets or removes the buyer's note on the checkout. On success, the\n * [`note`](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/note#standardapi-propertydetail-note)\n * property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyNoteChange(change: NoteChange): Promise;\n\n /**\n * @private\n */\n experimentalIsShopAppStyle?: boolean;\n\n /**\n * Updates the buyer's shipping address on the checkout. The provided fields\n * are merged into the existing address without prompting the buyer. On success,\n * the `shippingAddress` property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).\n */\n applyShippingAddressChange?(\n change: ShippingAddressChange,\n ): Promise;\n}" + "value": "export interface CheckoutApi {\n /**\n * Updates or removes an attribute on the cart and checkout. On success, the\n * [`attributes`](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/attributes#properties-propertydetail-attributes) property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * @deprecated Use cart metafields instead.\n */\n applyAttributeChange(change: AttributeChange): Promise;\n\n /**\n * Adds, removes, or updates line items in the cart. The returned promise resolves when the change has been applied by the server, and the [`lines`](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-lines#properties-propertydetail-lines) property updates with the new state.\n *\n * Accepts a single change per call. To make multiple changes, call this\n * method separately for each one.\n *\n * > Note: This method returns an error if the [cart instruction](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyCartLinesChange(change: CartLineChange): Promise;\n\n /**\n * Adds or removes a discount code on the checkout. The returned promise resolves when the change has been applied by the server, and the [`discountCodes`](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/discounts#properties-propertydetail-discountcodes) property updates with the new state.\n *\n * > Caution:\n * > See [security considerations](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves discount codes through a network call.\n *\n * > Note: This method returns an error if the [cart instruction](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyDiscountCodeChange(\n change: DiscountCodeChange,\n ): Promise;\n\n /**\n * Adds or removes a gift card from the checkout. The returned promise resolves when the change has been applied by the server, and the [`appliedGiftCards`](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/gift-cards#properties-propertydetail-appliedgiftcards) property updates with the new state.\n *\n * Unlike other write operations, gift card changes aren't gated by a cart\n * instruction flag.\n *\n * > Caution:\n * > See [security considerations](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves gift card codes through a network call.\n *\n * > Note: This method returns an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyGiftCardChange(change: GiftCardChange): Promise;\n\n /**\n * Creates, updates, or removes a cart metafield on the checkout. On success, the\n * [`metafields`](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/metafields#properties-propertydetail-metafields) property updates to reflect the change.\n *\n * Cart metafields are copied to order metafields at order creation time if there's a matching order metafield definition with the [`cart to order copyable`](https://shopify.dev/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n *\n * > Caution: `MetafieldRemoveChange` and `MetafieldUpdateChange` are deprecated. Use cart metafields with `MetafieldRemoveCartChange` and `MetafieldUpdateCartChange` instead. If `MetafieldUpdateChange` writes a metafield with the same namespace and key as a cart metafield that's configured to copy, the cart metafield won't be copied.\n *\n * > Note: This method returns an error if the [cart instruction](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyMetafieldChange(change: MetafieldChange): Promise;\n\n /**\n * Sets or removes the buyer's note on the checkout. On success, the\n * [`note`](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/note#properties-propertydetail-note)\n * property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyNoteChange(change: NoteChange): Promise;\n\n /**\n * @private\n */\n experimentalIsShopAppStyle?: boolean;\n\n /**\n * Updates the buyer's shipping address on the checkout. The provided fields\n * are merged into the existing address without prompting the buyer. On success,\n * the `shippingAddress` property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).\n */\n applyShippingAddressChange?(\n change: ShippingAddressChange,\n ): Promise;\n}" } }, "AttributeChange": { @@ -2672,7 +2672,7 @@ "syntaxKind": "PropertySignature", "name": "message", "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer." + "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer.\n\nRender your own localized error text rather than displaying this message to the buyer." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -2682,7 +2682,7 @@ "description": "Indicates that the line item wasn't changed successfully. Refer to the `message` property for details about the error." } ], - "value": "export interface CartLineChangeResultError {\n /**\n * Indicates that the line item wasn't changed successfully. Refer to the `message` property for details about the error.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface CartLineChangeResultError {\n /**\n * Indicates that the line item wasn't changed successfully. Refer to the `message` property for details about the error.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n *\n * Render your own localized error text rather than displaying this message\n * to the buyer.\n */\n message: string;\n}" } }, "DiscountCodeChange": { @@ -2886,7 +2886,7 @@ "syntaxKind": "PropertySignature", "name": "message", "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer." + "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer.\n\nRender your own localized error text rather than displaying this message to the buyer." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -2896,7 +2896,7 @@ "description": "Indicates that the gift card change couldn't be applied. Check the `message` property for details." } ], - "value": "export interface GiftCardChangeResultError {\n /**\n * Indicates that the gift card change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface GiftCardChangeResultError {\n /**\n * Indicates that the gift card change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n *\n * Render your own localized error text rather than displaying this message\n * to the buyer.\n */\n message: string;\n}" } }, "MetafieldChange": { @@ -3077,7 +3077,7 @@ "syntaxKind": "PropertySignature", "name": "message", "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer." + "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer.\n\nRender your own localized error text rather than displaying this message to the buyer." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -3087,7 +3087,7 @@ "description": "Indicates that the metafield change couldn't be applied. Check the `message` property for details." } ], - "value": "export interface MetafieldChangeResultError {\n /**\n * Indicates that the metafield change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface MetafieldChangeResultError {\n /**\n * Indicates that the metafield change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n *\n * Render your own localized error text rather than displaying this message\n * to the buyer.\n */\n message: string;\n}" } }, "NoteChange": { @@ -3177,7 +3177,7 @@ "syntaxKind": "PropertySignature", "name": "message", "value": "string", - "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer." + "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer.\n\nRender your own localized error text rather than displaying this message to the buyer." }, { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -3187,7 +3187,7 @@ "description": "Indicates that the note change couldn't be applied. Check the `message` property for details." } ], - "value": "export interface NoteChangeResultError {\n /**\n * Indicates that the note change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface NoteChangeResultError {\n /**\n * Indicates that the note change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n *\n * Render your own localized error text rather than displaying this message\n * to the buyer.\n */\n message: string;\n}" } }, "ShippingAddressUpdateChange": { @@ -3545,7 +3545,7 @@ "syntaxKind": "PropertySignature", "name": "analytics", "value": "Analytics", - "description": "The methods for interacting with [Web Pixels](https://shopify.dev/docs/apps/marketing), such as emitting an event." + "description": "Tracks custom events and sends visitor information to [Web Pixels](https://shopify.dev/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -3559,7 +3559,7 @@ "syntaxKind": "PropertySignature", "name": "applyTrackingConsentChange", "value": "ApplyTrackingConsentChangeType", - "description": "Enables setting and updating customer privacy consent settings and tracking consent metafields.\n\n> Note: Requires the [`customer_privacy` capability](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent) to be set to `true`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data)." + "description": "Enables setting and updating customer privacy consent settings and tracking consent metafields.\n\n> Note: Requires the [`collect_buyer_consent` capability](/docs/apps/build/customer-accounts/capabilities#collect-buyer-consent) to be set to `true`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data)." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -3580,7 +3580,7 @@ "syntaxKind": "PropertySignature", "name": "availablePaymentOptions", "value": "SubscribableSignalLike", - "description": "All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region." + "description": "All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n\nThe set of payment options can change when the buyer updates their address or cart, so subscribe to changes rather than reading once during initialization. Each option exposes `handle` and `type` only. Provider names, logos, fees, and installment terms aren't available." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -3617,7 +3617,7 @@ "syntaxKind": "PropertySignature", "name": "checkoutToken", "value": "SubscribableSignalLike", - "description": "A stable ID that represents the current checkout.\n\nThe value is `undefined` when the checkout hasn't been created on the server yet.\n\nUse this to correlate checkout sessions across your extension, web pixels, and backend systems.\n\nThis matches the `data.checkout.token` field in a [checkout-related WebPixel event](https://shopify.dev/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data) and the `checkout_token` field in the [REST Admin API `Order` resource](https://shopify.dev/docs/api/admin-rest/unstable/resources/order#resource-object)." + "description": "A stable ID that represents the current checkout.\n\nThe value is `undefined` when the checkout hasn't been created on the server yet.\n\nUse this to correlate checkout sessions across your extension, web pixels, and backend systems.\n\nThis matches the `data.checkout.token` field in a [checkout-related WebPixel event](https://shopify.dev/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data) and the `checkout_token` field in the [REST Admin API `Order` resource](https://shopify.dev/docs/api/admin-rest/unstable/resources/order#resource-object).\n\nCan be `undefined`. Handle the `undefined` state before using the value." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -3638,7 +3638,7 @@ "syntaxKind": "PropertySignature", "name": "deliveryGroups", "value": "SubscribableSignalLike", - "description": "The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items." + "description": "The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n\nEmpty until the buyer enters enough address information for Shopify to calculate shipping rates." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -3659,7 +3659,7 @@ "syntaxKind": "PropertySignature", "name": "extension", "value": "Extension", - "description": "The meta information about the extension." + "description": "Metadata about the running extension, including the current target, API version, capabilities, and editor context. Use this to conditionally render content based on where the extension is running." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -3667,7 +3667,7 @@ "name": "extensionPoint", "value": "Target", "description": "The identifier that specifies where in Shopify's UI your code is being injected. This is one of the targets you've included in your extension's configuration file.", - "deprecationMessage": "Deprecated as of version `2023-07`, use `extension.target` instead.", + "deprecationMessage": "Use `extension.target` instead.", "examples": [ { "title": "Example", @@ -3686,14 +3686,14 @@ "syntaxKind": "PropertySignature", "name": "i18n", "value": "I18n", - "description": "Utilities for translating content and formatting values according to the current [`localization`](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) of the checkout.\n\nRefer to [`localization` examples](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples) for more information." + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use alongside [`localization`](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) to build fully localized extensions." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "instructions", "value": "SubscribableSignalLike", - "description": "The cart instructions used to create the checkout and possibly limit extension capabilities.\n\nThese instructions should be checked before performing any actions that might be affected by them.\n\nFor example, if you intend to add a discount code via the `applyDiscountCodeChange` method, check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n\n> Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs aren't available. See the [update guide](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples) for more information." + "description": "The cart instructions used to create the checkout and possibly limit extension capabilities.\n\nThese instructions should be checked before performing any actions that might be affected by them.\n\nFor example, if you intend to add a discount code via the `applyDiscountCodeChange` method, check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n\n> Caution: Check cart instructions before calling select APIs, as > some may not be available. See the > [Cart Instructions API](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples) > for more information." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -3707,7 +3707,7 @@ "syntaxKind": "PropertySignature", "name": "localization", "value": "Localization", - "description": "The details about the location, language, and currency of the customer. For utilities to easily format and translate content based on these details, you can use the [`i18n`](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n) object instead." + "description": "The buyer's language, country, currency, and timezone context. For formatting and translation helpers, use the [`i18n`](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#properties-propertydetail-i18n) object instead." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -3737,21 +3737,21 @@ "syntaxKind": "PropertySignature", "name": "query", "value": ">(query: string, options?: { variables?: Variables; version?: StorefrontApiVersion; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>", - "description": "The method used to query the Storefront GraphQL API with a prefetched token.\n\nRefer to [Storefront API access examples](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/storefront-api) for more information." + "description": "The method used to query the Storefront GraphQL API with a prefetched token." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "selectedPaymentOptions", "value": "SubscribableSignalLike", - "description": "The payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card)." + "description": "The payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\n\nEach option exposes `handle` and `type` only. Provider names, logos, fees, and installment terms aren't available." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "sessionToken", "value": "SessionToken", - "description": "The session token providing a set of claims as a signed JSON Web Token (JWT).\n\nThe token has a TTL of five minutes.\n\nIf the previous token expires, this value reflects a new session token with a new signature and expiry.\n\nRefer to [session token examples](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/session-token) for more information." + "description": "The session token providing a set of claims as a signed JSON Web Token (JWT).\n\nThe token has a TTL of five minutes.\n\nIf the previous token expires, this value reflects a new session token with a new signature and expiry.\n\nLearn more about [session tokens](/docs/apps/build/authentication-authorization/session-tokens)." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -3773,14 +3773,14 @@ "syntaxKind": "PropertySignature", "name": "shop", "value": "Shop", - "description": "The shop where the checkout is taking place." + "description": "The store where the checkout is taking place, including the shop name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "storage", "value": "Storage", - "description": "The key-value storage for the extension.\n\nIt uses `localStorage` and should persist across the customer's current checkout session.\n\n> Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n\nData is shared across all activated extension targets of this extension. In versions 2023-07 and earlier, each activated extension target had its own storage." + "description": "Key-value storage that persists across page loads within the current checkout session. Data is shared across all activated targets associated with this extension.\n\n> Caution: Data persistence isn't guaranteed and storage is cleared when the buyer starts a new checkout." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -3802,31 +3802,31 @@ ] } ], - "value": "export interface StandardApi {\n /**\n * The methods for interacting with [Web Pixels](https://shopify.dev/docs/apps/marketing), such as emitting an event.\n */\n analytics: Analytics;\n\n /**\n * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\n */\n appliedGiftCards: SubscribableSignalLike;\n\n /**\n * The cart instructions used to create the checkout and possibly limit extension capabilities.\n *\n * These instructions should be checked before performing any actions that might be affected by them.\n *\n * For example, if you intend to add a discount code via the `applyDiscountCodeChange` method,\n * check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n *\n * > Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs aren't available.\n * See the [update guide](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples) for more information.\n *\n */\n instructions: SubscribableSignalLike;\n\n /**\n * The metafields requested in the\n * [`shopify.extension.toml`](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/configuration)\n * file. These metafields are updated when there's a change in the merchandise items\n * being purchased by the customer.\n *\n * App owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` isn't supported. See [app owned metafields](https://shopify.dev/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).\n */\n appMetafields: SubscribableSignalLike;\n\n /**\n * The custom key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).\n */\n buyerIdentity?: BuyerIdentity;\n\n /**\n * Provides details on the buyer's progression through the checkout and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/buyer-journey#examples)\n * examples for more information.\n */\n buyerJourney: BuyerJourney;\n\n /**\n * Settings applied to the buyer's checkout.\n */\n checkoutSettings: SubscribableSignalLike;\n\n /**\n * A stable ID that represents the current checkout.\n *\n * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\n *\n * This matches the `data.checkout.token` field in a [checkout-related WebPixel event](https://shopify.dev/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data)\n * and the `checkout_token` field in the [REST Admin API `Order` resource](https://shopify.dev/docs/api/admin-rest/unstable/resources/order#resource-object).\n */\n checkoutToken: SubscribableSignalLike;\n\n /**\n * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](https://shopify.dev/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * The meta information about the extension.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see https://shopify.dev/docs/apps/app-extensions/configuration#targets\n *\n * @deprecated Deprecated as of version `2023-07`, use `extension.target` instead.\n */\n extensionPoint: Target;\n\n /**\n * Utilities for translating content and formatting values according to the current\n * [`localization`](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization)\n * of the checkout.\n *\n * Refer to [`localization` examples](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples)\n * for more information.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The details about the location, language, and currency of the customer. For utilities to easily\n * format and translate content based on these details, you can use the\n * [`i18n`](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n)\n * object instead.\n */\n localization: Localization;\n\n /**\n * The metafields that apply to the current checkout.\n *\n * Metafields are stored locally on the client and are applied to the order object after the checkout completes.\n *\n * These metafields are shared by all extensions running on checkout, and\n * persist for as long as the customer is working on this checkout.\n *\n * Once the order is created, you can query these metafields using the\n * [GraphQL Admin API](https://shopify.dev/docs/admin-api/graphql/reference/orders/order#metafield-2021-01)\n *\n * > Caution:\n * `metafields` is deprecated. Use `appMetafields` with cart metafields instead.\n *\n * @deprecated Use `appMetafields` with cart metafields instead.\n */\n metafields: SubscribableSignalLike;\n\n /**\n * A note left by the customer to the merchant, either in their cart or during checkout.\n *\n * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\n */\n note: SubscribableSignalLike;\n\n /**\n * The method used to query the Storefront GraphQL API with a prefetched token.\n *\n * Refer to [Storefront API access examples](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/storefront-api) for more information.\n */\n query: >(\n query: string,\n options?: {variables?: Variables; version?: StorefrontApiVersion},\n ) => Promise<{data?: Data; errors?: GraphQLError[]}>;\n\n /**\n * The payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\n */\n selectedPaymentOptions: SubscribableSignalLike;\n\n /**\n * The session token providing a set of claims as a signed JSON Web Token (JWT).\n *\n * The token has a TTL of five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/session-token) for more information.\n */\n sessionToken: SessionToken;\n\n /**\n * The settings matching the settings definition written in the\n * [`shopify.extension.toml`](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates in real time as a merchant fills in the settings.\n */\n settings: SubscribableSignalLike;\n\n /**\n * The proposed customer shipping address. During the information step, the address\n * updates when the field is committed (on change) rather than every keystroke.\n * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).\n */\n shippingAddress?: SubscribableSignalLike;\n\n /**\n * The proposed customer billing address. The address updates when the field is\n * committed (on change) rather than every keystroke. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided yet.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).\n */\n billingAddress?: SubscribableSignalLike;\n\n /** The shop where the checkout is taking place. */\n shop: Shop;\n\n /**\n * The key-value storage for the extension.\n *\n * It uses `localStorage` and should persist across the customer's current checkout session.\n *\n * > Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n *\n * Data is shared across all activated extension targets of this extension. In versions 2023-07 and earlier,\n * each activated extension target had its own storage.\n */\n storage: Storage;\n\n /**\n * The renderer version being used for the extension.\n *\n * @example '2025-10'\n */\n version: Version;\n\n /**\n * Customer privacy consent settings and a flag denoting if consent has previously been collected.\n */\n customerPrivacy: SubscribableSignalLike;\n\n /**\n * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`customer_privacy` capability](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent) to be set to `true`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).\n */\n applyTrackingConsentChange: ApplyTrackingConsentChangeType;\n\n /**\n * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" + "value": "export interface StandardApi {\n /**\n * Tracks custom events and sends visitor information to\n * [Web Pixels](https://shopify.dev/docs/apps/marketing). Use `publish()` to emit events\n * and `visitor()` to submit buyer contact details.\n */\n analytics: Analytics;\n\n /**\n * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\n */\n appliedGiftCards: SubscribableSignalLike;\n\n /**\n * The cart instructions used to create the checkout and possibly limit extension capabilities.\n *\n * These instructions should be checked before performing any actions that might be affected by them.\n *\n * For example, if you intend to add a discount code via the `applyDiscountCodeChange` method,\n * check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n *\n * > Caution: Check cart instructions before calling select APIs, as\n * > some may not be available. See the\n * > [Cart Instructions API](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples)\n * > for more information.\n *\n */\n instructions: SubscribableSignalLike;\n\n /**\n * The metafields requested in the\n * [`shopify.extension.toml`](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/configuration)\n * file. These metafields are updated when there's a change in the merchandise items\n * being purchased by the customer.\n *\n * App owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` isn't supported. See [app owned metafields](https://shopify.dev/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).\n */\n appMetafields: SubscribableSignalLike;\n\n /**\n * The custom key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as\n * credit cards, wallets, and local payment methods. The list depends on\n * the shop's payment configuration and the buyer's region.\n *\n * The set of payment options can change when the buyer updates their\n * address or cart, so subscribe to changes rather than reading once\n * during initialization. Each option exposes `handle` and `type` only.\n * Provider names, logos, fees, and installment terms aren't available.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).\n */\n buyerIdentity?: BuyerIdentity;\n\n /**\n * Provides details on the buyer's progression through the checkout and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/buyer-journey#examples)\n * examples for more information.\n */\n buyerJourney: BuyerJourney;\n\n /**\n * Settings applied to the buyer's checkout.\n */\n checkoutSettings: SubscribableSignalLike;\n\n /**\n * A stable ID that represents the current checkout.\n *\n * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\n *\n * This matches the `data.checkout.token` field in a [checkout-related WebPixel event](https://shopify.dev/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data)\n * and the `checkout_token` field in the [REST Admin API `Order` resource](https://shopify.dev/docs/api/admin-rest/unstable/resources/order#resource-object).\n *\n * Can be `undefined`. Handle the `undefined` state before using the value.\n */\n checkoutToken: SubscribableSignalLike;\n\n /**\n * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n *\n * Empty until the buyer enters enough address information for Shopify to\n * calculate shipping rates.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](https://shopify.dev/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * Metadata about the running extension, including the current target, API version,\n * capabilities, and editor context. Use this to conditionally render content\n * based on where the extension is running.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see https://shopify.dev/docs/apps/app-extensions/configuration#targets\n *\n * @deprecated Use `extension.target` instead.\n */\n extensionPoint: Target;\n\n /**\n * Utilities for translating strings, formatting currencies, numbers, and dates\n * according to the buyer's locale. Use alongside\n * [`localization`](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization)\n * to build fully localized extensions.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The buyer's language, country, currency, and timezone context. For\n * formatting and translation helpers, use the\n * [`i18n`](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#properties-propertydetail-i18n)\n * object instead.\n */\n localization: Localization;\n\n /**\n * The metafields that apply to the current checkout.\n *\n * Metafields are stored locally on the client and are applied to the order object after the checkout completes.\n *\n * These metafields are shared by all extensions running on checkout, and\n * persist for as long as the customer is working on this checkout.\n *\n * Once the order is created, you can query these metafields using the\n * [GraphQL Admin API](https://shopify.dev/docs/admin-api/graphql/reference/orders/order#metafield-2021-01)\n *\n * > Caution:\n * `metafields` is deprecated. Use `appMetafields` with cart metafields instead.\n *\n * @deprecated Use `appMetafields` with cart metafields instead.\n */\n metafields: SubscribableSignalLike;\n\n /**\n * A note left by the customer to the merchant, either in their cart or during checkout.\n *\n * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\n */\n note: SubscribableSignalLike;\n\n /**\n * The method used to query the Storefront GraphQL API with a prefetched token.\n *\n */\n query: >(\n query: string,\n options?: {variables?: Variables; version?: StorefrontApiVersion},\n ) => Promise<{data?: Data; errors?: GraphQLError[]}>;\n\n /**\n * The payment options the buyer has currently selected. This updates as\n * the buyer changes their payment method. The array can contain multiple\n * entries when the buyer splits payment across methods (for example, a\n * gift card and a credit card).\n *\n * Each option exposes `handle` and `type` only. Provider names, logos,\n * fees, and installment terms aren't available.\n */\n selectedPaymentOptions: SubscribableSignalLike;\n\n /**\n * The session token providing a set of claims as a signed JSON Web Token (JWT).\n *\n * The token has a TTL of five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Learn more about [session tokens](/docs/apps/build/authentication-authorization/session-tokens).\n */\n sessionToken: SessionToken;\n\n /**\n * The settings matching the settings definition written in the\n * [`shopify.extension.toml`](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates in real time as a merchant fills in the settings.\n */\n settings: SubscribableSignalLike;\n\n /**\n * The proposed customer shipping address. During the information step, the address\n * updates when the field is committed (on change) rather than every keystroke.\n * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).\n */\n shippingAddress?: SubscribableSignalLike;\n\n /**\n * The proposed customer billing address. The address updates when the field is\n * committed (on change) rather than every keystroke. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided yet.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).\n */\n billingAddress?: SubscribableSignalLike;\n\n /**\n * The store where the checkout is taking place, including the shop name,\n * storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.\n */\n shop: Shop;\n\n /**\n * Key-value storage that persists across page loads within the current checkout\n * session. Data is shared across all activated targets associated with\n * this extension.\n *\n * > Caution: Data persistence isn't guaranteed and storage is cleared when the\n * buyer starts a new checkout.\n */\n storage: Storage;\n\n /**\n * The renderer version being used for the extension.\n *\n * @example '2025-10'\n */\n version: Version;\n\n /**\n * Customer privacy consent settings and a flag denoting if consent has previously been collected.\n */\n customerPrivacy: SubscribableSignalLike;\n\n /**\n * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`collect_buyer_consent` capability](/docs/apps/build/customer-accounts/capabilities#collect-buyer-consent) to be set to `true`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).\n */\n applyTrackingConsentChange: ApplyTrackingConsentChangeType;\n\n /**\n * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" } }, "Analytics": { "src/surfaces/checkout/api/standard/standard.ts": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Analytics", - "description": "", + "description": "Tracks custom events and sends visitor information to [Web Pixels](https://shopify.dev/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "publish", "value": "(name: string, data: Record) => Promise", - "description": "Publish method to emit analytics events to [Web Pixels](https://shopify.dev/docs/apps/marketing)." + "description": "Publishes a custom event to [Web Pixels](https://shopify.dev/docs/apps/marketing). Returns `true` when the event is successfully dispatched.\n\nThe Promise resolves to `true` when the event was dispatched. The boolean indicates dispatch confirmation only. It doesn't indicate whether any specific web pixel processed the event." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "visitor", "value": "(data: { email?: string; phone?: string; }) => Promise", - "description": "A method for capturing details about a visitor on the online store." + "description": "Submits buyer contact details for attribution and analytics purposes." } ], - "value": "export interface Analytics {\n /**\n * Publish method to emit analytics events to [Web Pixels](https://shopify.dev/docs/apps/marketing).\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * A method for capturing details about a visitor on the online store.\n */\n visitor(data: {email?: string; phone?: string}): Promise;\n}" + "value": "export interface Analytics {\n /**\n * Publishes a custom event to [Web Pixels](https://shopify.dev/docs/apps/marketing).\n * Returns `true` when the event is successfully dispatched.\n *\n * The Promise resolves to `true` when the event was dispatched. The boolean\n * indicates dispatch confirmation only. It doesn't indicate whether any\n * specific web pixel processed the event.\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * Submits buyer contact details for attribution and analytics purposes.\n */\n visitor(data: {email?: string; phone?: string}): Promise;\n}" } }, "VisitorResult": { @@ -3873,10 +3873,10 @@ "syntaxKind": "PropertySignature", "name": "type", "value": "'error'", - "description": "Indicates that the visitor information is invalid and wasn't submitted. Examples are using the wrong data type or missing a required property." + "description": "Indicates that the visitor information is invalid and wasn't submitted. Common causes include using the wrong data type or omitting a required property." } ], - "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Examples are using the wrong data type or missing a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Common causes include using the wrong data type or omitting a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" } }, "AppliedGiftCard": { @@ -4019,10 +4019,10 @@ "syntaxKind": "PropertySignature", "name": "value", "value": "string | null", - "description": "The new value to store in the metafield. Set to `null` to delete the metafield." + "description": "The new value to store in the metafield. Set to `null` to delete the metafield.\n\nConsent metafield values are strings, not booleans. Pass `null` to delete a tracking consent metafield." } ], - "value": "export interface TrackingConsentMetafieldChange {\n /**\n * The identifier for the tracking consent metafield to update.\n */\n key: string;\n /**\n * The new value to store in the metafield. Set to `null` to delete the metafield.\n */\n value: string | null;\n}" + "value": "export interface TrackingConsentMetafieldChange {\n /**\n * The identifier for the tracking consent metafield to update.\n */\n key: string;\n /**\n * The new value to store in the metafield. Set to `null` to delete the metafield.\n *\n * Consent metafield values are strings, not booleans. Pass `null` to delete\n * a tracking consent metafield.\n */\n value: string | null;\n}" } }, "VisitorConsent": { @@ -4341,7 +4341,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A globally-unique identifier for the customer in the format `gid://shopify/Customer/`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).", + "description": "An identifier for the customer in the format `gid://shopify/Customer/`. This value is unique per shop.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).", "examples": [ { "title": "Example", @@ -4394,7 +4394,7 @@ "isPrivate": true } ], - "value": "export interface Customer {\n /**\n * A globally-unique identifier for the customer in the format `gid://shopify/Customer/`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'gid://shopify/Customer/123'\n */\n id: string;\n /**\n * The email address associated with the customer's account. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).\n */\n email?: string;\n /**\n * The phone number associated with the customer's account. The value is `undefined` if no phone number is on file or the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).\n */\n phone?: string;\n /**\n * The customer's full name, typically a combination of first and last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).\n */\n fullName?: string;\n /**\n * The customer's first name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).\n */\n firstName?: string;\n /**\n * The customer's last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).\n */\n lastName?: string;\n /**\n * The customer's profile image, such as a Gravatar avatar. Use this to personalize the extension UI for the logged-in buyer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).\n */\n image: ImageDetails;\n /**\n * Whether the customer has opted in to receiving marketing communications from the merchant, such as email campaigns and promotional offers.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).\n *\n * > Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n *\n * @deprecated Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n */\n acceptsMarketing: boolean;\n /**\n * Whether the customer has opted in to email marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsEmailMarketing: boolean;\n /**\n * Whether the customer has opted in to SMS marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsSmsMarketing: boolean;\n /**\n * The store credit accounts owned by this customer that can be used as payment during checkout. Each account has a balance representing available store credit.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).\n *\n * @private\n */\n storeCreditAccounts: StoreCreditAccount[];\n /**\n * The number of orders the customer has previously placed with this shop.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).\n */\n ordersCount: number;\n}" + "value": "export interface Customer {\n /**\n * An identifier for the customer in the format `gid://shopify/Customer/`. This value is unique per shop.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'gid://shopify/Customer/123'\n */\n id: string;\n /**\n * The email address associated with the customer's account. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).\n */\n email?: string;\n /**\n * The phone number associated with the customer's account. The value is `undefined` if no phone number is on file or the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).\n */\n phone?: string;\n /**\n * The customer's full name, typically a combination of first and last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).\n */\n fullName?: string;\n /**\n * The customer's first name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).\n */\n firstName?: string;\n /**\n * The customer's last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).\n */\n lastName?: string;\n /**\n * The customer's profile image, such as a Gravatar avatar. Use this to personalize the extension UI for the logged-in buyer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).\n */\n image: ImageDetails;\n /**\n * Whether the customer has opted in to receiving marketing communications from the merchant, such as email campaigns and promotional offers.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).\n *\n * > Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n *\n * @deprecated Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n */\n acceptsMarketing: boolean;\n /**\n * Whether the customer has opted in to email marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsEmailMarketing: boolean;\n /**\n * Whether the customer has opted in to SMS marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsSmsMarketing: boolean;\n /**\n * The store credit accounts owned by this customer that can be used as payment during checkout. Each account has a balance representing available store credit.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).\n *\n * @private\n */\n storeCreditAccounts: StoreCreditAccount[];\n /**\n * The number of orders the customer has previously placed with this shop.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).\n */\n ordersCount: number;\n}" } }, "StoreCreditAccount": { @@ -4675,11 +4675,11 @@ "syntaxKind": "MethodSignature", "name": "perform", "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", + "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.\n\nRuns after all intercept results are collected. Use it for local state updates such as setting an error flag. By the time it runs, the navigation decision is final, so blocking logic belongs in the intercept handler itself, not here.", "isOptional": true } ], - "value": "interface InterceptorRequestAllow {\n /**\n * Indicates that the interceptor allows the buyer's journey to continue.\n */\n behavior: 'allow';\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" + "value": "interface InterceptorRequestAllow {\n /**\n * Indicates that the interceptor allows the buyer's journey to continue.\n */\n behavior: 'allow';\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n *\n * Runs after all intercept results are collected. Use it for local state\n * updates such as setting an error flag. By the time it runs, the navigation\n * decision is final, so blocking logic belongs in the intercept handler\n * itself, not here.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" } }, "InterceptorResult": { @@ -4751,7 +4751,7 @@ "syntaxKind": "MethodSignature", "name": "perform", "value": "(result: InterceptorResult) => void | Promise", - "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.", + "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.\n\nRuns after all intercept results are collected. Use it for local state updates such as setting an error flag. By the time it runs, the navigation decision is final, so blocking logic belongs in the intercept handler itself, not here.", "isOptional": true }, { @@ -4762,7 +4762,7 @@ "description": "The reason for blocking the interceptor request. This value isn't presented to the buyer, so it doesn't need to be localized. The value is used only for Shopify's own internal debugging and metrics." } ], - "value": "interface InterceptorRequestBlock {\n /**\n * Indicates that the interceptor blocks the buyer's journey from continuing.\n */\n behavior: 'block';\n\n /**\n * The reason for blocking the interceptor request. This value isn't presented to\n * the buyer, so it doesn't need to be localized. The value is used only for Shopify's\n * own internal debugging and metrics.\n */\n reason: string;\n\n /**\n * Used to pass errors to the checkout UI, outside your extension's UI boundaries.\n */\n errors?: ValidationError[];\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" + "value": "interface InterceptorRequestBlock {\n /**\n * Indicates that the interceptor blocks the buyer's journey from continuing.\n */\n behavior: 'block';\n\n /**\n * The reason for blocking the interceptor request. This value isn't presented to\n * the buyer, so it doesn't need to be localized. The value is used only for Shopify's\n * own internal debugging and metrics.\n */\n reason: string;\n\n /**\n * Used to pass errors to the checkout UI, outside your extension's UI boundaries.\n */\n errors?: ValidationError[];\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n *\n * Runs after all intercept results are collected. Use it for local state\n * updates such as setting an error flag. By the time it runs, the navigation\n * decision is final, so blocking logic belongs in the intercept handler\n * itself, not here.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" } }, "ValidationError": { @@ -4997,17 +4997,17 @@ "syntaxKind": "PropertySignature", "name": "totalShippingAmount", "value": "SubscribableSignalLike", - "description": "The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step." + "description": "The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step.\n\n`undefined` until the buyer selects a shipping method (typically after the information step)." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "totalTaxAmount", "value": "SubscribableSignalLike", - "description": "The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet." + "description": "The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet.\n\n`undefined` when taxes haven't been calculated or aren't available for the buyer's region." } ], - "value": "export interface CartCost {\n /**\n * The sum of all line item prices at the current step of checkout, before shipping and taxes are applied. Use this value to display the base cost of the items the buyer purchased.\n */\n subtotalAmount: SubscribableSignalLike;\n\n /**\n * The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step.\n */\n totalShippingAmount: SubscribableSignalLike;\n\n /**\n * The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet.\n */\n totalTaxAmount: SubscribableSignalLike;\n\n /**\n * The minimum total at the current step of checkout. Costs not yet calculated, such as shipping on the information step, aren't included. Gift cards and store credits are excluded from this total.\n */\n totalAmount: SubscribableSignalLike;\n}" + "value": "export interface CartCost {\n /**\n * The sum of all line item prices at the current step of checkout, before shipping and taxes are applied. Use this value to display the base cost of the items the buyer purchased.\n */\n subtotalAmount: SubscribableSignalLike;\n\n /**\n * The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step.\n *\n * `undefined` until the buyer selects a shipping method (typically after the\n * information step).\n */\n totalShippingAmount: SubscribableSignalLike;\n\n /**\n * The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet.\n *\n * `undefined` when taxes haven't been calculated or aren't available for the\n * buyer's region.\n */\n totalTaxAmount: SubscribableSignalLike;\n\n /**\n * The minimum total at the current step of checkout. Costs not yet calculated, such as shipping on the information step, aren't included. Gift cards and store credits are excluded from this total.\n */\n totalAmount: SubscribableSignalLike;\n}" } }, "CustomerPrivacy": { @@ -5098,31 +5098,31 @@ "syntaxKind": "PropertySignature", "name": "analytics", "value": "boolean", - "description": "Whether analytics data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Analytics data includes how the shop was used and what interactions occurred." + "description": "Whether analytics data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Analytics data includes how the shop was used and what interactions occurred.\n\nWhether analytics data can be collected right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.analytics`, before calling `shopify.analytics.publish()`." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "marketing", "value": "boolean", - "description": "Whether marketing data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Marketing data includes attribution and targeted advertising preferences." + "description": "Whether marketing data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Marketing data includes attribution and targeted advertising preferences.\n\nWhether marketing data can be collected right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.marketing`, before performing marketing-related data collection." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "preferences", "value": "boolean", - "description": "Whether preference data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Preference data includes language, currency, and sizing choices." + "description": "Whether preference data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Preference data includes language, currency, and sizing choices.\n\nWhether preference data can be collected right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.preferences`, before storing or reading buyer preference data." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "saleOfData", "value": "boolean", - "description": "Whether data can be shared with third parties based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. This typically applies to behavioral advertising data." + "description": "Whether data can be shared with third parties based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. This typically applies to behavioral advertising data.\n\nWhether buyer data can be shared with or sold to third parties right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.saleOfData`, before sharing or selling buyer data with third parties." } ], - "value": "export interface AllowedProcessing {\n /**\n * Whether analytics data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Analytics\n * data includes how the shop was used and what interactions occurred.\n */\n analytics: boolean;\n /**\n * Whether marketing data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Marketing\n * data includes attribution and targeted advertising preferences.\n */\n marketing: boolean;\n /**\n * Whether preference data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Preference\n * data includes language, currency, and sizing choices.\n */\n preferences: boolean;\n /**\n * Whether data can be shared with third parties based on the visitor's\n * consent, the merchant's privacy configuration, and the visitor's region.\n * This typically applies to behavioral advertising data.\n */\n saleOfData: boolean;\n}" + "value": "export interface AllowedProcessing {\n /**\n * Whether analytics data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Analytics\n * data includes how the shop was used and what interactions occurred.\n *\n * Whether analytics data can be collected right now. Combines the buyer's\n * consent, the merchant's privacy configuration, and the buyer's region into\n * a single boolean. Check this flag, not `visitorConsent.analytics`, before\n * calling `shopify.analytics.publish()`.\n */\n analytics: boolean;\n /**\n * Whether marketing data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Marketing\n * data includes attribution and targeted advertising preferences.\n *\n * Whether marketing data can be collected right now. Combines the buyer's\n * consent, the merchant's privacy configuration, and the buyer's region into\n * a single boolean. Check this flag, not `visitorConsent.marketing`, before\n * performing marketing-related data collection.\n */\n marketing: boolean;\n /**\n * Whether preference data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Preference\n * data includes language, currency, and sizing choices.\n *\n * Whether preference data can be collected right now. Combines the buyer's\n * consent, the merchant's privacy configuration, and the buyer's region into\n * a single boolean. Check this flag, not `visitorConsent.preferences`,\n * before storing or reading buyer preference data.\n */\n preferences: boolean;\n /**\n * Whether data can be shared with third parties based on the visitor's\n * consent, the merchant's privacy configuration, and the visitor's region.\n * This typically applies to behavioral advertising data.\n *\n * Whether buyer data can be shared with or sold to third parties right now.\n * Combines the buyer's consent, the merchant's privacy configuration, and\n * the buyer's region into a single boolean. Check this flag, not\n * `visitorConsent.saleOfData`, before sharing or selling buyer data with\n * third parties.\n */\n saleOfData: boolean;\n}" } }, "TrackingConsentMetafield": { @@ -5220,7 +5220,7 @@ "src/surfaces/checkout/api/standard/standard.ts": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Extension", - "description": "The meta information about an extension target.", + "description": "Metadata about the running extension, including its API version, target, capabilities, and editor context. Use this to read configuration details or conditionally render content based on where the extension is running.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -5246,7 +5246,7 @@ "syntaxKind": "PropertySignature", "name": "capabilities", "value": "SubscribableSignalLike", - "description": "The allowed capabilities of the extension, defined in your [shopify.extension.toml](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n\n* [`api_access`](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#api-access): the extension can access the Storefront API.\n\n* [`network_access`](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access): the extension can make external network calls.\n\n* [`block_progress`](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n\n* [`collect_buyer_consent.sms_marketing`](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n\n* [`collect_buyer_consent.customer_privacy`](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can register customer consent decisions that are honored on Shopify-managed services.\n\n* [`iframe.sources`](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#iframe): the extension can embed an external URL in an iframe." + "description": "The allowed capabilities of the extension, defined in your [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -5294,7 +5294,7 @@ "syntaxKind": "PropertySignature", "name": "version", "value": "string", - "description": "The published version of the running extension target.\n\nFor unpublished extensions, the value is `undefined`.", + "description": "The published version of the running extension target.\n\nFor unpublished extensions, the value is `undefined`.\n\nDon't use this property as a stable identifier in development environments. It becomes available only after the extension is published.", "isOptional": true, "examples": [ { @@ -5310,7 +5310,7 @@ ] } ], - "value": "export interface Extension {\n /**\n * The API version that was set in the extension config file.\n *\n * @example '2024-10', '2025-01', '2025-04', '2025-07', '2025-10'\n */\n apiVersion: ApiVersion;\n\n /**\n * The allowed capabilities of the extension, defined\n * in your [shopify.extension.toml](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n *\n * * [`api_access`](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#api-access): the extension can access the Storefront API.\n *\n * * [`network_access`](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access): the extension can make external network calls.\n *\n * * [`block_progress`](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.\n *\n * * [`collect_buyer_consent.sms_marketing`](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.\n *\n * * [`collect_buyer_consent.customer_privacy`](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent): the extension can register customer consent decisions that are honored on Shopify-managed services.\n *\n * * [`iframe.sources`](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#iframe): the extension can embed an external URL in an iframe.\n */\n capabilities: SubscribableSignalLike;\n\n /**\n * Information about the editor where the extension is being rendered.\n *\n * If the value is undefined, then the extension isn't running in an editor.\n */\n editor?: Editor;\n\n /**\n * A Boolean to show whether your extension is currently rendered to the screen.\n *\n * Shopify might render your extension before it's visible in the UI,\n * typically to pre-render extensions that appear on a later step of the\n * checkout.\n *\n * Your extension might also continue to run after the customer has navigated away\n * from where it was rendered. The extension continues running so that\n * your extension is immediately available to render if the customer navigates back.\n */\n rendered: SubscribableSignalLike;\n\n /**\n * The URL to the script that started the extension target.\n */\n scriptUrl: string;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see https://shopify.dev/docs/apps/app-extensions/configuration#targets\n */\n target: Target;\n\n /**\n * The published version of the running extension target.\n *\n * For unpublished extensions, the value is `undefined`.\n *\n * @example 3.0.10\n */\n version?: string;\n}" + "value": "export interface Extension {\n /**\n * The API version that was set in the extension config file.\n *\n * @example '2024-10', '2025-01', '2025-04', '2025-07', '2025-10'\n */\n apiVersion: ApiVersion;\n\n /**\n * The allowed capabilities of the extension, defined in your\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n */\n capabilities: SubscribableSignalLike;\n\n /**\n * Information about the editor where the extension is being rendered.\n *\n * If the value is undefined, then the extension isn't running in an editor.\n */\n editor?: Editor;\n\n /**\n * A Boolean to show whether your extension is currently rendered to the screen.\n *\n * Shopify might render your extension before it's visible in the UI,\n * typically to pre-render extensions that appear on a later step of the\n * checkout.\n *\n * Your extension might also continue to run after the customer has navigated away\n * from where it was rendered. The extension continues running so that\n * your extension is immediately available to render if the customer navigates back.\n */\n rendered: SubscribableSignalLike;\n\n /**\n * The URL to the script that started the extension target.\n */\n scriptUrl: string;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see https://shopify.dev/docs/apps/app-extensions/configuration#targets\n */\n target: Target;\n\n /**\n * The published version of the running extension target.\n *\n * For unpublished extensions, the value is `undefined`.\n *\n * Don't use this property as a stable identifier in development environments.\n * It becomes available only after the extension is published.\n *\n * @example 3.0.10\n */\n version?: string;\n}" } }, "ApiVersion": { @@ -5335,7 +5335,7 @@ "src/surfaces/checkout/api/standard/standard.ts": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Editor", - "description": "", + "description": "Information about the editor environment when an extension is rendered inside the checkout editor. The value is `undefined` when the extension is not rendering in an editor.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -5352,7 +5352,7 @@ "src/surfaces/checkout/api/standard/standard.ts": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18n", - "description": "", + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use the I18n API alongside the Localization API to build fully localized extensions.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -5390,7 +5390,7 @@ "src/surfaces/checkout/api/standard/standard.ts": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18nTranslate", - "description": "This returns a translated string matching a key in a locale file.", + "description": "Translates a key from your extension's locale files into a localized string. Supports interpolation with placeholder replacements and pluralization via the special `count` option.", "members": [], "value": "export interface I18nTranslate {\n (\n key: string,\n options?: Record,\n ): ReplacementType extends string | number\n ? string\n : (string | ReplacementType)[];\n}" } @@ -5574,14 +5574,14 @@ "src/surfaces/checkout/api/standard/standard.ts": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Localization", - "description": "", + "description": "The buyer's language, country, currency, and timezone context. Use this to adapt your extension to the buyer's region and display localized content.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "country", "value": "SubscribableSignalLike", - "description": "The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown." + "description": "The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n\nDerived from the buyer's shipping address. Returns `undefined` until the buyer enters a shipping address." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -5609,18 +5609,18 @@ "syntaxKind": "PropertySignature", "name": "market", "value": "SubscribableSignalLike", - "description": "The [market](https://shopify.dev/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n\n> Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.", - "deprecationMessage": "Deprecated as of version `2025-04`" + "description": "The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. The market context updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.", + "deprecationMessage": "Merchants now manage which extensions load for each\nmarket, so extensions no longer need to check this value." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "PropertySignature", "name": "timezone", "value": "SubscribableSignalLike", - "description": "The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time." + "description": "The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time." } ], - "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](https://shopify.dev/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n *\n * > Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" + "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n *\n * Derived from the buyer's shipping address. Returns `undefined` until the\n * buyer enters a shipping address.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout,\n * carried over from the cart context. Markets group countries and\n * regions with shared pricing, languages, and domains. The market\n * context updates when the buyer changes the country of their\n * shipping address. The value is `undefined` if the market is unknown.\n *\n * @deprecated Merchants now manage which extensions load for each\n * market, so extensions no longer need to check this value.\n */\n market: SubscribableSignalLike;\n}" } }, "Country": { @@ -5843,7 +5843,7 @@ "src/surfaces/checkout/api/standard/standard.ts": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SessionToken", - "description": "", + "description": "Authenticates requests between your extension and your app backend. Use session tokens to verify the identity of the buyer and the shop context when making server-side API calls. The token is a signed JWT that contains claims such as the customer ID, shop domain, and expiration.\n\nThe `sub` claim in the decoded token is present only when the buyer is logged in and the app has permission to read customer accounts. Absent for anonymous buyers.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -5870,7 +5870,7 @@ "src/surfaces/checkout/api/standard/standard.ts": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Shop", - "description": "", + "description": "Metadata about the merchant's store, including its name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -5910,32 +5910,32 @@ "syntaxKind": "PropertySignature", "name": "storefrontUrl", "value": "string", - "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n\n> Caution: > As of version `2024-04` this value no longer has a trailing slash.", + "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.", "isOptional": true } ], - "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n *\n * > Caution:\n * > As of version `2024-04` this value no longer has a trailing slash.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom domain.\n */\n myshopifyDomain: string;\n}" + "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom domain.\n */\n myshopifyDomain: string;\n}" } }, "Storage": { "src/surfaces/checkout/api/standard/standard.ts": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Storage", - "description": "A key-value storage object for the extension.\n\nStored data is available only to this specific extension and any of its instances.\n\nThe storage backend is implemented with `localStorage` and should persist across the buyer's checkout session. However, data persistence isn't guaranteed.", + "description": "Key-value storage for a specific extension. Use storage to save preferences or cached data that should survive page reloads without requiring a backend call. Stored data is only available to this specific extension. The storage backend is implemented with `localStorage` and data persistence isn't guaranteed.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "delete", "value": "(key: string) => Promise", - "description": "Delete stored data by key." + "description": "Deletes a previously stored value by key." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "syntaxKind": "MethodSignature", "name": "read", "value": "(key: string) => Promise", - "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original primitive.\n\nReturns `null` if no stored data exists." + "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original type.\n\nReturns the stored value for the given key, or `null` when no value exists. Doesn't throw on a missing key." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -5945,7 +5945,7 @@ "description": "Write stored data for this key.\n\nThe data must be serializable to JSON." } ], - "value": "export interface Storage {\n /**\n * Read and return a stored value by key.\n *\n * The stored data is deserialized from JSON and returned as\n * its original primitive.\n *\n * Returns `null` if no stored data exists.\n */\n read(key: string): Promise;\n\n /**\n * Write stored data for this key.\n *\n * The data must be serializable to JSON.\n */\n write(key: string, data: any): Promise;\n\n /**\n * Delete stored data by key.\n */\n delete(key: string): Promise;\n}" + "value": "export interface Storage {\n /**\n * Read and return a stored value by key.\n *\n * The stored data is deserialized from JSON and returned as\n * its original type.\n *\n * Returns the stored value for the given key, or `null` when no value\n * exists. Doesn't throw on a missing key.\n */\n read(key: string): Promise;\n\n /**\n * Write stored data for this key.\n *\n * The data must be serializable to JSON.\n */\n write(key: string, data: any): Promise;\n\n /**\n * Deletes a previously stored value by key.\n */\n delete(key: string): Promise;\n}" } }, "Version": { @@ -6263,7 +6263,7 @@ "syntaxKind": "PropertySignature", "name": "number", "value": "string", - "description": "A randomly generated alpha-numeric identifier for the order, distinct from `order.id`. The value is `undefined` for orders that were created before this field was introduced. All recent orders have a number.", + "description": "A randomly generated alpha-numeric identifier for the order, distinct from `order.id`. The value is `undefined` for orders that were created before this field was introduced. All recent orders have a number.\n\nOptional. Might not be present for orders created before 2024.", "isOptional": true }, { @@ -6274,7 +6274,7 @@ "description": "" } ], - "value": "export interface OrderConfirmation {\n order: {\n /**\n * A globally unique identifier for the order. This becomes the\n * [`Order`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Order) object ID in the\n * GraphQL Admin API after the order is created.\n *\n * @example 'gid://shopify/Order/123'\n */\n id: string;\n };\n /**\n * A randomly generated alpha-numeric identifier for the order, distinct\n * from `order.id`. The value is `undefined` for orders that were created\n * before this field was introduced. All recent orders have a number.\n */\n number?: string;\n\n /**\n * Whether this is the customer's first completed order with this shop. `true` means the buyer hasn't placed an order here before. Use this to show first-purchase messaging or trigger welcome offers.\n */\n isFirstOrder: boolean;\n}" + "value": "export interface OrderConfirmation {\n order: {\n /**\n * A globally unique identifier for the order. This becomes the\n * [`Order`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Order) object ID in the\n * GraphQL Admin API after the order is created.\n *\n * @example 'gid://shopify/Order/123'\n */\n id: string;\n };\n /**\n * A randomly generated alpha-numeric identifier for the order, distinct\n * from `order.id`. The value is `undefined` for orders that were created\n * before this field was introduced. All recent orders have a number.\n *\n * Optional. Might not be present for orders created before 2024.\n */\n number?: string;\n\n /**\n * Whether this is the customer's first completed order with this shop. `true` means the buyer hasn't placed an order here before. Use this to show first-purchase messaging or trigger welcome offers.\n */\n isFirstOrder: boolean;\n}" } }, "AllowedComponents": { @@ -6423,7 +6423,7 @@ "syntaxKind": "PropertySignature", "name": "localization", "value": "Localization", - "description": "The details about the location, language, and currency of the customer. For utilities to easily format and translate content based on these details, you can use the [`i18n`](https://shopify.dev/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-i18n) object instead." + "description": "The details about the location, language, and currency of the customer. For utilities to easily format and translate content based on these details, you can use the [`i18n`](https://shopify.dev/docs/api/checkout-ui-extensions/apis/localization#properties-propertydetail-i18n) object instead." }, { "filePath": "src/surfaces/checkout/api/address-autocomplete/standard.ts", @@ -6445,7 +6445,7 @@ "syntaxKind": "PropertySignature", "name": "sessionToken", "value": "SessionToken", - "description": "The session token providing a set of claims as a signed JSON Web Token (JWT).\n\nThe token has a TTL of 5 minutes.\n\nIf the previous token expires, this value will reflect a new session token with a new signature and expiry.\n\nRefer to [session token examples](https://shopify.dev/docs/api/checkout-ui-extensions/apis/session-token) for more information." + "description": "The session token providing a set of claims as a signed JSON Web Token (JWT).\n\nThe token has a TTL of 5 minutes.\n\nIf the previous token expires, this value will reflect a new session token with a new signature and expiry.\n\nLearn more about [session tokens](/docs/apps/build/authentication-authorization/session-tokens)." }, { "filePath": "src/surfaces/checkout/api/address-autocomplete/standard.ts", @@ -6496,7 +6496,7 @@ ] } ], - "value": "export interface AddressAutocompleteStandardApi<\n Target extends\n | 'purchase.address-autocomplete.suggest'\n | 'purchase.address-autocomplete.format-suggestion',\n> {\n /**\n * The metafields requested in the\n * [`shopify.extension.toml`](https://shopify.dev/docs/api/checkout-ui-extensions/configuration)\n * file. These metafields are updated when there's a change in the merchandise items\n * being purchased by the customer.\n *\n * App owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` is not supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * > Tip:\n * > Cart metafields are only available on carts created via the Storefront API version `2023-04` or later.*\n */\n appMetafields: AppMetafieldEntry[];\n\n /**\n * The methods for interacting with [Web Pixels](https://shopify.dev/docs/apps/marketing), such as emitting an event.\n */\n analytics: Analytics;\n\n /**\n * The custom attributes left by the customer to the merchant, either in their cart or during checkout.\n */\n attributes: Attribute[] | undefined;\n\n /**\n * The proposed customer billing address. The address updates when the field is\n * committed (on change) rather than every keystroke.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n billingAddress?: MailingAddress | undefined;\n\n /**\n * A stable ID that represents the current checkout.\n *\n * This matches the `data.checkout.token` field in a [checkout-related WebPixel event](https://shopify.dev/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data)\n * and the `checkout_token` field in the [REST Admin API `Order` resource](https://shopify.dev/docs/api/admin-rest/unstable/resources/order#resource-object).\n */\n checkoutToken: CheckoutToken | undefined;\n\n /**\n * The meta information about the extension.\n */\n extension: Extension;\n\n /**\n * Utilities for translating content and formatting values according to the current\n * [`localization`](https://shopify.dev/docs/api/checkout-ui-extensions/apis/localization)\n * Type 'RunnableExtensionInstance' is not assignable to type 'ExtensionInstance'.\n *\n * Refer to [`localization` examples](https://shopify.dev/docs/api/checkout-ui-extensions/apis/localization#examples)\n * for more information.\n */\n i18n: I18n;\n\n /**\n * The details about the location, language, and currency of the customer. For utilities to easily\n * format and translate content based on these details, you can use the\n * [`i18n`](https://shopify.dev/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-i18n)\n * object instead.\n */\n localization: Localization;\n\n /**\n * The metafields that apply to the current checkout.\n *\n * Metafields are stored locally on the client and are applied to the order object after the checkout completes.\n * They are shared by all extensions running on checkout, and\n * persist for as long as the customer is working on this checkout.\n *\n * Once the order is created, you can query these metafields using the\n * [GraphQL Admin API](https://shopify.dev/docs/admin-api/graphql/reference/orders/order#metafield-2021-01)\n *\n * > Caution:\n * `metafields` is deprecated. Use `appMetafields` with cart metafields instead.\n *\n * @deprecated Use `appMetafields` with cart metafields instead.\n */\n metafields: Metafield[];\n\n /**\n * The method used to query the Storefront GraphQL API with a prefetched token.\n *\n * Refer to [Storefront API access examples](https://shopify.dev/docs/api/checkout-ui-extensions/apis/storefront-api) for more information.\n */\n query: >(\n query: string,\n options?: {variables?: Variables; version?: StorefrontApiVersion},\n ) => Promise<{data?: Data; errors?: GraphQLError[]}>;\n\n /**\n * The session token providing a set of claims as a signed JSON Web Token (JWT).\n *\n * The token has a TTL of 5 minutes.\n *\n * If the previous token expires, this value will reflect a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](https://shopify.dev/docs/api/checkout-ui-extensions/apis/session-token) for more information.\n */\n sessionToken: SessionToken;\n\n /**\n * The settings matching the settings definition written in the\n * [`shopify.extension.toml`](https://shopify.dev/docs/api/checkout-ui-extensions/configuration) file.\n *\n * Refer to [settings examples](https://shopify.dev/docs/api/checkout-ui-extensions/apis/settings#examples) for more information.\n *\n * > Note: The settings are empty when an extension is being installed in the [checkout editor](https://help.shopify.com/en/manual/checkout-settings/checkout-extensibility/checkout-editor).\n\n */\n settings: ExtensionSettings;\n\n /**\n * The proposed customer shipping address. During the information step,\n * the address updates when the field is committed (on change) rather than every keystroke.\n *\n * > Note: An address value is only present if delivery is required. Otherwise, the subscribable value is undefined.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n shippingAddress?: MailingAddress | undefined;\n\n /** The shop where the checkout is taking place. */\n shop: Shop;\n\n /**\n * The key-value storage for the extension.\n *\n * It uses `localStorage` and should persist across the customer's current checkout session.\n *\n * > Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n *\n * Data is shared across all activated extension targets of this extension. In versions 2023-07 and earlier,\n * each activated extension target had its own storage.\n */\n storage: Storage;\n\n /**\n * The runner version being used for the extension.\n *\n * @example 'unstable'\n */\n version: Version;\n}" + "value": "export interface AddressAutocompleteStandardApi<\n Target extends\n | 'purchase.address-autocomplete.suggest'\n | 'purchase.address-autocomplete.format-suggestion',\n> {\n /**\n * The metafields requested in the\n * [`shopify.extension.toml`](https://shopify.dev/docs/api/checkout-ui-extensions/configuration)\n * file. These metafields are updated when there's a change in the merchandise items\n * being purchased by the customer.\n *\n * App owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` is not supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * > Tip:\n * > Cart metafields are only available on carts created via the Storefront API version `2023-04` or later.*\n */\n appMetafields: AppMetafieldEntry[];\n\n /**\n * The methods for interacting with [Web Pixels](https://shopify.dev/docs/apps/marketing), such as emitting an event.\n */\n analytics: Analytics;\n\n /**\n * The custom attributes left by the customer to the merchant, either in their cart or during checkout.\n */\n attributes: Attribute[] | undefined;\n\n /**\n * The proposed customer billing address. The address updates when the field is\n * committed (on change) rather than every keystroke.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n billingAddress?: MailingAddress | undefined;\n\n /**\n * A stable ID that represents the current checkout.\n *\n * This matches the `data.checkout.token` field in a [checkout-related WebPixel event](https://shopify.dev/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data)\n * and the `checkout_token` field in the [REST Admin API `Order` resource](https://shopify.dev/docs/api/admin-rest/unstable/resources/order#resource-object).\n */\n checkoutToken: CheckoutToken | undefined;\n\n /**\n * The meta information about the extension.\n */\n extension: Extension;\n\n /**\n * Utilities for translating content and formatting values according to the current\n * [`localization`](https://shopify.dev/docs/api/checkout-ui-extensions/apis/localization)\n * Type 'RunnableExtensionInstance' is not assignable to type 'ExtensionInstance'.\n *\n * Refer to [`localization` examples](https://shopify.dev/docs/api/checkout-ui-extensions/apis/localization#examples)\n * for more information.\n */\n i18n: I18n;\n\n /**\n * The details about the location, language, and currency of the customer. For utilities to easily\n * format and translate content based on these details, you can use the\n * [`i18n`](https://shopify.dev/docs/api/checkout-ui-extensions/apis/localization#properties-propertydetail-i18n)\n * object instead.\n */\n localization: Localization;\n\n /**\n * The metafields that apply to the current checkout.\n *\n * Metafields are stored locally on the client and are applied to the order object after the checkout completes.\n * They are shared by all extensions running on checkout, and\n * persist for as long as the customer is working on this checkout.\n *\n * Once the order is created, you can query these metafields using the\n * [GraphQL Admin API](https://shopify.dev/docs/admin-api/graphql/reference/orders/order#metafield-2021-01)\n *\n * > Caution:\n * `metafields` is deprecated. Use `appMetafields` with cart metafields instead.\n *\n * @deprecated Use `appMetafields` with cart metafields instead.\n */\n metafields: Metafield[];\n\n /**\n * The method used to query the Storefront GraphQL API with a prefetched token.\n *\n * Refer to [Storefront API access examples](https://shopify.dev/docs/api/checkout-ui-extensions/apis/storefront-api) for more information.\n */\n query: >(\n query: string,\n options?: {variables?: Variables; version?: StorefrontApiVersion},\n ) => Promise<{data?: Data; errors?: GraphQLError[]}>;\n\n /**\n * The session token providing a set of claims as a signed JSON Web Token (JWT).\n *\n * The token has a TTL of 5 minutes.\n *\n * If the previous token expires, this value will reflect a new session token with a new signature and expiry.\n *\n * Learn more about [session tokens](/docs/apps/build/authentication-authorization/session-tokens).\n */\n sessionToken: SessionToken;\n\n /**\n * The settings matching the settings definition written in the\n * [`shopify.extension.toml`](https://shopify.dev/docs/api/checkout-ui-extensions/configuration) file.\n *\n * Refer to [settings examples](https://shopify.dev/docs/api/checkout-ui-extensions/apis/settings#examples) for more information.\n *\n * > Note: The settings are empty when an extension is being installed in the [checkout editor](https://help.shopify.com/en/manual/checkout-settings/checkout-extensibility/checkout-editor).\n\n */\n settings: ExtensionSettings;\n\n /**\n * The proposed customer shipping address. During the information step,\n * the address updates when the field is committed (on change) rather than every keystroke.\n *\n * > Note: An address value is only present if delivery is required. Otherwise, the subscribable value is undefined.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n shippingAddress?: MailingAddress | undefined;\n\n /** The shop where the checkout is taking place. */\n shop: Shop;\n\n /**\n * The key-value storage for the extension.\n *\n * It uses `localStorage` and should persist across the customer's current checkout session.\n *\n * > Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n *\n * Data is shared across all activated extension targets of this extension. In versions 2023-07 and earlier,\n * each activated extension target had its own storage.\n */\n storage: Storage;\n\n /**\n * The runner version being used for the extension.\n *\n * @example 'unstable'\n */\n version: Version;\n}" } }, "AddressAutocompleteFormatSuggestionApi": { @@ -6878,10 +6878,10 @@ "syntaxKind": "PropertySignature", "name": "suggestions", "value": "AddressAutocompleteSuggestion[]", - "description": "An array of address autocomplete suggestions to show to the buyer.\n\n> Note: Only the first five suggestions will be displayed to the buyer." + "description": "An array of address autocomplete suggestions to show to the buyer. Checkout displays up to five address suggestions. Return no more than five. Additional suggestions are ignored." } ], - "value": "export interface AddressAutocompleteSuggestOutput {\n /**\n * An array of address autocomplete suggestions to show to the buyer.\n *\n * > Note: Only the first five suggestions will be displayed to the buyer.\n */\n suggestions: AddressAutocompleteSuggestion[];\n}" + "value": "export interface AddressAutocompleteSuggestOutput {\n /**\n * An array of address autocomplete suggestions to show to the buyer.\n * Checkout displays up to five address suggestions. Return no more\n * than five. Additional suggestions are ignored.\n */\n suggestions: AddressAutocompleteSuggestion[];\n}" } }, "ExtensionTargets": { @@ -7674,6 +7674,143 @@ "value": "export interface ShopifyGlobal {\n extend(\n target: ExtensionTarget,\n extend: () => ExtensionTargets[ExtensionTarget]['output'],\n ): void;\n reload(): void;\n}" } }, + "Navigation": { + "src/surfaces/customer-account/api/standard-api/standard-api.ts": { + "filePath": "src/surfaces/customer-account/api/standard-api/standard-api.ts", + "name": "Navigation", + "description": "Navigates between pages in customer accounts, including other extensions and host pages. Full-page extensions also get access to the current navigation entry and history state.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/customer-account/api/standard-api/standard-api.ts", + "syntaxKind": "MethodSignature", + "name": "addEventListener", + "value": "(type: \"currententrychange\", cb: (event: NavigationCurrentEntryChangeEvent) => void) => void", + "description": "Registers a listener that fires whenever the current navigation entry changes, such as when the buyer navigates to a different page." + }, + { + "filePath": "src/surfaces/customer-account/api/standard-api/standard-api.ts", + "syntaxKind": "PropertySignature", + "name": "currentEntry", + "value": "NavigationHistoryEntry", + "description": "The current navigation history entry, representing the page the buyer is viewing. Only available in full-page extensions." + }, + { + "filePath": "src/surfaces/customer-account/api/standard-api/standard-api.ts", + "syntaxKind": "PropertySignature", + "name": "navigate", + "value": "NavigateFunction", + "description": "Navigates to a URL, updating any provided state in the history entries list. Supports [custom protocols](/docs/api/customer-account-ui-extensions/{API_VERSION}#custom-protocols) for navigating within customer accounts." + }, + { + "filePath": "src/surfaces/customer-account/api/standard-api/standard-api.ts", + "syntaxKind": "MethodSignature", + "name": "removeEventListener", + "value": "(type: \"currententrychange\", cb: (event: NavigationCurrentEntryChangeEvent) => void) => void", + "description": "Removes a previously registered `currententrychange` listener." + }, + { + "filePath": "src/surfaces/customer-account/api/standard-api/standard-api.ts", + "syntaxKind": "MethodSignature", + "name": "updateCurrentEntry", + "value": "(options: NavigationUpdateCurrentEntryOptions) => void", + "description": "Updates the state of the current history entry without triggering a navigation. Use this when the state change is independent of a page transition, such as saving form progress." + } + ], + "value": "export interface Navigation {\n /**\n * Navigates to a URL, updating any provided state in the history entries list. Supports [custom protocols](/docs/api/customer-account-ui-extensions/{API_VERSION}#custom-protocols) for navigating within customer accounts.\n */\n navigate: NavigateFunction;\n /**\n * The current navigation history entry, representing the page the buyer is viewing. Only available in full-page extensions.\n */\n currentEntry: NavigationHistoryEntry;\n /**\n * Updates the state of the current history entry without triggering a navigation. Use this when the state change is independent of a page transition, such as saving form progress.\n */\n updateCurrentEntry(options: NavigationUpdateCurrentEntryOptions): void;\n /**\n * Registers a listener that fires whenever the current navigation entry changes, such as when the buyer navigates to a different page.\n */\n addEventListener(\n type: 'currententrychange',\n cb: (event: NavigationCurrentEntryChangeEvent) => void,\n ): void;\n /**\n * Removes a previously registered `currententrychange` listener.\n */\n removeEventListener(\n type: 'currententrychange',\n cb: (event: NavigationCurrentEntryChangeEvent) => void,\n ): void;\n}" + } + }, + "NavigationCurrentEntryChangeEvent": { + "src/surfaces/customer-account/api/standard-api/standard-api.ts": { + "filePath": "src/surfaces/customer-account/api/standard-api/standard-api.ts", + "name": "NavigationCurrentEntryChangeEvent", + "description": "The event object passed to `currententrychange` listeners when the current navigation entry changes.", + "members": [ + { + "filePath": "src/surfaces/customer-account/api/standard-api/standard-api.ts", + "syntaxKind": "PropertySignature", + "name": "from", + "value": "NavigationHistoryEntry", + "description": "The history entry the buyer navigated away from." + }, + { + "filePath": "src/surfaces/customer-account/api/standard-api/standard-api.ts", + "syntaxKind": "PropertySignature", + "name": "navigationType", + "value": "NavigationTypeString", + "description": "The type of navigation that caused the change: `'push'`, `'replace'`, or `'traverse'`.", + "isOptional": true + } + ], + "value": "export interface NavigationCurrentEntryChangeEvent {\n /**\n * The type of navigation that caused the change: `'push'`, `'replace'`, or `'traverse'`.\n */\n navigationType?: NavigationTypeString;\n /**\n * The history entry the buyer navigated away from.\n */\n from: NavigationHistoryEntry;\n}" + } + }, + "NavigationHistoryEntry": { + "src/surfaces/customer-account/api/standard-api/standard-api.ts": { + "filePath": "src/surfaces/customer-account/api/standard-api/standard-api.ts", + "name": "NavigationHistoryEntry", + "description": "A single entry in the navigation history stack. Each entry has a unique key, a URL, and optional developer-defined state.", + "members": [ + { + "filePath": "src/surfaces/customer-account/api/standard-api/standard-api.ts", + "syntaxKind": "MethodSignature", + "name": "getState", + "value": "() => unknown", + "description": "Returns a clone of the developer-defined state associated with this history entry." + }, + { + "filePath": "src/surfaces/customer-account/api/standard-api/standard-api.ts", + "syntaxKind": "PropertySignature", + "name": "key", + "value": "string", + "description": "A unique, platform-generated identifier for this entry's position in the history stack. This value identifies the slot, not the content." + }, + { + "filePath": "src/surfaces/customer-account/api/standard-api/standard-api.ts", + "syntaxKind": "PropertySignature", + "name": "url", + "value": "string | null", + "description": "The URL associated with this history entry, or `null` if unavailable." + } + ], + "value": "export interface NavigationHistoryEntry {\n /**\n * A unique, platform-generated identifier for this entry's position in the history stack. This value identifies the slot, not the content.\n */\n key: string;\n /**\n * The URL associated with this history entry, or `null` if unavailable.\n */\n url: string | null;\n /**\n * Returns a clone of the developer-defined state associated with this history entry.\n */\n getState(): unknown;\n}" + } + }, + "NavigationTypeString": { + "src/surfaces/customer-account/api/standard-api/standard-api.ts": { + "filePath": "src/surfaces/customer-account/api/standard-api/standard-api.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "NavigationTypeString", + "value": "'push' | 'replace' | 'traverse'", + "description": "An enumerated value representing the type of navigation." + } + }, + "NavigateFunction": { + "src/surfaces/customer-account/api/standard-api/standard-api.ts": { + "filePath": "src/surfaces/customer-account/api/standard-api/standard-api.ts", + "name": "NavigateFunction", + "description": "A callable function that navigates to a URL within customer accounts. Accepts a destination URL and optional navigation options.", + "members": [], + "value": "export interface NavigateFunction {\n /**\n * Navigates to a specific URL, updating any provided state in the history entries list.\n * @param url The destination URL to navigate to.\n */\n (url: string, options?: NavigationNavigateOptions): void;\n}" + } + }, + "NavigationUpdateCurrentEntryOptions": { + "src/surfaces/customer-account/api/standard-api/standard-api.ts": { + "filePath": "src/surfaces/customer-account/api/standard-api/standard-api.ts", + "name": "NavigationUpdateCurrentEntryOptions", + "description": "Options for `Navigation.updateCurrentEntry()`. Use this to update the state of the current history entry without triggering a navigation.", + "members": [ + { + "filePath": "src/surfaces/customer-account/api/standard-api/standard-api.ts", + "syntaxKind": "PropertySignature", + "name": "state", + "value": "unknown", + "description": "Developer-defined state to associate with the current navigation history entry." + } + ], + "value": "export interface NavigationUpdateCurrentEntryOptions {\n /**\n * Developer-defined state to associate with the current navigation history entry.\n */\n state: unknown;\n}" + } + }, "BaseElementProps": { "src/surfaces/customer-account/components/shared.ts": { "filePath": "src/surfaces/customer-account/components/shared.ts", @@ -7780,7 +7917,7 @@ "syntaxKind": "PropertySignature", "name": "initials", "value": "string", - "description": "The initials to display in the avatar when no image is provided or fails to load. Typically one or two characters representing a person's first and last name initials, such as \"JD\" for John Doe.", + "description": "The initials to display in the avatar when no image is provided or fails to load. Typically one or two characters representing a person's first and last name initials, such as \"JD\" for John Doe.\n\nCharacters beyond the first two might be truncated. Special characters, emojis, and non-Latin scripts might not render as expected.", "isOptional": true }, { @@ -7886,7 +8023,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/customer-account/components.ts", @@ -9901,7 +10038,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/customer-account/components.ts", @@ -10236,7 +10373,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/customer-account/components.ts", @@ -12244,7 +12381,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/customer-account/components.ts", @@ -12567,7 +12704,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/customer-account/components.ts", @@ -14583,7 +14720,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/customer-account/components.ts", @@ -14856,11 +14993,7 @@ "syntaxKind": "PropertySignature", "name": "breadcrumb-actions", "value": "HTMLElement", -<<<<<<< HEAD - "description": "The breadcrumb actions for the page. Accepts a single button element with restricted properties (see below).", -======= "description": "A navigation link that lets the customer return to the previous page. Accepts a single [button](/docs/api/{API_NAME}/{API_VERSION}/web-components/actions/button) component. Learn more about [breadcrumb actions](#breadcrumb-actions).", ->>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) "isOptional": true }, { @@ -14868,11 +15001,7 @@ "syntaxKind": "PropertySignature", "name": "primary-action", "value": "HTMLElement", -<<<<<<< HEAD - "description": "The primary action for the modal. Accepts a single [button](/docs/api/customer-account-ui-extensions/{API_VERSION}/web-components/actions/button) element. Use this for the main confirmation action, such as \"Submit\" or \"Confirm.\"", -======= "description": "The main call-to-action for the page. Accepts a single [button](/docs/api/{API_NAME}/{API_VERSION}/web-components/actions/button) component. Learn more about [primary actions](#primary-actions).", ->>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) "isOptional": true }, { @@ -14880,11 +15009,7 @@ "syntaxKind": "PropertySignature", "name": "secondary-actions", "value": "HTMLElement", -<<<<<<< HEAD - "description": "The secondary actions for the modal. Accepts multiple [button](/docs/api/customer-account-ui-extensions/{API_VERSION}/web-components/actions/button) elements. Use this for dismissive actions like \"Cancel\" or alternative actions.", -======= "description": "Additional actions for the page. Accepts one or more [button](/docs/api/{API_NAME}/{API_VERSION}/web-components/actions/button) components. Learn more about [secondary actions](#secondary-actions).", ->>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) "isOptional": true } ] @@ -14928,7 +15053,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/customer-account/components.ts", @@ -15848,7 +15973,7 @@ "syntaxKind": "PropertySignature", "name": "initials", "value": "string", - "description": "The initials to display in the avatar when no image is provided or fails to load. Typically one or two characters representing a person's first and last name initials, such as \"JD\" for John Doe.", + "description": "The initials to display in the avatar when no image is provided or fails to load. Typically one or two characters representing a person's first and last name initials, such as \"JD\" for John Doe.\n\nCharacters beyond the first two might be truncated. Special characters, emojis, and non-Latin scripts might not render as expected.", "isOptional": true }, { @@ -16953,7 +17078,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/customer-account/components.ts", @@ -17227,11 +17352,7 @@ "syntaxKind": "TypeAliasDeclaration", "name": "AvatarEventsDocs", "value": "AvatarEvents", -<<<<<<< HEAD "description": "The avatar component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", -======= - "description": "", ->>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) "isPublicDocs": true, "members": [ { @@ -17317,7 +17438,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/customer-account/components.ts", @@ -19326,7 +19447,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/customer-account/components.ts", @@ -19641,7 +19762,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/customer-account/components.ts", @@ -21650,7 +21771,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/customer-account/components.ts", @@ -21943,11 +22064,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityLabel", "value": "string", -<<<<<<< HEAD - "description": "A label used to describe the section that will be announced by assistive technologies.\n\nWhen no `heading` property is provided or included as a child of the section, you **must** provide an `accessibilityLabel` to describe the section. This is important as it allows assistive technologies to provide the right context to users.", -======= "description": "A label announced by assistive technologies that describes the purpose or contents of the element. Only set this when the element's visible content doesn't provide enough context on its own.", ->>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) "isOptional": true }, { @@ -21955,7 +22072,7 @@ "syntaxKind": "PropertySignature", "name": "heading", "value": "string", - "description": "A title displayed at the top of the section. When provided, it serves as both a visible heading and the accessible name for the section. If omitted, you must provide an `accessibilityLabel` instead.", + "description": "A title that describes the content of the section.", "isOptional": true }, { @@ -21983,11 +22100,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityLabel", "value": "string", -<<<<<<< HEAD - "description": "A label used to describe the section that will be announced by assistive technologies.\n\nWhen no `heading` property is provided or included as a child of the section, you **must** provide an `accessibilityLabel` to describe the section. This is important as it allows assistive technologies to provide the right context to users.", -======= "description": "A label announced by assistive technologies that describes the purpose or contents of the element. Only set this when the element's visible content doesn't provide enough context on its own.", ->>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) "isOptional": true }, { @@ -22009,7 +22122,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/customer-account/components.ts", @@ -22892,7 +23005,7 @@ "syntaxKind": "PropertySignature", "name": "heading", "value": "string", - "description": "A title displayed at the top of the section. When provided, it serves as both a visible heading and the accessible name for the section. If omitted, you must provide an `accessibilityLabel` instead.", + "description": "A title that describes the content of the section.", "isOptional": true }, { @@ -24026,7 +24139,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/customer-account/components.ts", @@ -24291,11 +24404,7 @@ "syntaxKind": "PropertySignature", "name": "primary-action", "value": "HTMLElement", -<<<<<<< HEAD - "description": "The primary action for the section. Accepts a single [button](/docs/api/customer-account-ui-extensions/{API_VERSION}/web-components/actions/button) element. Use this for the main action related to the section's content, such as \"Edit\" or \"Manage.\"", -======= "description": "The main call-to-action for the section. Accepts a single [button](/docs/api/{API_NAME}/{API_VERSION}/web-components/actions/button) component.", ->>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) "isOptional": true }, { @@ -24303,25 +24412,13 @@ "syntaxKind": "PropertySignature", "name": "secondary-actions", "value": "HTMLElement", -<<<<<<< HEAD - "description": "The secondary actions for the section. Accepts multiple [button](/docs/api/customer-account-ui-extensions/{API_VERSION}/web-components/actions/button) elements. Use this for supplementary actions like \"Remove\" or \"View details.\"", -======= "description": "Additional actions for the section. Accepts one or more [button](/docs/api/{API_NAME}/{API_VERSION}/web-components/actions/button) components.", ->>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) "isOptional": true } ] } }, "CallbackEvent": { - "src/surfaces/checkout/components/Button.ts": { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CallbackEvent", - "value": "TEvent & {\n currentTarget: HTMLElementTagNameMap[TTagName];\n}", - "description": "An event type that narrows the `currentTarget` to the specific HTML element associated with the custom element tag. This provides type-safe event handling in callback listeners.", - "isPublicDocs": true - }, "src/surfaces/customer-account/api/docs.ts": { "filePath": "src/surfaces/customer-account/api/docs.ts", "syntaxKind": "TypeAliasDeclaration", @@ -24331,14 +24428,6 @@ } }, "CallbackEventListener": { - "src/surfaces/checkout/components/Button.ts": { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "CallbackEventListener", - "value": "(EventListener & {\n (event: CallbackEvent & TData): void;\n}) | null", - "description": "A typed event listener for custom element events. The listener receives a `CallbackEvent` with the correct `currentTarget` type for the associated custom element tag.", - "isPublicDocs": true - }, "src/surfaces/customer-account/api/docs.ts": { "filePath": "src/surfaces/customer-account/api/docs.ts", "syntaxKind": "TypeAliasDeclaration", @@ -24347,57 +24436,64 @@ "description": "A typed event listener for custom element events. The listener receives a `CallbackEvent` with the correct `currentTarget` type for the associated custom element tag." } }, - "ButtonElementProps": { - "src/surfaces/checkout/components/Button.ts": { - "filePath": "src/surfaces/checkout/components/Button.ts", - "name": "ButtonElementProps", - "description": "Properties for the button component element.", - "isPublicDocs": true, + "ButtonProps": { + "src/surfaces/customer-account/api/docs.ts": { + "filePath": "src/surfaces/customer-account/api/docs.ts", + "name": "ButtonProps", + "description": "", "members": [ { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/docs.ts", "syntaxKind": "PropertySignature", "name": "accessibilityLabel", "value": "string", - "description": "A label that describes the purpose or content of the button for users of assistive technologies such as screen readers. Use this when the visible content alone doesn't provide enough context.", + "description": "A label that describes the purpose or contents of the Button. It will be read to users using assistive technologies such as screen readers.\n\nUse this when using only an icon or the button text is not enough context for users using assistive technologies.", "isOptional": true }, { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/docs.ts", + "syntaxKind": "PropertySignature", + "name": "click", + "value": "((event: CallbackEventListener) => void) | null", + "description": "Callback when the button is activated. This will be called before the action indicated by `type`.", + "isOptional": true + }, + { + "filePath": "src/surfaces/customer-account/api/docs.ts", "syntaxKind": "PropertySignature", "name": "command", "value": "'--auto' | '--show' | '--hide' | '--toggle' | '--copy'", - "description": "Sets the action the `commandFor` should take when this clickable is activated.\n\nSee the documentation of particular components for the actions they support.\n\n- `--auto`: Performs the default action for the target component.\n- `--show`: Displays the target component.\n- `--hide`: Conceals the target component.\n- `--toggle`: Alternates the target component.\n- `--copy`: Copies the target ClipboardItem.", + "description": "Sets the action the `commandFor` target should take when this component is activated.\n\n- `--auto`: A default action for the target component.\n- `--show`: Shows the target component.\n- `--hide`: Hides the target component.\n- `--toggle`: Toggles the target component.\n- `--copy`: Copies the target clipboard item.\n\nLearn more about the [`command` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).", "isOptional": true, "defaultValue": "'--auto'" }, { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/docs.ts", "syntaxKind": "PropertySignature", "name": "commandFor", "value": "string", - "description": "ID of a component that should respond to activations (such as clicks) on this component.\n\nSee `command` for how to control the behavior of the target.", + "description": "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).", "isOptional": true }, { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/docs.ts", "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Whether the button is disabled, preventing it from being clicked or receiving focus.", + "description": "Disables the button, disallowing any interaction.", "isOptional": true, "defaultValue": "false" }, { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/docs.ts", "syntaxKind": "PropertySignature", "name": "href", "value": "string", - "description": "The URL to navigate to when clicked. The `click` event fires first, then navigation occurs.\n\n- If set, it will navigate to the location specified by `href` after executing the `click` event.\n- If a `commandFor` is set, the `command` will be executed instead of the navigation.", + "description": "The URL to link to.\n\n- If set, it will navigate to the location specified by `href` after executing the `onClick` callback.\n- If a `commandFor` is set, the `command` will be executed instead of the navigation.", "isOptional": true }, { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/docs.ts", "syntaxKind": "PropertySignature", "name": "id", "value": "string", @@ -24405,28502 +24501,774 @@ "isOptional": true }, { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "inlineSize", - "value": "'auto' | 'fill' | 'fit-content'", - "description": "The inline width of the button component.\n\n- `auto`: The size depends on the surface and context.\n- `fill`: The button takes up 100% of the available inline size.\n- `fit-content`: The button takes up the minimum inline-size required to fit its content.", - "isOptional": true, - "defaultValue": "'auto'" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "interestFor", - "value": "string", - "description": "The ID of the component to show when users hover over or focus on this component. Pair with a target component that supports interest-based interactions. Learn more about the [interestFor attribute](https://open-ui.org/components/interest-invokers.explainer/#the-pitch-in-code).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/docs.ts", "syntaxKind": "PropertySignature", "name": "loading", "value": "boolean", - "description": "Whether the button is in a loading state, which replaces the button content with a loading indicator while a background action is being performed.\n\nThis also disables the button.", + "description": "Replaces content with a loading indicator.", "isOptional": true, "defaultValue": "false" }, { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/docs.ts", "syntaxKind": "PropertySignature", "name": "target", - "value": "'auto' | '_blank'", + "value": "'auto' | '_self' | '_blank'", "description": "Specifies where to display the linked URL.", "isOptional": true, "defaultValue": "'auto'" }, { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/docs.ts", "syntaxKind": "PropertySignature", "name": "tone", "value": "'auto' | 'neutral' | 'critical'", - "description": "The semantic meaning and color treatment of the button.\n\n- `'auto'`: Automatically determined based on context.\n- `'neutral'`: General information without specific intent.\n- `'critical'`: Urgent problems or destructive actions.", + "description": "Sets the tone of the Button, based on the intention of the information being conveyed.", "isOptional": true, "defaultValue": "'auto'" }, { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/docs.ts", "syntaxKind": "PropertySignature", "name": "type", - "value": "'submit' | 'button'", - "description": "The behavioral type of the button component, which determines what action it performs when activated.\n\n- `submit`: Submits the closest form.\n- `button`: Performs no default action when activated.\n- `reset`: Resets the closest form (returning fields to their default values).\n\nThis property is ignored if the component supports `href` or `commandFor`/`command` and one of them is set.", + "value": "'button' | 'submit'", + "description": "The behavior of the button.\n\n- `'submit'`: Submits the nearest containing form.\n- `'button'`: Performs no default action, relying on the `click` event handler for behavior.\n\nThis property is ignored if the component supports `href` or `commandFor`/`command` and one of them is set.", "isOptional": true, "defaultValue": "'button'" }, { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/docs.ts", "syntaxKind": "PropertySignature", "name": "variant", "value": "'auto' | 'primary' | 'secondary'", - "description": "The visual style variant of the button component, which controls its prominence and emphasis.\n\n- `'auto'`: Automatically determined by the button's context.\n- `'primary'`: High-emphasis style for the main action.\n- `'secondary'`: Medium-emphasis style for supporting actions.\n- `'tertiary'`: Low-emphasis style for less prominent actions.", + "description": "Changes the visual appearance of the Button.", "isOptional": true, - "defaultValue": "'auto'" + "defaultValue": "'auto' - the variant is automatically determined by the Button's context" } ], - "value": "export interface ButtonElementProps extends Pick {\n target?: Extract;\n tone?: Extract;\n type?: Extract;\n variant?: Extract;\n}" + "value": "interface ButtonProps {\n /**\n * A label that describes the purpose or contents of the Button. It will be read to users using assistive technologies such as screen readers.\n *\n * Use this when using only an icon or the button text is not enough context\n * for users using assistive technologies.\n */\n accessibilityLabel?: string;\n /**\n * 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).\n */\n commandFor?: string;\n /**\n * Sets the action the `commandFor` target should take when this component is activated.\n *\n * - `--auto`: A default action for the target component.\n * - `--show`: Shows the target component.\n * - `--hide`: Hides the target component.\n * - `--toggle`: Toggles the target component.\n * - `--copy`: Copies the target clipboard item.\n *\n * Learn more about the [`command` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).\n *\n * @default '--auto'\n */\n command?: '--auto' | '--show' | '--hide' | '--toggle' | '--copy';\n /**\n * Disables the button, disallowing any interaction.\n *\n * @defaultValue false\n */\n disabled?: boolean;\n /**\n * The URL to link to.\n *\n * - If set, it will navigate to the location specified by `href` after executing the `onClick` callback.\n * - If a `commandFor` is set, the `command` will be executed instead of the navigation.\n */\n href?: string;\n /**\n * A unique identifier for the element.\n */\n id?: string;\n /**\n * Replaces content with a loading indicator.\n *\n * @defaultValue false\n */\n loading?: boolean;\n /**\n * Specifies where to display the linked URL.\n * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#target\n *\n * 'auto' - The target is automatically determined based on the origin of the URL. Surfaces can set specific rules on how they handle each URL.\n * It’s expected that the behavior of `auto` is as `_self` except in specific cases.\n * For example, a surface could decide to open cross-origin URLs in a new window (as `_blank`).\n *\n * @default 'auto'\n */\n target?: 'auto' | '_self' | '_blank';\n /**\n * Sets the tone of the Button, based on the intention of the information being conveyed.\n *\n * @default 'auto'\n */\n tone?: 'auto' | 'neutral' | 'critical';\n /**\n * The behavior of the button.\n *\n * - `'submit'`: Submits the nearest containing form.\n * - `'button'`: Performs no default action, relying on the `click` event handler for behavior.\n *\n * This property is ignored if the component supports `href` or `commandFor`/`command` and one of them is set.\n *\n * @default 'button'\n */\n type?: 'button' | 'submit';\n /**\n * Changes the visual appearance of the Button.\n *\n * @default 'auto' - the variant is automatically determined by the Button's context\n */\n variant?: 'auto' | 'primary' | 'secondary';\n\n /**\n * Callback when the button is activated.\n * This will be called before the action indicated by `type`.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event\n */\n click?: ((event: CallbackEventListener) => void) | null;\n}" } }, - "ButtonEvents": { - "src/surfaces/checkout/components/Button.ts": { - "filePath": "src/surfaces/checkout/components/Button.ts", - "name": "ButtonEvents", + "Docs_OrderStatus_MetafieldsApi": { + "src/surfaces/customer-account/api/docs.ts": { + "filePath": "src/surfaces/customer-account/api/docs.ts", + "name": "Docs_OrderStatus_MetafieldsApi", "description": "", "isPublicDocs": true, "members": [ { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/docs.ts", "syntaxKind": "PropertySignature", - "name": "onClick", - "value": "(event: Event) => void", - "description": "A callback fired when the button is activated, before performing the action indicated by `type`. Learn more about the [click event](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event).", - "isOptional": true + "name": "appMetafields", + "value": "SubscribableSignalLike", + "description": "The [metafields](/docs/apps/build/custom-data/metafields) requested in the [`shopify.extension.toml`](/docs/apps/build/customer-accounts/metafields#create-the-metafield-definition) file. Metafields are custom data fields that store additional information on Shopify resources such as products, variants, customers, and the shop. These metafields are updated when there's a change in the merchandise items being purchased by the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when accessing metafields attached to `customer`, `company`, or `companyLocation` resources." + }, + { + "filePath": "src/surfaces/customer-account/api/docs.ts", + "syntaxKind": "PropertySignature", + "name": "metafields", + "value": "SubscribableSignalLike", + "description": "The [metafields](/docs/apps/build/custom-data/metafields) associated with the order. These metafields are shared across all extensions and persist throughout the checkout session.", + "deprecationMessage": "Use `appMetafields` instead, which provides richer data including the resource type and metafield content type." } ], - "value": "export interface ButtonEvents extends Pick {\n}" + "value": "export interface Docs_OrderStatus_MetafieldsApi\n extends Pick, 'appMetafields' | 'metafields'> {}" } }, - "ButtonElementEvents": { - "src/surfaces/checkout/components/Button.ts": { - "filePath": "src/surfaces/checkout/components/Button.ts", - "name": "ButtonElementEvents", - "description": "The button component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", + "Docs_OrderStatus_AttributesApi": { + "src/surfaces/customer-account/api/docs.ts": { + "filePath": "src/surfaces/customer-account/api/docs.ts", + "name": "Docs_OrderStatus_AttributesApi", + "description": "", "isPublicDocs": true, "members": [ { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/docs.ts", "syntaxKind": "PropertySignature", - "name": "click", - "value": "CallbackEventListener", - "description": "A callback fired when the button is clicked. This will be called before the action indicated by `type`.\n\nLearn more about the [click event](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event).", - "isOptional": true + "name": "attributes", + "value": "SubscribableSignalLike", + "description": "The custom key-value pairs attached to the order by the customer or by other extensions during cart or checkout. These are commonly used for delivery instructions, gift messages, or other information the buyer provides. The value is `undefined` if no attributes were set." } ], - "value": "export interface ButtonElementEvents {\n /**\n * A callback fired when the button is clicked. This will be called before the action indicated by `type`.\n *\n * Learn more about the [click event](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event).\n */\n click?: CallbackEventListener;\n}" + "value": "export interface Docs_OrderStatus_AttributesApi\n extends Pick, 'attributes'> {}" } }, - "ButtonElement": { - "src/surfaces/checkout/components/Button.ts": { - "filePath": "src/surfaces/checkout/components/Button.ts", - "name": "ButtonElement", + "Docs_OrderStatus_BuyerIdentityApi": { + "src/surfaces/customer-account/api/docs.ts": { + "filePath": "src/surfaces/customer-account/api/docs.ts", + "name": "Docs_OrderStatus_BuyerIdentityApi", "description": "", "isPublicDocs": true, "members": [ { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/docs.ts", "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "A label that describes the purpose or content of the button for users of assistive technologies such as screen readers. Use this when the visible content alone doesn't provide enough context.", + "name": "buyerIdentity", + "value": "OrderStatusBuyerIdentity", + "description": "The buyer who placed the order, including their customer account, email, phone number, and B2B purchasing company. Use this to personalize the **Order status** page or identify B2B orders.\n\nReflects the customer account at the time the order was placed. Doesn't update if account details change afterward.", "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "accessKey", - "value": "string", - "description": "The **`HTMLElement.accessKey`** property sets the keystroke which a user can press to jump to a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKey)" - }, + } + ], + "value": "export interface Docs_OrderStatus_BuyerIdentityApi\n extends Pick, 'buyerIdentity'> {}" + } + }, + "OrderStatusBuyerIdentity": { + "src/surfaces/customer-account/api/order-status/order-status.ts": { + "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", + "name": "OrderStatusBuyerIdentity", + "description": "Information about the buyer who placed the order.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data). The `customer` and `purchasingCompany` properties require level 1 access. The `email` and `phone` properties require level 2 access.", + "members": [ { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", "syntaxKind": "PropertySignature", - "name": "accessKeyLabel", - "value": "string", - "description": "The **`HTMLElement.accessKeyLabel`** read-only property returns a string containing the element's browser-assigned access key (if any); otherwise it returns an empty string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKeyLabel)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "addEventListener", - "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "after", - "value": "(...nodes: (string | Node)[]) => void", - "description": "Inserts nodes just after node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/after)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "animate", - "value": "(keyframes: Keyframe[] | PropertyIndexedKeyframes, options?: number | KeyframeAnimationOptions) => Animation", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animate)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "append", - "value": "(...nodes: (string | Node)[]) => void", - "description": "Inserts nodes after the last child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/append)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "appendChild", - "value": "(node: T) => T", - "description": "The **`appendChild()`** method of the Node interface adds a node to the end of the list of children of a specified parent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/appendChild)" + "name": "customer", + "value": "SubscribableSignalLike", + "description": "The buyer's customer account, including their ID and whether they have accepted marketing. The value is `undefined` if the buyer is a guest or hasn't logged in yet." }, { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", "syntaxKind": "PropertySignature", - "name": "ariaActiveDescendantElement", - "value": "Element | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaActiveDescendantElement)" + "name": "email", + "value": "SubscribableSignalLike", + "description": "The email address associated with the order. This is the email the buyer provided during checkout for order confirmation and communication. The value is `undefined` if the app doesn't have access to customer data." }, { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", "syntaxKind": "PropertySignature", - "name": "ariaAtomic", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAtomic)" + "name": "phone", + "value": "SubscribableSignalLike", + "description": "The phone number the buyer provided during checkout. The value is `undefined` if no phone number was provided or the app doesn't have access to customer data." }, { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", "syntaxKind": "PropertySignature", - "name": "ariaAutoComplete", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAutoComplete)" - }, + "name": "purchasingCompany", + "value": "SubscribableSignalLike<\n OrderStatusPurchasingCompany | undefined\n >", + "description": "The company and company location that a B2B (business-to-business) customer is purchasing on behalf of. Use this to identify the business context of the order. The value is `undefined` if the buyer isn't a B2B customer." + } + ], + "value": "export interface OrderStatusBuyerIdentity {\n /**\n * The buyer's customer account, including their ID and whether they have accepted marketing.\n * The value is `undefined` if the buyer is a guest or hasn't logged in yet.\n */\n customer: SubscribableSignalLike;\n\n /**\n * The email address associated with the order. This is the email the buyer provided during\n * checkout for order confirmation and communication. The value is `undefined` if the app\n * doesn't have access to customer data.\n */\n email: SubscribableSignalLike;\n\n /**\n * The phone number the buyer provided during checkout. The value is `undefined` if no phone\n * number was provided or the app doesn't have access to customer data.\n */\n phone: SubscribableSignalLike;\n\n /**\n * The company and company location that a B2B (business-to-business) customer is purchasing\n * on behalf of. Use this to identify the business context of the order. The value is\n * `undefined` if the buyer isn't a B2B customer.\n */\n purchasingCompany: SubscribableSignalLike<\n OrderStatusPurchasingCompany | undefined\n >;\n}" + } + }, + "OrderStatusCustomer": { + "src/surfaces/customer-account/api/order-status/order-status.ts": { + "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", + "name": "OrderStatusCustomer", + "description": "Information about a customer who has previously purchased from this shop.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data). The `id`, `image`, `acceptsMarketing`, and `storeCreditAccounts` properties require level 1 access. The `email`, `phone`, `fullName`, `firstName`, and `lastName` properties require level 2 access.", + "members": [ { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", "syntaxKind": "PropertySignature", - "name": "ariaBrailleLabel", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleLabel)" + "name": "acceptsMarketing", + "value": "boolean", + "description": "Whether the customer has opted in to receiving marketing communications from the merchant, such as email campaigns and promotional offers." }, { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", "syntaxKind": "PropertySignature", - "name": "ariaBrailleRoleDescription", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleRoleDescription)" + "name": "email", + "value": "string", + "description": "The email address associated with the customer's account. The value is `undefined` if the app doesn't have the required access level.", + "isOptional": true }, { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", "syntaxKind": "PropertySignature", - "name": "ariaBusy", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBusy)" + "name": "firstName", + "value": "string", + "description": "The customer's first name. The value is `undefined` if the app doesn't have the required access level.", + "isOptional": true }, { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", "syntaxKind": "PropertySignature", - "name": "ariaChecked", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaChecked)" + "name": "fullName", + "value": "string", + "description": "The customer's full name, typically a combination of first and last name. The value is `undefined` if the app doesn't have the required access level.", + "isOptional": true }, { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", "syntaxKind": "PropertySignature", - "name": "ariaColCount", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColCount)" + "name": "id", + "value": "string", + "description": "A globally-unique identifier for the customer in the format `gid://shopify/Customer/`. 'gid://shopify/Customer/123'" }, { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", "syntaxKind": "PropertySignature", - "name": "ariaColIndex", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndex)" + "name": "image", + "value": "ImageDetails", + "description": "The customer's profile image, such as a Gravatar avatar. Use this to personalize the extension UI for the logged-in buyer." }, { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", "syntaxKind": "PropertySignature", - "name": "ariaColIndexText", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndexText)" + "name": "lastName", + "value": "string", + "description": "The customer's last name. The value is `undefined` if the app doesn't have the required access level.", + "isOptional": true }, { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", "syntaxKind": "PropertySignature", - "name": "ariaColSpan", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColSpan)" + "name": "phone", + "value": "string", + "description": "The phone number associated with the customer's account. The value is `undefined` if no phone number is on file or the app doesn't have the required access level.", + "isOptional": true }, { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", "syntaxKind": "PropertySignature", - "name": "ariaControlsElements", - "value": "ReadonlyArray | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaControlsElements)" - }, + "name": "storeCreditAccounts", + "value": "StoreCreditAccount[]", + "description": "The store credit accounts owned by this customer that can be used as payment during checkout. Each account has a balance representing available store credit.", + "isPrivate": true + } + ], + "value": "export interface OrderStatusCustomer {\n /**\n * A globally-unique identifier for the customer in the format `gid://shopify/Customer/`. 'gid://shopify/Customer/123'\n */\n id: string;\n /**\n * The email address associated with the customer's account. The value is `undefined` if the app doesn't have the required access level.\n */\n email?: string;\n /**\n * The phone number associated with the customer's account. The value is `undefined` if no phone number is on file or the app doesn't have the required access level.\n */\n phone?: string;\n /**\n * The customer's full name, typically a combination of first and last name. The value is `undefined` if the app doesn't have the required access level.\n */\n fullName?: string;\n /**\n * The customer's first name. The value is `undefined` if the app doesn't have the required access level.\n */\n firstName?: string;\n /**\n * The customer's last name. The value is `undefined` if the app doesn't have the required access level.\n */\n lastName?: string;\n /**\n * The customer's profile image, such as a Gravatar avatar. Use this to personalize the extension UI for the logged-in buyer.\n */\n image: ImageDetails;\n /**\n * Whether the customer has opted in to receiving marketing communications from the merchant, such as email campaigns and promotional offers.\n */\n acceptsMarketing: boolean;\n /**\n * The store credit accounts owned by this customer that can be used as payment during checkout. Each account has a balance representing available store credit.\n *\n * @private\n */\n storeCreditAccounts: StoreCreditAccount[];\n}" + } + }, + "OrderStatusPurchasingCompany": { + "src/surfaces/customer-account/api/order-status/order-status.ts": { + "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", + "name": "OrderStatusPurchasingCompany", + "description": "Information about a company that the business customer is purchasing on behalf of.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", + "members": [ { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", "syntaxKind": "PropertySignature", - "name": "ariaCurrent", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaCurrent)" + "name": "company", + "value": "OrderStatusCompany", + "description": "The company that the B2B customer is purchasing on behalf of, including the company ID, name, and optional external ID." }, { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", "syntaxKind": "PropertySignature", - "name": "ariaDescribedByElements", - "value": "ReadonlyArray | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescribedByElements)" - }, + "name": "location", + "value": "OrderStatusCompanyLocation", + "description": "The specific company location where the order is being placed, including the location ID, name, and optional external ID." + } + ], + "value": "export interface OrderStatusPurchasingCompany {\n /**\n * The company that the B2B customer is purchasing on behalf of, including the company ID, name, and optional external ID.\n */\n company: OrderStatusCompany;\n /**\n * The specific company location where the order is being placed, including the location ID, name, and optional external ID.\n */\n location: OrderStatusCompanyLocation;\n}" + } + }, + "OrderStatusCompany": { + "src/surfaces/customer-account/api/order-status/order-status.ts": { + "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", + "name": "OrderStatusCompany", + "description": "{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", + "members": [ { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", "syntaxKind": "PropertySignature", - "name": "ariaDescription", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescription)" + "name": "externalId", + "value": "string", + "description": "A merchant-defined external identifier for the company, often used to map to an ID in an external ERP or CRM system. The value is `undefined` if no external ID has been set.", + "isOptional": true }, { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", "syntaxKind": "PropertySignature", - "name": "ariaDetailsElements", - "value": "ReadonlyArray | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDetailsElements)" + "name": "id", + "value": "string", + "description": "A globally-unique identifier for the company in the format `gid://shopify/Company/`." }, { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", "syntaxKind": "PropertySignature", - "name": "ariaDisabled", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDisabled)" - }, + "name": "name", + "value": "string", + "description": "The registered business name of the company, as configured by the merchant in Shopify admin." + } + ], + "value": "export interface OrderStatusCompany {\n /**\n * A globally-unique identifier for the company in the format `gid://shopify/Company/`.\n */\n id: string;\n /**\n * The registered business name of the company, as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * A merchant-defined external identifier for the company, often used to map to an ID in an external ERP or CRM system. The value is `undefined` if no external ID has been set.\n */\n externalId?: string;\n}" + } + }, + "OrderStatusCompanyLocation": { + "src/surfaces/customer-account/api/order-status/order-status.ts": { + "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", + "name": "OrderStatusCompanyLocation", + "description": "{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", + "members": [ { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", "syntaxKind": "PropertySignature", - "name": "ariaErrorMessageElements", - "value": "ReadonlyArray | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaErrorMessageElements)" + "name": "externalId", + "value": "string", + "description": "A merchant-defined external identifier for the company location, often used to map to an ID in an external ERP or CRM system. The value is `undefined` if no external ID has been set.", + "isOptional": true }, { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", "syntaxKind": "PropertySignature", - "name": "ariaExpanded", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaExpanded)" + "name": "id", + "value": "string", + "description": "A globally-unique identifier for the company location in the format `gid://shopify/CompanyLocation/`." }, { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", "syntaxKind": "PropertySignature", - "name": "ariaFlowToElements", - "value": "ReadonlyArray | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaFlowToElements)" - }, + "name": "name", + "value": "string", + "description": "The display name of the company location, such as a branch office or warehouse name." + } + ], + "value": "export interface OrderStatusCompanyLocation {\n /**\n * A globally-unique identifier for the company location in the format `gid://shopify/CompanyLocation/`.\n */\n id: string;\n /**\n * The display name of the company location, such as a branch office or warehouse name.\n */\n name: string;\n /**\n * A merchant-defined external identifier for the company location, often used to map to an ID in an external ERP or CRM system. The value is `undefined` if no external ID has been set.\n */\n externalId?: string;\n}" + } + }, + "Docs_OrderStatus_CheckoutSettingsApi": { + "src/surfaces/customer-account/api/docs.ts": { + "filePath": "src/surfaces/customer-account/api/docs.ts", + "name": "Docs_OrderStatus_CheckoutSettingsApi", + "description": "", + "isPublicDocs": true, + "members": [ { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/docs.ts", "syntaxKind": "PropertySignature", - "name": "ariaHasPopup", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHasPopup)" - }, + "name": "checkoutSettings", + "value": "SubscribableSignalLike", + "description": "The checkout settings that were active when the buyer placed the order, such as whether order notes and login are enabled.\n\nReturns the merchant's checkout configuration at the time of checkout. Doesn't reflect updates made after the order was placed." + } + ], + "value": "export interface Docs_OrderStatus_CheckoutSettingsApi\n extends Pick, 'checkoutSettings'> {}" + } + }, + "Docs_OrderStatus_CostApi": { + "src/surfaces/customer-account/api/docs.ts": { + "filePath": "src/surfaces/customer-account/api/docs.ts", + "name": "Docs_OrderStatus_CostApi", + "description": "", + "isPublicDocs": true, + "members": [ { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/docs.ts", "syntaxKind": "PropertySignature", - "name": "ariaHidden", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHidden)" - }, + "name": "cost", + "value": "CartCost", + "description": "A breakdown of the costs for the order, including the subtotal, shipping, tax, and total amounts." + } + ], + "value": "export interface Docs_OrderStatus_CostApi\n extends Pick, 'cost'> {}" + } + }, + "Docs_OrderStatus_LocalizationApi": { + "src/surfaces/customer-account/api/docs.ts": { + "filePath": "src/surfaces/customer-account/api/docs.ts", + "name": "Docs_OrderStatus_LocalizationApi", + "description": "", + "isPublicDocs": true, + "members": [ { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/docs.ts", "syntaxKind": "PropertySignature", - "name": "ariaInvalid", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaInvalid)" - }, + "name": "localization", + "value": "OrderStatusLocalization", + "description": "The buyer's locale, currency, time zone, country, and market context for the order. Use these values to adapt your extension's content to the buyer's region. For formatted dates, numbers, and translated strings, use the [Localization API](/docs/api/customer-account-ui-extensions/{API_VERSION}/target-apis/platform-apis/localization-api) instead." + } + ], + "value": "export interface Docs_OrderStatus_LocalizationApi\n extends Pick, 'localization'> {}" + } + }, + "OrderStatusLocalization": { + "src/surfaces/customer-account/api/order-status/order-status.ts": { + "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", + "name": "OrderStatusLocalization", + "description": "Provides raw localization data only. The `i18n` translation and formatting helpers from the Localization API aren't available on order status targets.", + "members": [ { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", "syntaxKind": "PropertySignature", - "name": "ariaKeyShortcuts", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaKeyShortcuts)" + "name": "country", + "value": "SubscribableSignalLike", + "description": "The country associated with the order, carried over from the cart context where it was used to contextualize the storefront experience. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown." }, { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", "syntaxKind": "PropertySignature", - "name": "ariaLabel", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabel)" + "name": "currency", + "value": "SubscribableSignalLike", + "description": "The currency used to display money amounts on the **Order status** page. Use this value to format prices and totals in the buyer's expected currency." }, { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", "syntaxKind": "PropertySignature", - "name": "ariaLabelledByElements", - "value": "ReadonlyArray | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabelledByElements)" + "name": "extensionLanguage", + "value": "SubscribableSignalLike", + "description": "The best available language match for your extension based on the buyer's language. If the buyer's language is `fr-CA` but your extension only supports `fr`, this returns `fr`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension." }, { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", "syntaxKind": "PropertySignature", - "name": "ariaLevel", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLevel)" + "name": "language", + "value": "SubscribableSignalLike", + "description": "The language the buyer sees on the **Order status** page. This reflects the language selected by the buyer or determined by their browser settings, and may differ from the languages your extension supports." }, { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", "syntaxKind": "PropertySignature", - "name": "ariaLive", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLive)" + "name": "market", + "value": "SubscribableSignalLike", + "description": "The [market](/docs/apps/build/markets) associated with the order, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. The value is `undefined` if the market is unknown." }, { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", "syntaxKind": "PropertySignature", - "name": "ariaModal", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaModal)" - }, + "name": "timezone", + "value": "SubscribableSignalLike", + "description": "The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time." + } + ], + "value": "export interface OrderStatusLocalization {\n /**\n * The currency used to display money amounts on the **Order status** page. Use this value\n * to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, derived from their browser or account settings. Use this value\n * to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees on the **Order status** page. This reflects the language\n * selected by the buyer or determined by their browser settings, and may differ from\n * the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language.\n * If the buyer's language is `fr-CA` but your extension only supports `fr`, this\n * returns `fr`. If your extension doesn't support any variant of the buyer's language,\n * this falls back to your extension's default locale (the `.default.json` translation file).\n * Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country associated with the order, carried over from the cart context where it was\n * used to contextualize the storefront experience. Use this value to display region-specific\n * content such as local support information or regional policies. The value is `undefined`\n * if the buyer's country is unknown.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) associated with the order, carried\n * over from the cart context. Markets group countries and regions with shared pricing,\n * languages, and domains. The value is `undefined` if the market is unknown.\n */\n market: SubscribableSignalLike;\n}" + } + }, + "Docs_OrderStatus_DiscountsApi": { + "src/surfaces/customer-account/api/docs.ts": { + "filePath": "src/surfaces/customer-account/api/docs.ts", + "name": "Docs_OrderStatus_DiscountsApi", + "description": "", + "isPublicDocs": true, + "members": [ { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/docs.ts", "syntaxKind": "PropertySignature", - "name": "ariaMultiLine", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiLine)" + "name": "discountAllocations", + "value": "SubscribableSignalLike", + "description": "The cart-level discount allocations applied to the order. A discount allocation represents how a discount is distributed across the order. Each allocation includes the discounted amount and one of the following types:\n\n- `CartCodeDiscountAllocation`: A discount the buyer applied by entering a code at checkout.\n- `CartAutomaticDiscountAllocation`: A discount the merchant configured in Shopify admin to apply automatically.\n- `CartCustomDiscountAllocation`: A discount created programmatically by a [Shopify Function](/docs/apps/build/functions).\n\nReturns order-level discounts only. For per-line discount allocations, read from individual cart lines via the Cart Lines API." }, { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/docs.ts", "syntaxKind": "PropertySignature", - "name": "ariaMultiSelectable", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiSelectable)" - }, + "name": "discountCodes", + "value": "SubscribableSignalLike", + "description": "A list of discount codes that the buyer entered during checkout and that were applied to the order." + } + ], + "value": "export interface Docs_OrderStatus_DiscountsApi\n extends Pick, 'discountAllocations' | 'discountCodes'> {}" + } + }, + "Docs_OrderStatus_GiftCardsApi": { + "src/surfaces/customer-account/api/docs.ts": { + "filePath": "src/surfaces/customer-account/api/docs.ts", + "name": "Docs_OrderStatus_GiftCardsApi", + "description": "", + "isPublicDocs": true, + "members": [ { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/docs.ts", "syntaxKind": "PropertySignature", - "name": "ariaOrientation", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOrientation)" - }, + "name": "appliedGiftCards", + "value": "SubscribableSignalLike", + "description": "The gift cards that were applied to the order. Each gift card includes the last four characters of the code, the amount used for this order, and the remaining balance." + } + ], + "value": "export interface Docs_OrderStatus_GiftCardsApi\n extends Pick, 'appliedGiftCards'> {}" + } + }, + "Docs_OrderStatus_NoteApi": { + "src/surfaces/customer-account/api/docs.ts": { + "filePath": "src/surfaces/customer-account/api/docs.ts", + "name": "Docs_OrderStatus_NoteApi", + "description": "", + "isPublicDocs": true, + "members": [ { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/docs.ts", "syntaxKind": "PropertySignature", - "name": "ariaOwnsElements", - "value": "ReadonlyArray | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOwnsElements)" - }, + "name": "note", + "value": "SubscribableSignalLike", + "description": "A note left by the customer to the merchant, either in their cart or during checkout. The value is `undefined` if no note was provided." + } + ], + "value": "export interface Docs_OrderStatus_NoteApi\n extends Pick, 'note'> {}" + } + }, + "Docs_OrderStatus_AddressApi": { + "src/surfaces/customer-account/api/docs.ts": { + "filePath": "src/surfaces/customer-account/api/docs.ts", + "name": "Docs_OrderStatus_AddressApi", + "description": "", + "isPublicDocs": true, + "members": [ { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/docs.ts", "syntaxKind": "PropertySignature", - "name": "ariaPlaceholder", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPlaceholder)" + "name": "billingAddress", + "value": "SubscribableSignalLike", + "description": "The billing address associated with the buyer's payment method for the order. The value is `undefined` if the order doesn't have a billing address on file.\n\nReflects the state at the time the order was placed. Doesn't update if the customer changes their account address afterward.", + "isOptional": true }, { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/docs.ts", "syntaxKind": "PropertySignature", - "name": "ariaPosInSet", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPosInSet)" - }, + "name": "shippingAddress", + "value": "SubscribableSignalLike", + "description": "The shipping address that the buyer provided for the order. This is where physical goods are delivered. The value is `undefined` if the order contains only digital products or if a shipping address wasn't required.\n\nReflects the state at the time the order was placed. Doesn't update if the customer changes their account address afterward.", + "isOptional": true + } + ], + "value": "export interface Docs_OrderStatus_AddressApi\n extends Pick, 'shippingAddress' | 'billingAddress'> {}" + } + }, + "Docs_OrderStatus_ShopApi": { + "src/surfaces/customer-account/api/docs.ts": { + "filePath": "src/surfaces/customer-account/api/docs.ts", + "name": "Docs_OrderStatus_ShopApi", + "description": "", + "isPublicDocs": true, + "members": [ { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/docs.ts", "syntaxKind": "PropertySignature", - "name": "ariaPressed", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPressed)" - }, + "name": "shop", + "value": "Shop", + "description": "The shop where the order was placed. Includes the shop ID, name, primary storefront URL, and myshopify.com domain." + } + ], + "value": "export interface Docs_OrderStatus_ShopApi\n extends Pick, 'shop'> {}" + } + }, + "Docs_OrderStatus_RequireLoginApi": { + "src/surfaces/customer-account/api/docs.ts": { + "filePath": "src/surfaces/customer-account/api/docs.ts", + "name": "Docs_OrderStatus_RequireLoginApi", + "description": "", + "isPublicDocs": true, + "members": [ { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/docs.ts", "syntaxKind": "PropertySignature", - "name": "ariaReadOnly", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaReadOnly)" - }, + "name": "requireLogin", + "value": "() => Promise", + "description": "Triggers a login prompt if the customer is viewing a pre-authenticated **Order status** page. Use this to require full authentication before displaying sensitive information in your extension.\n\nTriggers a login prompt for pre-authenticated buyers. Doesn't guarantee the buyer completes the login. Handle the dismissal case in your code." + } + ], + "value": "export interface Docs_OrderStatus_RequireLoginApi\n extends Pick, 'requireLogin'> {}" + } + }, + "Docs_OrderStatus_AuthenticationStateApi": { + "src/surfaces/customer-account/api/docs.ts": { + "filePath": "src/surfaces/customer-account/api/docs.ts", + "name": "Docs_OrderStatus_AuthenticationStateApi", + "description": "", + "isPublicDocs": true, + "members": [ { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/docs.ts", "syntaxKind": "PropertySignature", - "name": "ariaRelevant", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRelevant)" - }, + "name": "authenticationState", + "value": "SubscribableSignalLike", + "description": "The buyer's current authentication level on the **Order status** page. Use this to determine whether to display sensitive information or prompt the buyer to log in.\n\nRead-only. The authentication level can't be changed programmatically." + } + ], + "value": "export interface Docs_OrderStatus_AuthenticationStateApi\n extends Pick, 'authenticationState'> {}" + } + }, + "AuthenticationState": { + "src/surfaces/customer-account/api/order-status/order-status.ts": { + "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "AuthenticationState", + "value": "'fully_authenticated' | 'pre_authenticated'", + "description": "The buyer's authentication status on the **Order status** page:\n\n- `'fully_authenticated'`: The buyer has logged in to their customer account.\n- `'pre_authenticated'`: The buyer accessed the page via a direct link, such as from an order confirmation email, without logging in." + } + }, + "Docs_OrderStatus_CartLinesApi": { + "src/surfaces/customer-account/api/docs.ts": { + "filePath": "src/surfaces/customer-account/api/docs.ts", + "name": "Docs_OrderStatus_CartLinesApi", + "description": "", + "isPublicDocs": true, + "members": [ { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/docs.ts", "syntaxKind": "PropertySignature", - "name": "ariaRequired", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRequired)" - }, + "name": "lines", + "value": "SubscribableSignalLike", + "description": "A list of line items in the order. Each line includes the merchandise, quantity, cost, custom attributes, and discount allocations." + } + ], + "value": "export interface Docs_OrderStatus_CartLinesApi\n extends Pick, 'lines'> {}" + } + }, + "Docs_CartLineItem_CartLinesApi": { + "src/surfaces/customer-account/api/docs.ts": { + "filePath": "src/surfaces/customer-account/api/docs.ts", + "name": "Docs_CartLineItem_CartLinesApi", + "description": "The API object provided to `customer-account.order-status.cart-line-item.render-after` extension targets for interacting with individual cart line items.", + "isPublicDocs": true, + "members": [ { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/docs.ts", "syntaxKind": "PropertySignature", - "name": "ariaRoleDescription", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRoleDescription)" - }, + "name": "target", + "value": "SubscribableSignalLike", + "description": "The cart line that this extension is attached to. Use this to read the line item's merchandise, quantity, cost, and attributes." + } + ], + "value": "export interface Docs_CartLineItem_CartLinesApi\n extends Pick {}" + } + }, + "Docs_OrderStatus_OrderApi": { + "src/surfaces/customer-account/api/docs.ts": { + "filePath": "src/surfaces/customer-account/api/docs.ts", + "name": "Docs_OrderStatus_OrderApi", + "description": "", + "isPublicDocs": true, + "members": [ { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/docs.ts", "syntaxKind": "PropertySignature", - "name": "ariaRowCount", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowCount)" - }, + "name": "order", + "value": "SubscribableSignalLike", + "description": "The order that was placed after checkout completion. Includes the order ID, display name, confirmation number, and timestamps for processing and cancellation. The value is `undefined` if the order hasn't been fully processed yet." + } + ], + "value": "export interface Docs_OrderStatus_OrderApi\n extends Pick, 'order'> {}" + } + }, + "Order": { + "src/surfaces/customer-account/api/order-status/order-status.ts": { + "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", + "name": "Order", + "description": "Information about an order that was placed.", + "members": [ { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", "syntaxKind": "PropertySignature", - "name": "ariaRowIndex", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndex)" + "name": "cancelledAt", + "value": "string", + "description": "The date and time when the order was cancelled, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. The value is `undefined` if the order hasn't been cancelled. Use this to conditionally display cancellation details to the buyer.", + "isOptional": true }, { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", "syntaxKind": "PropertySignature", - "name": "ariaRowIndexText", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndexText)" + "name": "confirmationNumber", + "value": "string", + "description": "A randomly generated alphanumeric identifier for the order that the buyer can use when contacting the merchant about their purchase. This is always present for orders created in 2024 and onwards. For older orders, this value may be `undefined`.", + "isOptional": true }, { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", "syntaxKind": "PropertySignature", - "name": "ariaRowSpan", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowSpan)" + "name": "id", + "value": "string", + "description": "A globally-unique identifier for the order in the format `gid://shopify/Order/`. Use this to reference the order in the [GraphQL Admin API](/docs/api/admin-graphql).", + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "'gid://shopify/Order/1'", + "title": "Example" + } + ] + } + ] }, { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", "syntaxKind": "PropertySignature", - "name": "ariaSelected", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSelected)" + "name": "name", + "value": "string", + "description": "The merchant-facing order number prefixed with `#`, such as `#1001`. This is the human-readable identifier displayed to both the merchant in Shopify admin and the buyer on the **Order status** page and in email confirmations.", + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "'#1000'", + "title": "Example" + } + ] + } + ] }, { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", "syntaxKind": "PropertySignature", - "name": "ariaSetSize", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSetSize)" - }, + "name": "processedAt", + "value": "string", + "description": "The date and time when the order was processed, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. An order is processed after the buyer completes checkout and the payment is captured, at which point the order becomes visible in Shopify admin.", + "isOptional": true + } + ], + "value": "export interface Order {\n /**\n * A globally-unique identifier for the order in the format `gid://shopify/Order/`. Use this to reference the order in the [GraphQL Admin API](/docs/api/admin-graphql).\n *\n * @example 'gid://shopify/Order/1'\n */\n id: string;\n\n /**\n * The merchant-facing order number prefixed with `#`, such as `#1001`. This is the human-readable identifier displayed to both the merchant in Shopify admin and the buyer on the **Order status** page and in email confirmations.\n *\n * @example '#1000'\n */\n name: string;\n\n /**\n * The date and time when the order was cancelled, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. The value is `undefined` if the order hasn't been cancelled. Use this to conditionally display cancellation details to the buyer.\n */\n cancelledAt?: string;\n\n /**\n * A randomly generated alphanumeric identifier for the order that the buyer can use when contacting the merchant about their purchase. This is always present for orders created in 2024 and onwards. For older orders, this value may be `undefined`.\n */\n confirmationNumber?: string;\n\n /**\n * The date and time when the order was processed, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. An order is processed after the buyer completes checkout and the payment is captured, at which point the order becomes visible in Shopify admin.\n */\n processedAt?: string;\n}" + } + }, + "Docs_Standard_ExtensionApi": { + "src/surfaces/customer-account/api/docs.ts": { + "filePath": "src/surfaces/customer-account/api/docs.ts", + "name": "Docs_Standard_ExtensionApi", + "description": "", + "isPublicDocs": true, + "members": [ { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/docs.ts", "syntaxKind": "PropertySignature", - "name": "ariaSort", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSort)" - }, + "name": "extension", + "value": "Extension", + "description": "Metadata about the extension, including its target, version, and editor context. Use this to conditionally render content based on where the extension is running." + } + ], + "value": "export interface Docs_Standard_ExtensionApi\n extends Pick, 'extension'> {}" + } + }, + "Docs_Standard_AuthenticatedAccountApi": { + "src/surfaces/customer-account/api/docs.ts": { + "filePath": "src/surfaces/customer-account/api/docs.ts", + "name": "Docs_Standard_AuthenticatedAccountApi", + "description": "", + "isPublicDocs": true, + "members": [ { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/docs.ts", "syntaxKind": "PropertySignature", - "name": "ariaValueMax", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMax)" - }, + "name": "authenticatedAccount", + "value": "AuthenticatedAccount", + "description": "The logged-in customer's account information, including their customer ID and B2B company details. Use this to personalize your extension based on who is viewing the page." + } + ], + "value": "export interface Docs_Standard_AuthenticatedAccountApi\n extends Pick, 'authenticatedAccount'> {}" + } + }, + "AuthenticatedAccount": { + "src/surfaces/customer-account/api/shared.ts": { + "filePath": "src/surfaces/customer-account/api/shared.ts", + "name": "AuthenticatedAccount", + "description": "", + "members": [ { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/shared.ts", "syntaxKind": "PropertySignature", - "name": "ariaValueMin", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMin)" + "name": "customer", + "value": "SubscribableSignalLike", + "description": "The authenticated customer's account information. The value is `undefined` if the customer isn't logged in." }, { - "filePath": "src/surfaces/checkout/components/Button.ts", + "filePath": "src/surfaces/customer-account/api/shared.ts", "syntaxKind": "PropertySignature", - "name": "ariaValueNow", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueNow)" - }, + "name": "purchasingCompany", + "value": "SubscribableSignalLike", + "description": "The company that the authenticated B2B customer belongs to, including the company ID and location. The value is `undefined` if the customer isn't authenticated or isn't a B2B customer." + } + ], + "value": "export interface AuthenticatedAccount {\n /**\n * The company that the authenticated B2B customer belongs to, including the company ID and location. The value is `undefined` if the customer isn't authenticated or isn't a B2B customer.\n */\n purchasingCompany: SubscribableSignalLike;\n /**\n * The authenticated customer's account information. The value is `undefined` if the customer isn't logged in.\n */\n customer: SubscribableSignalLike;\n}" + } + }, + "Docs_Standard_VersionApi": { + "src/surfaces/customer-account/api/docs.ts": { + "filePath": "src/surfaces/customer-account/api/docs.ts", + "name": "Docs_Standard_VersionApi", + "description": "", + "isPublicDocs": true, + "members": [ { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "ariaValueText", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueText)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "assignedSlot", - "value": "HTMLSlotElement | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/assignedSlot)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "attachInternals", - "value": "() => ElementInternals", - "description": "The **`HTMLElement.attachInternals()`** method returns an ElementInternals object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attachInternals)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "attachShadow", - "value": "(init: ShadowRootInit) => ShadowRoot", - "description": "The **`Element.attachShadow()`** method attaches a shadow DOM tree to the specified element and returns a reference to its ShadowRoot.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attachShadow)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "ATTRIBUTE_NODE", - "value": "2", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "NamedNodeMap", - "description": "The **`Element.attributes`** property returns a live collection of all attribute nodes registered to the specified node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attributes)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "attributeStyleMap", - "value": "StylePropertyMap", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attributeStyleMap)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "autocapitalize", - "value": "string", - "description": "The **`autocapitalize`** property of the HTMLElement interface represents the element's capitalization behavior for user input.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocapitalize)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "autocorrect", - "value": "boolean", - "description": "The **`autocorrect`** property of the HTMLElement interface controls whether or not autocorrection of editable text is enabled for spelling and/or punctuation errors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocorrect)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "autofocus", - "value": "boolean", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autofocus)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "baseURI", - "value": "string", - "description": "The read-only **`baseURI`** property of the Node interface returns the absolute base URL of the document containing the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/baseURI)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "before", - "value": "(...nodes: (string | Node)[]) => void", - "description": "Inserts nodes just before node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/before)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "blur", - "value": "() => void", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/blur)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "CDATA_SECTION_NODE", - "value": "4", - "description": "node is a CDATASection node." - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "checkVisibility", - "value": "(options?: CheckVisibilityOptions) => boolean", - "description": "The **`checkVisibility()`** method of the Element interface checks whether the element is visible.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/checkVisibility)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "childElementCount", - "value": "number", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/childElementCount)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "childNodes", - "value": "NodeListOf", - "description": "The read-only **`childNodes`** property of the Node interface returns a live the first child node is assigned index `0`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/childNodes)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "HTMLCollection", - "description": "Returns the child elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/children)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "GetAccessor", - "name": "classList", - "value": "DOMTokenList", - "description": "The **`Element.classList`** is a read-only property that returns a live DOMTokenList collection of the `class` attributes of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/classList)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "className", - "value": "string", - "description": "The **`className`** property of the of the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/className)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "click", - "value": "() => void", - "description": "The **`HTMLElement.click()`** method simulates a mouse click on an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/click)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "clientHeight", - "value": "number", - "description": "The **`clientHeight`** read-only property of the Element interface is zero for elements with no CSS or inline layout boxes; otherwise, it's the inner height of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientHeight)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "clientLeft", - "value": "number", - "description": "The **`clientLeft`** read-only property of the Element interface returns the width of the left border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientLeft)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "clientTop", - "value": "number", - "description": "The **`clientTop`** read-only property of the Element interface returns the width of the top border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientTop)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "clientWidth", - "value": "number", - "description": "The **`clientWidth`** read-only property of the Element interface is zero for inline elements and elements with no CSS; otherwise, it's the inner width of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientWidth)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "cloneNode", - "value": "(subtree?: boolean) => Node", - "description": "The **`cloneNode()`** method of the Node interface returns a duplicate of the node on which this method was called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/cloneNode)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "closest", - "value": "{ (selector: K): HTMLElementTagNameMap[K]; (selector: K): SVGElementTagNameMap[K]; (selector: K): MathMLElementTagNameMap[K]; (selectors: string): E; }", - "description": "The **`closest()`** method of the Element interface traverses the element and its parents (heading toward the document root) until it finds a node that matches the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/closest)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "command", - "value": "'--auto' | '--show' | '--hide' | '--toggle' | '--copy'", - "description": "Sets the action the `commandFor` should take when this clickable is activated.\n\nSee the documentation of particular components for the actions they support.\n\n- `--auto`: Performs the default action for the target component.\n- `--show`: Displays the target component.\n- `--hide`: Conceals the target component.\n- `--toggle`: Alternates the target component.\n- `--copy`: Copies the target ClipboardItem.", - "isOptional": true, - "defaultValue": "'--auto'" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "commandFor", - "value": "string", - "description": "ID of a component that should respond to activations (such as clicks) on this component.\n\nSee `command` for how to control the behavior of the target.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "COMMENT_NODE", - "value": "8", - "description": "node is a Comment node." - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "compareDocumentPosition", - "value": "(other: Node) => number", - "description": "The **`compareDocumentPosition()`** method of the Node interface reports the position of its argument node relative to the node on which it is called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/compareDocumentPosition)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "computedStyleMap", - "value": "() => StylePropertyMapReadOnly", - "description": "The **`computedStyleMap()`** method of the Element interface returns a StylePropertyMapReadOnly interface which provides a read-only representation of a CSS declaration block that is an alternative to CSSStyleDeclaration.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/computedStyleMap)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "contains", - "value": "(other: Node) => boolean", - "description": "The **`contains()`** method of the Node interface returns a boolean value indicating whether a node is a descendant of a given node, that is the node itself, one of its direct children (Node.childNodes), one of the children's direct children, and so on.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/contains)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "contentEditable", - "value": "string", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/contentEditable)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "currentCSSZoom", - "value": "number", - "description": "The **`currentCSSZoom`** read-only property of the Element interface provides the 'effective' CSS `zoom` of an element, taking into account the zoom applied to the element and all its parent elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/currentCSSZoom)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "dataset", - "value": "DOMStringMap", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dataset)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "dir", - "value": "string", - "description": "The **`HTMLElement.dir`** property indicates the text writing directionality of the content of the current element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dir)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "Whether the button is disabled, preventing it from being clicked or receiving focus.", - "isOptional": true, - "defaultValue": "false" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "dispatchEvent", - "value": "(event: Event) => boolean", - "description": "The **`dispatchEvent()`** method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/dispatchEvent)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "DOCUMENT_FRAGMENT_NODE", - "value": "11", - "description": "node is a DocumentFragment node." - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "DOCUMENT_NODE", - "value": "9", - "description": "node is a document." - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "DOCUMENT_POSITION_CONTAINED_BY", - "value": "16", - "description": "Set when other is a descendant of node." - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "DOCUMENT_POSITION_CONTAINS", - "value": "8", - "description": "Set when other is an ancestor of node." - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "DOCUMENT_POSITION_DISCONNECTED", - "value": "1", - "description": "Set when node and other are not in the same tree." - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "DOCUMENT_POSITION_FOLLOWING", - "value": "4", - "description": "Set when other is following node." - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC", - "value": "32", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "DOCUMENT_POSITION_PRECEDING", - "value": "2", - "description": "Set when other is preceding node." - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "DOCUMENT_TYPE_NODE", - "value": "10", - "description": "node is a doctype." - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "draggable", - "value": "boolean", - "description": "The **`draggable`** property of the HTMLElement interface gets and sets a Boolean primitive indicating if the element is draggable.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/draggable)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "ELEMENT_NODE", - "value": "1", - "description": "node is an element." - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "enterKeyHint", - "value": "string", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/enterKeyHint)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "ENTITY_NODE", - "value": "6", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "ENTITY_REFERENCE_NODE", - "value": "5", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "firstChild", - "value": "ChildNode | null", - "description": "The read-only **`firstChild`** property of the Node interface returns the node's first child in the tree, or `null` if the node has no children.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/firstChild)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "firstElementChild", - "value": "Element | null", - "description": "Returns the first child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/firstElementChild)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "focus", - "value": "(options?: FocusOptions) => void", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/focus)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "getAnimations", - "value": "(options?: GetAnimationsOptions) => Animation[]", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAnimations)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "getAttribute", - "value": "(qualifiedName: string) => string", - "description": "The **`getAttribute()`** method of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttribute)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "getAttributeNames", - "value": "() => string[]", - "description": "The **`getAttributeNames()`** method of the array.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNames)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "getAttributeNode", - "value": "(qualifiedName: string) => Attr", - "description": "Returns the specified attribute of the specified element, as an Attr node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNode)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "getAttributeNodeNS", - "value": "(namespace: string, localName: string) => Attr", - "description": "The **`getAttributeNodeNS()`** method of the Element interface returns the namespaced Attr node of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNodeNS)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "getAttributeNS", - "value": "(namespace: string, localName: string) => string", - "description": "The **`getAttributeNS()`** method of the Element interface returns the string value of the attribute with the specified namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNS)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "getBoundingClientRect", - "value": "() => DOMRect", - "description": "The **`Element.getBoundingClientRect()`** method returns a position relative to the viewport.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getBoundingClientRect)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "getClientRects", - "value": "() => DOMRectList", - "description": "The **`getClientRects()`** method of the Element interface returns a collection of DOMRect objects that indicate the bounding rectangles for each CSS border box in a client.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getClientRects)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "getElementsByClassName", - "value": "(classNames: string) => HTMLCollectionOf", - "description": "The Element method **`getElementsByClassName()`** returns a live specified class name or names.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByClassName)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "getElementsByTagName", - "value": "{ (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: string): HTMLCollectionOf; }", - "description": "The **`Element.getElementsByTagName()`** method returns a live All descendants of the specified element are searched, but not the element itself.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagName)", - "deprecationMessage": "Deprecated" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "getElementsByTagNameNS", - "value": "{ (namespaceURI: \"http://www.w3.org/1999/xhtml\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/2000/svg\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/1998/Math/MathML\", localName: string): HTMLCollectionOf; (namespace: string, localName: string): HTMLCollectionOf; }", - "description": "The **`Element.getElementsByTagNameNS()`** method returns a live HTMLCollection of elements with the given tag name belonging to the given namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagNameNS)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "getHTML", - "value": "(options?: GetHTMLOptions) => string", - "description": "The **`getHTML()`** method of the Element interface is used to serialize an element's DOM to an HTML string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getHTML)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "getRootNode", - "value": "(options?: GetRootNodeOptions) => Node", - "description": "The **`getRootNode()`** method of the Node interface returns the context object's root, which optionally includes the shadow root if it is available.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/getRootNode)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "hasAttribute", - "value": "(qualifiedName: string) => boolean", - "description": "The **`Element.hasAttribute()`** method returns a **Boolean** value indicating whether the specified element has the specified attribute or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttribute)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "hasAttributeNS", - "value": "(namespace: string, localName: string) => boolean", - "description": "The **`hasAttributeNS()`** method of the Element interface returns a boolean value indicating whether the current element has the specified attribute with the specified namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributeNS)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "hasAttributes", - "value": "() => boolean", - "description": "The **`hasAttributes()`** method of the Element interface returns a boolean value indicating whether the current element has any attributes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributes)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "hasChildNodes", - "value": "() => boolean", - "description": "The **`hasChildNodes()`** method of the Node interface returns a boolean value indicating whether the given Node has child nodes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/hasChildNodes)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "hasPointerCapture", - "value": "(pointerId: number) => boolean", - "description": "The **`hasPointerCapture()`** method of the pointer capture for the pointer identified by the given pointer ID.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasPointerCapture)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "hidden", - "value": "boolean", - "description": "The HTMLElement property **`hidden`** reflects the value of the element's `hidden` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidden)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "hidePopover", - "value": "() => void", - "description": "The **`hidePopover()`** method of the HTMLElement interface hides a popover element (i.e., one that has a valid `popover` attribute) by removing it from the top layer and styling it with `display: none`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidePopover)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "href", - "value": "string", - "description": "The URL to navigate to when clicked. The `click` event fires first, then navigation occurs.\n\n- If set, it will navigate to the location specified by `href` after executing the `click` event.\n- If a `commandFor` is set, the `command` will be executed instead of the navigation.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the element.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "inert", - "value": "boolean", - "description": "The HTMLElement property **`inert`** reflects the value of the element's `inert` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inert)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "inlineSize", - "value": "'auto' | 'fill' | 'fit-content'", - "description": "The inline width of the button component.\n\n- `auto`: The size depends on the surface and context.\n- `fill`: The button takes up 100% of the available inline size.\n- `fit-content`: The button takes up the minimum inline-size required to fit its content.", - "isOptional": true, - "defaultValue": "'auto'" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "innerHTML", - "value": "string", - "description": "The **`innerHTML`** property of the Element interface gets or sets the HTML or XML markup contained within the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/innerHTML)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "innerText", - "value": "string", - "description": "The **`innerText`** property of the HTMLElement interface represents the rendered text content of a node and its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/innerText)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "inputMode", - "value": "string", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inputMode)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "insertAdjacentElement", - "value": "(where: InsertPosition, element: Element) => Element", - "description": "The **`insertAdjacentElement()`** method of the relative to the element it is invoked upon.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentElement)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "insertAdjacentHTML", - "value": "(position: InsertPosition, string: string) => void", - "description": "The **`insertAdjacentHTML()`** method of the the resulting nodes into the DOM tree at a specified position.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentHTML)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "insertAdjacentText", - "value": "(where: InsertPosition, data: string) => void", - "description": "The **`insertAdjacentText()`** method of the Element interface, given a relative position and a string, inserts a new text node at the given position relative to the element it is called from.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentText)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "insertBefore", - "value": "(node: T, child: Node) => T", - "description": "The **`insertBefore()`** method of the Node interface inserts a node before a _reference node_ as a child of a specified _parent node_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/insertBefore)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "interestFor", - "value": "string", - "description": "The ID of the component to show when users hover over or focus on this component. Pair with a target component that supports interest-based interactions. Learn more about the [interestFor attribute](https://open-ui.org/components/interest-invokers.explainer/#the-pitch-in-code).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "isConnected", - "value": "boolean", - "description": "The read-only **`isConnected`** property of the Node interface returns a boolean indicating whether the node is connected (directly or indirectly) to a Document object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isConnected)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "isContentEditable", - "value": "boolean", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/isContentEditable)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "isDefaultNamespace", - "value": "(namespace: string) => boolean", - "description": "The **`isDefaultNamespace()`** method of the Node interface accepts a namespace URI as an argument.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isDefaultNamespace)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "isEqualNode", - "value": "(otherNode: Node) => boolean", - "description": "The **`isEqualNode()`** method of the Node interface tests whether two nodes are equal.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isEqualNode)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "isSameNode", - "value": "(otherNode: Node) => boolean", - "description": "The **`isSameNode()`** method of the Node interface is a legacy alias the for the `===` strict equality operator.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isSameNode)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "lang", - "value": "string", - "description": "The **`lang`** property of the HTMLElement interface indicates the base language of an element's attribute values and text content, in the form of a MISSING: RFC(5646, 'BCP 47 language identifier tag')].\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/lang)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "lastChild", - "value": "ChildNode | null", - "description": "The read-only **`lastChild`** property of the Node interface returns the last child of the node, or `null` if there are no child nodes.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lastChild)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "lastElementChild", - "value": "Element | null", - "description": "Returns the last child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/lastElementChild)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "loading", - "value": "boolean", - "description": "Whether the button is in a loading state, which replaces the button content with a loading indicator while a background action is being performed.\n\nThis also disables the button.", - "isOptional": true, - "defaultValue": "false" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "localName", - "value": "string", - "description": "The **`Element.localName`** read-only property returns the local part of the qualified name of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/localName)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "lookupNamespaceURI", - "value": "(prefix: string) => string", - "description": "The **`lookupNamespaceURI()`** method of the Node interface takes a prefix as parameter and returns the namespace URI associated with it on the given node if found (and `null` if not).\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupNamespaceURI)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "lookupPrefix", - "value": "(namespace: string) => string", - "description": "The **`lookupPrefix()`** method of the Node interface returns a string containing the prefix for a given namespace URI, if present, and `null` if not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupPrefix)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "matches", - "value": "(selectors: string) => boolean", - "description": "The **`matches()`** method of the Element interface tests whether the element would be selected by the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "namespaceURI", - "value": "string | null", - "description": "The **`Element.namespaceURI`** read-only property returns the namespace URI of the element, or `null` if the element is not in a namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/namespaceURI)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "nextElementSibling", - "value": "Element | null", - "description": "Returns the first following sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/nextElementSibling)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "nextSibling", - "value": "ChildNode | null", - "description": "The read-only **`nextSibling`** property of the Node interface returns the node immediately following the specified one in their parent's Node.childNodes, or returns `null` if the specified node is the last child in the parent element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nextSibling)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "nodeName", - "value": "string", - "description": "The read-only **`nodeName`** property of Node returns the name of the current node as a string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeName)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "nodeType", - "value": "number", - "description": "The read-only **`nodeType`** property of a Node interface is an integer that identifies what the node is.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeType)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "nodeValue", - "value": "string | null", - "description": "The **`nodeValue`** property of the Node interface returns or sets the value of the current node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeValue)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "nonce", - "value": "string", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/nonce)", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "normalize", - "value": "() => void", - "description": "The **`normalize()`** method of the Node interface puts the specified node and all of its sub-tree into a _normalized_ form.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/normalize)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "NOTATION_NODE", - "value": "12", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "offsetHeight", - "value": "number", - "description": "The **`offsetHeight`** read-only property of the HTMLElement interface returns the height of an element, including vertical padding and borders, as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetHeight)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "offsetLeft", - "value": "number", - "description": "The **`offsetLeft`** read-only property of the HTMLElement interface returns the number of pixels that the _upper left corner_ of the current element is offset to the left within the HTMLElement.offsetParent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetLeft)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "offsetParent", - "value": "Element | null", - "description": "The **`HTMLElement.offsetParent`** read-only property returns a reference to the element which is the closest (nearest in the containment hierarchy) positioned ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetParent)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "offsetTop", - "value": "number", - "description": "The **`offsetTop`** read-only property of the HTMLElement interface returns the distance from the outer border of the current element (including its margin) to the top padding edge of the HTMLelement.offsetParent, the _closest positioned_ ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetTop)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "offsetWidth", - "value": "number", - "description": "The **`offsetWidth`** read-only property of the HTMLElement interface returns the layout width of an element as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetWidth)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "onabort", - "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/abort_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "onanimationcancel", - "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationcancel_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "onanimationend", - "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "onanimationiteration", - "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "onanimationstart", - "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "onauxclick", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/auxclick_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "onbeforeinput", - "value": "((this: GlobalEventHandlers, ev: InputEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforeinput_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "onbeforematch", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforematch_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "onbeforetoggle", - "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/beforetoggle_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "onblur", - "value": "((this: GlobalEventHandlers, ev: FocusEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/blur_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "oncancel", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/cancel_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "oncanplay", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplay_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "oncanplaythrough", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplaythrough_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "onchange", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/change_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "onclick", - "value": "(event: Event) => void", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "onclose", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/close_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "oncontextlost", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextlost_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "oncontextmenu", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/contextmenu_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "oncontextrestored", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextrestored_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "oncopy", - "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/copy_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "oncuechange", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLTrackElement/cuechange_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "oncut", - "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/cut_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "ondblclick", - "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/dblclick_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "ondrag", - "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drag_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "ondragend", - "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragend_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "ondragenter", - "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragenter_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "ondragleave", - "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragleave_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "ondragover", - "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragover_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "ondragstart", - "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragstart_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "ondrop", - "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drop_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "ondurationchange", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/durationchange_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "onemptied", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/emptied_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "onended", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ended_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "onerror", - "value": "OnErrorEventHandler", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/error_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "onfocus", - "value": "((this: GlobalEventHandlers, ev: FocusEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/focus_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "onformdata", - "value": "((this: GlobalEventHandlers, ev: FormDataEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/formdata_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "onfullscreenchange", - "value": "((this: Element, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenchange_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "onfullscreenerror", - "value": "((this: Element, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenerror_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "ongotpointercapture", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/gotpointercapture_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "oninput", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/input_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "oninvalid", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/invalid_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "onkeydown", - "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keydown_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "onkeypress", - "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", - "description": "", - "deprecationMessage": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keypress_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "onkeyup", - "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keyup_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "onload", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/load_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "onloadeddata", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadeddata_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "onloadedmetadata", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadedmetadata_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "onloadstart", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadstart_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "onlostpointercapture", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/lostpointercapture_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "onmousedown", - "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousedown_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "onmouseenter", - "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseenter_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "onmouseleave", - "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseleave_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "onmousemove", - "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousemove_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "onmouseout", - "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseout_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "onmouseover", - "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseover_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "onmouseup", - "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseup_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "onpaste", - "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/paste_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "onpause", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/pause_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "onplay", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/play_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "onplaying", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/playing_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "onpointercancel", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointercancel_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "onpointerdown", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerdown_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "onpointerenter", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerenter_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "onpointerleave", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerleave_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "onpointermove", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointermove_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "onpointerout", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerout_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "onpointerover", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerover_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "onpointerrawupdate", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "Available only in secure contexts.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerrawupdate_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "onpointerup", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerup_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "onprogress", - "value": "((this: GlobalEventHandlers, ev: ProgressEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/progress_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "onratechange", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ratechange_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "onreset", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/reset_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "onresize", - "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLVideoElement/resize_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "onscroll", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scroll_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "onscrollend", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scrollend_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "onsecuritypolicyviolation", - "value": "((this: GlobalEventHandlers, ev: SecurityPolicyViolationEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/securitypolicyviolation_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "onseeked", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeked_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "onseeking", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeking_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "onselect", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/select_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "onselectionchange", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/selectionchange_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "onselectstart", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/selectstart_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "onslotchange", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLSlotElement/slotchange_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "onstalled", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/stalled_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "onsubmit", - "value": "((this: GlobalEventHandlers, ev: SubmitEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/submit_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "onsuspend", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/suspend_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "ontimeupdate", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/timeupdate_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "ontoggle", - "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/toggle_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "ontouchcancel", - "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchcancel_event)", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "ontouchend", - "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchend_event)", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "ontouchmove", - "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchmove_event)", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "ontouchstart", - "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchstart_event)", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "ontransitioncancel", - "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitioncancel_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "ontransitionend", - "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "ontransitionrun", - "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionrun_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "ontransitionstart", - "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionstart_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "onvolumechange", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/volumechange_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "onwaiting", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/waiting_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "onwebkitanimationend", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "", - "deprecationMessage": "This is a legacy alias of `onanimationend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "onwebkitanimationiteration", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "", - "deprecationMessage": "This is a legacy alias of `onanimationiteration`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "onwebkitanimationstart", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "", - "deprecationMessage": "This is a legacy alias of `onanimationstart`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "onwebkittransitionend", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "", - "deprecationMessage": "This is a legacy alias of `ontransitionend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "onwheel", - "value": "((this: GlobalEventHandlers, ev: WheelEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/wheel_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "outerHTML", - "value": "string", - "description": "The **`outerHTML`** attribute of the Element DOM interface gets the serialized HTML fragment describing the element including its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/outerHTML)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "outerText", - "value": "string", - "description": "The **`outerText`** property of the HTMLElement interface returns the same value as HTMLElement.innerText.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/outerText)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "ownerDocument", - "value": "Document", - "description": "The read-only **`ownerDocument`** property of the Node interface returns the top-level document object of the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/ownerDocument)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "parentElement", - "value": "HTMLElement | null", - "description": "The read-only **`parentElement`** property of Node interface returns the DOM node's parent Element, or `null` if the node either has no parent, or its parent isn't a DOM Element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentElement)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "parentNode", - "value": "ParentNode | null", - "description": "The read-only **`parentNode`** property of the Node interface returns the parent of the specified node in the DOM tree.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentNode)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "GetAccessor", - "name": "part", - "value": "DOMTokenList", - "description": "The **`part`** property of the Element interface represents the part identifier(s) of the element (i.e., set using the `part` attribute), returned as a DOMTokenList.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/part)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "popover", - "value": "string | null", - "description": "The **`popover`** property of the HTMLElement interface gets and sets an element's popover state via JavaScript (`'auto'`, `'hint'`, or `'manual'`), and can be used for feature detection.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/popover)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "prefix", - "value": "string | null", - "description": "The **`Element.prefix`** read-only property returns the namespace prefix of the specified element, or `null` if no prefix is specified.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/prefix)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "prepend", - "value": "(...nodes: (string | Node)[]) => void", - "description": "Inserts nodes before the first child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/prepend)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "previousElementSibling", - "value": "Element | null", - "description": "Returns the first preceding sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/previousElementSibling)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "previousSibling", - "value": "ChildNode | null", - "description": "The read-only **`previousSibling`** property of the Node interface returns the node immediately preceding the specified one in its parent's or `null` if the specified node is the first in that list.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/previousSibling)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "PROCESSING_INSTRUCTION_NODE", - "value": "7", - "description": "node is a ProcessingInstruction node." - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "querySelector", - "value": "{ (selectors: K): HTMLElementTagNameMap[K]; (selectors: K): SVGElementTagNameMap[K]; (selectors: K): MathMLElementTagNameMap[K]; (selectors: K): HTMLElementDeprecatedTagNameMap[K]; (selectors: string): E; }", - "description": "Returns the first element that is a descendant of node that matches selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelector)", - "deprecationMessage": "Deprecated" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "querySelectorAll", - "value": "{ (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: string): NodeListOf; }", - "description": "Returns all element descendants of node that match selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelectorAll)", - "deprecationMessage": "Deprecated" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "releasePointerCapture", - "value": "(pointerId: number) => void", - "description": "The **`releasePointerCapture()`** method of the previously set for a specific (PointerEvent) _pointer_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/releasePointerCapture)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "remove", - "value": "() => void", - "description": "Removes node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/remove)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "removeAttribute", - "value": "(qualifiedName: string) => void", - "description": "The Element method **`removeAttribute()`** removes the attribute with the specified name from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttribute)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "removeAttributeNode", - "value": "(attr: Attr) => Attr", - "description": "The **`removeAttributeNode()`** method of the Element interface removes the specified Attr node from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNode)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "removeAttributeNS", - "value": "(namespace: string, localName: string) => void", - "description": "The **`removeAttributeNS()`** method of the If you are working with HTML and you don't need to specify the requested attribute as being part of a specific namespace, use the Element.removeAttribute() method instead.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNS)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "removeChild", - "value": "(child: T) => T", - "description": "The **`removeChild()`** method of the Node interface removes a child node from the DOM and returns the removed node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/removeChild)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "removeEventListener", - "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "replaceChild", - "value": "(node: Node, child: T) => T", - "description": "The **`replaceChild()`** method of the Node interface replaces a child node within the given (parent) node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/replaceChild)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "replaceChildren", - "value": "(...nodes: (string | Node)[]) => void", - "description": "Replace all children of node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/replaceChildren)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "replaceWith", - "value": "(...nodes: (string | Node)[]) => void", - "description": "Replaces node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/replaceWith)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "requestFullscreen", - "value": "(options?: FullscreenOptions) => Promise", - "description": "The **`Element.requestFullscreen()`** method issues an asynchronous request to make the element be displayed in fullscreen mode.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestFullscreen)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "requestPointerLock", - "value": "(options?: PointerLockOptions) => Promise", - "description": "The **`requestPointerLock()`** method of the Element interface lets you asynchronously ask for the pointer to be locked on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestPointerLock)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "role", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/role)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "scroll", - "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", - "description": "The **`scroll()`** method of the Element interface scrolls the element to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scroll)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "scrollBy", - "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", - "description": "The **`scrollBy()`** method of the Element interface scrolls an element by the given amount.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollBy)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "scrollHeight", - "value": "number", - "description": "The **`scrollHeight`** read-only property of the Element interface is a measurement of the height of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollHeight)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "scrollIntoView", - "value": "(arg?: boolean | ScrollIntoViewOptions) => void", - "description": "The Element interface's **`scrollIntoView()`** method scrolls the element's ancestor containers such that the element on which `scrollIntoView()` is called is visible to the user.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollIntoView)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "scrollLeft", - "value": "number", - "description": "The **`scrollLeft`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its left edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollLeft)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "scrollTo", - "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", - "description": "The **`scrollTo()`** method of the Element interface scrolls to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTo)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "scrollTop", - "value": "number", - "description": "The **`scrollTop`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its top edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTop)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "scrollWidth", - "value": "number", - "description": "The **`scrollWidth`** read-only property of the Element interface is a measurement of the width of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollWidth)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "setAttribute", - "value": "(qualifiedName: string, value: string) => void", - "description": "The **`setAttribute()`** method of the Element interface sets the value of an attribute on the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttribute)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "setAttributeNode", - "value": "(attr: Attr) => Attr", - "description": "The **`setAttributeNode()`** method of the Element interface adds a new Attr node to the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNode)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "setAttributeNodeNS", - "value": "(attr: Attr) => Attr", - "description": "The **`setAttributeNodeNS()`** method of the Element interface adds a new namespaced Attr node to an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNodeNS)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "setAttributeNS", - "value": "(namespace: string, qualifiedName: string, value: string) => void", - "description": "`setAttributeNS` adds a new attribute or changes the value of an attribute with the given namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNS)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "setHTMLUnsafe", - "value": "(html: string) => void", - "description": "The **`setHTMLUnsafe()`** method of the Element interface is used to parse a string of HTML into a DocumentFragment, optionally filtering out unwanted elements and attributes, and those that don't belong in the context, and then using it to replace the element's subtree in the DOM.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setHTMLUnsafe)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "setPointerCapture", - "value": "(pointerId: number) => void", - "description": "The **`setPointerCapture()`** method of the _capture target_ of future pointer events.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setPointerCapture)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "shadowRoot", - "value": "ShadowRoot | null", - "description": "The `Element.shadowRoot` read-only property represents the shadow root hosted by the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/shadowRoot)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "showPopover", - "value": "() => void", - "description": "The **`showPopover()`** method of the HTMLElement interface shows a Popover_API element (i.e., one that has a valid `popover` attribute) by adding it to the top layer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/showPopover)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "slot", - "value": "string", - "description": "The **`slot`** property of the Element interface returns the name of the shadow DOM slot the element is inserted in.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/slot)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "spellcheck", - "value": "boolean", - "description": "The **`spellcheck`** property of the HTMLElement interface represents a boolean value that controls the spell-checking hint.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/spellcheck)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "GetAccessor", - "name": "style", - "value": "CSSStyleDeclaration", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/style)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "tabIndex", - "value": "number", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/tabIndex)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "tagName", - "value": "string", - "description": "The **`tagName`** read-only property of the Element interface returns the tag name of the element on which it's called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/tagName)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "'auto' | '_blank'", - "description": "Specifies where to display the linked URL.", - "isOptional": true, - "defaultValue": "'auto'" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "TEXT_NODE", - "value": "3", - "description": "node is a Text node." - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "GetAccessor", - "name": "textContent", - "value": "string", - "description": "[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/Node/textContent)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The **`HTMLElement.title`** property represents the title of the element: the text usually displayed in a 'tooltip' popup when the mouse is over the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/title)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "toggleAttribute", - "value": "(qualifiedName: string, force?: boolean) => boolean", - "description": "The **`toggleAttribute()`** method of the present and adding it if it is not present) on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/toggleAttribute)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "togglePopover", - "value": "(options?: boolean) => boolean", - "description": "The **`togglePopover()`** method of the HTMLElement interface toggles a Popover_API element (i.e., one that has a valid `popover` attribute) between the hidden and showing states.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/togglePopover)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "tone", - "value": "'auto' | 'neutral' | 'critical'", - "description": "The semantic meaning and color treatment of the button.\n\n- `'auto'`: Automatically determined based on context.\n- `'neutral'`: General information without specific intent.\n- `'critical'`: Urgent problems or destructive actions.", - "isOptional": true, - "defaultValue": "'auto'" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "translate", - "value": "boolean", - "description": "The **`translate`** property of the HTMLElement interface indicates whether an element's attribute values and the values of its Text node children are to be translated when the page is localized, or whether to leave them unchanged.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/translate)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'submit' | 'button'", - "description": "The behavioral type of the button component, which determines what action it performs when activated.\n\n- `submit`: Submits the closest form.\n- `button`: Performs no default action when activated.\n- `reset`: Resets the closest form (returning fields to their default values).\n\nThis property is ignored if the component supports `href` or `commandFor`/`command` and one of them is set.", - "isOptional": true, - "defaultValue": "'button'" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "variant", - "value": "'auto' | 'primary' | 'secondary'", - "description": "The visual style variant of the button component, which controls its prominence and emphasis.\n\n- `'auto'`: Automatically determined by the button's context.\n- `'primary'`: High-emphasis style for the main action.\n- `'secondary'`: Medium-emphasis style for supporting actions.\n- `'tertiary'`: Low-emphasis style for less prominent actions.", - "isOptional": true, - "defaultValue": "'auto'" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "MethodSignature", - "name": "webkitMatchesSelector", - "value": "(selectors: string) => boolean", - "description": "", - "deprecationMessage": "This is a legacy alias of `matches`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "writingSuggestions", - "value": "string", - "description": "The **`writingSuggestions`** property of the HTMLElement interface is a string indicating if browser-provided writing suggestions should be enabled under the scope of the element or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/writingSuggestions)" - } - ], - "value": "export interface ButtonElement extends ButtonElementProps, Omit {\n onclick: ButtonEvents['onClick'];\n}" - } - }, - "ButtonProps": { - "src/surfaces/checkout/components/Button.ts": { - "filePath": "src/surfaces/checkout/components/Button.ts", - "name": "ButtonProps", - "description": "", - "isPublicDocs": true, - "members": [ - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "A label that describes the purpose or content of the button for users of assistive technologies such as screen readers. Use this when the visible content alone doesn't provide enough context.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "command", - "value": "'--auto' | '--show' | '--hide' | '--toggle' | '--copy'", - "description": "Sets the action the `commandFor` should take when this clickable is activated.\n\nSee the documentation of particular components for the actions they support.\n\n- `--auto`: Performs the default action for the target component.\n- `--show`: Displays the target component.\n- `--hide`: Conceals the target component.\n- `--toggle`: Alternates the target component.\n- `--copy`: Copies the target ClipboardItem.", - "isOptional": true, - "defaultValue": "'--auto'" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "commandFor", - "value": "string", - "description": "ID of a component that should respond to activations (such as clicks) on this component.\n\nSee `command` for how to control the behavior of the target.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "Whether the button is disabled, preventing it from being clicked or receiving focus.", - "isOptional": true, - "defaultValue": "false" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "href", - "value": "string", - "description": "The URL to navigate to when clicked. The `click` event fires first, then navigation occurs.\n\n- If set, it will navigate to the location specified by `href` after executing the `click` event.\n- If a `commandFor` is set, the `command` will be executed instead of the navigation.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the element.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "inlineSize", - "value": "'auto' | 'fill' | 'fit-content'", - "description": "The inline width of the button component.\n\n- `auto`: The size depends on the surface and context.\n- `fill`: The button takes up 100% of the available inline size.\n- `fit-content`: The button takes up the minimum inline-size required to fit its content.", - "isOptional": true, - "defaultValue": "'auto'" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "interestFor", - "value": "string", - "description": "The ID of the component to show when users hover over or focus on this component. Pair with a target component that supports interest-based interactions. Learn more about the [interestFor attribute](https://open-ui.org/components/interest-invokers.explainer/#the-pitch-in-code).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "loading", - "value": "boolean", - "description": "Whether the button is in a loading state, which replaces the button content with a loading indicator while a background action is being performed.\n\nThis also disables the button.", - "isOptional": true, - "defaultValue": "false" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "onClick", - "value": "(event: Event) => void", - "description": "A callback fired when the button is activated, before performing the action indicated by `type`. Learn more about the [click event](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "'auto' | '_blank'", - "description": "Specifies where to display the linked URL.", - "isOptional": true, - "defaultValue": "'auto'" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "tone", - "value": "'auto' | 'neutral' | 'critical'", - "description": "The semantic meaning and color treatment of the button.\n\n- `'auto'`: Automatically determined based on context.\n- `'neutral'`: General information without specific intent.\n- `'critical'`: Urgent problems or destructive actions.", - "isOptional": true, - "defaultValue": "'auto'" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'submit' | 'button'", - "description": "The behavioral type of the button component, which determines what action it performs when activated.\n\n- `submit`: Submits the closest form.\n- `button`: Performs no default action when activated.\n- `reset`: Resets the closest form (returning fields to their default values).\n\nThis property is ignored if the component supports `href` or `commandFor`/`command` and one of them is set.", - "isOptional": true, - "defaultValue": "'button'" - }, - { - "filePath": "src/surfaces/checkout/components/Button.ts", - "syntaxKind": "PropertySignature", - "name": "variant", - "value": "'auto' | 'primary' | 'secondary'", - "description": "The visual style variant of the button component, which controls its prominence and emphasis.\n\n- `'auto'`: Automatically determined by the button's context.\n- `'primary'`: High-emphasis style for the main action.\n- `'secondary'`: Medium-emphasis style for supporting actions.\n- `'tertiary'`: Low-emphasis style for less prominent actions.", - "isOptional": true, - "defaultValue": "'auto'" - } - ], - "value": "export interface ButtonProps extends ButtonElementProps, ButtonEvents {\n}" - }, - "src/surfaces/customer-account/api/docs.ts": { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "name": "ButtonProps", - "description": "", - "members": [ - { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "A label that describes the purpose or contents of the Button. It will be read to users using assistive technologies such as screen readers.\n\nUse this when using only an icon or the button text is not enough context for users using assistive technologies.", - "isOptional": true - }, - { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "syntaxKind": "PropertySignature", - "name": "click", - "value": "((event: CallbackEventListener) => void) | null", - "description": "Callback when the button is activated. This will be called before the action indicated by `type`.", - "isOptional": true - }, - { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "syntaxKind": "PropertySignature", - "name": "command", - "value": "'--auto' | '--show' | '--hide' | '--toggle' | '--copy'", - "description": "Sets the action the `commandFor` should take when this clickable is activated.\n\nSee the documentation of particular components for the actions they support.\n\n- `--auto`: a default action for the target component.\n- `--show`: shows the target component.\n- `--hide`: hides the target component.\n- `--toggle`: toggles the target component.\n- `--copy`: copies the target ClipboardItem.", - "isOptional": true, - "defaultValue": "'--auto'" - }, - { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "syntaxKind": "PropertySignature", - "name": "commandFor", - "value": "string", - "description": "ID of a component that should respond to activations (e.g. clicks) on this component.\n\nSee `command` for how to control the behavior of the target.", - "isOptional": true - }, - { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "Disables the button, disallowing any interaction.", - "isOptional": true, - "defaultValue": "false" - }, - { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "syntaxKind": "PropertySignature", - "name": "href", - "value": "string", - "description": "The URL to link to.\n\n- If set, it will navigate to the location specified by `href` after executing the `onClick` callback.\n- If a `commandFor` is set, the `command` will be executed instead of the navigation.", - "isOptional": true - }, - { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the element.", - "isOptional": true - }, - { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "syntaxKind": "PropertySignature", - "name": "loading", - "value": "boolean", - "description": "Replaces content with a loading indicator.", - "isOptional": true, - "defaultValue": "false" - }, - { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "'auto' | '_self' | '_blank'", - "description": "Specifies where to display the linked URL.", - "isOptional": true, - "defaultValue": "'auto'" - }, - { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "syntaxKind": "PropertySignature", - "name": "tone", - "value": "'auto' | 'neutral' | 'critical'", - "description": "Sets the tone of the Button, based on the intention of the information being conveyed.", - "isOptional": true, - "defaultValue": "'auto'" - }, - { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'button' | 'submit'", - "description": "The behavior of the button.\n\n- `'submit'` - Used to indicate the component acts as a submit button, meaning it submits the closest form.\n- `'button'` - Used to indicate the component acts as a button, meaning it has no default action.\n- `'reset'` - Used to indicate the component acts as a reset button, meaning it resets the closest form (returning fields to their default values).\n\nThis property is ignored if the component supports `href` or `commandFor`/`command` and one of them is set.", - "isOptional": true, - "defaultValue": "'button'" - }, - { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "syntaxKind": "PropertySignature", - "name": "variant", - "value": "'auto' | 'primary' | 'secondary'", - "description": "Changes the visual appearance of the Button.", - "isOptional": true, - "defaultValue": "'auto' - the variant is automatically determined by the Button's context" - } - ], -<<<<<<< HEAD - "value": "interface ButtonProps {\n /**\n * A label that describes the purpose or contents of the Button. It will be read to users using assistive technologies such as screen readers.\n *\n * Use this when using only an icon or the button text is not enough context\n * for users using assistive technologies.\n */\n accessibilityLabel?: string;\n /**\n * ID of a component that should respond to activations (e.g. clicks) on this component.\n *\n * See `command` for how to control the behavior of the target.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#commandfor\n */\n commandFor?: string;\n /**\n * Sets the action the `commandFor` should take when this clickable is activated.\n *\n * See the documentation of particular components for the actions they support.\n *\n * - `--auto`: a default action for the target component.\n * - `--show`: shows the target component.\n * - `--hide`: hides the target component.\n * - `--toggle`: toggles the target component.\n * - `--copy`: copies the target ClipboardItem.\n *\n * @default '--auto'\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command\n */\n command?: '--auto' | '--show' | '--hide' | '--toggle' | '--copy';\n /**\n * Disables the button, disallowing any interaction.\n *\n * @defaultValue false\n */\n disabled?: boolean;\n /**\n * The URL to link to.\n *\n * - If set, it will navigate to the location specified by `href` after executing the `onClick` callback.\n * - If a `commandFor` is set, the `command` will be executed instead of the navigation.\n */\n href?: string;\n /**\n * A unique identifier for the element.\n */\n id?: string;\n /**\n * Replaces content with a loading indicator.\n *\n * @defaultValue false\n */\n loading?: boolean;\n /**\n * Specifies where to display the linked URL.\n * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#target\n *\n * 'auto' - The target is automatically determined based on the origin of the URL. Surfaces can set specific rules on how they handle each URL.\n * It’s expected that the behavior of `auto` is as `_self` except in specific cases.\n * For example, a surface could decide to open cross-origin URLs in a new window (as `_blank`).\n *\n * @default 'auto'\n */\n target?: 'auto' | '_self' | '_blank';\n /**\n * Sets the tone of the Button, based on the intention of the information being conveyed.\n *\n * @default 'auto'\n */\n tone?: 'auto' | 'neutral' | 'critical';\n /**\n * The behavior of the button.\n *\n * - `'submit'` - Used to indicate the component acts as a submit button, meaning it submits the closest form.\n * - `'button'` - Used to indicate the component acts as a button, meaning it has no default action.\n * - `'reset'` - Used to indicate the component acts as a reset button, meaning it resets the closest form (returning fields to their default values).\n *\n * This property is ignored if the component supports `href` or `commandFor`/`command` and one of them is set.\n *\n * @default 'button'\n */\n type?: 'button' | 'submit';\n /**\n * Changes the visual appearance of the Button.\n *\n * @default 'auto' - the variant is automatically determined by the Button's context\n */\n variant?: 'auto' | 'primary' | 'secondary';\n\n /**\n * Callback when the button is activated.\n * This will be called before the action indicated by `type`.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event\n */\n click?: ((event: CallbackEventListener) => void) | null;\n}" - } - }, - "CheckboxElementProps": { - "src/surfaces/checkout/components/Checkbox.ts": { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "name": "CheckboxElementProps", - "description": "Properties for the Checkbox component element.", - "isPublicDocs": true, - "members": [ - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "A label used for users using assistive technologies like screen readers. When set, any children or `label` supplied will not be announced. This can also be used to display a control without a visual label, while still providing context to users using screen readers.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "checked", - "value": "boolean", - "description": "Whether the control is active.", - "isOptional": true, - "defaultValue": "false" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "command", - "value": "'--auto' | '--show' | '--hide' | '--toggle'", - "description": "Sets the action the `commandFor` should take when this clickable is activated.\n\nSee the documentation of particular components for the actions they support.\n\n- `--auto`: Performs the default action for the target component.\n- `--show`: Displays the target component.\n- `--hide`: Conceals the target component.\n- `--toggle`: Alternates the target component.\n- `--copy`: Copies the target ClipboardItem.", - "isOptional": true, - "defaultValue": "'--auto'" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "commandFor", - "value": "string", - "description": "ID of a component that should respond to activations (such as clicks) on this component.\n\nSee `command` for how to control the behavior of the target.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "defaultChecked", - "value": "boolean", - "description": "Whether the control is active by default.", - "isOptional": true, - "defaultValue": "false" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "Disables the control, disallowing any interaction.", - "isOptional": true, - "defaultValue": "false" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "error", - "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the element.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "label", - "value": "string", - "description": "Visual content to use as the control label.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "An identifier for the control that is unique within the nearest containing `Form` component.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "required", - "value": "boolean", - "description": "Whether the field needs a value. This requirement adds semantic value to the field, but it will not cause an error to appear automatically. If you want to present an error when this field is empty, you can do so with the `error` property.", - "isOptional": true, - "defaultValue": "false" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value used in form data when the control is checked.", - "isOptional": true - } - ], - "value": "export interface CheckboxElementProps extends Pick {\n command?: Extract;\n}" - } - }, - "CheckboxEvents": { - "src/surfaces/checkout/components/Checkbox.ts": { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "name": "CheckboxEvents", - "description": "", - "isPublicDocs": true, - "members": [ - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "onChange", - "value": "(event: Event) => void", - "description": "A callback that is run whenever the control is changed.", - "isOptional": true - } - ], - "value": "export interface CheckboxEvents extends Pick {\n}" - } - }, - "CheckboxElementEvents": { - "src/surfaces/checkout/components/Checkbox.ts": { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "name": "CheckboxElementEvents", - "description": "Events for the Checkbox component element.", - "isPublicDocs": true, - "members": [ - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "change", - "value": "CallbackEventListener", - "description": "A callback that is run whenever the control is changed.", - "isOptional": true - } - ], - "value": "export interface CheckboxElementEvents {\n /**\n * A callback that is run whenever the control is changed.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event\n */\n change?: CallbackEventListener;\n}" - } - }, - "CheckboxElement": { - "src/surfaces/checkout/components/Checkbox.ts": { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "name": "CheckboxElement", - "description": "", - "isPublicDocs": true, - "members": [ - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "A label used for users using assistive technologies like screen readers. When set, any children or `label` supplied will not be announced. This can also be used to display a control without a visual label, while still providing context to users using screen readers.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "accessKey", - "value": "string", - "description": "The **`HTMLElement.accessKey`** property sets the keystroke which a user can press to jump to a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKey)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "accessKeyLabel", - "value": "string", - "description": "The **`HTMLElement.accessKeyLabel`** read-only property returns a string containing the element's browser-assigned access key (if any); otherwise it returns an empty string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKeyLabel)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "MethodSignature", - "name": "addEventListener", - "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "MethodSignature", - "name": "after", - "value": "(...nodes: (string | Node)[]) => void", - "description": "Inserts nodes just after node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/after)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "MethodSignature", - "name": "animate", - "value": "(keyframes: Keyframe[] | PropertyIndexedKeyframes, options?: number | KeyframeAnimationOptions) => Animation", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animate)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "MethodSignature", - "name": "append", - "value": "(...nodes: (string | Node)[]) => void", - "description": "Inserts nodes after the last child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/append)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "MethodSignature", - "name": "appendChild", - "value": "(node: T) => T", - "description": "The **`appendChild()`** method of the Node interface adds a node to the end of the list of children of a specified parent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/appendChild)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "ariaActiveDescendantElement", - "value": "Element | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaActiveDescendantElement)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "ariaAtomic", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAtomic)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "ariaAutoComplete", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAutoComplete)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "ariaBrailleLabel", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleLabel)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "ariaBrailleRoleDescription", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleRoleDescription)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "ariaBusy", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBusy)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "ariaChecked", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaChecked)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "ariaColCount", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColCount)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "ariaColIndex", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndex)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "ariaColIndexText", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndexText)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "ariaColSpan", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColSpan)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "ariaControlsElements", - "value": "ReadonlyArray | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaControlsElements)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "ariaCurrent", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaCurrent)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "ariaDescribedByElements", - "value": "ReadonlyArray | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescribedByElements)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "ariaDescription", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescription)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "ariaDetailsElements", - "value": "ReadonlyArray | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDetailsElements)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "ariaDisabled", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDisabled)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "ariaErrorMessageElements", - "value": "ReadonlyArray | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaErrorMessageElements)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "ariaExpanded", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaExpanded)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "ariaFlowToElements", - "value": "ReadonlyArray | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaFlowToElements)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "ariaHasPopup", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHasPopup)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "ariaHidden", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHidden)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "ariaInvalid", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaInvalid)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "ariaKeyShortcuts", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaKeyShortcuts)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "ariaLabel", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabel)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "ariaLabelledByElements", - "value": "ReadonlyArray | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabelledByElements)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "ariaLevel", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLevel)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "ariaLive", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLive)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "ariaModal", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaModal)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "ariaMultiLine", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiLine)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "ariaMultiSelectable", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiSelectable)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "ariaOrientation", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOrientation)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "ariaOwnsElements", - "value": "ReadonlyArray | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOwnsElements)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "ariaPlaceholder", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPlaceholder)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "ariaPosInSet", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPosInSet)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "ariaPressed", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPressed)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "ariaReadOnly", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaReadOnly)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "ariaRelevant", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRelevant)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "ariaRequired", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRequired)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "ariaRoleDescription", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRoleDescription)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "ariaRowCount", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowCount)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "ariaRowIndex", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndex)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "ariaRowIndexText", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndexText)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "ariaRowSpan", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowSpan)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "ariaSelected", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSelected)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "ariaSetSize", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSetSize)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "ariaSort", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSort)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "ariaValueMax", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMax)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "ariaValueMin", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMin)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "ariaValueNow", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueNow)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "ariaValueText", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueText)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "assignedSlot", - "value": "HTMLSlotElement | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/assignedSlot)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "MethodSignature", - "name": "attachInternals", - "value": "() => ElementInternals", - "description": "The **`HTMLElement.attachInternals()`** method returns an ElementInternals object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attachInternals)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "MethodSignature", - "name": "attachShadow", - "value": "(init: ShadowRootInit) => ShadowRoot", - "description": "The **`Element.attachShadow()`** method attaches a shadow DOM tree to the specified element and returns a reference to its ShadowRoot.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attachShadow)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "ATTRIBUTE_NODE", - "value": "2", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "NamedNodeMap", - "description": "The **`Element.attributes`** property returns a live collection of all attribute nodes registered to the specified node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attributes)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "attributeStyleMap", - "value": "StylePropertyMap", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attributeStyleMap)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "autocapitalize", - "value": "string", - "description": "The **`autocapitalize`** property of the HTMLElement interface represents the element's capitalization behavior for user input.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocapitalize)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "autocorrect", - "value": "boolean", - "description": "The **`autocorrect`** property of the HTMLElement interface controls whether or not autocorrection of editable text is enabled for spelling and/or punctuation errors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocorrect)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "autofocus", - "value": "boolean", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autofocus)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "baseURI", - "value": "string", - "description": "The read-only **`baseURI`** property of the Node interface returns the absolute base URL of the document containing the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/baseURI)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "MethodSignature", - "name": "before", - "value": "(...nodes: (string | Node)[]) => void", - "description": "Inserts nodes just before node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/before)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "MethodSignature", - "name": "blur", - "value": "() => void", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/blur)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "CDATA_SECTION_NODE", - "value": "4", - "description": "node is a CDATASection node." - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "checked", - "value": "boolean", - "description": "Whether the control is active.", - "isOptional": true, - "defaultValue": "false" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "MethodSignature", - "name": "checkVisibility", - "value": "(options?: CheckVisibilityOptions) => boolean", - "description": "The **`checkVisibility()`** method of the Element interface checks whether the element is visible.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/checkVisibility)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "childElementCount", - "value": "number", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/childElementCount)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "childNodes", - "value": "NodeListOf", - "description": "The read-only **`childNodes`** property of the Node interface returns a live the first child node is assigned index `0`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/childNodes)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "HTMLCollection", - "description": "Returns the child elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/children)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "GetAccessor", - "name": "classList", - "value": "DOMTokenList", - "description": "The **`Element.classList`** is a read-only property that returns a live DOMTokenList collection of the `class` attributes of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/classList)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "className", - "value": "string", - "description": "The **`className`** property of the of the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/className)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "MethodSignature", - "name": "click", - "value": "() => void", - "description": "The **`HTMLElement.click()`** method simulates a mouse click on an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/click)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "clientHeight", - "value": "number", - "description": "The **`clientHeight`** read-only property of the Element interface is zero for elements with no CSS or inline layout boxes; otherwise, it's the inner height of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientHeight)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "clientLeft", - "value": "number", - "description": "The **`clientLeft`** read-only property of the Element interface returns the width of the left border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientLeft)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "clientTop", - "value": "number", - "description": "The **`clientTop`** read-only property of the Element interface returns the width of the top border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientTop)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "clientWidth", - "value": "number", - "description": "The **`clientWidth`** read-only property of the Element interface is zero for inline elements and elements with no CSS; otherwise, it's the inner width of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientWidth)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "MethodSignature", - "name": "cloneNode", - "value": "(subtree?: boolean) => Node", - "description": "The **`cloneNode()`** method of the Node interface returns a duplicate of the node on which this method was called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/cloneNode)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "MethodSignature", - "name": "closest", - "value": "{ (selector: K): HTMLElementTagNameMap[K]; (selector: K): SVGElementTagNameMap[K]; (selector: K): MathMLElementTagNameMap[K]; (selectors: string): E; }", - "description": "The **`closest()`** method of the Element interface traverses the element and its parents (heading toward the document root) until it finds a node that matches the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/closest)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "command", - "value": "'--auto' | '--show' | '--hide' | '--toggle'", - "description": "Sets the action the `commandFor` should take when this clickable is activated.\n\nSee the documentation of particular components for the actions they support.\n\n- `--auto`: Performs the default action for the target component.\n- `--show`: Displays the target component.\n- `--hide`: Conceals the target component.\n- `--toggle`: Alternates the target component.\n- `--copy`: Copies the target ClipboardItem.", - "isOptional": true, - "defaultValue": "'--auto'" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "commandFor", - "value": "string", - "description": "ID of a component that should respond to activations (such as clicks) on this component.\n\nSee `command` for how to control the behavior of the target.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "COMMENT_NODE", - "value": "8", - "description": "node is a Comment node." - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "MethodSignature", - "name": "compareDocumentPosition", - "value": "(other: Node) => number", - "description": "The **`compareDocumentPosition()`** method of the Node interface reports the position of its argument node relative to the node on which it is called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/compareDocumentPosition)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "MethodSignature", - "name": "computedStyleMap", - "value": "() => StylePropertyMapReadOnly", - "description": "The **`computedStyleMap()`** method of the Element interface returns a StylePropertyMapReadOnly interface which provides a read-only representation of a CSS declaration block that is an alternative to CSSStyleDeclaration.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/computedStyleMap)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "MethodSignature", - "name": "contains", - "value": "(other: Node) => boolean", - "description": "The **`contains()`** method of the Node interface returns a boolean value indicating whether a node is a descendant of a given node, that is the node itself, one of its direct children (Node.childNodes), one of the children's direct children, and so on.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/contains)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "contentEditable", - "value": "string", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/contentEditable)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "currentCSSZoom", - "value": "number", - "description": "The **`currentCSSZoom`** read-only property of the Element interface provides the 'effective' CSS `zoom` of an element, taking into account the zoom applied to the element and all its parent elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/currentCSSZoom)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "dataset", - "value": "DOMStringMap", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dataset)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "defaultChecked", - "value": "boolean", - "description": "Whether the control is active by default.", - "isOptional": true, - "defaultValue": "false" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "dir", - "value": "string", - "description": "The **`HTMLElement.dir`** property indicates the text writing directionality of the content of the current element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dir)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "Disables the control, disallowing any interaction.", - "isOptional": true, - "defaultValue": "false" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "MethodSignature", - "name": "dispatchEvent", - "value": "(event: Event) => boolean", - "description": "The **`dispatchEvent()`** method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/dispatchEvent)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "DOCUMENT_FRAGMENT_NODE", - "value": "11", - "description": "node is a DocumentFragment node." - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "DOCUMENT_NODE", - "value": "9", - "description": "node is a document." - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "DOCUMENT_POSITION_CONTAINED_BY", - "value": "16", - "description": "Set when other is a descendant of node." - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "DOCUMENT_POSITION_CONTAINS", - "value": "8", - "description": "Set when other is an ancestor of node." - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "DOCUMENT_POSITION_DISCONNECTED", - "value": "1", - "description": "Set when node and other are not in the same tree." - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "DOCUMENT_POSITION_FOLLOWING", - "value": "4", - "description": "Set when other is following node." - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC", - "value": "32", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "DOCUMENT_POSITION_PRECEDING", - "value": "2", - "description": "Set when other is preceding node." - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "DOCUMENT_TYPE_NODE", - "value": "10", - "description": "node is a doctype." - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "draggable", - "value": "boolean", - "description": "The **`draggable`** property of the HTMLElement interface gets and sets a Boolean primitive indicating if the element is draggable.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/draggable)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "ELEMENT_NODE", - "value": "1", - "description": "node is an element." - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "enterKeyHint", - "value": "string", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/enterKeyHint)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "ENTITY_NODE", - "value": "6", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "ENTITY_REFERENCE_NODE", - "value": "5", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "error", - "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "firstChild", - "value": "ChildNode | null", - "description": "The read-only **`firstChild`** property of the Node interface returns the node's first child in the tree, or `null` if the node has no children.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/firstChild)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "firstElementChild", - "value": "Element | null", - "description": "Returns the first child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/firstElementChild)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "MethodSignature", - "name": "focus", - "value": "(options?: FocusOptions) => void", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/focus)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "MethodSignature", - "name": "getAnimations", - "value": "(options?: GetAnimationsOptions) => Animation[]", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAnimations)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "MethodSignature", - "name": "getAttribute", - "value": "(qualifiedName: string) => string", - "description": "The **`getAttribute()`** method of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttribute)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "MethodSignature", - "name": "getAttributeNames", - "value": "() => string[]", - "description": "The **`getAttributeNames()`** method of the array.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNames)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "MethodSignature", - "name": "getAttributeNode", - "value": "(qualifiedName: string) => Attr", - "description": "Returns the specified attribute of the specified element, as an Attr node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNode)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "MethodSignature", - "name": "getAttributeNodeNS", - "value": "(namespace: string, localName: string) => Attr", - "description": "The **`getAttributeNodeNS()`** method of the Element interface returns the namespaced Attr node of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNodeNS)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "MethodSignature", - "name": "getAttributeNS", - "value": "(namespace: string, localName: string) => string", - "description": "The **`getAttributeNS()`** method of the Element interface returns the string value of the attribute with the specified namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNS)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "MethodSignature", - "name": "getBoundingClientRect", - "value": "() => DOMRect", - "description": "The **`Element.getBoundingClientRect()`** method returns a position relative to the viewport.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getBoundingClientRect)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "MethodSignature", - "name": "getClientRects", - "value": "() => DOMRectList", - "description": "The **`getClientRects()`** method of the Element interface returns a collection of DOMRect objects that indicate the bounding rectangles for each CSS border box in a client.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getClientRects)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "MethodSignature", - "name": "getElementsByClassName", - "value": "(classNames: string) => HTMLCollectionOf", - "description": "The Element method **`getElementsByClassName()`** returns a live specified class name or names.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByClassName)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "MethodSignature", - "name": "getElementsByTagName", - "value": "{ (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: string): HTMLCollectionOf; }", - "description": "The **`Element.getElementsByTagName()`** method returns a live All descendants of the specified element are searched, but not the element itself.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagName)", - "deprecationMessage": "Deprecated" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "MethodSignature", - "name": "getElementsByTagNameNS", - "value": "{ (namespaceURI: \"http://www.w3.org/1999/xhtml\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/2000/svg\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/1998/Math/MathML\", localName: string): HTMLCollectionOf; (namespace: string, localName: string): HTMLCollectionOf; }", - "description": "The **`Element.getElementsByTagNameNS()`** method returns a live HTMLCollection of elements with the given tag name belonging to the given namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagNameNS)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "MethodSignature", - "name": "getHTML", - "value": "(options?: GetHTMLOptions) => string", - "description": "The **`getHTML()`** method of the Element interface is used to serialize an element's DOM to an HTML string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getHTML)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "MethodSignature", - "name": "getRootNode", - "value": "(options?: GetRootNodeOptions) => Node", - "description": "The **`getRootNode()`** method of the Node interface returns the context object's root, which optionally includes the shadow root if it is available.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/getRootNode)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "MethodSignature", - "name": "hasAttribute", - "value": "(qualifiedName: string) => boolean", - "description": "The **`Element.hasAttribute()`** method returns a **Boolean** value indicating whether the specified element has the specified attribute or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttribute)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "MethodSignature", - "name": "hasAttributeNS", - "value": "(namespace: string, localName: string) => boolean", - "description": "The **`hasAttributeNS()`** method of the Element interface returns a boolean value indicating whether the current element has the specified attribute with the specified namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributeNS)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "MethodSignature", - "name": "hasAttributes", - "value": "() => boolean", - "description": "The **`hasAttributes()`** method of the Element interface returns a boolean value indicating whether the current element has any attributes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributes)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "MethodSignature", - "name": "hasChildNodes", - "value": "() => boolean", - "description": "The **`hasChildNodes()`** method of the Node interface returns a boolean value indicating whether the given Node has child nodes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/hasChildNodes)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "MethodSignature", - "name": "hasPointerCapture", - "value": "(pointerId: number) => boolean", - "description": "The **`hasPointerCapture()`** method of the pointer capture for the pointer identified by the given pointer ID.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasPointerCapture)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "hidden", - "value": "boolean", - "description": "The HTMLElement property **`hidden`** reflects the value of the element's `hidden` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidden)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "MethodSignature", - "name": "hidePopover", - "value": "() => void", - "description": "The **`hidePopover()`** method of the HTMLElement interface hides a popover element (i.e., one that has a valid `popover` attribute) by removing it from the top layer and styling it with `display: none`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidePopover)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the element.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "inert", - "value": "boolean", - "description": "The HTMLElement property **`inert`** reflects the value of the element's `inert` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inert)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "innerHTML", - "value": "string", - "description": "The **`innerHTML`** property of the Element interface gets or sets the HTML or XML markup contained within the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/innerHTML)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "innerText", - "value": "string", - "description": "The **`innerText`** property of the HTMLElement interface represents the rendered text content of a node and its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/innerText)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "inputMode", - "value": "string", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inputMode)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "MethodSignature", - "name": "insertAdjacentElement", - "value": "(where: InsertPosition, element: Element) => Element", - "description": "The **`insertAdjacentElement()`** method of the relative to the element it is invoked upon.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentElement)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "MethodSignature", - "name": "insertAdjacentHTML", - "value": "(position: InsertPosition, string: string) => void", - "description": "The **`insertAdjacentHTML()`** method of the the resulting nodes into the DOM tree at a specified position.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentHTML)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "MethodSignature", - "name": "insertAdjacentText", - "value": "(where: InsertPosition, data: string) => void", - "description": "The **`insertAdjacentText()`** method of the Element interface, given a relative position and a string, inserts a new text node at the given position relative to the element it is called from.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentText)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "MethodSignature", - "name": "insertBefore", - "value": "(node: T, child: Node) => T", - "description": "The **`insertBefore()`** method of the Node interface inserts a node before a _reference node_ as a child of a specified _parent node_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/insertBefore)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "isConnected", - "value": "boolean", - "description": "The read-only **`isConnected`** property of the Node interface returns a boolean indicating whether the node is connected (directly or indirectly) to a Document object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isConnected)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "isContentEditable", - "value": "boolean", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/isContentEditable)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "MethodSignature", - "name": "isDefaultNamespace", - "value": "(namespace: string) => boolean", - "description": "The **`isDefaultNamespace()`** method of the Node interface accepts a namespace URI as an argument.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isDefaultNamespace)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "MethodSignature", - "name": "isEqualNode", - "value": "(otherNode: Node) => boolean", - "description": "The **`isEqualNode()`** method of the Node interface tests whether two nodes are equal.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isEqualNode)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "MethodSignature", - "name": "isSameNode", - "value": "(otherNode: Node) => boolean", - "description": "The **`isSameNode()`** method of the Node interface is a legacy alias the for the `===` strict equality operator.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isSameNode)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "label", - "value": "string", - "description": "Visual content to use as the control label.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "lang", - "value": "string", - "description": "The **`lang`** property of the HTMLElement interface indicates the base language of an element's attribute values and text content, in the form of a MISSING: RFC(5646, 'BCP 47 language identifier tag')].\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/lang)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "lastChild", - "value": "ChildNode | null", - "description": "The read-only **`lastChild`** property of the Node interface returns the last child of the node, or `null` if there are no child nodes.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lastChild)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "lastElementChild", - "value": "Element | null", - "description": "Returns the last child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/lastElementChild)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "localName", - "value": "string", - "description": "The **`Element.localName`** read-only property returns the local part of the qualified name of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/localName)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "MethodSignature", - "name": "lookupNamespaceURI", - "value": "(prefix: string) => string", - "description": "The **`lookupNamespaceURI()`** method of the Node interface takes a prefix as parameter and returns the namespace URI associated with it on the given node if found (and `null` if not).\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupNamespaceURI)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "MethodSignature", - "name": "lookupPrefix", - "value": "(namespace: string) => string", - "description": "The **`lookupPrefix()`** method of the Node interface returns a string containing the prefix for a given namespace URI, if present, and `null` if not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupPrefix)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "MethodSignature", - "name": "matches", - "value": "(selectors: string) => boolean", - "description": "The **`matches()`** method of the Element interface tests whether the element would be selected by the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "An identifier for the control that is unique within the nearest containing `Form` component.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "namespaceURI", - "value": "string | null", - "description": "The **`Element.namespaceURI`** read-only property returns the namespace URI of the element, or `null` if the element is not in a namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/namespaceURI)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "nextElementSibling", - "value": "Element | null", - "description": "Returns the first following sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/nextElementSibling)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "nextSibling", - "value": "ChildNode | null", - "description": "The read-only **`nextSibling`** property of the Node interface returns the node immediately following the specified one in their parent's Node.childNodes, or returns `null` if the specified node is the last child in the parent element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nextSibling)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "nodeName", - "value": "string", - "description": "The read-only **`nodeName`** property of Node returns the name of the current node as a string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeName)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "nodeType", - "value": "number", - "description": "The read-only **`nodeType`** property of a Node interface is an integer that identifies what the node is.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeType)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "nodeValue", - "value": "string | null", - "description": "The **`nodeValue`** property of the Node interface returns or sets the value of the current node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeValue)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "nonce", - "value": "string", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/nonce)", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "MethodSignature", - "name": "normalize", - "value": "() => void", - "description": "The **`normalize()`** method of the Node interface puts the specified node and all of its sub-tree into a _normalized_ form.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/normalize)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "NOTATION_NODE", - "value": "12", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "offsetHeight", - "value": "number", - "description": "The **`offsetHeight`** read-only property of the HTMLElement interface returns the height of an element, including vertical padding and borders, as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetHeight)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "offsetLeft", - "value": "number", - "description": "The **`offsetLeft`** read-only property of the HTMLElement interface returns the number of pixels that the _upper left corner_ of the current element is offset to the left within the HTMLElement.offsetParent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetLeft)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "offsetParent", - "value": "Element | null", - "description": "The **`HTMLElement.offsetParent`** read-only property returns a reference to the element which is the closest (nearest in the containment hierarchy) positioned ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetParent)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "offsetTop", - "value": "number", - "description": "The **`offsetTop`** read-only property of the HTMLElement interface returns the distance from the outer border of the current element (including its margin) to the top padding edge of the HTMLelement.offsetParent, the _closest positioned_ ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetTop)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "offsetWidth", - "value": "number", - "description": "The **`offsetWidth`** read-only property of the HTMLElement interface returns the layout width of an element as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetWidth)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "onabort", - "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/abort_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "onanimationcancel", - "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationcancel_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "onanimationend", - "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "onanimationiteration", - "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "onanimationstart", - "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "onauxclick", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/auxclick_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "onbeforeinput", - "value": "((this: GlobalEventHandlers, ev: InputEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforeinput_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "onbeforematch", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforematch_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "onbeforetoggle", - "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/beforetoggle_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "onblur", - "value": "((this: GlobalEventHandlers, ev: FocusEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/blur_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "oncancel", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/cancel_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "oncanplay", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplay_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "oncanplaythrough", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplaythrough_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "onchange", - "value": "(event: Event) => void", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "onclick", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/click_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "onclose", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/close_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "oncontextlost", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextlost_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "oncontextmenu", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/contextmenu_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "oncontextrestored", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextrestored_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "oncopy", - "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/copy_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "oncuechange", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLTrackElement/cuechange_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "oncut", - "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/cut_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "ondblclick", - "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/dblclick_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "ondrag", - "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drag_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "ondragend", - "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragend_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "ondragenter", - "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragenter_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "ondragleave", - "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragleave_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "ondragover", - "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragover_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "ondragstart", - "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragstart_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "ondrop", - "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drop_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "ondurationchange", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/durationchange_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "onemptied", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/emptied_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "onended", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ended_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "onerror", - "value": "OnErrorEventHandler", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/error_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "onfocus", - "value": "((this: GlobalEventHandlers, ev: FocusEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/focus_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "onformdata", - "value": "((this: GlobalEventHandlers, ev: FormDataEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/formdata_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "onfullscreenchange", - "value": "((this: Element, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenchange_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "onfullscreenerror", - "value": "((this: Element, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenerror_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "ongotpointercapture", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/gotpointercapture_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "oninput", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/input_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "oninvalid", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/invalid_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "onkeydown", - "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keydown_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "onkeypress", - "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", - "description": "", - "deprecationMessage": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keypress_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "onkeyup", - "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keyup_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "onload", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/load_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "onloadeddata", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadeddata_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "onloadedmetadata", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadedmetadata_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "onloadstart", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadstart_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "onlostpointercapture", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/lostpointercapture_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "onmousedown", - "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousedown_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "onmouseenter", - "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseenter_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "onmouseleave", - "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseleave_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "onmousemove", - "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousemove_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "onmouseout", - "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseout_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "onmouseover", - "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseover_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "onmouseup", - "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseup_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "onpaste", - "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/paste_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "onpause", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/pause_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "onplay", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/play_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "onplaying", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/playing_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "onpointercancel", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointercancel_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "onpointerdown", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerdown_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "onpointerenter", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerenter_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "onpointerleave", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerleave_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "onpointermove", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointermove_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "onpointerout", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerout_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "onpointerover", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerover_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "onpointerrawupdate", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "Available only in secure contexts.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerrawupdate_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "onpointerup", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerup_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "onprogress", - "value": "((this: GlobalEventHandlers, ev: ProgressEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/progress_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "onratechange", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ratechange_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "onreset", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/reset_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "onresize", - "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLVideoElement/resize_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "onscroll", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scroll_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "onscrollend", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scrollend_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "onsecuritypolicyviolation", - "value": "((this: GlobalEventHandlers, ev: SecurityPolicyViolationEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/securitypolicyviolation_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "onseeked", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeked_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "onseeking", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeking_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "onselect", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/select_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "onselectionchange", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/selectionchange_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "onselectstart", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/selectstart_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "onslotchange", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLSlotElement/slotchange_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "onstalled", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/stalled_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "onsubmit", - "value": "((this: GlobalEventHandlers, ev: SubmitEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/submit_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "onsuspend", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/suspend_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "ontimeupdate", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/timeupdate_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "ontoggle", - "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/toggle_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "ontouchcancel", - "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchcancel_event)", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "ontouchend", - "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchend_event)", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "ontouchmove", - "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchmove_event)", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "ontouchstart", - "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchstart_event)", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "ontransitioncancel", - "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitioncancel_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "ontransitionend", - "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "ontransitionrun", - "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionrun_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "ontransitionstart", - "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionstart_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "onvolumechange", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/volumechange_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "onwaiting", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/waiting_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "onwebkitanimationend", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "", - "deprecationMessage": "This is a legacy alias of `onanimationend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "onwebkitanimationiteration", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "", - "deprecationMessage": "This is a legacy alias of `onanimationiteration`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "onwebkitanimationstart", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "", - "deprecationMessage": "This is a legacy alias of `onanimationstart`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "onwebkittransitionend", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "", - "deprecationMessage": "This is a legacy alias of `ontransitionend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "onwheel", - "value": "((this: GlobalEventHandlers, ev: WheelEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/wheel_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "outerHTML", - "value": "string", - "description": "The **`outerHTML`** attribute of the Element DOM interface gets the serialized HTML fragment describing the element including its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/outerHTML)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "outerText", - "value": "string", - "description": "The **`outerText`** property of the HTMLElement interface returns the same value as HTMLElement.innerText.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/outerText)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "ownerDocument", - "value": "Document", - "description": "The read-only **`ownerDocument`** property of the Node interface returns the top-level document object of the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/ownerDocument)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "parentElement", - "value": "HTMLElement | null", - "description": "The read-only **`parentElement`** property of Node interface returns the DOM node's parent Element, or `null` if the node either has no parent, or its parent isn't a DOM Element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentElement)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "parentNode", - "value": "ParentNode | null", - "description": "The read-only **`parentNode`** property of the Node interface returns the parent of the specified node in the DOM tree.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentNode)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "GetAccessor", - "name": "part", - "value": "DOMTokenList", - "description": "The **`part`** property of the Element interface represents the part identifier(s) of the element (i.e., set using the `part` attribute), returned as a DOMTokenList.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/part)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "popover", - "value": "string | null", - "description": "The **`popover`** property of the HTMLElement interface gets and sets an element's popover state via JavaScript (`'auto'`, `'hint'`, or `'manual'`), and can be used for feature detection.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/popover)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "prefix", - "value": "string | null", - "description": "The **`Element.prefix`** read-only property returns the namespace prefix of the specified element, or `null` if no prefix is specified.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/prefix)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "MethodSignature", - "name": "prepend", - "value": "(...nodes: (string | Node)[]) => void", - "description": "Inserts nodes before the first child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/prepend)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "previousElementSibling", - "value": "Element | null", - "description": "Returns the first preceding sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/previousElementSibling)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "previousSibling", - "value": "ChildNode | null", - "description": "The read-only **`previousSibling`** property of the Node interface returns the node immediately preceding the specified one in its parent's or `null` if the specified node is the first in that list.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/previousSibling)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "PROCESSING_INSTRUCTION_NODE", - "value": "7", - "description": "node is a ProcessingInstruction node." - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "MethodSignature", - "name": "querySelector", - "value": "{ (selectors: K): HTMLElementTagNameMap[K]; (selectors: K): SVGElementTagNameMap[K]; (selectors: K): MathMLElementTagNameMap[K]; (selectors: K): HTMLElementDeprecatedTagNameMap[K]; (selectors: string): E; }", - "description": "Returns the first element that is a descendant of node that matches selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelector)", - "deprecationMessage": "Deprecated" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "MethodSignature", - "name": "querySelectorAll", - "value": "{ (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: string): NodeListOf; }", - "description": "Returns all element descendants of node that match selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelectorAll)", - "deprecationMessage": "Deprecated" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "MethodSignature", - "name": "releasePointerCapture", - "value": "(pointerId: number) => void", - "description": "The **`releasePointerCapture()`** method of the previously set for a specific (PointerEvent) _pointer_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/releasePointerCapture)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "MethodSignature", - "name": "remove", - "value": "() => void", - "description": "Removes node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/remove)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "MethodSignature", - "name": "removeAttribute", - "value": "(qualifiedName: string) => void", - "description": "The Element method **`removeAttribute()`** removes the attribute with the specified name from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttribute)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "MethodSignature", - "name": "removeAttributeNode", - "value": "(attr: Attr) => Attr", - "description": "The **`removeAttributeNode()`** method of the Element interface removes the specified Attr node from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNode)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "MethodSignature", - "name": "removeAttributeNS", - "value": "(namespace: string, localName: string) => void", - "description": "The **`removeAttributeNS()`** method of the If you are working with HTML and you don't need to specify the requested attribute as being part of a specific namespace, use the Element.removeAttribute() method instead.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNS)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "MethodSignature", - "name": "removeChild", - "value": "(child: T) => T", - "description": "The **`removeChild()`** method of the Node interface removes a child node from the DOM and returns the removed node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/removeChild)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "MethodSignature", - "name": "removeEventListener", - "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "MethodSignature", - "name": "replaceChild", - "value": "(node: Node, child: T) => T", - "description": "The **`replaceChild()`** method of the Node interface replaces a child node within the given (parent) node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/replaceChild)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "MethodSignature", - "name": "replaceChildren", - "value": "(...nodes: (string | Node)[]) => void", - "description": "Replace all children of node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/replaceChildren)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "MethodSignature", - "name": "replaceWith", - "value": "(...nodes: (string | Node)[]) => void", - "description": "Replaces node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/replaceWith)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "MethodSignature", - "name": "requestFullscreen", - "value": "(options?: FullscreenOptions) => Promise", - "description": "The **`Element.requestFullscreen()`** method issues an asynchronous request to make the element be displayed in fullscreen mode.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestFullscreen)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "MethodSignature", - "name": "requestPointerLock", - "value": "(options?: PointerLockOptions) => Promise", - "description": "The **`requestPointerLock()`** method of the Element interface lets you asynchronously ask for the pointer to be locked on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestPointerLock)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "required", - "value": "boolean", - "description": "Whether the field needs a value. This requirement adds semantic value to the field, but it will not cause an error to appear automatically. If you want to present an error when this field is empty, you can do so with the `error` property.", - "isOptional": true, - "defaultValue": "false" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "role", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/role)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "MethodSignature", - "name": "scroll", - "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", - "description": "The **`scroll()`** method of the Element interface scrolls the element to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scroll)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "MethodSignature", - "name": "scrollBy", - "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", - "description": "The **`scrollBy()`** method of the Element interface scrolls an element by the given amount.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollBy)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "scrollHeight", - "value": "number", - "description": "The **`scrollHeight`** read-only property of the Element interface is a measurement of the height of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollHeight)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "MethodSignature", - "name": "scrollIntoView", - "value": "(arg?: boolean | ScrollIntoViewOptions) => void", - "description": "The Element interface's **`scrollIntoView()`** method scrolls the element's ancestor containers such that the element on which `scrollIntoView()` is called is visible to the user.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollIntoView)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "scrollLeft", - "value": "number", - "description": "The **`scrollLeft`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its left edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollLeft)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "MethodSignature", - "name": "scrollTo", - "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", - "description": "The **`scrollTo()`** method of the Element interface scrolls to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTo)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "scrollTop", - "value": "number", - "description": "The **`scrollTop`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its top edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTop)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "scrollWidth", - "value": "number", - "description": "The **`scrollWidth`** read-only property of the Element interface is a measurement of the width of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollWidth)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "MethodSignature", - "name": "setAttribute", - "value": "(qualifiedName: string, value: string) => void", - "description": "The **`setAttribute()`** method of the Element interface sets the value of an attribute on the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttribute)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "MethodSignature", - "name": "setAttributeNode", - "value": "(attr: Attr) => Attr", - "description": "The **`setAttributeNode()`** method of the Element interface adds a new Attr node to the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNode)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "MethodSignature", - "name": "setAttributeNodeNS", - "value": "(attr: Attr) => Attr", - "description": "The **`setAttributeNodeNS()`** method of the Element interface adds a new namespaced Attr node to an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNodeNS)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "MethodSignature", - "name": "setAttributeNS", - "value": "(namespace: string, qualifiedName: string, value: string) => void", - "description": "`setAttributeNS` adds a new attribute or changes the value of an attribute with the given namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNS)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "MethodSignature", - "name": "setHTMLUnsafe", - "value": "(html: string) => void", - "description": "The **`setHTMLUnsafe()`** method of the Element interface is used to parse a string of HTML into a DocumentFragment, optionally filtering out unwanted elements and attributes, and those that don't belong in the context, and then using it to replace the element's subtree in the DOM.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setHTMLUnsafe)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "MethodSignature", - "name": "setPointerCapture", - "value": "(pointerId: number) => void", - "description": "The **`setPointerCapture()`** method of the _capture target_ of future pointer events.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setPointerCapture)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "shadowRoot", - "value": "ShadowRoot | null", - "description": "The `Element.shadowRoot` read-only property represents the shadow root hosted by the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/shadowRoot)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "MethodSignature", - "name": "showPopover", - "value": "() => void", - "description": "The **`showPopover()`** method of the HTMLElement interface shows a Popover_API element (i.e., one that has a valid `popover` attribute) by adding it to the top layer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/showPopover)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "slot", - "value": "string", - "description": "The **`slot`** property of the Element interface returns the name of the shadow DOM slot the element is inserted in.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/slot)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "spellcheck", - "value": "boolean", - "description": "The **`spellcheck`** property of the HTMLElement interface represents a boolean value that controls the spell-checking hint.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/spellcheck)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "GetAccessor", - "name": "style", - "value": "CSSStyleDeclaration", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/style)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "tabIndex", - "value": "number", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/tabIndex)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "tagName", - "value": "string", - "description": "The **`tagName`** read-only property of the Element interface returns the tag name of the element on which it's called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/tagName)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "TEXT_NODE", - "value": "3", - "description": "node is a Text node." - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "GetAccessor", - "name": "textContent", - "value": "string", - "description": "[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/Node/textContent)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The **`HTMLElement.title`** property represents the title of the element: the text usually displayed in a 'tooltip' popup when the mouse is over the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/title)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "MethodSignature", - "name": "toggleAttribute", - "value": "(qualifiedName: string, force?: boolean) => boolean", - "description": "The **`toggleAttribute()`** method of the present and adding it if it is not present) on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/toggleAttribute)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "MethodSignature", - "name": "togglePopover", - "value": "(options?: boolean) => boolean", - "description": "The **`togglePopover()`** method of the HTMLElement interface toggles a Popover_API element (i.e., one that has a valid `popover` attribute) between the hidden and showing states.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/togglePopover)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "translate", - "value": "boolean", - "description": "The **`translate`** property of the HTMLElement interface indicates whether an element's attribute values and the values of its Text node children are to be translated when the page is localized, or whether to leave them unchanged.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/translate)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value used in form data when the control is checked.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "MethodSignature", - "name": "webkitMatchesSelector", - "value": "(selectors: string) => boolean", - "description": "", - "deprecationMessage": "This is a legacy alias of `matches`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "writingSuggestions", - "value": "string", - "description": "The **`writingSuggestions`** property of the HTMLElement interface is a string indicating if browser-provided writing suggestions should be enabled under the scope of the element or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/writingSuggestions)" - } - ], - "value": "export interface CheckboxElement extends CheckboxElementProps, Omit {\n onchange: CheckboxEvents['onChange'];\n}" - } - }, - "CheckboxProps": { - "src/surfaces/checkout/components/Checkbox.ts": { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "name": "CheckboxProps", - "description": "", - "isPublicDocs": true, - "members": [ - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "A label used for users using assistive technologies like screen readers. When set, any children or `label` supplied will not be announced. This can also be used to display a control without a visual label, while still providing context to users using screen readers.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "checked", - "value": "boolean", - "description": "Whether the control is active.", - "isOptional": true, - "defaultValue": "false" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "command", - "value": "'--auto' | '--show' | '--hide' | '--toggle'", - "description": "Sets the action the `commandFor` should take when this clickable is activated.\n\nSee the documentation of particular components for the actions they support.\n\n- `--auto`: Performs the default action for the target component.\n- `--show`: Displays the target component.\n- `--hide`: Conceals the target component.\n- `--toggle`: Alternates the target component.\n- `--copy`: Copies the target ClipboardItem.", - "isOptional": true, - "defaultValue": "'--auto'" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "commandFor", - "value": "string", - "description": "ID of a component that should respond to activations (such as clicks) on this component.\n\nSee `command` for how to control the behavior of the target.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "defaultChecked", - "value": "boolean", - "description": "Whether the control is active by default.", - "isOptional": true, - "defaultValue": "false" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "Disables the control, disallowing any interaction.", - "isOptional": true, - "defaultValue": "false" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "error", - "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the element.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "label", - "value": "string", - "description": "Visual content to use as the control label.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "An identifier for the control that is unique within the nearest containing `Form` component.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "onChange", - "value": "(event: Event) => void", - "description": "A callback that is run whenever the control is changed.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "required", - "value": "boolean", - "description": "Whether the field needs a value. This requirement adds semantic value to the field, but it will not cause an error to appear automatically. If you want to present an error when this field is empty, you can do so with the `error` property.", - "isOptional": true, - "defaultValue": "false" - }, - { - "filePath": "src/surfaces/checkout/components/Checkbox.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The value used in form data when the control is checked.", - "isOptional": true - } - ], - "value": "export interface CheckboxProps extends CheckboxElementProps, CheckboxEvents {\n}" - } - }, - "ReducedIconTypes": { - "src/surfaces/checkout/components/TextField.ts": { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "ReducedIconTypes", - "value": "'reset' | 'map' | 'menu' | 'search' | 'circle' | 'filter' | 'image' | 'alert-circle' | 'alert-triangle-filled' | 'alert-triangle' | 'arrow-down' | 'arrow-left' | 'arrow-right' | 'arrow-up-right' | 'arrow-up' | 'bag' | 'bullet' | 'calendar' | 'camera' | 'caret-down' | 'cart' | 'cash-dollar' | 'categories' | 'check-circle' | 'check-circle-filled' | 'check' | 'chevron-down' | 'chevron-left' | 'chevron-right' | 'chevron-up' | 'clipboard' | 'clock' | 'credit-card' | 'delete' | 'delivered' | 'delivery' | 'disabled' | 'discount' | 'edit' | 'email' | 'empty' | 'external' | 'geolocation' | 'gift-card' | 'globe' | 'grid' | 'info-filled' | 'info' | 'list-bulleted' | 'location' | 'lock' | 'menu-horizontal' | 'menu-vertical' | 'minus' | 'mobile' | 'note' | 'order' | 'organization' | 'plus' | 'profile' | 'question-circle-filled' | 'question-circle' | 'reorder' | 'return' | 'savings' | 'settings' | 'star-filled' | 'star-half' | 'star' | 'store' | 'truck' | 'upload' | 'x-circle-filled' | 'x-circle' | 'x'", - "description": "", - "isPublicDocs": true - } - }, - "IconElementProps": { - "src/surfaces/checkout/components/TextField.ts": { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "name": "IconElementProps", - "description": "", - "isPublicDocs": true, - "members": [ - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the element.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "size", - "value": "'base' | 'small' | 'small-200' | 'small-100' | 'large' | 'large-100'", - "description": "The size of the icon.\n\n- `'base'`: Default size that works well for most use cases.\n- `'small'`: Small icon for inline use within text or compact UI elements.\n- `'small-200'`: Extra small icon for the most compact contexts.\n- `'small-100'`: Small icon suitable for tight or dense layouts.\n- `'large'`: Large icon for emphasis or prominent display.\n- `'large-100'`: Extra large icon for maximum visual impact.", - "isOptional": true, - "defaultValue": "'base'" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "tone", - "value": "'info' | 'auto' | 'neutral' | 'success' | 'warning' | 'critical' | 'custom'", - "description": "The semantic meaning and color treatment of the icon.\n\n- `'info'`: Informational content or helpful tips.\n- `'auto'`: Automatically determined based on context.\n- `'neutral'`: General information without specific intent.\n- `'success'`: Positive outcomes or successful states.\n- `'warning'`: Important warnings about potential issues.\n- `'critical'`: Urgent problems or destructive actions.\n- `'custom'`: Inherits a custom color from its parent element's CSS.", - "isOptional": true, - "defaultValue": "'auto'" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'' | ReducedIconTypes", - "description": "The icon to display. Can be any icon name from the icon library or a custom string identifier.", - "isOptional": true - } - ], - "value": "export interface IconElementProps extends Pick {\n tone?: Extract;\n size?: Extract;\n type?: '' | ReducedIconTypes;\n}" - } - }, - "IconElement": { - "src/surfaces/checkout/components/TextField.ts": { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "name": "IconElement", - "description": "", - "isPublicDocs": true, - "members": [ - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "accessKey", - "value": "string", - "description": "The **`HTMLElement.accessKey`** property sets the keystroke which a user can press to jump to a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKey)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "accessKeyLabel", - "value": "string", - "description": "The **`HTMLElement.accessKeyLabel`** read-only property returns a string containing the element's browser-assigned access key (if any); otherwise it returns an empty string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKeyLabel)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "addEventListener", - "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "after", - "value": "(...nodes: (string | Node)[]) => void", - "description": "Inserts nodes just after node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/after)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "animate", - "value": "(keyframes: Keyframe[] | PropertyIndexedKeyframes, options?: number | KeyframeAnimationOptions) => Animation", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animate)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "append", - "value": "(...nodes: (string | Node)[]) => void", - "description": "Inserts nodes after the last child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/append)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "appendChild", - "value": "(node: T) => T", - "description": "The **`appendChild()`** method of the Node interface adds a node to the end of the list of children of a specified parent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/appendChild)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ariaActiveDescendantElement", - "value": "Element | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaActiveDescendantElement)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ariaAtomic", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAtomic)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ariaAutoComplete", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAutoComplete)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ariaBrailleLabel", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleLabel)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ariaBrailleRoleDescription", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleRoleDescription)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ariaBusy", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBusy)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ariaChecked", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaChecked)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ariaColCount", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColCount)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ariaColIndex", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndex)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ariaColIndexText", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndexText)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ariaColSpan", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColSpan)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ariaControlsElements", - "value": "ReadonlyArray | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaControlsElements)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ariaCurrent", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaCurrent)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ariaDescribedByElements", - "value": "ReadonlyArray | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescribedByElements)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ariaDescription", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescription)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ariaDetailsElements", - "value": "ReadonlyArray | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDetailsElements)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ariaDisabled", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDisabled)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ariaErrorMessageElements", - "value": "ReadonlyArray | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaErrorMessageElements)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ariaExpanded", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaExpanded)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ariaFlowToElements", - "value": "ReadonlyArray | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaFlowToElements)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ariaHasPopup", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHasPopup)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ariaHidden", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHidden)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ariaInvalid", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaInvalid)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ariaKeyShortcuts", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaKeyShortcuts)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ariaLabel", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabel)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ariaLabelledByElements", - "value": "ReadonlyArray | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabelledByElements)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ariaLevel", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLevel)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ariaLive", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLive)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ariaModal", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaModal)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ariaMultiLine", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiLine)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ariaMultiSelectable", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiSelectable)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ariaOrientation", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOrientation)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ariaOwnsElements", - "value": "ReadonlyArray | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOwnsElements)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ariaPlaceholder", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPlaceholder)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ariaPosInSet", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPosInSet)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ariaPressed", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPressed)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ariaReadOnly", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaReadOnly)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ariaRelevant", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRelevant)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ariaRequired", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRequired)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ariaRoleDescription", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRoleDescription)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ariaRowCount", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowCount)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ariaRowIndex", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndex)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ariaRowIndexText", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndexText)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ariaRowSpan", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowSpan)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ariaSelected", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSelected)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ariaSetSize", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSetSize)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ariaSort", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSort)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ariaValueMax", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMax)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ariaValueMin", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMin)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ariaValueNow", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueNow)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ariaValueText", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueText)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "assignedSlot", - "value": "HTMLSlotElement | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/assignedSlot)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "attachInternals", - "value": "() => ElementInternals", - "description": "The **`HTMLElement.attachInternals()`** method returns an ElementInternals object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attachInternals)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "attachShadow", - "value": "(init: ShadowRootInit) => ShadowRoot", - "description": "The **`Element.attachShadow()`** method attaches a shadow DOM tree to the specified element and returns a reference to its ShadowRoot.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attachShadow)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ATTRIBUTE_NODE", - "value": "2", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "NamedNodeMap", - "description": "The **`Element.attributes`** property returns a live collection of all attribute nodes registered to the specified node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attributes)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "attributeStyleMap", - "value": "StylePropertyMap", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attributeStyleMap)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "autocapitalize", - "value": "string", - "description": "The **`autocapitalize`** property of the HTMLElement interface represents the element's capitalization behavior for user input.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocapitalize)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "autocorrect", - "value": "boolean", - "description": "The **`autocorrect`** property of the HTMLElement interface controls whether or not autocorrection of editable text is enabled for spelling and/or punctuation errors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocorrect)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "autofocus", - "value": "boolean", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autofocus)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "baseURI", - "value": "string", - "description": "The read-only **`baseURI`** property of the Node interface returns the absolute base URL of the document containing the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/baseURI)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "before", - "value": "(...nodes: (string | Node)[]) => void", - "description": "Inserts nodes just before node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/before)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "blur", - "value": "() => void", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/blur)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "CDATA_SECTION_NODE", - "value": "4", - "description": "node is a CDATASection node." - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "checkVisibility", - "value": "(options?: CheckVisibilityOptions) => boolean", - "description": "The **`checkVisibility()`** method of the Element interface checks whether the element is visible.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/checkVisibility)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "childElementCount", - "value": "number", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/childElementCount)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "childNodes", - "value": "NodeListOf", - "description": "The read-only **`childNodes`** property of the Node interface returns a live the first child node is assigned index `0`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/childNodes)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "HTMLCollection", - "description": "Returns the child elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/children)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "GetAccessor", - "name": "classList", - "value": "DOMTokenList", - "description": "The **`Element.classList`** is a read-only property that returns a live DOMTokenList collection of the `class` attributes of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/classList)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "className", - "value": "string", - "description": "The **`className`** property of the of the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/className)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "click", - "value": "() => void", - "description": "The **`HTMLElement.click()`** method simulates a mouse click on an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/click)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "clientHeight", - "value": "number", - "description": "The **`clientHeight`** read-only property of the Element interface is zero for elements with no CSS or inline layout boxes; otherwise, it's the inner height of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientHeight)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "clientLeft", - "value": "number", - "description": "The **`clientLeft`** read-only property of the Element interface returns the width of the left border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientLeft)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "clientTop", - "value": "number", - "description": "The **`clientTop`** read-only property of the Element interface returns the width of the top border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientTop)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "clientWidth", - "value": "number", - "description": "The **`clientWidth`** read-only property of the Element interface is zero for inline elements and elements with no CSS; otherwise, it's the inner width of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientWidth)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "cloneNode", - "value": "(subtree?: boolean) => Node", - "description": "The **`cloneNode()`** method of the Node interface returns a duplicate of the node on which this method was called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/cloneNode)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "closest", - "value": "{ (selector: K): HTMLElementTagNameMap[K]; (selector: K): SVGElementTagNameMap[K]; (selector: K): MathMLElementTagNameMap[K]; (selectors: string): E; }", - "description": "The **`closest()`** method of the Element interface traverses the element and its parents (heading toward the document root) until it finds a node that matches the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/closest)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "COMMENT_NODE", - "value": "8", - "description": "node is a Comment node." - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "compareDocumentPosition", - "value": "(other: Node) => number", - "description": "The **`compareDocumentPosition()`** method of the Node interface reports the position of its argument node relative to the node on which it is called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/compareDocumentPosition)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "computedStyleMap", - "value": "() => StylePropertyMapReadOnly", - "description": "The **`computedStyleMap()`** method of the Element interface returns a StylePropertyMapReadOnly interface which provides a read-only representation of a CSS declaration block that is an alternative to CSSStyleDeclaration.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/computedStyleMap)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "contains", - "value": "(other: Node) => boolean", - "description": "The **`contains()`** method of the Node interface returns a boolean value indicating whether a node is a descendant of a given node, that is the node itself, one of its direct children (Node.childNodes), one of the children's direct children, and so on.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/contains)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "contentEditable", - "value": "string", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/contentEditable)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "currentCSSZoom", - "value": "number", - "description": "The **`currentCSSZoom`** read-only property of the Element interface provides the 'effective' CSS `zoom` of an element, taking into account the zoom applied to the element and all its parent elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/currentCSSZoom)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "dataset", - "value": "DOMStringMap", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dataset)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "dir", - "value": "string", - "description": "The **`HTMLElement.dir`** property indicates the text writing directionality of the content of the current element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dir)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "dispatchEvent", - "value": "(event: Event) => boolean", - "description": "The **`dispatchEvent()`** method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/dispatchEvent)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "DOCUMENT_FRAGMENT_NODE", - "value": "11", - "description": "node is a DocumentFragment node." - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "DOCUMENT_NODE", - "value": "9", - "description": "node is a document." - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "DOCUMENT_POSITION_CONTAINED_BY", - "value": "16", - "description": "Set when other is a descendant of node." - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "DOCUMENT_POSITION_CONTAINS", - "value": "8", - "description": "Set when other is an ancestor of node." - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "DOCUMENT_POSITION_DISCONNECTED", - "value": "1", - "description": "Set when node and other are not in the same tree." - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "DOCUMENT_POSITION_FOLLOWING", - "value": "4", - "description": "Set when other is following node." - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC", - "value": "32", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "DOCUMENT_POSITION_PRECEDING", - "value": "2", - "description": "Set when other is preceding node." - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "DOCUMENT_TYPE_NODE", - "value": "10", - "description": "node is a doctype." - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "draggable", - "value": "boolean", - "description": "The **`draggable`** property of the HTMLElement interface gets and sets a Boolean primitive indicating if the element is draggable.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/draggable)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ELEMENT_NODE", - "value": "1", - "description": "node is an element." - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "enterKeyHint", - "value": "string", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/enterKeyHint)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ENTITY_NODE", - "value": "6", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ENTITY_REFERENCE_NODE", - "value": "5", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "firstChild", - "value": "ChildNode | null", - "description": "The read-only **`firstChild`** property of the Node interface returns the node's first child in the tree, or `null` if the node has no children.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/firstChild)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "firstElementChild", - "value": "Element | null", - "description": "Returns the first child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/firstElementChild)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "focus", - "value": "(options?: FocusOptions) => void", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/focus)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "getAnimations", - "value": "(options?: GetAnimationsOptions) => Animation[]", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAnimations)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "getAttribute", - "value": "(qualifiedName: string) => string", - "description": "The **`getAttribute()`** method of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttribute)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "getAttributeNames", - "value": "() => string[]", - "description": "The **`getAttributeNames()`** method of the array.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNames)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "getAttributeNode", - "value": "(qualifiedName: string) => Attr", - "description": "Returns the specified attribute of the specified element, as an Attr node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNode)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "getAttributeNodeNS", - "value": "(namespace: string, localName: string) => Attr", - "description": "The **`getAttributeNodeNS()`** method of the Element interface returns the namespaced Attr node of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNodeNS)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "getAttributeNS", - "value": "(namespace: string, localName: string) => string", - "description": "The **`getAttributeNS()`** method of the Element interface returns the string value of the attribute with the specified namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNS)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "getBoundingClientRect", - "value": "() => DOMRect", - "description": "The **`Element.getBoundingClientRect()`** method returns a position relative to the viewport.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getBoundingClientRect)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "getClientRects", - "value": "() => DOMRectList", - "description": "The **`getClientRects()`** method of the Element interface returns a collection of DOMRect objects that indicate the bounding rectangles for each CSS border box in a client.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getClientRects)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "getElementsByClassName", - "value": "(classNames: string) => HTMLCollectionOf", - "description": "The Element method **`getElementsByClassName()`** returns a live specified class name or names.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByClassName)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "getElementsByTagName", - "value": "{ (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: string): HTMLCollectionOf; }", - "description": "The **`Element.getElementsByTagName()`** method returns a live All descendants of the specified element are searched, but not the element itself.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagName)", - "deprecationMessage": "Deprecated" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "getElementsByTagNameNS", - "value": "{ (namespaceURI: \"http://www.w3.org/1999/xhtml\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/2000/svg\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/1998/Math/MathML\", localName: string): HTMLCollectionOf; (namespace: string, localName: string): HTMLCollectionOf; }", - "description": "The **`Element.getElementsByTagNameNS()`** method returns a live HTMLCollection of elements with the given tag name belonging to the given namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagNameNS)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "getHTML", - "value": "(options?: GetHTMLOptions) => string", - "description": "The **`getHTML()`** method of the Element interface is used to serialize an element's DOM to an HTML string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getHTML)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "getRootNode", - "value": "(options?: GetRootNodeOptions) => Node", - "description": "The **`getRootNode()`** method of the Node interface returns the context object's root, which optionally includes the shadow root if it is available.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/getRootNode)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "hasAttribute", - "value": "(qualifiedName: string) => boolean", - "description": "The **`Element.hasAttribute()`** method returns a **Boolean** value indicating whether the specified element has the specified attribute or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttribute)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "hasAttributeNS", - "value": "(namespace: string, localName: string) => boolean", - "description": "The **`hasAttributeNS()`** method of the Element interface returns a boolean value indicating whether the current element has the specified attribute with the specified namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributeNS)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "hasAttributes", - "value": "() => boolean", - "description": "The **`hasAttributes()`** method of the Element interface returns a boolean value indicating whether the current element has any attributes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributes)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "hasChildNodes", - "value": "() => boolean", - "description": "The **`hasChildNodes()`** method of the Node interface returns a boolean value indicating whether the given Node has child nodes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/hasChildNodes)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "hasPointerCapture", - "value": "(pointerId: number) => boolean", - "description": "The **`hasPointerCapture()`** method of the pointer capture for the pointer identified by the given pointer ID.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasPointerCapture)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "hidden", - "value": "boolean", - "description": "The HTMLElement property **`hidden`** reflects the value of the element's `hidden` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidden)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "hidePopover", - "value": "() => void", - "description": "The **`hidePopover()`** method of the HTMLElement interface hides a popover element (i.e., one that has a valid `popover` attribute) by removing it from the top layer and styling it with `display: none`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidePopover)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the element.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "inert", - "value": "boolean", - "description": "The HTMLElement property **`inert`** reflects the value of the element's `inert` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inert)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "innerHTML", - "value": "string", - "description": "The **`innerHTML`** property of the Element interface gets or sets the HTML or XML markup contained within the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/innerHTML)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "innerText", - "value": "string", - "description": "The **`innerText`** property of the HTMLElement interface represents the rendered text content of a node and its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/innerText)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "inputMode", - "value": "string", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inputMode)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "insertAdjacentElement", - "value": "(where: InsertPosition, element: Element) => Element", - "description": "The **`insertAdjacentElement()`** method of the relative to the element it is invoked upon.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentElement)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "insertAdjacentHTML", - "value": "(position: InsertPosition, string: string) => void", - "description": "The **`insertAdjacentHTML()`** method of the the resulting nodes into the DOM tree at a specified position.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentHTML)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "insertAdjacentText", - "value": "(where: InsertPosition, data: string) => void", - "description": "The **`insertAdjacentText()`** method of the Element interface, given a relative position and a string, inserts a new text node at the given position relative to the element it is called from.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentText)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "insertBefore", - "value": "(node: T, child: Node) => T", - "description": "The **`insertBefore()`** method of the Node interface inserts a node before a _reference node_ as a child of a specified _parent node_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/insertBefore)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "isConnected", - "value": "boolean", - "description": "The read-only **`isConnected`** property of the Node interface returns a boolean indicating whether the node is connected (directly or indirectly) to a Document object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isConnected)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "isContentEditable", - "value": "boolean", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/isContentEditable)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "isDefaultNamespace", - "value": "(namespace: string) => boolean", - "description": "The **`isDefaultNamespace()`** method of the Node interface accepts a namespace URI as an argument.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isDefaultNamespace)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "isEqualNode", - "value": "(otherNode: Node) => boolean", - "description": "The **`isEqualNode()`** method of the Node interface tests whether two nodes are equal.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isEqualNode)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "isSameNode", - "value": "(otherNode: Node) => boolean", - "description": "The **`isSameNode()`** method of the Node interface is a legacy alias the for the `===` strict equality operator.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isSameNode)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "lang", - "value": "string", - "description": "The **`lang`** property of the HTMLElement interface indicates the base language of an element's attribute values and text content, in the form of a MISSING: RFC(5646, 'BCP 47 language identifier tag')].\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/lang)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "lastChild", - "value": "ChildNode | null", - "description": "The read-only **`lastChild`** property of the Node interface returns the last child of the node, or `null` if there are no child nodes.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lastChild)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "lastElementChild", - "value": "Element | null", - "description": "Returns the last child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/lastElementChild)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "localName", - "value": "string", - "description": "The **`Element.localName`** read-only property returns the local part of the qualified name of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/localName)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "lookupNamespaceURI", - "value": "(prefix: string) => string", - "description": "The **`lookupNamespaceURI()`** method of the Node interface takes a prefix as parameter and returns the namespace URI associated with it on the given node if found (and `null` if not).\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupNamespaceURI)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "lookupPrefix", - "value": "(namespace: string) => string", - "description": "The **`lookupPrefix()`** method of the Node interface returns a string containing the prefix for a given namespace URI, if present, and `null` if not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupPrefix)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "matches", - "value": "(selectors: string) => boolean", - "description": "The **`matches()`** method of the Element interface tests whether the element would be selected by the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "namespaceURI", - "value": "string | null", - "description": "The **`Element.namespaceURI`** read-only property returns the namespace URI of the element, or `null` if the element is not in a namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/namespaceURI)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "nextElementSibling", - "value": "Element | null", - "description": "Returns the first following sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/nextElementSibling)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "nextSibling", - "value": "ChildNode | null", - "description": "The read-only **`nextSibling`** property of the Node interface returns the node immediately following the specified one in their parent's Node.childNodes, or returns `null` if the specified node is the last child in the parent element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nextSibling)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "nodeName", - "value": "string", - "description": "The read-only **`nodeName`** property of Node returns the name of the current node as a string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeName)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "nodeType", - "value": "number", - "description": "The read-only **`nodeType`** property of a Node interface is an integer that identifies what the node is.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeType)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "nodeValue", - "value": "string | null", - "description": "The **`nodeValue`** property of the Node interface returns or sets the value of the current node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeValue)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "nonce", - "value": "string", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/nonce)", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "normalize", - "value": "() => void", - "description": "The **`normalize()`** method of the Node interface puts the specified node and all of its sub-tree into a _normalized_ form.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/normalize)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "NOTATION_NODE", - "value": "12", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "offsetHeight", - "value": "number", - "description": "The **`offsetHeight`** read-only property of the HTMLElement interface returns the height of an element, including vertical padding and borders, as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetHeight)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "offsetLeft", - "value": "number", - "description": "The **`offsetLeft`** read-only property of the HTMLElement interface returns the number of pixels that the _upper left corner_ of the current element is offset to the left within the HTMLElement.offsetParent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetLeft)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "offsetParent", - "value": "Element | null", - "description": "The **`HTMLElement.offsetParent`** read-only property returns a reference to the element which is the closest (nearest in the containment hierarchy) positioned ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetParent)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "offsetTop", - "value": "number", - "description": "The **`offsetTop`** read-only property of the HTMLElement interface returns the distance from the outer border of the current element (including its margin) to the top padding edge of the HTMLelement.offsetParent, the _closest positioned_ ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetTop)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "offsetWidth", - "value": "number", - "description": "The **`offsetWidth`** read-only property of the HTMLElement interface returns the layout width of an element as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetWidth)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onabort", - "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/abort_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onanimationcancel", - "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationcancel_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onanimationend", - "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onanimationiteration", - "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onanimationstart", - "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onauxclick", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/auxclick_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onbeforeinput", - "value": "((this: GlobalEventHandlers, ev: InputEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforeinput_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onbeforematch", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforematch_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onbeforetoggle", - "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/beforetoggle_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onblur", - "value": "((this: GlobalEventHandlers, ev: FocusEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/blur_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "oncancel", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/cancel_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "oncanplay", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplay_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "oncanplaythrough", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplaythrough_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onchange", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/change_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onclick", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/click_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onclose", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/close_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "oncontextlost", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextlost_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "oncontextmenu", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/contextmenu_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "oncontextrestored", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextrestored_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "oncopy", - "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/copy_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "oncuechange", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLTrackElement/cuechange_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "oncut", - "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/cut_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ondblclick", - "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/dblclick_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ondrag", - "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drag_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ondragend", - "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragend_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ondragenter", - "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragenter_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ondragleave", - "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragleave_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ondragover", - "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragover_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ondragstart", - "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragstart_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ondrop", - "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drop_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ondurationchange", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/durationchange_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onemptied", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/emptied_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onended", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ended_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onerror", - "value": "OnErrorEventHandler", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/error_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onfocus", - "value": "((this: GlobalEventHandlers, ev: FocusEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/focus_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onformdata", - "value": "((this: GlobalEventHandlers, ev: FormDataEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/formdata_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onfullscreenchange", - "value": "((this: Element, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenchange_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onfullscreenerror", - "value": "((this: Element, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenerror_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ongotpointercapture", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/gotpointercapture_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "oninput", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/input_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "oninvalid", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/invalid_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onkeydown", - "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keydown_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onkeypress", - "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", - "description": "", - "deprecationMessage": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keypress_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onkeyup", - "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keyup_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onload", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/load_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onloadeddata", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadeddata_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onloadedmetadata", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadedmetadata_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onloadstart", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadstart_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onlostpointercapture", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/lostpointercapture_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onmousedown", - "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousedown_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onmouseenter", - "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseenter_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onmouseleave", - "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseleave_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onmousemove", - "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousemove_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onmouseout", - "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseout_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onmouseover", - "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseover_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onmouseup", - "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseup_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onpaste", - "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/paste_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onpause", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/pause_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onplay", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/play_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onplaying", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/playing_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onpointercancel", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointercancel_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onpointerdown", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerdown_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onpointerenter", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerenter_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onpointerleave", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerleave_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onpointermove", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointermove_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onpointerout", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerout_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onpointerover", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerover_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onpointerrawupdate", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "Available only in secure contexts.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerrawupdate_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onpointerup", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerup_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onprogress", - "value": "((this: GlobalEventHandlers, ev: ProgressEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/progress_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onratechange", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ratechange_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onreset", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/reset_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onresize", - "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLVideoElement/resize_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onscroll", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scroll_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onscrollend", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scrollend_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onsecuritypolicyviolation", - "value": "((this: GlobalEventHandlers, ev: SecurityPolicyViolationEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/securitypolicyviolation_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onseeked", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeked_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onseeking", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeking_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onselect", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/select_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onselectionchange", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/selectionchange_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onselectstart", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/selectstart_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onslotchange", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLSlotElement/slotchange_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onstalled", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/stalled_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onsubmit", - "value": "((this: GlobalEventHandlers, ev: SubmitEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/submit_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onsuspend", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/suspend_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ontimeupdate", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/timeupdate_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ontoggle", - "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/toggle_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ontouchcancel", - "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchcancel_event)", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ontouchend", - "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchend_event)", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ontouchmove", - "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchmove_event)", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ontouchstart", - "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchstart_event)", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ontransitioncancel", - "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitioncancel_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ontransitionend", - "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ontransitionrun", - "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionrun_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ontransitionstart", - "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionstart_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onvolumechange", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/volumechange_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onwaiting", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/waiting_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onwebkitanimationend", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "", - "deprecationMessage": "This is a legacy alias of `onanimationend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onwebkitanimationiteration", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "", - "deprecationMessage": "This is a legacy alias of `onanimationiteration`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onwebkitanimationstart", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "", - "deprecationMessage": "This is a legacy alias of `onanimationstart`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onwebkittransitionend", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "", - "deprecationMessage": "This is a legacy alias of `ontransitionend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onwheel", - "value": "((this: GlobalEventHandlers, ev: WheelEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/wheel_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "outerHTML", - "value": "string", - "description": "The **`outerHTML`** attribute of the Element DOM interface gets the serialized HTML fragment describing the element including its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/outerHTML)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "outerText", - "value": "string", - "description": "The **`outerText`** property of the HTMLElement interface returns the same value as HTMLElement.innerText.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/outerText)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ownerDocument", - "value": "Document", - "description": "The read-only **`ownerDocument`** property of the Node interface returns the top-level document object of the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/ownerDocument)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "parentElement", - "value": "HTMLElement | null", - "description": "The read-only **`parentElement`** property of Node interface returns the DOM node's parent Element, or `null` if the node either has no parent, or its parent isn't a DOM Element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentElement)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "parentNode", - "value": "ParentNode | null", - "description": "The read-only **`parentNode`** property of the Node interface returns the parent of the specified node in the DOM tree.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentNode)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "GetAccessor", - "name": "part", - "value": "DOMTokenList", - "description": "The **`part`** property of the Element interface represents the part identifier(s) of the element (i.e., set using the `part` attribute), returned as a DOMTokenList.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/part)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "popover", - "value": "string | null", - "description": "The **`popover`** property of the HTMLElement interface gets and sets an element's popover state via JavaScript (`'auto'`, `'hint'`, or `'manual'`), and can be used for feature detection.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/popover)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "prefix", - "value": "string | null", - "description": "The **`Element.prefix`** read-only property returns the namespace prefix of the specified element, or `null` if no prefix is specified.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/prefix)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "prepend", - "value": "(...nodes: (string | Node)[]) => void", - "description": "Inserts nodes before the first child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/prepend)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "previousElementSibling", - "value": "Element | null", - "description": "Returns the first preceding sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/previousElementSibling)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "previousSibling", - "value": "ChildNode | null", - "description": "The read-only **`previousSibling`** property of the Node interface returns the node immediately preceding the specified one in its parent's or `null` if the specified node is the first in that list.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/previousSibling)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "PROCESSING_INSTRUCTION_NODE", - "value": "7", - "description": "node is a ProcessingInstruction node." - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "querySelector", - "value": "{ (selectors: K): HTMLElementTagNameMap[K]; (selectors: K): SVGElementTagNameMap[K]; (selectors: K): MathMLElementTagNameMap[K]; (selectors: K): HTMLElementDeprecatedTagNameMap[K]; (selectors: string): E; }", - "description": "Returns the first element that is a descendant of node that matches selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelector)", - "deprecationMessage": "Deprecated" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "querySelectorAll", - "value": "{ (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: string): NodeListOf; }", - "description": "Returns all element descendants of node that match selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelectorAll)", - "deprecationMessage": "Deprecated" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "releasePointerCapture", - "value": "(pointerId: number) => void", - "description": "The **`releasePointerCapture()`** method of the previously set for a specific (PointerEvent) _pointer_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/releasePointerCapture)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "remove", - "value": "() => void", - "description": "Removes node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/remove)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "removeAttribute", - "value": "(qualifiedName: string) => void", - "description": "The Element method **`removeAttribute()`** removes the attribute with the specified name from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttribute)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "removeAttributeNode", - "value": "(attr: Attr) => Attr", - "description": "The **`removeAttributeNode()`** method of the Element interface removes the specified Attr node from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNode)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "removeAttributeNS", - "value": "(namespace: string, localName: string) => void", - "description": "The **`removeAttributeNS()`** method of the If you are working with HTML and you don't need to specify the requested attribute as being part of a specific namespace, use the Element.removeAttribute() method instead.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNS)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "removeChild", - "value": "(child: T) => T", - "description": "The **`removeChild()`** method of the Node interface removes a child node from the DOM and returns the removed node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/removeChild)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "removeEventListener", - "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "replaceChild", - "value": "(node: Node, child: T) => T", - "description": "The **`replaceChild()`** method of the Node interface replaces a child node within the given (parent) node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/replaceChild)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "replaceChildren", - "value": "(...nodes: (string | Node)[]) => void", - "description": "Replace all children of node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/replaceChildren)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "replaceWith", - "value": "(...nodes: (string | Node)[]) => void", - "description": "Replaces node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/replaceWith)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "requestFullscreen", - "value": "(options?: FullscreenOptions) => Promise", - "description": "The **`Element.requestFullscreen()`** method issues an asynchronous request to make the element be displayed in fullscreen mode.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestFullscreen)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "requestPointerLock", - "value": "(options?: PointerLockOptions) => Promise", - "description": "The **`requestPointerLock()`** method of the Element interface lets you asynchronously ask for the pointer to be locked on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestPointerLock)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "role", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/role)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "scroll", - "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", - "description": "The **`scroll()`** method of the Element interface scrolls the element to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scroll)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "scrollBy", - "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", - "description": "The **`scrollBy()`** method of the Element interface scrolls an element by the given amount.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollBy)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "scrollHeight", - "value": "number", - "description": "The **`scrollHeight`** read-only property of the Element interface is a measurement of the height of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollHeight)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "scrollIntoView", - "value": "(arg?: boolean | ScrollIntoViewOptions) => void", - "description": "The Element interface's **`scrollIntoView()`** method scrolls the element's ancestor containers such that the element on which `scrollIntoView()` is called is visible to the user.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollIntoView)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "scrollLeft", - "value": "number", - "description": "The **`scrollLeft`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its left edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollLeft)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "scrollTo", - "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", - "description": "The **`scrollTo()`** method of the Element interface scrolls to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTo)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "scrollTop", - "value": "number", - "description": "The **`scrollTop`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its top edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTop)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "scrollWidth", - "value": "number", - "description": "The **`scrollWidth`** read-only property of the Element interface is a measurement of the width of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollWidth)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "setAttribute", - "value": "(qualifiedName: string, value: string) => void", - "description": "The **`setAttribute()`** method of the Element interface sets the value of an attribute on the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttribute)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "setAttributeNode", - "value": "(attr: Attr) => Attr", - "description": "The **`setAttributeNode()`** method of the Element interface adds a new Attr node to the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNode)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "setAttributeNodeNS", - "value": "(attr: Attr) => Attr", - "description": "The **`setAttributeNodeNS()`** method of the Element interface adds a new namespaced Attr node to an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNodeNS)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "setAttributeNS", - "value": "(namespace: string, qualifiedName: string, value: string) => void", - "description": "`setAttributeNS` adds a new attribute or changes the value of an attribute with the given namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNS)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "setHTMLUnsafe", - "value": "(html: string) => void", - "description": "The **`setHTMLUnsafe()`** method of the Element interface is used to parse a string of HTML into a DocumentFragment, optionally filtering out unwanted elements and attributes, and those that don't belong in the context, and then using it to replace the element's subtree in the DOM.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setHTMLUnsafe)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "setPointerCapture", - "value": "(pointerId: number) => void", - "description": "The **`setPointerCapture()`** method of the _capture target_ of future pointer events.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setPointerCapture)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "shadowRoot", - "value": "ShadowRoot | null", - "description": "The `Element.shadowRoot` read-only property represents the shadow root hosted by the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/shadowRoot)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "showPopover", - "value": "() => void", - "description": "The **`showPopover()`** method of the HTMLElement interface shows a Popover_API element (i.e., one that has a valid `popover` attribute) by adding it to the top layer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/showPopover)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "size", - "value": "'base' | 'small' | 'small-200' | 'small-100' | 'large' | 'large-100'", - "description": "The size of the icon.\n\n- `'base'`: Default size that works well for most use cases.\n- `'small'`: Small icon for inline use within text or compact UI elements.\n- `'small-200'`: Extra small icon for the most compact contexts.\n- `'small-100'`: Small icon suitable for tight or dense layouts.\n- `'large'`: Large icon for emphasis or prominent display.\n- `'large-100'`: Extra large icon for maximum visual impact.", - "isOptional": true, - "defaultValue": "'base'" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "slot", - "value": "string", - "description": "The **`slot`** property of the Element interface returns the name of the shadow DOM slot the element is inserted in.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/slot)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "spellcheck", - "value": "boolean", - "description": "The **`spellcheck`** property of the HTMLElement interface represents a boolean value that controls the spell-checking hint.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/spellcheck)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "GetAccessor", - "name": "style", - "value": "CSSStyleDeclaration", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/style)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "tabIndex", - "value": "number", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/tabIndex)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "tagName", - "value": "string", - "description": "The **`tagName`** read-only property of the Element interface returns the tag name of the element on which it's called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/tagName)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "TEXT_NODE", - "value": "3", - "description": "node is a Text node." - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "GetAccessor", - "name": "textContent", - "value": "string", - "description": "[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/Node/textContent)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The **`HTMLElement.title`** property represents the title of the element: the text usually displayed in a 'tooltip' popup when the mouse is over the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/title)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "toggleAttribute", - "value": "(qualifiedName: string, force?: boolean) => boolean", - "description": "The **`toggleAttribute()`** method of the present and adding it if it is not present) on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/toggleAttribute)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "togglePopover", - "value": "(options?: boolean) => boolean", - "description": "The **`togglePopover()`** method of the HTMLElement interface toggles a Popover_API element (i.e., one that has a valid `popover` attribute) between the hidden and showing states.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/togglePopover)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "tone", - "value": "'info' | 'auto' | 'neutral' | 'success' | 'warning' | 'critical' | 'custom'", - "description": "The semantic meaning and color treatment of the icon.\n\n- `'info'`: Informational content or helpful tips.\n- `'auto'`: Automatically determined based on context.\n- `'neutral'`: General information without specific intent.\n- `'success'`: Positive outcomes or successful states.\n- `'warning'`: Important warnings about potential issues.\n- `'critical'`: Urgent problems or destructive actions.\n- `'custom'`: Inherits a custom color from its parent element's CSS.", - "isOptional": true, - "defaultValue": "'auto'" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "translate", - "value": "boolean", - "description": "The **`translate`** property of the HTMLElement interface indicates whether an element's attribute values and the values of its Text node children are to be translated when the page is localized, or whether to leave them unchanged.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/translate)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'' | ReducedIconTypes", - "description": "The icon to display. Can be any icon name from the icon library or a custom string identifier.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "webkitMatchesSelector", - "value": "(selectors: string) => boolean", - "description": "", - "deprecationMessage": "This is a legacy alias of `matches`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "writingSuggestions", - "value": "string", - "description": "The **`writingSuggestions`** property of the HTMLElement interface is a string indicating if browser-provided writing suggestions should be enabled under the scope of the element or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/writingSuggestions)" - } - ], - "value": "export interface IconElement extends IconElementProps, Omit {\n}" - } - }, - "IconProps": { - "src/surfaces/checkout/components/TextField.ts": { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "name": "IconProps", - "description": "", - "isPublicDocs": true, - "members": [ - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the element.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "size", - "value": "'base' | 'small' | 'small-200' | 'small-100' | 'large' | 'large-100'", - "description": "The size of the icon.\n\n- `'base'`: Default size that works well for most use cases.\n- `'small'`: Small icon for inline use within text or compact UI elements.\n- `'small-200'`: Extra small icon for the most compact contexts.\n- `'small-100'`: Small icon suitable for tight or dense layouts.\n- `'large'`: Large icon for emphasis or prominent display.\n- `'large-100'`: Extra large icon for maximum visual impact.", - "isOptional": true, - "defaultValue": "'base'" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "tone", - "value": "'info' | 'auto' | 'neutral' | 'success' | 'warning' | 'critical' | 'custom'", - "description": "The semantic meaning and color treatment of the icon.\n\n- `'info'`: Informational content or helpful tips.\n- `'auto'`: Automatically determined based on context.\n- `'neutral'`: General information without specific intent.\n- `'success'`: Positive outcomes or successful states.\n- `'warning'`: Important warnings about potential issues.\n- `'critical'`: Urgent problems or destructive actions.\n- `'custom'`: Inherits a custom color from its parent element's CSS.", - "isOptional": true, - "defaultValue": "'auto'" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "type", - "value": "'' | ReducedIconTypes", - "description": "The icon to display. Can be any icon name from the icon library or a custom string identifier.", - "isOptional": true - } - ], - "value": "export interface IconProps extends IconElementProps {\n}" - } - }, - "TextFieldElementProps": { - "src/surfaces/checkout/components/TextField.ts": { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "name": "TextFieldElementProps", - "description": "Properties for the TextField component element.", - "isPublicDocs": true, - "members": [ - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "autocomplete", - "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", - "isOptional": true, - "defaultValue": "'on' for everything else" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "defaultValue", - "value": "string", - "description": "The default value for the field.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "Disables the field, disallowing any interaction.", - "isOptional": true, - "defaultValue": "false" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "error", - "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "icon", - "value": "'' | 'reset' | 'map' | 'menu' | 'search' | 'circle' | 'filter' | 'image' | 'alert-circle' | 'alert-triangle-filled' | 'alert-triangle' | 'arrow-down' | 'arrow-left' | 'arrow-right' | 'arrow-up-right' | 'arrow-up' | 'bag' | 'bullet' | 'calendar' | 'camera' | 'caret-down' | 'cart' | 'cash-dollar' | 'categories' | 'check-circle' | 'check-circle-filled' | 'check' | 'chevron-down' | 'chevron-left' | 'chevron-right' | 'chevron-up' | 'clipboard' | 'clock' | 'credit-card' | 'delete' | 'delivered' | 'delivery' | 'disabled' | 'discount' | 'edit' | 'email' | 'empty' | 'external' | 'geolocation' | 'gift-card' | 'globe' | 'grid' | 'info-filled' | 'info' | 'list-bulleted' | 'location' | 'lock' | 'menu-horizontal' | 'menu-vertical' | 'minus' | 'mobile' | 'note' | 'order' | 'organization' | 'plus' | 'profile' | 'question-circle-filled' | 'question-circle' | 'reorder' | 'return' | 'savings' | 'settings' | 'star-filled' | 'star-half' | 'star' | 'store' | 'truck' | 'upload' | 'x-circle-filled' | 'x-circle' | 'x'", - "description": "The type of icon to be displayed in the field.", - "isOptional": true, - "defaultValue": "''" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the element.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "label", - "value": "string", - "description": "Content to use as the field label.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "labelAccessibilityVisibility", - "value": "'visible' | 'exclusive'", - "description": "Changes the visibility of the component's label.\n\n- `visible`: the label is visible to all users.\n- `exclusive`: the label is visually hidden but remains in the accessibility tree.", - "isOptional": true, - "defaultValue": "'visible'" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "maxLength", - "value": "number", - "description": "Specifies the maximum number of characters allowed.", - "isOptional": true, - "defaultValue": "Infinity" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "minLength", - "value": "number", - "description": "Specifies the min number of characters allowed.", - "isOptional": true, - "defaultValue": "0" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "placeholder", - "value": "string", - "description": "", - "isOptional": true, - "deprecationMessage": "Use `label` instead.", - "isPrivate": true - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "prefix", - "value": "string", - "description": "A value to be displayed immediately before the editable portion of the field.\n\nThis is useful for displaying an implied part of the value, such as \"https://\" or \"+353\".\n\nThis cannot be edited by the user, and it isn't included in the value of the field.\n\nIt may not be displayed until the user has interacted with the input. For example, an inline label may take the place of the prefix until the user focuses the input.", - "isOptional": true, - "defaultValue": "''" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "readOnly", - "value": "boolean", - "description": "The field cannot be edited by the user. It is focusable will be announced by screen readers.", - "isOptional": true, - "defaultValue": "false" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "required", - "value": "boolean", - "description": "Whether the field needs a value. This requirement adds semantic value to the field, but it will not cause an error to appear automatically. If you want to present an error when this field is empty, you can do so with the `error` property.", - "isOptional": true, - "defaultValue": "false" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "suffix", - "value": "string", - "description": "A value to be displayed immediately after the editable portion of the field.\n\nThis is useful for displaying an implied part of the value, such as \"@shopify.com\", or \"%\".\n\nThis cannot be edited by the user, and it isn't included in the value of the field.\n\nIt may not be displayed until the user has interacted with the input. For example, an inline label may take the place of the suffix until the user focuses the input.", - "isOptional": true, - "defaultValue": "''" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The current value for the field. If omitted, the field will be empty.", - "isOptional": true - } - ], - "value": "export interface TextFieldElementProps extends Pick {\n icon?: IconProps['type'];\n /**\n * @deprecated Use `label` instead.\n * @private\n */\n placeholder?: string;\n}" - } - }, - "TextFieldEvents": { - "src/surfaces/checkout/components/TextField.ts": { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "name": "TextFieldEvents", - "description": "", - "isPublicDocs": true, - "members": [ - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onBlur", - "value": "(event: FocusEvent) => void", - "description": "A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onChange", - "value": "(event: Event) => void", - "description": "Callback when the user has **finished editing** a field, for example, once they have blurred the field.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onFocus", - "value": "(event: FocusEvent) => void", - "description": "A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onInput", - "value": "(event: Event) => void", - "description": "Callback when the user makes any changes in the field.", - "isOptional": true - } - ], - "value": "export interface TextFieldEvents extends Pick {\n}" - } - }, - "TextFieldElementEvents": { - "src/surfaces/checkout/components/TextField.ts": { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "name": "TextFieldElementEvents", - "description": "Events for the TextField component element.", - "isPublicDocs": true, - "members": [ - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "blur", - "value": "CallbackEventListener", - "description": "A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "change", - "value": "CallbackEventListener", - "description": "Callback when the user has **finished editing** a field, for example, once they have blurred the field.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "focus", - "value": "CallbackEventListener", - "description": "A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "input", - "value": "CallbackEventListener", - "description": "Callback when the user makes any changes in the field.", - "isOptional": true - } - ], - "value": "export interface TextFieldElementEvents {\n /**\n * A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event\n */\n blur?: CallbackEventListener;\n /**\n * Callback when the user has **finished editing** a field, for example, once they have blurred the field.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event\n */\n change?: CallbackEventListener;\n /**\n * A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event\n */\n focus?: CallbackEventListener;\n /**\n * Callback when the user makes any changes in the field.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event\n */\n input?: CallbackEventListener;\n}" - } - }, - "TextFieldElementSlots": { - "src/surfaces/checkout/components/TextField.ts": { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "name": "TextFieldElementSlots", - "description": "Slots for the TextField component element.", - "isPublicDocs": true, - "members": [ - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "accessory", - "value": "HTMLElement", - "description": "Additional content to be displayed in the field. Commonly used to display an icon that activates a tooltip providing more information.", - "isOptional": true - } - ], - "value": "export interface TextFieldElementSlots {\n /**\n * Additional content to be displayed in the field.\n * Commonly used to display an icon that activates a tooltip providing more information.\n */\n accessory?: HTMLElement;\n}" - } - }, - "TextFieldElement": { - "src/surfaces/checkout/components/TextField.ts": { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "name": "TextFieldElement", - "description": "", - "isPublicDocs": true, - "members": [ - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "accessKey", - "value": "string", - "description": "The **`HTMLElement.accessKey`** property sets the keystroke which a user can press to jump to a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKey)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "accessKeyLabel", - "value": "string", - "description": "The **`HTMLElement.accessKeyLabel`** read-only property returns a string containing the element's browser-assigned access key (if any); otherwise it returns an empty string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKeyLabel)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "addEventListener", - "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "after", - "value": "(...nodes: (string | Node)[]) => void", - "description": "Inserts nodes just after node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/after)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "animate", - "value": "(keyframes: Keyframe[] | PropertyIndexedKeyframes, options?: number | KeyframeAnimationOptions) => Animation", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animate)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "append", - "value": "(...nodes: (string | Node)[]) => void", - "description": "Inserts nodes after the last child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/append)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "appendChild", - "value": "(node: T) => T", - "description": "The **`appendChild()`** method of the Node interface adds a node to the end of the list of children of a specified parent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/appendChild)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ariaActiveDescendantElement", - "value": "Element | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaActiveDescendantElement)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ariaAtomic", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAtomic)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ariaAutoComplete", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAutoComplete)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ariaBrailleLabel", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleLabel)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ariaBrailleRoleDescription", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleRoleDescription)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ariaBusy", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBusy)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ariaChecked", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaChecked)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ariaColCount", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColCount)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ariaColIndex", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndex)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ariaColIndexText", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndexText)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ariaColSpan", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColSpan)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ariaControlsElements", - "value": "ReadonlyArray | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaControlsElements)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ariaCurrent", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaCurrent)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ariaDescribedByElements", - "value": "ReadonlyArray | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescribedByElements)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ariaDescription", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescription)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ariaDetailsElements", - "value": "ReadonlyArray | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDetailsElements)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ariaDisabled", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDisabled)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ariaErrorMessageElements", - "value": "ReadonlyArray | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaErrorMessageElements)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ariaExpanded", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaExpanded)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ariaFlowToElements", - "value": "ReadonlyArray | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaFlowToElements)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ariaHasPopup", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHasPopup)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ariaHidden", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHidden)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ariaInvalid", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaInvalid)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ariaKeyShortcuts", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaKeyShortcuts)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ariaLabel", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabel)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ariaLabelledByElements", - "value": "ReadonlyArray | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabelledByElements)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ariaLevel", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLevel)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ariaLive", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLive)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ariaModal", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaModal)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ariaMultiLine", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiLine)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ariaMultiSelectable", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiSelectable)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ariaOrientation", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOrientation)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ariaOwnsElements", - "value": "ReadonlyArray | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOwnsElements)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ariaPlaceholder", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPlaceholder)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ariaPosInSet", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPosInSet)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ariaPressed", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPressed)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ariaReadOnly", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaReadOnly)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ariaRelevant", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRelevant)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ariaRequired", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRequired)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ariaRoleDescription", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRoleDescription)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ariaRowCount", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowCount)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ariaRowIndex", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndex)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ariaRowIndexText", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndexText)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ariaRowSpan", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowSpan)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ariaSelected", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSelected)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ariaSetSize", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSetSize)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ariaSort", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSort)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ariaValueMax", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMax)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ariaValueMin", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMin)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ariaValueNow", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueNow)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ariaValueText", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueText)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "assignedSlot", - "value": "HTMLSlotElement | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/assignedSlot)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "attachInternals", - "value": "() => ElementInternals", - "description": "The **`HTMLElement.attachInternals()`** method returns an ElementInternals object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attachInternals)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "attachShadow", - "value": "(init: ShadowRootInit) => ShadowRoot", - "description": "The **`Element.attachShadow()`** method attaches a shadow DOM tree to the specified element and returns a reference to its ShadowRoot.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attachShadow)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ATTRIBUTE_NODE", - "value": "2", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "NamedNodeMap", - "description": "The **`Element.attributes`** property returns a live collection of all attribute nodes registered to the specified node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attributes)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "attributeStyleMap", - "value": "StylePropertyMap", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attributeStyleMap)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "autocapitalize", - "value": "string", - "description": "The **`autocapitalize`** property of the HTMLElement interface represents the element's capitalization behavior for user input.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocapitalize)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "autocomplete", - "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", - "isOptional": true, - "defaultValue": "'on' for everything else" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "autocorrect", - "value": "boolean", - "description": "The **`autocorrect`** property of the HTMLElement interface controls whether or not autocorrection of editable text is enabled for spelling and/or punctuation errors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocorrect)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "autofocus", - "value": "boolean", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autofocus)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "baseURI", - "value": "string", - "description": "The read-only **`baseURI`** property of the Node interface returns the absolute base URL of the document containing the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/baseURI)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "before", - "value": "(...nodes: (string | Node)[]) => void", - "description": "Inserts nodes just before node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/before)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "blur", - "value": "() => void", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/blur)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "CDATA_SECTION_NODE", - "value": "4", - "description": "node is a CDATASection node." - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "checkVisibility", - "value": "(options?: CheckVisibilityOptions) => boolean", - "description": "The **`checkVisibility()`** method of the Element interface checks whether the element is visible.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/checkVisibility)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "childElementCount", - "value": "number", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/childElementCount)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "childNodes", - "value": "NodeListOf", - "description": "The read-only **`childNodes`** property of the Node interface returns a live the first child node is assigned index `0`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/childNodes)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "HTMLCollection", - "description": "Returns the child elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/children)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "GetAccessor", - "name": "classList", - "value": "DOMTokenList", - "description": "The **`Element.classList`** is a read-only property that returns a live DOMTokenList collection of the `class` attributes of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/classList)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "className", - "value": "string", - "description": "The **`className`** property of the of the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/className)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "click", - "value": "() => void", - "description": "The **`HTMLElement.click()`** method simulates a mouse click on an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/click)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "clientHeight", - "value": "number", - "description": "The **`clientHeight`** read-only property of the Element interface is zero for elements with no CSS or inline layout boxes; otherwise, it's the inner height of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientHeight)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "clientLeft", - "value": "number", - "description": "The **`clientLeft`** read-only property of the Element interface returns the width of the left border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientLeft)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "clientTop", - "value": "number", - "description": "The **`clientTop`** read-only property of the Element interface returns the width of the top border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientTop)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "clientWidth", - "value": "number", - "description": "The **`clientWidth`** read-only property of the Element interface is zero for inline elements and elements with no CSS; otherwise, it's the inner width of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientWidth)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "cloneNode", - "value": "(subtree?: boolean) => Node", - "description": "The **`cloneNode()`** method of the Node interface returns a duplicate of the node on which this method was called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/cloneNode)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "closest", - "value": "{ (selector: K): HTMLElementTagNameMap[K]; (selector: K): SVGElementTagNameMap[K]; (selector: K): MathMLElementTagNameMap[K]; (selectors: string): E; }", - "description": "The **`closest()`** method of the Element interface traverses the element and its parents (heading toward the document root) until it finds a node that matches the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/closest)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "COMMENT_NODE", - "value": "8", - "description": "node is a Comment node." - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "compareDocumentPosition", - "value": "(other: Node) => number", - "description": "The **`compareDocumentPosition()`** method of the Node interface reports the position of its argument node relative to the node on which it is called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/compareDocumentPosition)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "computedStyleMap", - "value": "() => StylePropertyMapReadOnly", - "description": "The **`computedStyleMap()`** method of the Element interface returns a StylePropertyMapReadOnly interface which provides a read-only representation of a CSS declaration block that is an alternative to CSSStyleDeclaration.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/computedStyleMap)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "contains", - "value": "(other: Node) => boolean", - "description": "The **`contains()`** method of the Node interface returns a boolean value indicating whether a node is a descendant of a given node, that is the node itself, one of its direct children (Node.childNodes), one of the children's direct children, and so on.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/contains)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "contentEditable", - "value": "string", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/contentEditable)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "currentCSSZoom", - "value": "number", - "description": "The **`currentCSSZoom`** read-only property of the Element interface provides the 'effective' CSS `zoom` of an element, taking into account the zoom applied to the element and all its parent elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/currentCSSZoom)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "dataset", - "value": "DOMStringMap", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dataset)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "defaultValue", - "value": "string", - "description": "The default value for the field.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "dir", - "value": "string", - "description": "The **`HTMLElement.dir`** property indicates the text writing directionality of the content of the current element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dir)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "Disables the field, disallowing any interaction.", - "isOptional": true, - "defaultValue": "false" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "dispatchEvent", - "value": "(event: Event) => boolean", - "description": "The **`dispatchEvent()`** method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/dispatchEvent)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "DOCUMENT_FRAGMENT_NODE", - "value": "11", - "description": "node is a DocumentFragment node." - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "DOCUMENT_NODE", - "value": "9", - "description": "node is a document." - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "DOCUMENT_POSITION_CONTAINED_BY", - "value": "16", - "description": "Set when other is a descendant of node." - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "DOCUMENT_POSITION_CONTAINS", - "value": "8", - "description": "Set when other is an ancestor of node." - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "DOCUMENT_POSITION_DISCONNECTED", - "value": "1", - "description": "Set when node and other are not in the same tree." - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "DOCUMENT_POSITION_FOLLOWING", - "value": "4", - "description": "Set when other is following node." - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC", - "value": "32", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "DOCUMENT_POSITION_PRECEDING", - "value": "2", - "description": "Set when other is preceding node." - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "DOCUMENT_TYPE_NODE", - "value": "10", - "description": "node is a doctype." - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "draggable", - "value": "boolean", - "description": "The **`draggable`** property of the HTMLElement interface gets and sets a Boolean primitive indicating if the element is draggable.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/draggable)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ELEMENT_NODE", - "value": "1", - "description": "node is an element." - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "enterKeyHint", - "value": "string", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/enterKeyHint)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ENTITY_NODE", - "value": "6", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ENTITY_REFERENCE_NODE", - "value": "5", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "error", - "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "firstChild", - "value": "ChildNode | null", - "description": "The read-only **`firstChild`** property of the Node interface returns the node's first child in the tree, or `null` if the node has no children.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/firstChild)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "firstElementChild", - "value": "Element | null", - "description": "Returns the first child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/firstElementChild)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "focus", - "value": "(options?: FocusOptions) => void", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/focus)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "getAnimations", - "value": "(options?: GetAnimationsOptions) => Animation[]", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAnimations)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "getAttribute", - "value": "(qualifiedName: string) => string", - "description": "The **`getAttribute()`** method of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttribute)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "getAttributeNames", - "value": "() => string[]", - "description": "The **`getAttributeNames()`** method of the array.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNames)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "getAttributeNode", - "value": "(qualifiedName: string) => Attr", - "description": "Returns the specified attribute of the specified element, as an Attr node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNode)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "getAttributeNodeNS", - "value": "(namespace: string, localName: string) => Attr", - "description": "The **`getAttributeNodeNS()`** method of the Element interface returns the namespaced Attr node of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNodeNS)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "getAttributeNS", - "value": "(namespace: string, localName: string) => string", - "description": "The **`getAttributeNS()`** method of the Element interface returns the string value of the attribute with the specified namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNS)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "getBoundingClientRect", - "value": "() => DOMRect", - "description": "The **`Element.getBoundingClientRect()`** method returns a position relative to the viewport.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getBoundingClientRect)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "getClientRects", - "value": "() => DOMRectList", - "description": "The **`getClientRects()`** method of the Element interface returns a collection of DOMRect objects that indicate the bounding rectangles for each CSS border box in a client.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getClientRects)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "getElementsByClassName", - "value": "(classNames: string) => HTMLCollectionOf", - "description": "The Element method **`getElementsByClassName()`** returns a live specified class name or names.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByClassName)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "getElementsByTagName", - "value": "{ (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: string): HTMLCollectionOf; }", - "description": "The **`Element.getElementsByTagName()`** method returns a live All descendants of the specified element are searched, but not the element itself.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagName)", - "deprecationMessage": "Deprecated" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "getElementsByTagNameNS", - "value": "{ (namespaceURI: \"http://www.w3.org/1999/xhtml\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/2000/svg\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/1998/Math/MathML\", localName: string): HTMLCollectionOf; (namespace: string, localName: string): HTMLCollectionOf; }", - "description": "The **`Element.getElementsByTagNameNS()`** method returns a live HTMLCollection of elements with the given tag name belonging to the given namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagNameNS)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "getHTML", - "value": "(options?: GetHTMLOptions) => string", - "description": "The **`getHTML()`** method of the Element interface is used to serialize an element's DOM to an HTML string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getHTML)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "getRootNode", - "value": "(options?: GetRootNodeOptions) => Node", - "description": "The **`getRootNode()`** method of the Node interface returns the context object's root, which optionally includes the shadow root if it is available.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/getRootNode)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "hasAttribute", - "value": "(qualifiedName: string) => boolean", - "description": "The **`Element.hasAttribute()`** method returns a **Boolean** value indicating whether the specified element has the specified attribute or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttribute)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "hasAttributeNS", - "value": "(namespace: string, localName: string) => boolean", - "description": "The **`hasAttributeNS()`** method of the Element interface returns a boolean value indicating whether the current element has the specified attribute with the specified namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributeNS)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "hasAttributes", - "value": "() => boolean", - "description": "The **`hasAttributes()`** method of the Element interface returns a boolean value indicating whether the current element has any attributes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributes)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "hasChildNodes", - "value": "() => boolean", - "description": "The **`hasChildNodes()`** method of the Node interface returns a boolean value indicating whether the given Node has child nodes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/hasChildNodes)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "hasPointerCapture", - "value": "(pointerId: number) => boolean", - "description": "The **`hasPointerCapture()`** method of the pointer capture for the pointer identified by the given pointer ID.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasPointerCapture)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "hidden", - "value": "boolean", - "description": "The HTMLElement property **`hidden`** reflects the value of the element's `hidden` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidden)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "hidePopover", - "value": "() => void", - "description": "The **`hidePopover()`** method of the HTMLElement interface hides a popover element (i.e., one that has a valid `popover` attribute) by removing it from the top layer and styling it with `display: none`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidePopover)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "icon", - "value": "'' | 'reset' | 'map' | 'menu' | 'search' | 'circle' | 'filter' | 'image' | 'alert-circle' | 'alert-triangle-filled' | 'alert-triangle' | 'arrow-down' | 'arrow-left' | 'arrow-right' | 'arrow-up-right' | 'arrow-up' | 'bag' | 'bullet' | 'calendar' | 'camera' | 'caret-down' | 'cart' | 'cash-dollar' | 'categories' | 'check-circle' | 'check-circle-filled' | 'check' | 'chevron-down' | 'chevron-left' | 'chevron-right' | 'chevron-up' | 'clipboard' | 'clock' | 'credit-card' | 'delete' | 'delivered' | 'delivery' | 'disabled' | 'discount' | 'edit' | 'email' | 'empty' | 'external' | 'geolocation' | 'gift-card' | 'globe' | 'grid' | 'info-filled' | 'info' | 'list-bulleted' | 'location' | 'lock' | 'menu-horizontal' | 'menu-vertical' | 'minus' | 'mobile' | 'note' | 'order' | 'organization' | 'plus' | 'profile' | 'question-circle-filled' | 'question-circle' | 'reorder' | 'return' | 'savings' | 'settings' | 'star-filled' | 'star-half' | 'star' | 'store' | 'truck' | 'upload' | 'x-circle-filled' | 'x-circle' | 'x'", - "description": "The type of icon to be displayed in the field.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the element.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "inert", - "value": "boolean", - "description": "The HTMLElement property **`inert`** reflects the value of the element's `inert` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inert)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "innerHTML", - "value": "string", - "description": "The **`innerHTML`** property of the Element interface gets or sets the HTML or XML markup contained within the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/innerHTML)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "innerText", - "value": "string", - "description": "The **`innerText`** property of the HTMLElement interface represents the rendered text content of a node and its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/innerText)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "inputMode", - "value": "string", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inputMode)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "insertAdjacentElement", - "value": "(where: InsertPosition, element: Element) => Element", - "description": "The **`insertAdjacentElement()`** method of the relative to the element it is invoked upon.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentElement)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "insertAdjacentHTML", - "value": "(position: InsertPosition, string: string) => void", - "description": "The **`insertAdjacentHTML()`** method of the the resulting nodes into the DOM tree at a specified position.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentHTML)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "insertAdjacentText", - "value": "(where: InsertPosition, data: string) => void", - "description": "The **`insertAdjacentText()`** method of the Element interface, given a relative position and a string, inserts a new text node at the given position relative to the element it is called from.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentText)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "insertBefore", - "value": "(node: T, child: Node) => T", - "description": "The **`insertBefore()`** method of the Node interface inserts a node before a _reference node_ as a child of a specified _parent node_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/insertBefore)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "isConnected", - "value": "boolean", - "description": "The read-only **`isConnected`** property of the Node interface returns a boolean indicating whether the node is connected (directly or indirectly) to a Document object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isConnected)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "isContentEditable", - "value": "boolean", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/isContentEditable)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "isDefaultNamespace", - "value": "(namespace: string) => boolean", - "description": "The **`isDefaultNamespace()`** method of the Node interface accepts a namespace URI as an argument.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isDefaultNamespace)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "isEqualNode", - "value": "(otherNode: Node) => boolean", - "description": "The **`isEqualNode()`** method of the Node interface tests whether two nodes are equal.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isEqualNode)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "isSameNode", - "value": "(otherNode: Node) => boolean", - "description": "The **`isSameNode()`** method of the Node interface is a legacy alias the for the `===` strict equality operator.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isSameNode)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "label", - "value": "string", - "description": "Content to use as the field label.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "labelAccessibilityVisibility", - "value": "'visible' | 'exclusive'", - "description": "Changes the visibility of the component's label.\n\n- `visible`: the label is visible to all users.\n- `exclusive`: the label is visually hidden but remains in the accessibility tree.", - "isOptional": true, - "defaultValue": "'visible'" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "lang", - "value": "string", - "description": "The **`lang`** property of the HTMLElement interface indicates the base language of an element's attribute values and text content, in the form of a MISSING: RFC(5646, 'BCP 47 language identifier tag')].\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/lang)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "lastChild", - "value": "ChildNode | null", - "description": "The read-only **`lastChild`** property of the Node interface returns the last child of the node, or `null` if there are no child nodes.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lastChild)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "lastElementChild", - "value": "Element | null", - "description": "Returns the last child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/lastElementChild)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "localName", - "value": "string", - "description": "The **`Element.localName`** read-only property returns the local part of the qualified name of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/localName)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "lookupNamespaceURI", - "value": "(prefix: string) => string", - "description": "The **`lookupNamespaceURI()`** method of the Node interface takes a prefix as parameter and returns the namespace URI associated with it on the given node if found (and `null` if not).\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupNamespaceURI)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "lookupPrefix", - "value": "(namespace: string) => string", - "description": "The **`lookupPrefix()`** method of the Node interface returns a string containing the prefix for a given namespace URI, if present, and `null` if not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupPrefix)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "matches", - "value": "(selectors: string) => boolean", - "description": "The **`matches()`** method of the Element interface tests whether the element would be selected by the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "maxLength", - "value": "number", - "description": "Specifies the maximum number of characters allowed.", - "isOptional": true, - "defaultValue": "Infinity" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "minLength", - "value": "number", - "description": "Specifies the min number of characters allowed.", - "isOptional": true, - "defaultValue": "0" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "namespaceURI", - "value": "string | null", - "description": "The **`Element.namespaceURI`** read-only property returns the namespace URI of the element, or `null` if the element is not in a namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/namespaceURI)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "nextElementSibling", - "value": "Element | null", - "description": "Returns the first following sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/nextElementSibling)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "nextSibling", - "value": "ChildNode | null", - "description": "The read-only **`nextSibling`** property of the Node interface returns the node immediately following the specified one in their parent's Node.childNodes, or returns `null` if the specified node is the last child in the parent element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nextSibling)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "nodeName", - "value": "string", - "description": "The read-only **`nodeName`** property of Node returns the name of the current node as a string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeName)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "nodeType", - "value": "number", - "description": "The read-only **`nodeType`** property of a Node interface is an integer that identifies what the node is.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeType)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "nodeValue", - "value": "string | null", - "description": "The **`nodeValue`** property of the Node interface returns or sets the value of the current node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeValue)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "nonce", - "value": "string", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/nonce)", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "normalize", - "value": "() => void", - "description": "The **`normalize()`** method of the Node interface puts the specified node and all of its sub-tree into a _normalized_ form.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/normalize)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "NOTATION_NODE", - "value": "12", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "offsetHeight", - "value": "number", - "description": "The **`offsetHeight`** read-only property of the HTMLElement interface returns the height of an element, including vertical padding and borders, as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetHeight)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "offsetLeft", - "value": "number", - "description": "The **`offsetLeft`** read-only property of the HTMLElement interface returns the number of pixels that the _upper left corner_ of the current element is offset to the left within the HTMLElement.offsetParent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetLeft)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "offsetParent", - "value": "Element | null", - "description": "The **`HTMLElement.offsetParent`** read-only property returns a reference to the element which is the closest (nearest in the containment hierarchy) positioned ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetParent)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "offsetTop", - "value": "number", - "description": "The **`offsetTop`** read-only property of the HTMLElement interface returns the distance from the outer border of the current element (including its margin) to the top padding edge of the HTMLelement.offsetParent, the _closest positioned_ ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetTop)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "offsetWidth", - "value": "number", - "description": "The **`offsetWidth`** read-only property of the HTMLElement interface returns the layout width of an element as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetWidth)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onabort", - "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/abort_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onanimationcancel", - "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationcancel_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onanimationend", - "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onanimationiteration", - "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onanimationstart", - "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onauxclick", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/auxclick_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onbeforeinput", - "value": "((this: GlobalEventHandlers, ev: InputEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforeinput_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onbeforematch", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforematch_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onbeforetoggle", - "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/beforetoggle_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onblur", - "value": "(event: FocusEvent) => void", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "oncancel", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/cancel_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "oncanplay", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplay_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "oncanplaythrough", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplaythrough_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onchange", - "value": "(event: Event) => void", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onclick", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/click_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onclose", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/close_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "oncontextlost", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextlost_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "oncontextmenu", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/contextmenu_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "oncontextrestored", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextrestored_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "oncopy", - "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/copy_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "oncuechange", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLTrackElement/cuechange_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "oncut", - "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/cut_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ondblclick", - "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/dblclick_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ondrag", - "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drag_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ondragend", - "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragend_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ondragenter", - "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragenter_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ondragleave", - "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragleave_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ondragover", - "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragover_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ondragstart", - "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragstart_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ondrop", - "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drop_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ondurationchange", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/durationchange_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onemptied", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/emptied_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onended", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ended_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onerror", - "value": "OnErrorEventHandler", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/error_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onfocus", - "value": "(event: FocusEvent) => void", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onformdata", - "value": "((this: GlobalEventHandlers, ev: FormDataEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/formdata_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onfullscreenchange", - "value": "((this: Element, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenchange_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onfullscreenerror", - "value": "((this: Element, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenerror_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ongotpointercapture", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/gotpointercapture_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "oninput", - "value": "(event: Event) => void", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "oninvalid", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/invalid_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onkeydown", - "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keydown_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onkeypress", - "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", - "description": "", - "deprecationMessage": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keypress_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onkeyup", - "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keyup_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onload", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/load_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onloadeddata", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadeddata_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onloadedmetadata", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadedmetadata_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onloadstart", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadstart_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onlostpointercapture", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/lostpointercapture_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onmousedown", - "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousedown_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onmouseenter", - "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseenter_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onmouseleave", - "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseleave_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onmousemove", - "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousemove_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onmouseout", - "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseout_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onmouseover", - "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseover_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onmouseup", - "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseup_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onpaste", - "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/paste_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onpause", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/pause_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onplay", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/play_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onplaying", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/playing_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onpointercancel", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointercancel_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onpointerdown", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerdown_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onpointerenter", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerenter_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onpointerleave", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerleave_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onpointermove", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointermove_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onpointerout", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerout_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onpointerover", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerover_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onpointerrawupdate", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "Available only in secure contexts.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerrawupdate_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onpointerup", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerup_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onprogress", - "value": "((this: GlobalEventHandlers, ev: ProgressEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/progress_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onratechange", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ratechange_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onreset", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/reset_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onresize", - "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLVideoElement/resize_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onscroll", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scroll_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onscrollend", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scrollend_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onsecuritypolicyviolation", - "value": "((this: GlobalEventHandlers, ev: SecurityPolicyViolationEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/securitypolicyviolation_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onseeked", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeked_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onseeking", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeking_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onselect", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/select_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onselectionchange", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/selectionchange_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onselectstart", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/selectstart_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onslotchange", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLSlotElement/slotchange_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onstalled", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/stalled_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onsubmit", - "value": "((this: GlobalEventHandlers, ev: SubmitEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/submit_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onsuspend", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/suspend_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ontimeupdate", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/timeupdate_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ontoggle", - "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/toggle_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ontouchcancel", - "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchcancel_event)", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ontouchend", - "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchend_event)", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ontouchmove", - "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchmove_event)", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ontouchstart", - "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchstart_event)", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ontransitioncancel", - "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitioncancel_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ontransitionend", - "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ontransitionrun", - "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionrun_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ontransitionstart", - "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionstart_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onvolumechange", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/volumechange_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onwaiting", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/waiting_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onwebkitanimationend", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "", - "deprecationMessage": "This is a legacy alias of `onanimationend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onwebkitanimationiteration", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "", - "deprecationMessage": "This is a legacy alias of `onanimationiteration`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onwebkitanimationstart", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "", - "deprecationMessage": "This is a legacy alias of `onanimationstart`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onwebkittransitionend", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "", - "deprecationMessage": "This is a legacy alias of `ontransitionend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onwheel", - "value": "((this: GlobalEventHandlers, ev: WheelEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/wheel_event)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "outerHTML", - "value": "string", - "description": "The **`outerHTML`** attribute of the Element DOM interface gets the serialized HTML fragment describing the element including its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/outerHTML)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "outerText", - "value": "string", - "description": "The **`outerText`** property of the HTMLElement interface returns the same value as HTMLElement.innerText.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/outerText)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "ownerDocument", - "value": "Document", - "description": "The read-only **`ownerDocument`** property of the Node interface returns the top-level document object of the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/ownerDocument)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "parentElement", - "value": "HTMLElement | null", - "description": "The read-only **`parentElement`** property of Node interface returns the DOM node's parent Element, or `null` if the node either has no parent, or its parent isn't a DOM Element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentElement)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "parentNode", - "value": "ParentNode | null", - "description": "The read-only **`parentNode`** property of the Node interface returns the parent of the specified node in the DOM tree.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentNode)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "GetAccessor", - "name": "part", - "value": "DOMTokenList", - "description": "The **`part`** property of the Element interface represents the part identifier(s) of the element (i.e., set using the `part` attribute), returned as a DOMTokenList.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/part)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "placeholder", - "value": "string", - "description": "", - "isOptional": true, - "deprecationMessage": "Use `label` instead.", - "isPrivate": true - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "popover", - "value": "string | null", - "description": "The **`popover`** property of the HTMLElement interface gets and sets an element's popover state via JavaScript (`'auto'`, `'hint'`, or `'manual'`), and can be used for feature detection.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/popover)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "prefix", - "value": "string", - "description": "A value to be displayed immediately before the editable portion of the field.\n\nThis is useful for displaying an implied part of the value, such as \"https://\" or \"+353\".\n\nThis cannot be edited by the user, and it isn't included in the value of the field.\n\nIt may not be displayed until the user has interacted with the input. For example, an inline label may take the place of the prefix until the user focuses the input.", - "isOptional": true, - "defaultValue": "''" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "prepend", - "value": "(...nodes: (string | Node)[]) => void", - "description": "Inserts nodes before the first child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/prepend)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "previousElementSibling", - "value": "Element | null", - "description": "Returns the first preceding sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/previousElementSibling)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "previousSibling", - "value": "ChildNode | null", - "description": "The read-only **`previousSibling`** property of the Node interface returns the node immediately preceding the specified one in its parent's or `null` if the specified node is the first in that list.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/previousSibling)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "PROCESSING_INSTRUCTION_NODE", - "value": "7", - "description": "node is a ProcessingInstruction node." - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "querySelector", - "value": "{ (selectors: K): HTMLElementTagNameMap[K]; (selectors: K): SVGElementTagNameMap[K]; (selectors: K): MathMLElementTagNameMap[K]; (selectors: K): HTMLElementDeprecatedTagNameMap[K]; (selectors: string): E; }", - "description": "Returns the first element that is a descendant of node that matches selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelector)", - "deprecationMessage": "Deprecated" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "querySelectorAll", - "value": "{ (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: string): NodeListOf; }", - "description": "Returns all element descendants of node that match selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelectorAll)", - "deprecationMessage": "Deprecated" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "readOnly", - "value": "boolean", - "description": "The field cannot be edited by the user. It is focusable will be announced by screen readers.", - "isOptional": true, - "defaultValue": "false" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "releasePointerCapture", - "value": "(pointerId: number) => void", - "description": "The **`releasePointerCapture()`** method of the previously set for a specific (PointerEvent) _pointer_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/releasePointerCapture)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "remove", - "value": "() => void", - "description": "Removes node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/remove)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "removeAttribute", - "value": "(qualifiedName: string) => void", - "description": "The Element method **`removeAttribute()`** removes the attribute with the specified name from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttribute)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "removeAttributeNode", - "value": "(attr: Attr) => Attr", - "description": "The **`removeAttributeNode()`** method of the Element interface removes the specified Attr node from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNode)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "removeAttributeNS", - "value": "(namespace: string, localName: string) => void", - "description": "The **`removeAttributeNS()`** method of the If you are working with HTML and you don't need to specify the requested attribute as being part of a specific namespace, use the Element.removeAttribute() method instead.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNS)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "removeChild", - "value": "(child: T) => T", - "description": "The **`removeChild()`** method of the Node interface removes a child node from the DOM and returns the removed node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/removeChild)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "removeEventListener", - "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "replaceChild", - "value": "(node: Node, child: T) => T", - "description": "The **`replaceChild()`** method of the Node interface replaces a child node within the given (parent) node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/replaceChild)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "replaceChildren", - "value": "(...nodes: (string | Node)[]) => void", - "description": "Replace all children of node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/replaceChildren)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "replaceWith", - "value": "(...nodes: (string | Node)[]) => void", - "description": "Replaces node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/replaceWith)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "requestFullscreen", - "value": "(options?: FullscreenOptions) => Promise", - "description": "The **`Element.requestFullscreen()`** method issues an asynchronous request to make the element be displayed in fullscreen mode.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestFullscreen)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "requestPointerLock", - "value": "(options?: PointerLockOptions) => Promise", - "description": "The **`requestPointerLock()`** method of the Element interface lets you asynchronously ask for the pointer to be locked on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestPointerLock)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "required", - "value": "boolean", - "description": "Whether the field needs a value. This requirement adds semantic value to the field, but it will not cause an error to appear automatically. If you want to present an error when this field is empty, you can do so with the `error` property.", - "isOptional": true, - "defaultValue": "false" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "role", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/role)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "scroll", - "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", - "description": "The **`scroll()`** method of the Element interface scrolls the element to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scroll)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "scrollBy", - "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", - "description": "The **`scrollBy()`** method of the Element interface scrolls an element by the given amount.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollBy)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "scrollHeight", - "value": "number", - "description": "The **`scrollHeight`** read-only property of the Element interface is a measurement of the height of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollHeight)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "scrollIntoView", - "value": "(arg?: boolean | ScrollIntoViewOptions) => void", - "description": "The Element interface's **`scrollIntoView()`** method scrolls the element's ancestor containers such that the element on which `scrollIntoView()` is called is visible to the user.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollIntoView)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "scrollLeft", - "value": "number", - "description": "The **`scrollLeft`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its left edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollLeft)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "scrollTo", - "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", - "description": "The **`scrollTo()`** method of the Element interface scrolls to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTo)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "scrollTop", - "value": "number", - "description": "The **`scrollTop`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its top edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTop)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "scrollWidth", - "value": "number", - "description": "The **`scrollWidth`** read-only property of the Element interface is a measurement of the width of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollWidth)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "setAttribute", - "value": "(qualifiedName: string, value: string) => void", - "description": "The **`setAttribute()`** method of the Element interface sets the value of an attribute on the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttribute)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "setAttributeNode", - "value": "(attr: Attr) => Attr", - "description": "The **`setAttributeNode()`** method of the Element interface adds a new Attr node to the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNode)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "setAttributeNodeNS", - "value": "(attr: Attr) => Attr", - "description": "The **`setAttributeNodeNS()`** method of the Element interface adds a new namespaced Attr node to an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNodeNS)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "setAttributeNS", - "value": "(namespace: string, qualifiedName: string, value: string) => void", - "description": "`setAttributeNS` adds a new attribute or changes the value of an attribute with the given namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNS)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "setHTMLUnsafe", - "value": "(html: string) => void", - "description": "The **`setHTMLUnsafe()`** method of the Element interface is used to parse a string of HTML into a DocumentFragment, optionally filtering out unwanted elements and attributes, and those that don't belong in the context, and then using it to replace the element's subtree in the DOM.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setHTMLUnsafe)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "setPointerCapture", - "value": "(pointerId: number) => void", - "description": "The **`setPointerCapture()`** method of the _capture target_ of future pointer events.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setPointerCapture)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "shadowRoot", - "value": "ShadowRoot | null", - "description": "The `Element.shadowRoot` read-only property represents the shadow root hosted by the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/shadowRoot)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "showPopover", - "value": "() => void", - "description": "The **`showPopover()`** method of the HTMLElement interface shows a Popover_API element (i.e., one that has a valid `popover` attribute) by adding it to the top layer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/showPopover)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "slot", - "value": "string", - "description": "The **`slot`** property of the Element interface returns the name of the shadow DOM slot the element is inserted in.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/slot)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "spellcheck", - "value": "boolean", - "description": "The **`spellcheck`** property of the HTMLElement interface represents a boolean value that controls the spell-checking hint.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/spellcheck)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "GetAccessor", - "name": "style", - "value": "CSSStyleDeclaration", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/style)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "suffix", - "value": "string", - "description": "A value to be displayed immediately after the editable portion of the field.\n\nThis is useful for displaying an implied part of the value, such as \"@shopify.com\", or \"%\".\n\nThis cannot be edited by the user, and it isn't included in the value of the field.\n\nIt may not be displayed until the user has interacted with the input. For example, an inline label may take the place of the suffix until the user focuses the input.", - "isOptional": true, - "defaultValue": "''" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "tabIndex", - "value": "number", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/tabIndex)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "tagName", - "value": "string", - "description": "The **`tagName`** read-only property of the Element interface returns the tag name of the element on which it's called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/tagName)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "TEXT_NODE", - "value": "3", - "description": "node is a Text node." - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "GetAccessor", - "name": "textContent", - "value": "string", - "description": "[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/Node/textContent)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The **`HTMLElement.title`** property represents the title of the element: the text usually displayed in a 'tooltip' popup when the mouse is over the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/title)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "toggleAttribute", - "value": "(qualifiedName: string, force?: boolean) => boolean", - "description": "The **`toggleAttribute()`** method of the present and adding it if it is not present) on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/toggleAttribute)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "togglePopover", - "value": "(options?: boolean) => boolean", - "description": "The **`togglePopover()`** method of the HTMLElement interface toggles a Popover_API element (i.e., one that has a valid `popover` attribute) between the hidden and showing states.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/togglePopover)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "translate", - "value": "boolean", - "description": "The **`translate`** property of the HTMLElement interface indicates whether an element's attribute values and the values of its Text node children are to be translated when the page is localized, or whether to leave them unchanged.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/translate)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The current value for the field. If omitted, the field will be empty.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "MethodSignature", - "name": "webkitMatchesSelector", - "value": "(selectors: string) => boolean", - "description": "", - "deprecationMessage": "This is a legacy alias of `matches`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "writingSuggestions", - "value": "string", - "description": "The **`writingSuggestions`** property of the HTMLElement interface is a string indicating if browser-provided writing suggestions should be enabled under the scope of the element or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/writingSuggestions)" - } - ], - "value": "export interface TextFieldElement extends TextFieldElementProps, Omit {\n onblur: TextFieldEvents['onBlur'];\n onchange: TextFieldEvents['onChange'];\n onfocus: TextFieldEvents['onFocus'];\n oninput: TextFieldEvents['onInput'];\n}" - } - }, - "TextFieldProps": { - "src/surfaces/checkout/components/TextField.ts": { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "name": "TextFieldProps", - "description": "", - "isPublicDocs": true, - "members": [ - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "autocomplete", - "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", - "isOptional": true, - "defaultValue": "'on' for everything else" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "defaultValue", - "value": "string", - "description": "The default value for the field.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "Disables the field, disallowing any interaction.", - "isOptional": true, - "defaultValue": "false" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "error", - "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "icon", - "value": "'' | 'reset' | 'map' | 'menu' | 'search' | 'circle' | 'filter' | 'image' | 'alert-circle' | 'alert-triangle-filled' | 'alert-triangle' | 'arrow-down' | 'arrow-left' | 'arrow-right' | 'arrow-up-right' | 'arrow-up' | 'bag' | 'bullet' | 'calendar' | 'camera' | 'caret-down' | 'cart' | 'cash-dollar' | 'categories' | 'check-circle' | 'check-circle-filled' | 'check' | 'chevron-down' | 'chevron-left' | 'chevron-right' | 'chevron-up' | 'clipboard' | 'clock' | 'credit-card' | 'delete' | 'delivered' | 'delivery' | 'disabled' | 'discount' | 'edit' | 'email' | 'empty' | 'external' | 'geolocation' | 'gift-card' | 'globe' | 'grid' | 'info-filled' | 'info' | 'list-bulleted' | 'location' | 'lock' | 'menu-horizontal' | 'menu-vertical' | 'minus' | 'mobile' | 'note' | 'order' | 'organization' | 'plus' | 'profile' | 'question-circle-filled' | 'question-circle' | 'reorder' | 'return' | 'savings' | 'settings' | 'star-filled' | 'star-half' | 'star' | 'store' | 'truck' | 'upload' | 'x-circle-filled' | 'x-circle' | 'x'", - "description": "The type of icon to be displayed in the field.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the element.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "label", - "value": "string", - "description": "Content to use as the field label.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "labelAccessibilityVisibility", - "value": "'visible' | 'exclusive'", - "description": "Changes the visibility of the component's label.\n\n- `visible`: the label is visible to all users.\n- `exclusive`: the label is visually hidden but remains in the accessibility tree.", - "isOptional": true, - "defaultValue": "'visible'" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "maxLength", - "value": "number", - "description": "Specifies the maximum number of characters allowed.", - "isOptional": true, - "defaultValue": "Infinity" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "minLength", - "value": "number", - "description": "Specifies the min number of characters allowed.", - "isOptional": true, - "defaultValue": "0" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onBlur", - "value": "(event: FocusEvent) => void", - "description": "A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onChange", - "value": "(event: Event) => void", - "description": "Callback when the user has **finished editing** a field, for example, once they have blurred the field.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onFocus", - "value": "(event: FocusEvent) => void", - "description": "A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "onInput", - "value": "(event: Event) => void", - "description": "Callback when the user makes any changes in the field.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "placeholder", - "value": "string", - "description": "", - "isOptional": true, - "deprecationMessage": "Use `label` instead.", - "isPrivate": true - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "prefix", - "value": "string", - "description": "A value to be displayed immediately before the editable portion of the field.\n\nThis is useful for displaying an implied part of the value, such as \"https://\" or \"+353\".\n\nThis cannot be edited by the user, and it isn't included in the value of the field.\n\nIt may not be displayed until the user has interacted with the input. For example, an inline label may take the place of the prefix until the user focuses the input.", - "isOptional": true, - "defaultValue": "''" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "readOnly", - "value": "boolean", - "description": "The field cannot be edited by the user. It is focusable will be announced by screen readers.", - "isOptional": true, - "defaultValue": "false" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "required", - "value": "boolean", - "description": "Whether the field needs a value. This requirement adds semantic value to the field, but it will not cause an error to appear automatically. If you want to present an error when this field is empty, you can do so with the `error` property.", - "isOptional": true, - "defaultValue": "false" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "suffix", - "value": "string", - "description": "A value to be displayed immediately after the editable portion of the field.\n\nThis is useful for displaying an implied part of the value, such as \"@shopify.com\", or \"%\".\n\nThis cannot be edited by the user, and it isn't included in the value of the field.\n\nIt may not be displayed until the user has interacted with the input. For example, an inline label may take the place of the suffix until the user focuses the input.", - "isOptional": true, - "defaultValue": "''" - }, - { - "filePath": "src/surfaces/checkout/components/TextField.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The current value for the field. If omitted, the field will be empty.", - "isOptional": true - } - ], - "value": "export interface TextFieldProps extends TextFieldElementProps, TextFieldEvents {\n}" - } - }, - "SelectElementProps": { - "src/surfaces/checkout/components/Select.ts": { - "filePath": "src/surfaces/checkout/components/Select.ts", - "name": "SelectElementProps", - "description": "Properties for the Select component element.", - "isPublicDocs": true, - "members": [ - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "autocomplete", - "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", - "isOptional": true, - "defaultValue": "'on' for everything else" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "Disables the field, disallowing any interaction.", - "isOptional": true, - "defaultValue": "false" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "error", - "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the element.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "label", - "value": "string", - "description": "Content to use as the field label.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "placeholder", - "value": "string", - "description": "A short hint that describes the expected value of the field.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "required", - "value": "boolean", - "description": "Whether the field needs a value. This requirement adds semantic value to the field, but it will not cause an error to appear automatically. If you want to present an error when this field is empty, you can do so with the `error` property.", - "isOptional": true, - "defaultValue": "false" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The current value for the field. If omitted, the field will be empty.", - "isOptional": true - } - ], - "value": "export interface SelectElementProps extends Pick {\n}" - } - }, - "SelectEvents": { - "src/surfaces/checkout/components/Select.ts": { - "filePath": "src/surfaces/checkout/components/Select.ts", - "name": "SelectEvents", - "description": "", - "isPublicDocs": true, - "members": [ - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "onBlur", - "value": "(event: FocusEvent) => void", - "description": "A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "onChange", - "value": "(event: Event) => void", - "description": "Callback when the user has **finished editing** a field, for example, once they have blurred the field.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "onFocus", - "value": "(event: FocusEvent) => void", - "description": "A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", - "isOptional": true - } - ], - "value": "export interface SelectEvents extends Pick {\n}" - } - }, - "SelectElementEvents": { - "src/surfaces/checkout/components/Select.ts": { - "filePath": "src/surfaces/checkout/components/Select.ts", - "name": "SelectElementEvents", - "description": "Events for the Select component element.", - "isPublicDocs": true, - "members": [ - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "blur", - "value": "CallbackEventListener", - "description": "A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "change", - "value": "CallbackEventListener", - "description": "Callback when the user has **finished editing** a field, for example, once they have blurred the field.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "focus", - "value": "CallbackEventListener", - "description": "A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", - "isOptional": true - } - ], - "value": "export interface SelectElementEvents {\n /**\n * A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event\n */\n blur?: CallbackEventListener;\n /**\n * Callback when the user has **finished editing** a field, for example, once they have blurred the field.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event\n */\n change?: CallbackEventListener;\n /**\n * A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event\n */\n focus?: CallbackEventListener;\n}" - } - }, - "SelectElement": { - "src/surfaces/checkout/components/Select.ts": { - "filePath": "src/surfaces/checkout/components/Select.ts", - "name": "SelectElement", - "description": "", - "isPublicDocs": true, - "members": [ - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "accessKey", - "value": "string", - "description": "The **`HTMLElement.accessKey`** property sets the keystroke which a user can press to jump to a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKey)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "accessKeyLabel", - "value": "string", - "description": "The **`HTMLElement.accessKeyLabel`** read-only property returns a string containing the element's browser-assigned access key (if any); otherwise it returns an empty string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKeyLabel)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "MethodSignature", - "name": "addEventListener", - "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "MethodSignature", - "name": "after", - "value": "(...nodes: (string | Node)[]) => void", - "description": "Inserts nodes just after node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/after)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "MethodSignature", - "name": "animate", - "value": "(keyframes: Keyframe[] | PropertyIndexedKeyframes, options?: number | KeyframeAnimationOptions) => Animation", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animate)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "MethodSignature", - "name": "append", - "value": "(...nodes: (string | Node)[]) => void", - "description": "Inserts nodes after the last child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/append)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "MethodSignature", - "name": "appendChild", - "value": "(node: T) => T", - "description": "The **`appendChild()`** method of the Node interface adds a node to the end of the list of children of a specified parent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/appendChild)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "ariaActiveDescendantElement", - "value": "Element | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaActiveDescendantElement)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "ariaAtomic", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAtomic)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "ariaAutoComplete", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAutoComplete)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "ariaBrailleLabel", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleLabel)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "ariaBrailleRoleDescription", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleRoleDescription)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "ariaBusy", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBusy)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "ariaChecked", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaChecked)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "ariaColCount", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColCount)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "ariaColIndex", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndex)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "ariaColIndexText", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndexText)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "ariaColSpan", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColSpan)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "ariaControlsElements", - "value": "ReadonlyArray | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaControlsElements)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "ariaCurrent", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaCurrent)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "ariaDescribedByElements", - "value": "ReadonlyArray | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescribedByElements)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "ariaDescription", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescription)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "ariaDetailsElements", - "value": "ReadonlyArray | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDetailsElements)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "ariaDisabled", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDisabled)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "ariaErrorMessageElements", - "value": "ReadonlyArray | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaErrorMessageElements)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "ariaExpanded", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaExpanded)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "ariaFlowToElements", - "value": "ReadonlyArray | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaFlowToElements)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "ariaHasPopup", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHasPopup)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "ariaHidden", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHidden)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "ariaInvalid", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaInvalid)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "ariaKeyShortcuts", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaKeyShortcuts)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "ariaLabel", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabel)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "ariaLabelledByElements", - "value": "ReadonlyArray | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabelledByElements)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "ariaLevel", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLevel)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "ariaLive", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLive)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "ariaModal", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaModal)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "ariaMultiLine", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiLine)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "ariaMultiSelectable", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiSelectable)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "ariaOrientation", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOrientation)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "ariaOwnsElements", - "value": "ReadonlyArray | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOwnsElements)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "ariaPlaceholder", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPlaceholder)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "ariaPosInSet", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPosInSet)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "ariaPressed", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPressed)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "ariaReadOnly", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaReadOnly)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "ariaRelevant", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRelevant)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "ariaRequired", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRequired)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "ariaRoleDescription", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRoleDescription)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "ariaRowCount", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowCount)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "ariaRowIndex", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndex)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "ariaRowIndexText", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndexText)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "ariaRowSpan", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowSpan)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "ariaSelected", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSelected)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "ariaSetSize", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSetSize)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "ariaSort", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSort)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "ariaValueMax", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMax)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "ariaValueMin", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMin)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "ariaValueNow", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueNow)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "ariaValueText", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueText)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "assignedSlot", - "value": "HTMLSlotElement | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/assignedSlot)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "MethodSignature", - "name": "attachInternals", - "value": "() => ElementInternals", - "description": "The **`HTMLElement.attachInternals()`** method returns an ElementInternals object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attachInternals)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "MethodSignature", - "name": "attachShadow", - "value": "(init: ShadowRootInit) => ShadowRoot", - "description": "The **`Element.attachShadow()`** method attaches a shadow DOM tree to the specified element and returns a reference to its ShadowRoot.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attachShadow)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "ATTRIBUTE_NODE", - "value": "2", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "NamedNodeMap", - "description": "The **`Element.attributes`** property returns a live collection of all attribute nodes registered to the specified node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attributes)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "attributeStyleMap", - "value": "StylePropertyMap", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attributeStyleMap)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "autocapitalize", - "value": "string", - "description": "The **`autocapitalize`** property of the HTMLElement interface represents the element's capitalization behavior for user input.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocapitalize)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "autocomplete", - "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", - "isOptional": true, - "defaultValue": "'on' for everything else" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "autocorrect", - "value": "boolean", - "description": "The **`autocorrect`** property of the HTMLElement interface controls whether or not autocorrection of editable text is enabled for spelling and/or punctuation errors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocorrect)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "autofocus", - "value": "boolean", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autofocus)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "baseURI", - "value": "string", - "description": "The read-only **`baseURI`** property of the Node interface returns the absolute base URL of the document containing the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/baseURI)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "MethodSignature", - "name": "before", - "value": "(...nodes: (string | Node)[]) => void", - "description": "Inserts nodes just before node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/before)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "MethodSignature", - "name": "blur", - "value": "() => void", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/blur)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "CDATA_SECTION_NODE", - "value": "4", - "description": "node is a CDATASection node." - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "MethodSignature", - "name": "checkVisibility", - "value": "(options?: CheckVisibilityOptions) => boolean", - "description": "The **`checkVisibility()`** method of the Element interface checks whether the element is visible.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/checkVisibility)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "childElementCount", - "value": "number", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/childElementCount)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "childNodes", - "value": "NodeListOf", - "description": "The read-only **`childNodes`** property of the Node interface returns a live the first child node is assigned index `0`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/childNodes)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "HTMLCollection", - "description": "Returns the child elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/children)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "GetAccessor", - "name": "classList", - "value": "DOMTokenList", - "description": "The **`Element.classList`** is a read-only property that returns a live DOMTokenList collection of the `class` attributes of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/classList)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "className", - "value": "string", - "description": "The **`className`** property of the of the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/className)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "MethodSignature", - "name": "click", - "value": "() => void", - "description": "The **`HTMLElement.click()`** method simulates a mouse click on an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/click)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "clientHeight", - "value": "number", - "description": "The **`clientHeight`** read-only property of the Element interface is zero for elements with no CSS or inline layout boxes; otherwise, it's the inner height of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientHeight)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "clientLeft", - "value": "number", - "description": "The **`clientLeft`** read-only property of the Element interface returns the width of the left border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientLeft)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "clientTop", - "value": "number", - "description": "The **`clientTop`** read-only property of the Element interface returns the width of the top border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientTop)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "clientWidth", - "value": "number", - "description": "The **`clientWidth`** read-only property of the Element interface is zero for inline elements and elements with no CSS; otherwise, it's the inner width of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientWidth)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "MethodSignature", - "name": "cloneNode", - "value": "(subtree?: boolean) => Node", - "description": "The **`cloneNode()`** method of the Node interface returns a duplicate of the node on which this method was called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/cloneNode)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "MethodSignature", - "name": "closest", - "value": "{ (selector: K): HTMLElementTagNameMap[K]; (selector: K): SVGElementTagNameMap[K]; (selector: K): MathMLElementTagNameMap[K]; (selectors: string): E; }", - "description": "The **`closest()`** method of the Element interface traverses the element and its parents (heading toward the document root) until it finds a node that matches the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/closest)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "COMMENT_NODE", - "value": "8", - "description": "node is a Comment node." - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "MethodSignature", - "name": "compareDocumentPosition", - "value": "(other: Node) => number", - "description": "The **`compareDocumentPosition()`** method of the Node interface reports the position of its argument node relative to the node on which it is called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/compareDocumentPosition)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "MethodSignature", - "name": "computedStyleMap", - "value": "() => StylePropertyMapReadOnly", - "description": "The **`computedStyleMap()`** method of the Element interface returns a StylePropertyMapReadOnly interface which provides a read-only representation of a CSS declaration block that is an alternative to CSSStyleDeclaration.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/computedStyleMap)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "MethodSignature", - "name": "contains", - "value": "(other: Node) => boolean", - "description": "The **`contains()`** method of the Node interface returns a boolean value indicating whether a node is a descendant of a given node, that is the node itself, one of its direct children (Node.childNodes), one of the children's direct children, and so on.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/contains)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "contentEditable", - "value": "string", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/contentEditable)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "currentCSSZoom", - "value": "number", - "description": "The **`currentCSSZoom`** read-only property of the Element interface provides the 'effective' CSS `zoom` of an element, taking into account the zoom applied to the element and all its parent elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/currentCSSZoom)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "dataset", - "value": "DOMStringMap", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dataset)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "dir", - "value": "string", - "description": "The **`HTMLElement.dir`** property indicates the text writing directionality of the content of the current element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dir)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "Disables the field, disallowing any interaction.", - "isOptional": true, - "defaultValue": "false" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "MethodSignature", - "name": "dispatchEvent", - "value": "(event: Event) => boolean", - "description": "The **`dispatchEvent()`** method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/dispatchEvent)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "DOCUMENT_FRAGMENT_NODE", - "value": "11", - "description": "node is a DocumentFragment node." - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "DOCUMENT_NODE", - "value": "9", - "description": "node is a document." - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "DOCUMENT_POSITION_CONTAINED_BY", - "value": "16", - "description": "Set when other is a descendant of node." - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "DOCUMENT_POSITION_CONTAINS", - "value": "8", - "description": "Set when other is an ancestor of node." - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "DOCUMENT_POSITION_DISCONNECTED", - "value": "1", - "description": "Set when node and other are not in the same tree." - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "DOCUMENT_POSITION_FOLLOWING", - "value": "4", - "description": "Set when other is following node." - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC", - "value": "32", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "DOCUMENT_POSITION_PRECEDING", - "value": "2", - "description": "Set when other is preceding node." - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "DOCUMENT_TYPE_NODE", - "value": "10", - "description": "node is a doctype." - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "draggable", - "value": "boolean", - "description": "The **`draggable`** property of the HTMLElement interface gets and sets a Boolean primitive indicating if the element is draggable.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/draggable)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "ELEMENT_NODE", - "value": "1", - "description": "node is an element." - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "enterKeyHint", - "value": "string", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/enterKeyHint)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "ENTITY_NODE", - "value": "6", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "ENTITY_REFERENCE_NODE", - "value": "5", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "error", - "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "firstChild", - "value": "ChildNode | null", - "description": "The read-only **`firstChild`** property of the Node interface returns the node's first child in the tree, or `null` if the node has no children.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/firstChild)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "firstElementChild", - "value": "Element | null", - "description": "Returns the first child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/firstElementChild)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "MethodSignature", - "name": "focus", - "value": "(options?: FocusOptions) => void", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/focus)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "MethodSignature", - "name": "getAnimations", - "value": "(options?: GetAnimationsOptions) => Animation[]", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAnimations)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "MethodSignature", - "name": "getAttribute", - "value": "(qualifiedName: string) => string", - "description": "The **`getAttribute()`** method of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttribute)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "MethodSignature", - "name": "getAttributeNames", - "value": "() => string[]", - "description": "The **`getAttributeNames()`** method of the array.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNames)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "MethodSignature", - "name": "getAttributeNode", - "value": "(qualifiedName: string) => Attr", - "description": "Returns the specified attribute of the specified element, as an Attr node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNode)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "MethodSignature", - "name": "getAttributeNodeNS", - "value": "(namespace: string, localName: string) => Attr", - "description": "The **`getAttributeNodeNS()`** method of the Element interface returns the namespaced Attr node of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNodeNS)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "MethodSignature", - "name": "getAttributeNS", - "value": "(namespace: string, localName: string) => string", - "description": "The **`getAttributeNS()`** method of the Element interface returns the string value of the attribute with the specified namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNS)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "MethodSignature", - "name": "getBoundingClientRect", - "value": "() => DOMRect", - "description": "The **`Element.getBoundingClientRect()`** method returns a position relative to the viewport.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getBoundingClientRect)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "MethodSignature", - "name": "getClientRects", - "value": "() => DOMRectList", - "description": "The **`getClientRects()`** method of the Element interface returns a collection of DOMRect objects that indicate the bounding rectangles for each CSS border box in a client.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getClientRects)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "MethodSignature", - "name": "getElementsByClassName", - "value": "(classNames: string) => HTMLCollectionOf", - "description": "The Element method **`getElementsByClassName()`** returns a live specified class name or names.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByClassName)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "MethodSignature", - "name": "getElementsByTagName", - "value": "{ (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: string): HTMLCollectionOf; }", - "description": "The **`Element.getElementsByTagName()`** method returns a live All descendants of the specified element are searched, but not the element itself.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagName)", - "deprecationMessage": "Deprecated" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "MethodSignature", - "name": "getElementsByTagNameNS", - "value": "{ (namespaceURI: \"http://www.w3.org/1999/xhtml\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/2000/svg\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/1998/Math/MathML\", localName: string): HTMLCollectionOf; (namespace: string, localName: string): HTMLCollectionOf; }", - "description": "The **`Element.getElementsByTagNameNS()`** method returns a live HTMLCollection of elements with the given tag name belonging to the given namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagNameNS)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "MethodSignature", - "name": "getHTML", - "value": "(options?: GetHTMLOptions) => string", - "description": "The **`getHTML()`** method of the Element interface is used to serialize an element's DOM to an HTML string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getHTML)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "MethodSignature", - "name": "getRootNode", - "value": "(options?: GetRootNodeOptions) => Node", - "description": "The **`getRootNode()`** method of the Node interface returns the context object's root, which optionally includes the shadow root if it is available.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/getRootNode)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "MethodSignature", - "name": "hasAttribute", - "value": "(qualifiedName: string) => boolean", - "description": "The **`Element.hasAttribute()`** method returns a **Boolean** value indicating whether the specified element has the specified attribute or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttribute)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "MethodSignature", - "name": "hasAttributeNS", - "value": "(namespace: string, localName: string) => boolean", - "description": "The **`hasAttributeNS()`** method of the Element interface returns a boolean value indicating whether the current element has the specified attribute with the specified namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributeNS)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "MethodSignature", - "name": "hasAttributes", - "value": "() => boolean", - "description": "The **`hasAttributes()`** method of the Element interface returns a boolean value indicating whether the current element has any attributes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributes)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "MethodSignature", - "name": "hasChildNodes", - "value": "() => boolean", - "description": "The **`hasChildNodes()`** method of the Node interface returns a boolean value indicating whether the given Node has child nodes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/hasChildNodes)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "MethodSignature", - "name": "hasPointerCapture", - "value": "(pointerId: number) => boolean", - "description": "The **`hasPointerCapture()`** method of the pointer capture for the pointer identified by the given pointer ID.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasPointerCapture)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "hidden", - "value": "boolean", - "description": "The HTMLElement property **`hidden`** reflects the value of the element's `hidden` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidden)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "MethodSignature", - "name": "hidePopover", - "value": "() => void", - "description": "The **`hidePopover()`** method of the HTMLElement interface hides a popover element (i.e., one that has a valid `popover` attribute) by removing it from the top layer and styling it with `display: none`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidePopover)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the element.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "inert", - "value": "boolean", - "description": "The HTMLElement property **`inert`** reflects the value of the element's `inert` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inert)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "innerHTML", - "value": "string", - "description": "The **`innerHTML`** property of the Element interface gets or sets the HTML or XML markup contained within the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/innerHTML)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "innerText", - "value": "string", - "description": "The **`innerText`** property of the HTMLElement interface represents the rendered text content of a node and its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/innerText)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "inputMode", - "value": "string", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inputMode)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "MethodSignature", - "name": "insertAdjacentElement", - "value": "(where: InsertPosition, element: Element) => Element", - "description": "The **`insertAdjacentElement()`** method of the relative to the element it is invoked upon.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentElement)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "MethodSignature", - "name": "insertAdjacentHTML", - "value": "(position: InsertPosition, string: string) => void", - "description": "The **`insertAdjacentHTML()`** method of the the resulting nodes into the DOM tree at a specified position.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentHTML)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "MethodSignature", - "name": "insertAdjacentText", - "value": "(where: InsertPosition, data: string) => void", - "description": "The **`insertAdjacentText()`** method of the Element interface, given a relative position and a string, inserts a new text node at the given position relative to the element it is called from.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentText)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "MethodSignature", - "name": "insertBefore", - "value": "(node: T, child: Node) => T", - "description": "The **`insertBefore()`** method of the Node interface inserts a node before a _reference node_ as a child of a specified _parent node_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/insertBefore)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "isConnected", - "value": "boolean", - "description": "The read-only **`isConnected`** property of the Node interface returns a boolean indicating whether the node is connected (directly or indirectly) to a Document object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isConnected)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "isContentEditable", - "value": "boolean", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/isContentEditable)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "MethodSignature", - "name": "isDefaultNamespace", - "value": "(namespace: string) => boolean", - "description": "The **`isDefaultNamespace()`** method of the Node interface accepts a namespace URI as an argument.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isDefaultNamespace)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "MethodSignature", - "name": "isEqualNode", - "value": "(otherNode: Node) => boolean", - "description": "The **`isEqualNode()`** method of the Node interface tests whether two nodes are equal.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isEqualNode)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "MethodSignature", - "name": "isSameNode", - "value": "(otherNode: Node) => boolean", - "description": "The **`isSameNode()`** method of the Node interface is a legacy alias the for the `===` strict equality operator.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isSameNode)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "label", - "value": "string", - "description": "Content to use as the field label.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "lang", - "value": "string", - "description": "The **`lang`** property of the HTMLElement interface indicates the base language of an element's attribute values and text content, in the form of a MISSING: RFC(5646, 'BCP 47 language identifier tag')].\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/lang)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "lastChild", - "value": "ChildNode | null", - "description": "The read-only **`lastChild`** property of the Node interface returns the last child of the node, or `null` if there are no child nodes.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lastChild)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "lastElementChild", - "value": "Element | null", - "description": "Returns the last child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/lastElementChild)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "localName", - "value": "string", - "description": "The **`Element.localName`** read-only property returns the local part of the qualified name of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/localName)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "MethodSignature", - "name": "lookupNamespaceURI", - "value": "(prefix: string) => string", - "description": "The **`lookupNamespaceURI()`** method of the Node interface takes a prefix as parameter and returns the namespace URI associated with it on the given node if found (and `null` if not).\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupNamespaceURI)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "MethodSignature", - "name": "lookupPrefix", - "value": "(namespace: string) => string", - "description": "The **`lookupPrefix()`** method of the Node interface returns a string containing the prefix for a given namespace URI, if present, and `null` if not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupPrefix)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "MethodSignature", - "name": "matches", - "value": "(selectors: string) => boolean", - "description": "The **`matches()`** method of the Element interface tests whether the element would be selected by the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "namespaceURI", - "value": "string | null", - "description": "The **`Element.namespaceURI`** read-only property returns the namespace URI of the element, or `null` if the element is not in a namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/namespaceURI)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "nextElementSibling", - "value": "Element | null", - "description": "Returns the first following sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/nextElementSibling)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "nextSibling", - "value": "ChildNode | null", - "description": "The read-only **`nextSibling`** property of the Node interface returns the node immediately following the specified one in their parent's Node.childNodes, or returns `null` if the specified node is the last child in the parent element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nextSibling)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "nodeName", - "value": "string", - "description": "The read-only **`nodeName`** property of Node returns the name of the current node as a string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeName)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "nodeType", - "value": "number", - "description": "The read-only **`nodeType`** property of a Node interface is an integer that identifies what the node is.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeType)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "nodeValue", - "value": "string | null", - "description": "The **`nodeValue`** property of the Node interface returns or sets the value of the current node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeValue)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "nonce", - "value": "string", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/nonce)", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "MethodSignature", - "name": "normalize", - "value": "() => void", - "description": "The **`normalize()`** method of the Node interface puts the specified node and all of its sub-tree into a _normalized_ form.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/normalize)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "NOTATION_NODE", - "value": "12", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "offsetHeight", - "value": "number", - "description": "The **`offsetHeight`** read-only property of the HTMLElement interface returns the height of an element, including vertical padding and borders, as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetHeight)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "offsetLeft", - "value": "number", - "description": "The **`offsetLeft`** read-only property of the HTMLElement interface returns the number of pixels that the _upper left corner_ of the current element is offset to the left within the HTMLElement.offsetParent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetLeft)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "offsetParent", - "value": "Element | null", - "description": "The **`HTMLElement.offsetParent`** read-only property returns a reference to the element which is the closest (nearest in the containment hierarchy) positioned ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetParent)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "offsetTop", - "value": "number", - "description": "The **`offsetTop`** read-only property of the HTMLElement interface returns the distance from the outer border of the current element (including its margin) to the top padding edge of the HTMLelement.offsetParent, the _closest positioned_ ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetTop)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "offsetWidth", - "value": "number", - "description": "The **`offsetWidth`** read-only property of the HTMLElement interface returns the layout width of an element as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetWidth)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "onabort", - "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/abort_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "onanimationcancel", - "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationcancel_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "onanimationend", - "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "onanimationiteration", - "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "onanimationstart", - "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "onauxclick", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/auxclick_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "onbeforeinput", - "value": "((this: GlobalEventHandlers, ev: InputEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforeinput_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "onbeforematch", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforematch_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "onbeforetoggle", - "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/beforetoggle_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "onblur", - "value": "(event: FocusEvent) => void", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "oncancel", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/cancel_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "oncanplay", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplay_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "oncanplaythrough", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplaythrough_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "onchange", - "value": "(event: Event) => void", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "onclick", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/click_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "onclose", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/close_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "oncontextlost", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextlost_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "oncontextmenu", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/contextmenu_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "oncontextrestored", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextrestored_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "oncopy", - "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/copy_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "oncuechange", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLTrackElement/cuechange_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "oncut", - "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/cut_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "ondblclick", - "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/dblclick_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "ondrag", - "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drag_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "ondragend", - "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragend_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "ondragenter", - "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragenter_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "ondragleave", - "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragleave_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "ondragover", - "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragover_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "ondragstart", - "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragstart_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "ondrop", - "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drop_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "ondurationchange", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/durationchange_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "onemptied", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/emptied_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "onended", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ended_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "onerror", - "value": "OnErrorEventHandler", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/error_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "onfocus", - "value": "(event: FocusEvent) => void", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "onformdata", - "value": "((this: GlobalEventHandlers, ev: FormDataEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/formdata_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "onfullscreenchange", - "value": "((this: Element, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenchange_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "onfullscreenerror", - "value": "((this: Element, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenerror_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "ongotpointercapture", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/gotpointercapture_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "oninput", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/input_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "oninvalid", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/invalid_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "onkeydown", - "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keydown_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "onkeypress", - "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", - "description": "", - "deprecationMessage": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keypress_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "onkeyup", - "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keyup_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "onload", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/load_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "onloadeddata", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadeddata_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "onloadedmetadata", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadedmetadata_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "onloadstart", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadstart_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "onlostpointercapture", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/lostpointercapture_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "onmousedown", - "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousedown_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "onmouseenter", - "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseenter_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "onmouseleave", - "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseleave_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "onmousemove", - "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousemove_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "onmouseout", - "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseout_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "onmouseover", - "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseover_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "onmouseup", - "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseup_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "onpaste", - "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/paste_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "onpause", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/pause_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "onplay", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/play_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "onplaying", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/playing_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "onpointercancel", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointercancel_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "onpointerdown", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerdown_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "onpointerenter", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerenter_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "onpointerleave", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerleave_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "onpointermove", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointermove_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "onpointerout", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerout_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "onpointerover", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerover_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "onpointerrawupdate", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "Available only in secure contexts.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerrawupdate_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "onpointerup", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerup_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "onprogress", - "value": "((this: GlobalEventHandlers, ev: ProgressEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/progress_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "onratechange", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ratechange_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "onreset", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/reset_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "onresize", - "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLVideoElement/resize_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "onscroll", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scroll_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "onscrollend", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scrollend_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "onsecuritypolicyviolation", - "value": "((this: GlobalEventHandlers, ev: SecurityPolicyViolationEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/securitypolicyviolation_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "onseeked", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeked_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "onseeking", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeking_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "onselect", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/select_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "onselectionchange", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/selectionchange_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "onselectstart", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/selectstart_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "onslotchange", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLSlotElement/slotchange_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "onstalled", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/stalled_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "onsubmit", - "value": "((this: GlobalEventHandlers, ev: SubmitEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/submit_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "onsuspend", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/suspend_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "ontimeupdate", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/timeupdate_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "ontoggle", - "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/toggle_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "ontouchcancel", - "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchcancel_event)", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "ontouchend", - "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchend_event)", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "ontouchmove", - "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchmove_event)", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "ontouchstart", - "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchstart_event)", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "ontransitioncancel", - "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitioncancel_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "ontransitionend", - "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "ontransitionrun", - "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionrun_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "ontransitionstart", - "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionstart_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "onvolumechange", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/volumechange_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "onwaiting", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/waiting_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "onwebkitanimationend", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "", - "deprecationMessage": "This is a legacy alias of `onanimationend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "onwebkitanimationiteration", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "", - "deprecationMessage": "This is a legacy alias of `onanimationiteration`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "onwebkitanimationstart", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "", - "deprecationMessage": "This is a legacy alias of `onanimationstart`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "onwebkittransitionend", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "", - "deprecationMessage": "This is a legacy alias of `ontransitionend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "onwheel", - "value": "((this: GlobalEventHandlers, ev: WheelEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/wheel_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "outerHTML", - "value": "string", - "description": "The **`outerHTML`** attribute of the Element DOM interface gets the serialized HTML fragment describing the element including its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/outerHTML)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "outerText", - "value": "string", - "description": "The **`outerText`** property of the HTMLElement interface returns the same value as HTMLElement.innerText.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/outerText)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "ownerDocument", - "value": "Document", - "description": "The read-only **`ownerDocument`** property of the Node interface returns the top-level document object of the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/ownerDocument)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "parentElement", - "value": "HTMLElement | null", - "description": "The read-only **`parentElement`** property of Node interface returns the DOM node's parent Element, or `null` if the node either has no parent, or its parent isn't a DOM Element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentElement)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "parentNode", - "value": "ParentNode | null", - "description": "The read-only **`parentNode`** property of the Node interface returns the parent of the specified node in the DOM tree.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentNode)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "GetAccessor", - "name": "part", - "value": "DOMTokenList", - "description": "The **`part`** property of the Element interface represents the part identifier(s) of the element (i.e., set using the `part` attribute), returned as a DOMTokenList.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/part)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "placeholder", - "value": "string", - "description": "A short hint that describes the expected value of the field.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "popover", - "value": "string | null", - "description": "The **`popover`** property of the HTMLElement interface gets and sets an element's popover state via JavaScript (`'auto'`, `'hint'`, or `'manual'`), and can be used for feature detection.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/popover)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "prefix", - "value": "string | null", - "description": "The **`Element.prefix`** read-only property returns the namespace prefix of the specified element, or `null` if no prefix is specified.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/prefix)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "MethodSignature", - "name": "prepend", - "value": "(...nodes: (string | Node)[]) => void", - "description": "Inserts nodes before the first child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/prepend)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "previousElementSibling", - "value": "Element | null", - "description": "Returns the first preceding sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/previousElementSibling)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "previousSibling", - "value": "ChildNode | null", - "description": "The read-only **`previousSibling`** property of the Node interface returns the node immediately preceding the specified one in its parent's or `null` if the specified node is the first in that list.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/previousSibling)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "PROCESSING_INSTRUCTION_NODE", - "value": "7", - "description": "node is a ProcessingInstruction node." - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "MethodSignature", - "name": "querySelector", - "value": "{ (selectors: K): HTMLElementTagNameMap[K]; (selectors: K): SVGElementTagNameMap[K]; (selectors: K): MathMLElementTagNameMap[K]; (selectors: K): HTMLElementDeprecatedTagNameMap[K]; (selectors: string): E; }", - "description": "Returns the first element that is a descendant of node that matches selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelector)", - "deprecationMessage": "Deprecated" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "MethodSignature", - "name": "querySelectorAll", - "value": "{ (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: string): NodeListOf; }", - "description": "Returns all element descendants of node that match selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelectorAll)", - "deprecationMessage": "Deprecated" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "MethodSignature", - "name": "releasePointerCapture", - "value": "(pointerId: number) => void", - "description": "The **`releasePointerCapture()`** method of the previously set for a specific (PointerEvent) _pointer_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/releasePointerCapture)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "MethodSignature", - "name": "remove", - "value": "() => void", - "description": "Removes node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/remove)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "MethodSignature", - "name": "removeAttribute", - "value": "(qualifiedName: string) => void", - "description": "The Element method **`removeAttribute()`** removes the attribute with the specified name from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttribute)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "MethodSignature", - "name": "removeAttributeNode", - "value": "(attr: Attr) => Attr", - "description": "The **`removeAttributeNode()`** method of the Element interface removes the specified Attr node from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNode)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "MethodSignature", - "name": "removeAttributeNS", - "value": "(namespace: string, localName: string) => void", - "description": "The **`removeAttributeNS()`** method of the If you are working with HTML and you don't need to specify the requested attribute as being part of a specific namespace, use the Element.removeAttribute() method instead.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNS)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "MethodSignature", - "name": "removeChild", - "value": "(child: T) => T", - "description": "The **`removeChild()`** method of the Node interface removes a child node from the DOM and returns the removed node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/removeChild)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "MethodSignature", - "name": "removeEventListener", - "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "MethodSignature", - "name": "replaceChild", - "value": "(node: Node, child: T) => T", - "description": "The **`replaceChild()`** method of the Node interface replaces a child node within the given (parent) node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/replaceChild)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "MethodSignature", - "name": "replaceChildren", - "value": "(...nodes: (string | Node)[]) => void", - "description": "Replace all children of node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/replaceChildren)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "MethodSignature", - "name": "replaceWith", - "value": "(...nodes: (string | Node)[]) => void", - "description": "Replaces node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/replaceWith)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "MethodSignature", - "name": "requestFullscreen", - "value": "(options?: FullscreenOptions) => Promise", - "description": "The **`Element.requestFullscreen()`** method issues an asynchronous request to make the element be displayed in fullscreen mode.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestFullscreen)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "MethodSignature", - "name": "requestPointerLock", - "value": "(options?: PointerLockOptions) => Promise", - "description": "The **`requestPointerLock()`** method of the Element interface lets you asynchronously ask for the pointer to be locked on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestPointerLock)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "required", - "value": "boolean", - "description": "Whether the field needs a value. This requirement adds semantic value to the field, but it will not cause an error to appear automatically. If you want to present an error when this field is empty, you can do so with the `error` property.", - "isOptional": true, - "defaultValue": "false" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "role", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/role)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "MethodSignature", - "name": "scroll", - "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", - "description": "The **`scroll()`** method of the Element interface scrolls the element to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scroll)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "MethodSignature", - "name": "scrollBy", - "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", - "description": "The **`scrollBy()`** method of the Element interface scrolls an element by the given amount.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollBy)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "scrollHeight", - "value": "number", - "description": "The **`scrollHeight`** read-only property of the Element interface is a measurement of the height of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollHeight)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "MethodSignature", - "name": "scrollIntoView", - "value": "(arg?: boolean | ScrollIntoViewOptions) => void", - "description": "The Element interface's **`scrollIntoView()`** method scrolls the element's ancestor containers such that the element on which `scrollIntoView()` is called is visible to the user.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollIntoView)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "scrollLeft", - "value": "number", - "description": "The **`scrollLeft`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its left edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollLeft)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "MethodSignature", - "name": "scrollTo", - "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", - "description": "The **`scrollTo()`** method of the Element interface scrolls to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTo)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "scrollTop", - "value": "number", - "description": "The **`scrollTop`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its top edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTop)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "scrollWidth", - "value": "number", - "description": "The **`scrollWidth`** read-only property of the Element interface is a measurement of the width of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollWidth)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "MethodSignature", - "name": "setAttribute", - "value": "(qualifiedName: string, value: string) => void", - "description": "The **`setAttribute()`** method of the Element interface sets the value of an attribute on the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttribute)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "MethodSignature", - "name": "setAttributeNode", - "value": "(attr: Attr) => Attr", - "description": "The **`setAttributeNode()`** method of the Element interface adds a new Attr node to the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNode)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "MethodSignature", - "name": "setAttributeNodeNS", - "value": "(attr: Attr) => Attr", - "description": "The **`setAttributeNodeNS()`** method of the Element interface adds a new namespaced Attr node to an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNodeNS)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "MethodSignature", - "name": "setAttributeNS", - "value": "(namespace: string, qualifiedName: string, value: string) => void", - "description": "`setAttributeNS` adds a new attribute or changes the value of an attribute with the given namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNS)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "MethodSignature", - "name": "setHTMLUnsafe", - "value": "(html: string) => void", - "description": "The **`setHTMLUnsafe()`** method of the Element interface is used to parse a string of HTML into a DocumentFragment, optionally filtering out unwanted elements and attributes, and those that don't belong in the context, and then using it to replace the element's subtree in the DOM.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setHTMLUnsafe)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "MethodSignature", - "name": "setPointerCapture", - "value": "(pointerId: number) => void", - "description": "The **`setPointerCapture()`** method of the _capture target_ of future pointer events.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setPointerCapture)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "shadowRoot", - "value": "ShadowRoot | null", - "description": "The `Element.shadowRoot` read-only property represents the shadow root hosted by the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/shadowRoot)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "MethodSignature", - "name": "showPopover", - "value": "() => void", - "description": "The **`showPopover()`** method of the HTMLElement interface shows a Popover_API element (i.e., one that has a valid `popover` attribute) by adding it to the top layer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/showPopover)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "slot", - "value": "string", - "description": "The **`slot`** property of the Element interface returns the name of the shadow DOM slot the element is inserted in.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/slot)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "spellcheck", - "value": "boolean", - "description": "The **`spellcheck`** property of the HTMLElement interface represents a boolean value that controls the spell-checking hint.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/spellcheck)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "GetAccessor", - "name": "style", - "value": "CSSStyleDeclaration", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/style)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "tabIndex", - "value": "number", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/tabIndex)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "tagName", - "value": "string", - "description": "The **`tagName`** read-only property of the Element interface returns the tag name of the element on which it's called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/tagName)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "TEXT_NODE", - "value": "3", - "description": "node is a Text node." - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "GetAccessor", - "name": "textContent", - "value": "string", - "description": "[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/Node/textContent)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The **`HTMLElement.title`** property represents the title of the element: the text usually displayed in a 'tooltip' popup when the mouse is over the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/title)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "MethodSignature", - "name": "toggleAttribute", - "value": "(qualifiedName: string, force?: boolean) => boolean", - "description": "The **`toggleAttribute()`** method of the present and adding it if it is not present) on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/toggleAttribute)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "MethodSignature", - "name": "togglePopover", - "value": "(options?: boolean) => boolean", - "description": "The **`togglePopover()`** method of the HTMLElement interface toggles a Popover_API element (i.e., one that has a valid `popover` attribute) between the hidden and showing states.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/togglePopover)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "translate", - "value": "boolean", - "description": "The **`translate`** property of the HTMLElement interface indicates whether an element's attribute values and the values of its Text node children are to be translated when the page is localized, or whether to leave them unchanged.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/translate)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The current value for the field. If omitted, the field will be empty.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "MethodSignature", - "name": "webkitMatchesSelector", - "value": "(selectors: string) => boolean", - "description": "", - "deprecationMessage": "This is a legacy alias of `matches`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "writingSuggestions", - "value": "string", - "description": "The **`writingSuggestions`** property of the HTMLElement interface is a string indicating if browser-provided writing suggestions should be enabled under the scope of the element or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/writingSuggestions)" - } - ], - "value": "export interface SelectElement extends SelectElementProps, Omit {\n onblur: SelectEvents['onBlur'];\n onchange: SelectEvents['onChange'];\n onfocus: SelectEvents['onFocus'];\n}" - } - }, - "SelectProps": { - "src/surfaces/checkout/components/Select.ts": { - "filePath": "src/surfaces/checkout/components/Select.ts", - "name": "SelectProps", - "description": "", - "isPublicDocs": true, - "members": [ - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "autocomplete", - "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", - "isOptional": true, - "defaultValue": "'on' for everything else" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "Disables the field, disallowing any interaction.", - "isOptional": true, - "defaultValue": "false" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "error", - "value": "string", - "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the element.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "label", - "value": "string", - "description": "Content to use as the field label.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "onBlur", - "value": "(event: FocusEvent) => void", - "description": "A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "onChange", - "value": "(event: Event) => void", - "description": "Callback when the user has **finished editing** a field, for example, once they have blurred the field.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "onFocus", - "value": "(event: FocusEvent) => void", - "description": "A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "placeholder", - "value": "string", - "description": "A short hint that describes the expected value of the field.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "required", - "value": "boolean", - "description": "Whether the field needs a value. This requirement adds semantic value to the field, but it will not cause an error to appear automatically. If you want to present an error when this field is empty, you can do so with the `error` property.", - "isOptional": true, - "defaultValue": "false" - }, - { - "filePath": "src/surfaces/checkout/components/Select.ts", - "syntaxKind": "PropertySignature", - "name": "value", - "value": "string", - "description": "The current value for the field. If omitted, the field will be empty.", - "isOptional": true - } - ], - "value": "export interface SelectProps extends SelectElementProps, SelectEvents {\n}" - } - }, - "ClickableChipElementProps": { - "src/surfaces/checkout/components/ClickableChip.ts": { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "name": "ClickableChipElementProps", - "description": "The clickable chip component displays interactive labels or categories that users can click or remove. Use clickable chip to show filter tags, selected options, or merchant-created labels that users need to interact with or dismiss.\n\nClickable chips support multiple visual variants, optional icons, and can function as both clickable buttons and removable tags for flexible interaction patterns. For non-interactive labels, use [chip](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/typography-and-content/chip).", - "isPublicDocs": true, - "members": [ - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "A label that describes the purpose or contents of the chip. It will be read to users using assistive technologies such as screen readers.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "Disables the chip, disallowing any interaction.", - "isOptional": true, - "defaultValue": "false" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "hidden", - "value": "boolean", - "description": "Determines whether the chip is hidden.\n\nIf this property is being set on each framework render (as in 'controlled' usage), and the chip is `removable`, ensure you update app state for this property when the `remove` event fires.\n\nIf the chip is not `removable`, it can still be hidden by setting this property.", - "isOptional": true, - "defaultValue": "false" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "href", - "value": "string", - "description": "The URL to link to. When set, the chip navigates to the specified location after the `click` event fires.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the element.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "removable", - "value": "boolean", - "description": "Whether the chip is removable.", - "isOptional": true, - "defaultValue": "false" - } - ], - "value": "export interface ClickableChipElementProps extends Pick {\n}" - } - }, - "ClickableChipEvents": { - "src/surfaces/checkout/components/ClickableChip.ts": { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "name": "ClickableChipEvents", - "description": "", - "isPublicDocs": true, - "members": [ - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "onAfterHide", - "value": "(event: Event) => void", - "description": "Event handler when the chip has fully hidden.\n\nThe `hidden` property will be `true` when this event fires.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "onClick", - "value": "(event: Event) => void", - "description": "Callback when the chip is clicked.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "onRemove", - "value": "(event: Event) => void", - "description": "Callback when the chip is removed.", - "isOptional": true - } - ], - "value": "export interface ClickableChipEvents extends Pick {\n}" - } - }, - "ClickableChipElementEvents": { - "src/surfaces/checkout/components/ClickableChip.ts": { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "name": "ClickableChipElementEvents", - "description": "The clickable chip component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", - "isPublicDocs": true, - "members": [ - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "afterhide", - "value": "CallbackEventListener", - "description": "A callback fired after the chip is hidden. The `hidden` property will be `true` when this event fires.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "click", - "value": "CallbackEventListener", - "description": "A callback fired when the chip is clicked.\n\nLearn more about the [click event](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event).", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "remove", - "value": "CallbackEventListener", - "description": "A callback fired when the chip is removed.", - "isOptional": true - } - ], - "value": "export interface ClickableChipElementEvents {\n /**\n * A callback fired after the chip is hidden. The `hidden` property will be `true` when this event fires.\n */\n afterhide?: CallbackEventListener;\n /**\n * A callback fired when the chip is clicked.\n *\n * Learn more about the [click event](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event).\n */\n click?: CallbackEventListener;\n /**\n * A callback fired when the chip is removed.\n */\n remove?: CallbackEventListener;\n}" - } - }, - "ClickableChipElementSlots": { - "src/surfaces/checkout/components/ClickableChip.ts": { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "name": "ClickableChipElementSlots", - "description": "The clickable chip component supports slots for additional content placement. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", - "isPublicDocs": true, - "members": [ - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "graphic", - "value": "HTMLElement", - "description": "The graphic to display inside of the chip.\n\nOnly `s-icon` element and its `type` attribute are supported.", - "isOptional": true - } - ], - "value": "export interface ClickableChipElementSlots {\n /**\n * The graphic to display inside of the chip.\n *\n * Only `s-icon` element and its `type` attribute are supported.\n */\n graphic?: HTMLElement;\n}" - } - }, - "ClickableChipElement": { - "src/surfaces/checkout/components/ClickableChip.ts": { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "name": "ClickableChipElement", - "description": "", - "isPublicDocs": true, - "members": [ - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "A label that describes the purpose or contents of the chip. It will be read to users using assistive technologies such as screen readers.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "accessKey", - "value": "string", - "description": "The **`HTMLElement.accessKey`** property sets the keystroke which a user can press to jump to a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKey)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "accessKeyLabel", - "value": "string", - "description": "The **`HTMLElement.accessKeyLabel`** read-only property returns a string containing the element's browser-assigned access key (if any); otherwise it returns an empty string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKeyLabel)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "MethodSignature", - "name": "addEventListener", - "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "MethodSignature", - "name": "after", - "value": "(...nodes: (string | Node)[]) => void", - "description": "Inserts nodes just after node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/after)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "MethodSignature", - "name": "animate", - "value": "(keyframes: Keyframe[] | PropertyIndexedKeyframes, options?: number | KeyframeAnimationOptions) => Animation", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animate)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "MethodSignature", - "name": "append", - "value": "(...nodes: (string | Node)[]) => void", - "description": "Inserts nodes after the last child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/append)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "MethodSignature", - "name": "appendChild", - "value": "(node: T) => T", - "description": "The **`appendChild()`** method of the Node interface adds a node to the end of the list of children of a specified parent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/appendChild)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "ariaActiveDescendantElement", - "value": "Element | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaActiveDescendantElement)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "ariaAtomic", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAtomic)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "ariaAutoComplete", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAutoComplete)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "ariaBrailleLabel", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleLabel)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "ariaBrailleRoleDescription", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleRoleDescription)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "ariaBusy", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBusy)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "ariaChecked", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaChecked)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "ariaColCount", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColCount)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "ariaColIndex", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndex)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "ariaColIndexText", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndexText)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "ariaColSpan", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColSpan)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "ariaControlsElements", - "value": "ReadonlyArray | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaControlsElements)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "ariaCurrent", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaCurrent)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "ariaDescribedByElements", - "value": "ReadonlyArray | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescribedByElements)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "ariaDescription", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescription)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "ariaDetailsElements", - "value": "ReadonlyArray | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDetailsElements)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "ariaDisabled", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDisabled)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "ariaErrorMessageElements", - "value": "ReadonlyArray | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaErrorMessageElements)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "ariaExpanded", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaExpanded)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "ariaFlowToElements", - "value": "ReadonlyArray | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaFlowToElements)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "ariaHasPopup", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHasPopup)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "ariaHidden", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHidden)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "ariaInvalid", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaInvalid)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "ariaKeyShortcuts", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaKeyShortcuts)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "ariaLabel", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabel)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "ariaLabelledByElements", - "value": "ReadonlyArray | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabelledByElements)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "ariaLevel", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLevel)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "ariaLive", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLive)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "ariaModal", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaModal)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "ariaMultiLine", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiLine)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "ariaMultiSelectable", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiSelectable)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "ariaOrientation", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOrientation)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "ariaOwnsElements", - "value": "ReadonlyArray | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOwnsElements)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "ariaPlaceholder", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPlaceholder)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "ariaPosInSet", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPosInSet)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "ariaPressed", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPressed)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "ariaReadOnly", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaReadOnly)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "ariaRelevant", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRelevant)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "ariaRequired", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRequired)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "ariaRoleDescription", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRoleDescription)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "ariaRowCount", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowCount)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "ariaRowIndex", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndex)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "ariaRowIndexText", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndexText)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "ariaRowSpan", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowSpan)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "ariaSelected", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSelected)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "ariaSetSize", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSetSize)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "ariaSort", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSort)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "ariaValueMax", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMax)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "ariaValueMin", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMin)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "ariaValueNow", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueNow)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "ariaValueText", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueText)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "assignedSlot", - "value": "HTMLSlotElement | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/assignedSlot)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "MethodSignature", - "name": "attachInternals", - "value": "() => ElementInternals", - "description": "The **`HTMLElement.attachInternals()`** method returns an ElementInternals object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attachInternals)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "MethodSignature", - "name": "attachShadow", - "value": "(init: ShadowRootInit) => ShadowRoot", - "description": "The **`Element.attachShadow()`** method attaches a shadow DOM tree to the specified element and returns a reference to its ShadowRoot.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attachShadow)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "ATTRIBUTE_NODE", - "value": "2", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "NamedNodeMap", - "description": "The **`Element.attributes`** property returns a live collection of all attribute nodes registered to the specified node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attributes)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "attributeStyleMap", - "value": "StylePropertyMap", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attributeStyleMap)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "autocapitalize", - "value": "string", - "description": "The **`autocapitalize`** property of the HTMLElement interface represents the element's capitalization behavior for user input.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocapitalize)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "autocorrect", - "value": "boolean", - "description": "The **`autocorrect`** property of the HTMLElement interface controls whether or not autocorrection of editable text is enabled for spelling and/or punctuation errors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocorrect)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "autofocus", - "value": "boolean", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autofocus)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "baseURI", - "value": "string", - "description": "The read-only **`baseURI`** property of the Node interface returns the absolute base URL of the document containing the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/baseURI)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "MethodSignature", - "name": "before", - "value": "(...nodes: (string | Node)[]) => void", - "description": "Inserts nodes just before node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/before)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "MethodSignature", - "name": "blur", - "value": "() => void", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/blur)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "CDATA_SECTION_NODE", - "value": "4", - "description": "node is a CDATASection node." - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "MethodSignature", - "name": "checkVisibility", - "value": "(options?: CheckVisibilityOptions) => boolean", - "description": "The **`checkVisibility()`** method of the Element interface checks whether the element is visible.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/checkVisibility)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "childElementCount", - "value": "number", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/childElementCount)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "childNodes", - "value": "NodeListOf", - "description": "The read-only **`childNodes`** property of the Node interface returns a live the first child node is assigned index `0`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/childNodes)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "HTMLCollection", - "description": "Returns the child elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/children)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "GetAccessor", - "name": "classList", - "value": "DOMTokenList", - "description": "The **`Element.classList`** is a read-only property that returns a live DOMTokenList collection of the `class` attributes of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/classList)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "className", - "value": "string", - "description": "The **`className`** property of the of the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/className)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "MethodSignature", - "name": "click", - "value": "() => void", - "description": "The **`HTMLElement.click()`** method simulates a mouse click on an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/click)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "clientHeight", - "value": "number", - "description": "The **`clientHeight`** read-only property of the Element interface is zero for elements with no CSS or inline layout boxes; otherwise, it's the inner height of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientHeight)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "clientLeft", - "value": "number", - "description": "The **`clientLeft`** read-only property of the Element interface returns the width of the left border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientLeft)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "clientTop", - "value": "number", - "description": "The **`clientTop`** read-only property of the Element interface returns the width of the top border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientTop)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "clientWidth", - "value": "number", - "description": "The **`clientWidth`** read-only property of the Element interface is zero for inline elements and elements with no CSS; otherwise, it's the inner width of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientWidth)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "MethodSignature", - "name": "cloneNode", - "value": "(subtree?: boolean) => Node", - "description": "The **`cloneNode()`** method of the Node interface returns a duplicate of the node on which this method was called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/cloneNode)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "MethodSignature", - "name": "closest", - "value": "{ (selector: K): HTMLElementTagNameMap[K]; (selector: K): SVGElementTagNameMap[K]; (selector: K): MathMLElementTagNameMap[K]; (selectors: string): E; }", - "description": "The **`closest()`** method of the Element interface traverses the element and its parents (heading toward the document root) until it finds a node that matches the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/closest)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "COMMENT_NODE", - "value": "8", - "description": "node is a Comment node." - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "MethodSignature", - "name": "compareDocumentPosition", - "value": "(other: Node) => number", - "description": "The **`compareDocumentPosition()`** method of the Node interface reports the position of its argument node relative to the node on which it is called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/compareDocumentPosition)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "MethodSignature", - "name": "computedStyleMap", - "value": "() => StylePropertyMapReadOnly", - "description": "The **`computedStyleMap()`** method of the Element interface returns a StylePropertyMapReadOnly interface which provides a read-only representation of a CSS declaration block that is an alternative to CSSStyleDeclaration.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/computedStyleMap)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "MethodSignature", - "name": "contains", - "value": "(other: Node) => boolean", - "description": "The **`contains()`** method of the Node interface returns a boolean value indicating whether a node is a descendant of a given node, that is the node itself, one of its direct children (Node.childNodes), one of the children's direct children, and so on.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/contains)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "contentEditable", - "value": "string", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/contentEditable)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "currentCSSZoom", - "value": "number", - "description": "The **`currentCSSZoom`** read-only property of the Element interface provides the 'effective' CSS `zoom` of an element, taking into account the zoom applied to the element and all its parent elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/currentCSSZoom)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "dataset", - "value": "DOMStringMap", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dataset)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "dir", - "value": "string", - "description": "The **`HTMLElement.dir`** property indicates the text writing directionality of the content of the current element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dir)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "Disables the chip, disallowing any interaction.", - "isOptional": true, - "defaultValue": "false" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "MethodSignature", - "name": "dispatchEvent", - "value": "(event: Event) => boolean", - "description": "The **`dispatchEvent()`** method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/dispatchEvent)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "DOCUMENT_FRAGMENT_NODE", - "value": "11", - "description": "node is a DocumentFragment node." - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "DOCUMENT_NODE", - "value": "9", - "description": "node is a document." - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "DOCUMENT_POSITION_CONTAINED_BY", - "value": "16", - "description": "Set when other is a descendant of node." - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "DOCUMENT_POSITION_CONTAINS", - "value": "8", - "description": "Set when other is an ancestor of node." - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "DOCUMENT_POSITION_DISCONNECTED", - "value": "1", - "description": "Set when node and other are not in the same tree." - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "DOCUMENT_POSITION_FOLLOWING", - "value": "4", - "description": "Set when other is following node." - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC", - "value": "32", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "DOCUMENT_POSITION_PRECEDING", - "value": "2", - "description": "Set when other is preceding node." - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "DOCUMENT_TYPE_NODE", - "value": "10", - "description": "node is a doctype." - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "draggable", - "value": "boolean", - "description": "The **`draggable`** property of the HTMLElement interface gets and sets a Boolean primitive indicating if the element is draggable.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/draggable)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "ELEMENT_NODE", - "value": "1", - "description": "node is an element." - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "enterKeyHint", - "value": "string", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/enterKeyHint)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "ENTITY_NODE", - "value": "6", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "ENTITY_REFERENCE_NODE", - "value": "5", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "firstChild", - "value": "ChildNode | null", - "description": "The read-only **`firstChild`** property of the Node interface returns the node's first child in the tree, or `null` if the node has no children.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/firstChild)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "firstElementChild", - "value": "Element | null", - "description": "Returns the first child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/firstElementChild)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "MethodSignature", - "name": "focus", - "value": "(options?: FocusOptions) => void", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/focus)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "MethodSignature", - "name": "getAnimations", - "value": "(options?: GetAnimationsOptions) => Animation[]", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAnimations)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "MethodSignature", - "name": "getAttribute", - "value": "(qualifiedName: string) => string", - "description": "The **`getAttribute()`** method of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttribute)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "MethodSignature", - "name": "getAttributeNames", - "value": "() => string[]", - "description": "The **`getAttributeNames()`** method of the array.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNames)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "MethodSignature", - "name": "getAttributeNode", - "value": "(qualifiedName: string) => Attr", - "description": "Returns the specified attribute of the specified element, as an Attr node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNode)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "MethodSignature", - "name": "getAttributeNodeNS", - "value": "(namespace: string, localName: string) => Attr", - "description": "The **`getAttributeNodeNS()`** method of the Element interface returns the namespaced Attr node of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNodeNS)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "MethodSignature", - "name": "getAttributeNS", - "value": "(namespace: string, localName: string) => string", - "description": "The **`getAttributeNS()`** method of the Element interface returns the string value of the attribute with the specified namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNS)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "MethodSignature", - "name": "getBoundingClientRect", - "value": "() => DOMRect", - "description": "The **`Element.getBoundingClientRect()`** method returns a position relative to the viewport.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getBoundingClientRect)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "MethodSignature", - "name": "getClientRects", - "value": "() => DOMRectList", - "description": "The **`getClientRects()`** method of the Element interface returns a collection of DOMRect objects that indicate the bounding rectangles for each CSS border box in a client.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getClientRects)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "MethodSignature", - "name": "getElementsByClassName", - "value": "(classNames: string) => HTMLCollectionOf", - "description": "The Element method **`getElementsByClassName()`** returns a live specified class name or names.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByClassName)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "MethodSignature", - "name": "getElementsByTagName", - "value": "{ (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: string): HTMLCollectionOf; }", - "description": "The **`Element.getElementsByTagName()`** method returns a live All descendants of the specified element are searched, but not the element itself.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagName)", - "deprecationMessage": "Deprecated" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "MethodSignature", - "name": "getElementsByTagNameNS", - "value": "{ (namespaceURI: \"http://www.w3.org/1999/xhtml\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/2000/svg\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/1998/Math/MathML\", localName: string): HTMLCollectionOf; (namespace: string, localName: string): HTMLCollectionOf; }", - "description": "The **`Element.getElementsByTagNameNS()`** method returns a live HTMLCollection of elements with the given tag name belonging to the given namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagNameNS)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "MethodSignature", - "name": "getHTML", - "value": "(options?: GetHTMLOptions) => string", - "description": "The **`getHTML()`** method of the Element interface is used to serialize an element's DOM to an HTML string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getHTML)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "MethodSignature", - "name": "getRootNode", - "value": "(options?: GetRootNodeOptions) => Node", - "description": "The **`getRootNode()`** method of the Node interface returns the context object's root, which optionally includes the shadow root if it is available.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/getRootNode)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "MethodSignature", - "name": "hasAttribute", - "value": "(qualifiedName: string) => boolean", - "description": "The **`Element.hasAttribute()`** method returns a **Boolean** value indicating whether the specified element has the specified attribute or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttribute)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "MethodSignature", - "name": "hasAttributeNS", - "value": "(namespace: string, localName: string) => boolean", - "description": "The **`hasAttributeNS()`** method of the Element interface returns a boolean value indicating whether the current element has the specified attribute with the specified namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributeNS)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "MethodSignature", - "name": "hasAttributes", - "value": "() => boolean", - "description": "The **`hasAttributes()`** method of the Element interface returns a boolean value indicating whether the current element has any attributes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributes)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "MethodSignature", - "name": "hasChildNodes", - "value": "() => boolean", - "description": "The **`hasChildNodes()`** method of the Node interface returns a boolean value indicating whether the given Node has child nodes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/hasChildNodes)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "MethodSignature", - "name": "hasPointerCapture", - "value": "(pointerId: number) => boolean", - "description": "The **`hasPointerCapture()`** method of the pointer capture for the pointer identified by the given pointer ID.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasPointerCapture)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "hidden", - "value": "boolean", - "description": "Determines whether the chip is hidden.\n\nIf this property is being set on each framework render (as in 'controlled' usage), and the chip is `removable`, ensure you update app state for this property when the `remove` event fires.\n\nIf the chip is not `removable`, it can still be hidden by setting this property.", - "isOptional": true, - "defaultValue": "false" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "MethodSignature", - "name": "hidePopover", - "value": "() => void", - "description": "The **`hidePopover()`** method of the HTMLElement interface hides a popover element (i.e., one that has a valid `popover` attribute) by removing it from the top layer and styling it with `display: none`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidePopover)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "href", - "value": "string", - "description": "The URL to link to. When set, the chip navigates to the specified location after the `click` event fires.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the element.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "inert", - "value": "boolean", - "description": "The HTMLElement property **`inert`** reflects the value of the element's `inert` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inert)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "innerHTML", - "value": "string", - "description": "The **`innerHTML`** property of the Element interface gets or sets the HTML or XML markup contained within the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/innerHTML)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "innerText", - "value": "string", - "description": "The **`innerText`** property of the HTMLElement interface represents the rendered text content of a node and its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/innerText)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "inputMode", - "value": "string", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inputMode)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "MethodSignature", - "name": "insertAdjacentElement", - "value": "(where: InsertPosition, element: Element) => Element", - "description": "The **`insertAdjacentElement()`** method of the relative to the element it is invoked upon.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentElement)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "MethodSignature", - "name": "insertAdjacentHTML", - "value": "(position: InsertPosition, string: string) => void", - "description": "The **`insertAdjacentHTML()`** method of the the resulting nodes into the DOM tree at a specified position.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentHTML)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "MethodSignature", - "name": "insertAdjacentText", - "value": "(where: InsertPosition, data: string) => void", - "description": "The **`insertAdjacentText()`** method of the Element interface, given a relative position and a string, inserts a new text node at the given position relative to the element it is called from.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentText)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "MethodSignature", - "name": "insertBefore", - "value": "(node: T, child: Node) => T", - "description": "The **`insertBefore()`** method of the Node interface inserts a node before a _reference node_ as a child of a specified _parent node_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/insertBefore)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "isConnected", - "value": "boolean", - "description": "The read-only **`isConnected`** property of the Node interface returns a boolean indicating whether the node is connected (directly or indirectly) to a Document object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isConnected)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "isContentEditable", - "value": "boolean", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/isContentEditable)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "MethodSignature", - "name": "isDefaultNamespace", - "value": "(namespace: string) => boolean", - "description": "The **`isDefaultNamespace()`** method of the Node interface accepts a namespace URI as an argument.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isDefaultNamespace)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "MethodSignature", - "name": "isEqualNode", - "value": "(otherNode: Node) => boolean", - "description": "The **`isEqualNode()`** method of the Node interface tests whether two nodes are equal.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isEqualNode)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "MethodSignature", - "name": "isSameNode", - "value": "(otherNode: Node) => boolean", - "description": "The **`isSameNode()`** method of the Node interface is a legacy alias the for the `===` strict equality operator.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isSameNode)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "lang", - "value": "string", - "description": "The **`lang`** property of the HTMLElement interface indicates the base language of an element's attribute values and text content, in the form of a MISSING: RFC(5646, 'BCP 47 language identifier tag')].\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/lang)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "lastChild", - "value": "ChildNode | null", - "description": "The read-only **`lastChild`** property of the Node interface returns the last child of the node, or `null` if there are no child nodes.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lastChild)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "lastElementChild", - "value": "Element | null", - "description": "Returns the last child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/lastElementChild)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "localName", - "value": "string", - "description": "The **`Element.localName`** read-only property returns the local part of the qualified name of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/localName)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "MethodSignature", - "name": "lookupNamespaceURI", - "value": "(prefix: string) => string", - "description": "The **`lookupNamespaceURI()`** method of the Node interface takes a prefix as parameter and returns the namespace URI associated with it on the given node if found (and `null` if not).\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupNamespaceURI)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "MethodSignature", - "name": "lookupPrefix", - "value": "(namespace: string) => string", - "description": "The **`lookupPrefix()`** method of the Node interface returns a string containing the prefix for a given namespace URI, if present, and `null` if not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupPrefix)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "MethodSignature", - "name": "matches", - "value": "(selectors: string) => boolean", - "description": "The **`matches()`** method of the Element interface tests whether the element would be selected by the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "namespaceURI", - "value": "string | null", - "description": "The **`Element.namespaceURI`** read-only property returns the namespace URI of the element, or `null` if the element is not in a namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/namespaceURI)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "nextElementSibling", - "value": "Element | null", - "description": "Returns the first following sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/nextElementSibling)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "nextSibling", - "value": "ChildNode | null", - "description": "The read-only **`nextSibling`** property of the Node interface returns the node immediately following the specified one in their parent's Node.childNodes, or returns `null` if the specified node is the last child in the parent element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nextSibling)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "nodeName", - "value": "string", - "description": "The read-only **`nodeName`** property of Node returns the name of the current node as a string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeName)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "nodeType", - "value": "number", - "description": "The read-only **`nodeType`** property of a Node interface is an integer that identifies what the node is.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeType)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "nodeValue", - "value": "string | null", - "description": "The **`nodeValue`** property of the Node interface returns or sets the value of the current node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeValue)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "nonce", - "value": "string", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/nonce)", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "MethodSignature", - "name": "normalize", - "value": "() => void", - "description": "The **`normalize()`** method of the Node interface puts the specified node and all of its sub-tree into a _normalized_ form.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/normalize)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "NOTATION_NODE", - "value": "12", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "offsetHeight", - "value": "number", - "description": "The **`offsetHeight`** read-only property of the HTMLElement interface returns the height of an element, including vertical padding and borders, as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetHeight)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "offsetLeft", - "value": "number", - "description": "The **`offsetLeft`** read-only property of the HTMLElement interface returns the number of pixels that the _upper left corner_ of the current element is offset to the left within the HTMLElement.offsetParent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetLeft)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "offsetParent", - "value": "Element | null", - "description": "The **`HTMLElement.offsetParent`** read-only property returns a reference to the element which is the closest (nearest in the containment hierarchy) positioned ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetParent)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "offsetTop", - "value": "number", - "description": "The **`offsetTop`** read-only property of the HTMLElement interface returns the distance from the outer border of the current element (including its margin) to the top padding edge of the HTMLelement.offsetParent, the _closest positioned_ ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetTop)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "offsetWidth", - "value": "number", - "description": "The **`offsetWidth`** read-only property of the HTMLElement interface returns the layout width of an element as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetWidth)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "onabort", - "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/abort_event)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "onafterhide", - "value": "(event: Event) => void", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "onanimationcancel", - "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationcancel_event)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "onanimationend", - "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "onanimationiteration", - "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "onanimationstart", - "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "onauxclick", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/auxclick_event)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "onbeforeinput", - "value": "((this: GlobalEventHandlers, ev: InputEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforeinput_event)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "onbeforematch", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforematch_event)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "onbeforetoggle", - "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/beforetoggle_event)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "onblur", - "value": "((this: GlobalEventHandlers, ev: FocusEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/blur_event)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "oncancel", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/cancel_event)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "oncanplay", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplay_event)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "oncanplaythrough", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplaythrough_event)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "onchange", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/change_event)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "onclick", - "value": "(event: Event) => void", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "onclose", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/close_event)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "oncontextlost", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextlost_event)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "oncontextmenu", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/contextmenu_event)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "oncontextrestored", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextrestored_event)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "oncopy", - "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/copy_event)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "oncuechange", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLTrackElement/cuechange_event)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "oncut", - "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/cut_event)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "ondblclick", - "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/dblclick_event)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "ondrag", - "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drag_event)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "ondragend", - "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragend_event)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "ondragenter", - "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragenter_event)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "ondragleave", - "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragleave_event)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "ondragover", - "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragover_event)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "ondragstart", - "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragstart_event)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "ondrop", - "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drop_event)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "ondurationchange", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/durationchange_event)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "onemptied", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/emptied_event)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "onended", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ended_event)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "onerror", - "value": "OnErrorEventHandler", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/error_event)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "onfocus", - "value": "((this: GlobalEventHandlers, ev: FocusEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/focus_event)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "onformdata", - "value": "((this: GlobalEventHandlers, ev: FormDataEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/formdata_event)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "onfullscreenchange", - "value": "((this: Element, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenchange_event)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "onfullscreenerror", - "value": "((this: Element, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenerror_event)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "ongotpointercapture", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/gotpointercapture_event)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "oninput", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/input_event)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "oninvalid", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/invalid_event)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "onkeydown", - "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keydown_event)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "onkeypress", - "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", - "description": "", - "deprecationMessage": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keypress_event)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "onkeyup", - "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keyup_event)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "onload", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/load_event)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "onloadeddata", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadeddata_event)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "onloadedmetadata", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadedmetadata_event)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "onloadstart", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadstart_event)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "onlostpointercapture", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/lostpointercapture_event)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "onmousedown", - "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousedown_event)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "onmouseenter", - "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseenter_event)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "onmouseleave", - "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseleave_event)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "onmousemove", - "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousemove_event)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "onmouseout", - "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseout_event)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "onmouseover", - "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseover_event)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "onmouseup", - "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseup_event)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "onpaste", - "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/paste_event)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "onpause", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/pause_event)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "onplay", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/play_event)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "onplaying", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/playing_event)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "onpointercancel", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointercancel_event)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "onpointerdown", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerdown_event)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "onpointerenter", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerenter_event)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "onpointerleave", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerleave_event)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "onpointermove", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointermove_event)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "onpointerout", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerout_event)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "onpointerover", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerover_event)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "onpointerrawupdate", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "Available only in secure contexts.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerrawupdate_event)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "onpointerup", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerup_event)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "onprogress", - "value": "((this: GlobalEventHandlers, ev: ProgressEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/progress_event)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "onratechange", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ratechange_event)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "onremove", - "value": "(event: Event) => void", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "onreset", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/reset_event)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "onresize", - "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLVideoElement/resize_event)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "onscroll", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scroll_event)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "onscrollend", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scrollend_event)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "onsecuritypolicyviolation", - "value": "((this: GlobalEventHandlers, ev: SecurityPolicyViolationEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/securitypolicyviolation_event)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "onseeked", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeked_event)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "onseeking", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeking_event)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "onselect", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/select_event)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "onselectionchange", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/selectionchange_event)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "onselectstart", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/selectstart_event)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "onslotchange", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLSlotElement/slotchange_event)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "onstalled", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/stalled_event)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "onsubmit", - "value": "((this: GlobalEventHandlers, ev: SubmitEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/submit_event)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "onsuspend", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/suspend_event)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "ontimeupdate", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/timeupdate_event)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "ontoggle", - "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/toggle_event)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "ontouchcancel", - "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchcancel_event)", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "ontouchend", - "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchend_event)", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "ontouchmove", - "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchmove_event)", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "ontouchstart", - "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchstart_event)", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "ontransitioncancel", - "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitioncancel_event)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "ontransitionend", - "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "ontransitionrun", - "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionrun_event)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "ontransitionstart", - "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionstart_event)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "onvolumechange", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/volumechange_event)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "onwaiting", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/waiting_event)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "onwebkitanimationend", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "", - "deprecationMessage": "This is a legacy alias of `onanimationend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "onwebkitanimationiteration", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "", - "deprecationMessage": "This is a legacy alias of `onanimationiteration`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "onwebkitanimationstart", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "", - "deprecationMessage": "This is a legacy alias of `onanimationstart`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "onwebkittransitionend", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "", - "deprecationMessage": "This is a legacy alias of `ontransitionend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "onwheel", - "value": "((this: GlobalEventHandlers, ev: WheelEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/wheel_event)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "outerHTML", - "value": "string", - "description": "The **`outerHTML`** attribute of the Element DOM interface gets the serialized HTML fragment describing the element including its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/outerHTML)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "outerText", - "value": "string", - "description": "The **`outerText`** property of the HTMLElement interface returns the same value as HTMLElement.innerText.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/outerText)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "ownerDocument", - "value": "Document", - "description": "The read-only **`ownerDocument`** property of the Node interface returns the top-level document object of the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/ownerDocument)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "parentElement", - "value": "HTMLElement | null", - "description": "The read-only **`parentElement`** property of Node interface returns the DOM node's parent Element, or `null` if the node either has no parent, or its parent isn't a DOM Element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentElement)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "parentNode", - "value": "ParentNode | null", - "description": "The read-only **`parentNode`** property of the Node interface returns the parent of the specified node in the DOM tree.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentNode)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "GetAccessor", - "name": "part", - "value": "DOMTokenList", - "description": "The **`part`** property of the Element interface represents the part identifier(s) of the element (i.e., set using the `part` attribute), returned as a DOMTokenList.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/part)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "popover", - "value": "string | null", - "description": "The **`popover`** property of the HTMLElement interface gets and sets an element's popover state via JavaScript (`'auto'`, `'hint'`, or `'manual'`), and can be used for feature detection.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/popover)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "prefix", - "value": "string | null", - "description": "The **`Element.prefix`** read-only property returns the namespace prefix of the specified element, or `null` if no prefix is specified.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/prefix)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "MethodSignature", - "name": "prepend", - "value": "(...nodes: (string | Node)[]) => void", - "description": "Inserts nodes before the first child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/prepend)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "previousElementSibling", - "value": "Element | null", - "description": "Returns the first preceding sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/previousElementSibling)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "previousSibling", - "value": "ChildNode | null", - "description": "The read-only **`previousSibling`** property of the Node interface returns the node immediately preceding the specified one in its parent's or `null` if the specified node is the first in that list.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/previousSibling)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "PROCESSING_INSTRUCTION_NODE", - "value": "7", - "description": "node is a ProcessingInstruction node." - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "MethodSignature", - "name": "querySelector", - "value": "{ (selectors: K): HTMLElementTagNameMap[K]; (selectors: K): SVGElementTagNameMap[K]; (selectors: K): MathMLElementTagNameMap[K]; (selectors: K): HTMLElementDeprecatedTagNameMap[K]; (selectors: string): E; }", - "description": "Returns the first element that is a descendant of node that matches selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelector)", - "deprecationMessage": "Deprecated" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "MethodSignature", - "name": "querySelectorAll", - "value": "{ (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: string): NodeListOf; }", - "description": "Returns all element descendants of node that match selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelectorAll)", - "deprecationMessage": "Deprecated" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "MethodSignature", - "name": "releasePointerCapture", - "value": "(pointerId: number) => void", - "description": "The **`releasePointerCapture()`** method of the previously set for a specific (PointerEvent) _pointer_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/releasePointerCapture)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "removable", - "value": "boolean", - "description": "Whether the chip is removable.", - "isOptional": true, - "defaultValue": "false" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "MethodSignature", - "name": "remove", - "value": "() => void", - "description": "Removes node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/remove)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "MethodSignature", - "name": "removeAttribute", - "value": "(qualifiedName: string) => void", - "description": "The Element method **`removeAttribute()`** removes the attribute with the specified name from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttribute)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "MethodSignature", - "name": "removeAttributeNode", - "value": "(attr: Attr) => Attr", - "description": "The **`removeAttributeNode()`** method of the Element interface removes the specified Attr node from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNode)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "MethodSignature", - "name": "removeAttributeNS", - "value": "(namespace: string, localName: string) => void", - "description": "The **`removeAttributeNS()`** method of the If you are working with HTML and you don't need to specify the requested attribute as being part of a specific namespace, use the Element.removeAttribute() method instead.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNS)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "MethodSignature", - "name": "removeChild", - "value": "(child: T) => T", - "description": "The **`removeChild()`** method of the Node interface removes a child node from the DOM and returns the removed node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/removeChild)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "MethodSignature", - "name": "removeEventListener", - "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "MethodSignature", - "name": "replaceChild", - "value": "(node: Node, child: T) => T", - "description": "The **`replaceChild()`** method of the Node interface replaces a child node within the given (parent) node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/replaceChild)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "MethodSignature", - "name": "replaceChildren", - "value": "(...nodes: (string | Node)[]) => void", - "description": "Replace all children of node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/replaceChildren)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "MethodSignature", - "name": "replaceWith", - "value": "(...nodes: (string | Node)[]) => void", - "description": "Replaces node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/replaceWith)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "MethodSignature", - "name": "requestFullscreen", - "value": "(options?: FullscreenOptions) => Promise", - "description": "The **`Element.requestFullscreen()`** method issues an asynchronous request to make the element be displayed in fullscreen mode.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestFullscreen)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "MethodSignature", - "name": "requestPointerLock", - "value": "(options?: PointerLockOptions) => Promise", - "description": "The **`requestPointerLock()`** method of the Element interface lets you asynchronously ask for the pointer to be locked on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestPointerLock)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "role", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/role)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "MethodSignature", - "name": "scroll", - "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", - "description": "The **`scroll()`** method of the Element interface scrolls the element to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scroll)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "MethodSignature", - "name": "scrollBy", - "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", - "description": "The **`scrollBy()`** method of the Element interface scrolls an element by the given amount.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollBy)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "scrollHeight", - "value": "number", - "description": "The **`scrollHeight`** read-only property of the Element interface is a measurement of the height of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollHeight)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "MethodSignature", - "name": "scrollIntoView", - "value": "(arg?: boolean | ScrollIntoViewOptions) => void", - "description": "The Element interface's **`scrollIntoView()`** method scrolls the element's ancestor containers such that the element on which `scrollIntoView()` is called is visible to the user.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollIntoView)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "scrollLeft", - "value": "number", - "description": "The **`scrollLeft`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its left edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollLeft)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "MethodSignature", - "name": "scrollTo", - "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", - "description": "The **`scrollTo()`** method of the Element interface scrolls to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTo)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "scrollTop", - "value": "number", - "description": "The **`scrollTop`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its top edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTop)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "scrollWidth", - "value": "number", - "description": "The **`scrollWidth`** read-only property of the Element interface is a measurement of the width of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollWidth)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "MethodSignature", - "name": "setAttribute", - "value": "(qualifiedName: string, value: string) => void", - "description": "The **`setAttribute()`** method of the Element interface sets the value of an attribute on the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttribute)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "MethodSignature", - "name": "setAttributeNode", - "value": "(attr: Attr) => Attr", - "description": "The **`setAttributeNode()`** method of the Element interface adds a new Attr node to the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNode)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "MethodSignature", - "name": "setAttributeNodeNS", - "value": "(attr: Attr) => Attr", - "description": "The **`setAttributeNodeNS()`** method of the Element interface adds a new namespaced Attr node to an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNodeNS)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "MethodSignature", - "name": "setAttributeNS", - "value": "(namespace: string, qualifiedName: string, value: string) => void", - "description": "`setAttributeNS` adds a new attribute or changes the value of an attribute with the given namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNS)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "MethodSignature", - "name": "setHTMLUnsafe", - "value": "(html: string) => void", - "description": "The **`setHTMLUnsafe()`** method of the Element interface is used to parse a string of HTML into a DocumentFragment, optionally filtering out unwanted elements and attributes, and those that don't belong in the context, and then using it to replace the element's subtree in the DOM.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setHTMLUnsafe)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "MethodSignature", - "name": "setPointerCapture", - "value": "(pointerId: number) => void", - "description": "The **`setPointerCapture()`** method of the _capture target_ of future pointer events.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setPointerCapture)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "shadowRoot", - "value": "ShadowRoot | null", - "description": "The `Element.shadowRoot` read-only property represents the shadow root hosted by the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/shadowRoot)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "MethodSignature", - "name": "showPopover", - "value": "() => void", - "description": "The **`showPopover()`** method of the HTMLElement interface shows a Popover_API element (i.e., one that has a valid `popover` attribute) by adding it to the top layer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/showPopover)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "slot", - "value": "string", - "description": "The **`slot`** property of the Element interface returns the name of the shadow DOM slot the element is inserted in.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/slot)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "spellcheck", - "value": "boolean", - "description": "The **`spellcheck`** property of the HTMLElement interface represents a boolean value that controls the spell-checking hint.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/spellcheck)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "GetAccessor", - "name": "style", - "value": "CSSStyleDeclaration", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/style)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "tabIndex", - "value": "number", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/tabIndex)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "tagName", - "value": "string", - "description": "The **`tagName`** read-only property of the Element interface returns the tag name of the element on which it's called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/tagName)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "TEXT_NODE", - "value": "3", - "description": "node is a Text node." - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "GetAccessor", - "name": "textContent", - "value": "string", - "description": "[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/Node/textContent)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The **`HTMLElement.title`** property represents the title of the element: the text usually displayed in a 'tooltip' popup when the mouse is over the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/title)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "MethodSignature", - "name": "toggleAttribute", - "value": "(qualifiedName: string, force?: boolean) => boolean", - "description": "The **`toggleAttribute()`** method of the present and adding it if it is not present) on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/toggleAttribute)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "MethodSignature", - "name": "togglePopover", - "value": "(options?: boolean) => boolean", - "description": "The **`togglePopover()`** method of the HTMLElement interface toggles a Popover_API element (i.e., one that has a valid `popover` attribute) between the hidden and showing states.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/togglePopover)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "translate", - "value": "boolean", - "description": "The **`translate`** property of the HTMLElement interface indicates whether an element's attribute values and the values of its Text node children are to be translated when the page is localized, or whether to leave them unchanged.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/translate)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "MethodSignature", - "name": "webkitMatchesSelector", - "value": "(selectors: string) => boolean", - "description": "", - "deprecationMessage": "This is a legacy alias of `matches`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "writingSuggestions", - "value": "string", - "description": "The **`writingSuggestions`** property of the HTMLElement interface is a string indicating if browser-provided writing suggestions should be enabled under the scope of the element or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/writingSuggestions)" - } - ], - "value": "export interface ClickableChipElement extends ClickableChipElementProps, Omit {\n onafterhide: ClickableChipEvents['onAfterHide'];\n onclick: ClickableChipEvents['onClick'];\n onremove: ClickableChipEvents['onRemove'];\n}" - } - }, - "ClickableChipProps": { - "src/surfaces/checkout/components/ClickableChip.ts": { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "name": "ClickableChipProps", - "description": "", - "isPublicDocs": true, - "members": [ - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "A label that describes the purpose or contents of the chip. It will be read to users using assistive technologies such as screen readers.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "disabled", - "value": "boolean", - "description": "Disables the chip, disallowing any interaction.", - "isOptional": true, - "defaultValue": "false" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "hidden", - "value": "boolean", - "description": "Determines whether the chip is hidden.\n\nIf this property is being set on each framework render (as in 'controlled' usage), and the chip is `removable`, ensure you update app state for this property when the `remove` event fires.\n\nIf the chip is not `removable`, it can still be hidden by setting this property.", - "isOptional": true, - "defaultValue": "false" - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "href", - "value": "string", - "description": "The URL to link to. When set, the chip navigates to the specified location after the `click` event fires.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the element.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "onAfterHide", - "value": "(event: Event) => void", - "description": "Event handler when the chip has fully hidden.\n\nThe `hidden` property will be `true` when this event fires.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "onClick", - "value": "(event: Event) => void", - "description": "Callback when the chip is clicked.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "onRemove", - "value": "(event: Event) => void", - "description": "Callback when the chip is removed.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/ClickableChip.ts", - "syntaxKind": "PropertySignature", - "name": "removable", - "value": "boolean", - "description": "Whether the chip is removable.", - "isOptional": true, - "defaultValue": "false" - } - ], - "value": "export interface ClickableChipProps extends ClickableChipElementProps, ClickableChipEvents {\n}" - } - }, - "BadgeElementProps": { - "src/surfaces/checkout/components/Badge.ts": { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "name": "BadgeElementProps", - "description": "Properties for the Badge component element.", - "isPublicDocs": true, - "members": [ - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "color", - "value": "'base' | 'subdued'", - "description": "Modify the color to be more or less intense.", - "isOptional": true, - "defaultValue": "'base'" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "icon", - "value": "'' | ReducedIconTypes", - "description": "The type of icon to be displayed in the badge.", - "isOptional": true, - "defaultValue": "''" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "iconPosition", - "value": "'start' | 'end'", - "description": "The position of the icon in relation to the text.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the element.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "size", - "value": "'base' | 'small' | 'small-100'", - "description": "Adjusts the size.", - "isOptional": true, - "defaultValue": "'base'" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "tone", - "value": "'auto' | 'neutral' | 'critical'", - "description": "Sets the tone of the Badge, based on the intention of the information being conveyed.", - "isOptional": true, - "defaultValue": "'auto'" - } - ], - "value": "export interface BadgeElementProps extends Pick {\n size?: Extract;\n tone?: Extract;\n color?: Extract;\n icon?: '' | ReducedIconTypes;\n}" - } - }, - "BadgeElement": { - "src/surfaces/checkout/components/Badge.ts": { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "name": "BadgeElement", - "description": "", - "isPublicDocs": true, - "members": [ - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "accessKey", - "value": "string", - "description": "The **`HTMLElement.accessKey`** property sets the keystroke which a user can press to jump to a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKey)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "accessKeyLabel", - "value": "string", - "description": "The **`HTMLElement.accessKeyLabel`** read-only property returns a string containing the element's browser-assigned access key (if any); otherwise it returns an empty string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKeyLabel)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "MethodSignature", - "name": "addEventListener", - "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "MethodSignature", - "name": "after", - "value": "(...nodes: (string | Node)[]) => void", - "description": "Inserts nodes just after node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/after)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "MethodSignature", - "name": "animate", - "value": "(keyframes: Keyframe[] | PropertyIndexedKeyframes, options?: number | KeyframeAnimationOptions) => Animation", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animate)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "MethodSignature", - "name": "append", - "value": "(...nodes: (string | Node)[]) => void", - "description": "Inserts nodes after the last child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/append)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "MethodSignature", - "name": "appendChild", - "value": "(node: T) => T", - "description": "The **`appendChild()`** method of the Node interface adds a node to the end of the list of children of a specified parent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/appendChild)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "ariaActiveDescendantElement", - "value": "Element | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaActiveDescendantElement)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "ariaAtomic", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAtomic)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "ariaAutoComplete", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAutoComplete)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "ariaBrailleLabel", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleLabel)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "ariaBrailleRoleDescription", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleRoleDescription)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "ariaBusy", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBusy)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "ariaChecked", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaChecked)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "ariaColCount", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColCount)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "ariaColIndex", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndex)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "ariaColIndexText", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndexText)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "ariaColSpan", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColSpan)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "ariaControlsElements", - "value": "ReadonlyArray | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaControlsElements)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "ariaCurrent", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaCurrent)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "ariaDescribedByElements", - "value": "ReadonlyArray | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescribedByElements)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "ariaDescription", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescription)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "ariaDetailsElements", - "value": "ReadonlyArray | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDetailsElements)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "ariaDisabled", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDisabled)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "ariaErrorMessageElements", - "value": "ReadonlyArray | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaErrorMessageElements)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "ariaExpanded", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaExpanded)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "ariaFlowToElements", - "value": "ReadonlyArray | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaFlowToElements)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "ariaHasPopup", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHasPopup)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "ariaHidden", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHidden)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "ariaInvalid", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaInvalid)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "ariaKeyShortcuts", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaKeyShortcuts)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "ariaLabel", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabel)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "ariaLabelledByElements", - "value": "ReadonlyArray | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabelledByElements)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "ariaLevel", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLevel)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "ariaLive", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLive)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "ariaModal", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaModal)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "ariaMultiLine", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiLine)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "ariaMultiSelectable", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiSelectable)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "ariaOrientation", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOrientation)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "ariaOwnsElements", - "value": "ReadonlyArray | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOwnsElements)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "ariaPlaceholder", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPlaceholder)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "ariaPosInSet", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPosInSet)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "ariaPressed", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPressed)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "ariaReadOnly", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaReadOnly)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "ariaRelevant", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRelevant)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "ariaRequired", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRequired)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "ariaRoleDescription", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRoleDescription)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "ariaRowCount", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowCount)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "ariaRowIndex", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndex)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "ariaRowIndexText", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndexText)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "ariaRowSpan", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowSpan)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "ariaSelected", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSelected)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "ariaSetSize", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSetSize)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "ariaSort", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSort)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "ariaValueMax", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMax)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "ariaValueMin", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMin)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "ariaValueNow", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueNow)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "ariaValueText", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueText)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "assignedSlot", - "value": "HTMLSlotElement | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/assignedSlot)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "MethodSignature", - "name": "attachInternals", - "value": "() => ElementInternals", - "description": "The **`HTMLElement.attachInternals()`** method returns an ElementInternals object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attachInternals)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "MethodSignature", - "name": "attachShadow", - "value": "(init: ShadowRootInit) => ShadowRoot", - "description": "The **`Element.attachShadow()`** method attaches a shadow DOM tree to the specified element and returns a reference to its ShadowRoot.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attachShadow)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "ATTRIBUTE_NODE", - "value": "2", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "NamedNodeMap", - "description": "The **`Element.attributes`** property returns a live collection of all attribute nodes registered to the specified node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attributes)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "attributeStyleMap", - "value": "StylePropertyMap", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attributeStyleMap)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "autocapitalize", - "value": "string", - "description": "The **`autocapitalize`** property of the HTMLElement interface represents the element's capitalization behavior for user input.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocapitalize)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "autocorrect", - "value": "boolean", - "description": "The **`autocorrect`** property of the HTMLElement interface controls whether or not autocorrection of editable text is enabled for spelling and/or punctuation errors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocorrect)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "autofocus", - "value": "boolean", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autofocus)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "baseURI", - "value": "string", - "description": "The read-only **`baseURI`** property of the Node interface returns the absolute base URL of the document containing the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/baseURI)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "MethodSignature", - "name": "before", - "value": "(...nodes: (string | Node)[]) => void", - "description": "Inserts nodes just before node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/before)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "MethodSignature", - "name": "blur", - "value": "() => void", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/blur)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "CDATA_SECTION_NODE", - "value": "4", - "description": "node is a CDATASection node." - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "MethodSignature", - "name": "checkVisibility", - "value": "(options?: CheckVisibilityOptions) => boolean", - "description": "The **`checkVisibility()`** method of the Element interface checks whether the element is visible.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/checkVisibility)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "childElementCount", - "value": "number", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/childElementCount)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "childNodes", - "value": "NodeListOf", - "description": "The read-only **`childNodes`** property of the Node interface returns a live the first child node is assigned index `0`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/childNodes)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "HTMLCollection", - "description": "Returns the child elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/children)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "GetAccessor", - "name": "classList", - "value": "DOMTokenList", - "description": "The **`Element.classList`** is a read-only property that returns a live DOMTokenList collection of the `class` attributes of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/classList)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "className", - "value": "string", - "description": "The **`className`** property of the of the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/className)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "MethodSignature", - "name": "click", - "value": "() => void", - "description": "The **`HTMLElement.click()`** method simulates a mouse click on an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/click)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "clientHeight", - "value": "number", - "description": "The **`clientHeight`** read-only property of the Element interface is zero for elements with no CSS or inline layout boxes; otherwise, it's the inner height of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientHeight)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "clientLeft", - "value": "number", - "description": "The **`clientLeft`** read-only property of the Element interface returns the width of the left border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientLeft)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "clientTop", - "value": "number", - "description": "The **`clientTop`** read-only property of the Element interface returns the width of the top border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientTop)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "clientWidth", - "value": "number", - "description": "The **`clientWidth`** read-only property of the Element interface is zero for inline elements and elements with no CSS; otherwise, it's the inner width of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientWidth)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "MethodSignature", - "name": "cloneNode", - "value": "(subtree?: boolean) => Node", - "description": "The **`cloneNode()`** method of the Node interface returns a duplicate of the node on which this method was called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/cloneNode)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "MethodSignature", - "name": "closest", - "value": "{ (selector: K): HTMLElementTagNameMap[K]; (selector: K): SVGElementTagNameMap[K]; (selector: K): MathMLElementTagNameMap[K]; (selectors: string): E; }", - "description": "The **`closest()`** method of the Element interface traverses the element and its parents (heading toward the document root) until it finds a node that matches the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/closest)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "color", - "value": "'base' | 'subdued'", - "description": "Modify the color to be more or less intense.", - "isOptional": true, - "defaultValue": "'base'" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "COMMENT_NODE", - "value": "8", - "description": "node is a Comment node." - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "MethodSignature", - "name": "compareDocumentPosition", - "value": "(other: Node) => number", - "description": "The **`compareDocumentPosition()`** method of the Node interface reports the position of its argument node relative to the node on which it is called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/compareDocumentPosition)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "MethodSignature", - "name": "computedStyleMap", - "value": "() => StylePropertyMapReadOnly", - "description": "The **`computedStyleMap()`** method of the Element interface returns a StylePropertyMapReadOnly interface which provides a read-only representation of a CSS declaration block that is an alternative to CSSStyleDeclaration.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/computedStyleMap)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "MethodSignature", - "name": "contains", - "value": "(other: Node) => boolean", - "description": "The **`contains()`** method of the Node interface returns a boolean value indicating whether a node is a descendant of a given node, that is the node itself, one of its direct children (Node.childNodes), one of the children's direct children, and so on.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/contains)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "contentEditable", - "value": "string", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/contentEditable)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "currentCSSZoom", - "value": "number", - "description": "The **`currentCSSZoom`** read-only property of the Element interface provides the 'effective' CSS `zoom` of an element, taking into account the zoom applied to the element and all its parent elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/currentCSSZoom)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "dataset", - "value": "DOMStringMap", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dataset)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "dir", - "value": "string", - "description": "The **`HTMLElement.dir`** property indicates the text writing directionality of the content of the current element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dir)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "MethodSignature", - "name": "dispatchEvent", - "value": "(event: Event) => boolean", - "description": "The **`dispatchEvent()`** method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/dispatchEvent)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "DOCUMENT_FRAGMENT_NODE", - "value": "11", - "description": "node is a DocumentFragment node." - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "DOCUMENT_NODE", - "value": "9", - "description": "node is a document." - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "DOCUMENT_POSITION_CONTAINED_BY", - "value": "16", - "description": "Set when other is a descendant of node." - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "DOCUMENT_POSITION_CONTAINS", - "value": "8", - "description": "Set when other is an ancestor of node." - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "DOCUMENT_POSITION_DISCONNECTED", - "value": "1", - "description": "Set when node and other are not in the same tree." - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "DOCUMENT_POSITION_FOLLOWING", - "value": "4", - "description": "Set when other is following node." - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC", - "value": "32", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "DOCUMENT_POSITION_PRECEDING", - "value": "2", - "description": "Set when other is preceding node." - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "DOCUMENT_TYPE_NODE", - "value": "10", - "description": "node is a doctype." - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "draggable", - "value": "boolean", - "description": "The **`draggable`** property of the HTMLElement interface gets and sets a Boolean primitive indicating if the element is draggable.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/draggable)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "ELEMENT_NODE", - "value": "1", - "description": "node is an element." - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "enterKeyHint", - "value": "string", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/enterKeyHint)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "ENTITY_NODE", - "value": "6", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "ENTITY_REFERENCE_NODE", - "value": "5", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "firstChild", - "value": "ChildNode | null", - "description": "The read-only **`firstChild`** property of the Node interface returns the node's first child in the tree, or `null` if the node has no children.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/firstChild)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "firstElementChild", - "value": "Element | null", - "description": "Returns the first child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/firstElementChild)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "MethodSignature", - "name": "focus", - "value": "(options?: FocusOptions) => void", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/focus)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "MethodSignature", - "name": "getAnimations", - "value": "(options?: GetAnimationsOptions) => Animation[]", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAnimations)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "MethodSignature", - "name": "getAttribute", - "value": "(qualifiedName: string) => string", - "description": "The **`getAttribute()`** method of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttribute)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "MethodSignature", - "name": "getAttributeNames", - "value": "() => string[]", - "description": "The **`getAttributeNames()`** method of the array.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNames)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "MethodSignature", - "name": "getAttributeNode", - "value": "(qualifiedName: string) => Attr", - "description": "Returns the specified attribute of the specified element, as an Attr node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNode)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "MethodSignature", - "name": "getAttributeNodeNS", - "value": "(namespace: string, localName: string) => Attr", - "description": "The **`getAttributeNodeNS()`** method of the Element interface returns the namespaced Attr node of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNodeNS)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "MethodSignature", - "name": "getAttributeNS", - "value": "(namespace: string, localName: string) => string", - "description": "The **`getAttributeNS()`** method of the Element interface returns the string value of the attribute with the specified namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNS)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "MethodSignature", - "name": "getBoundingClientRect", - "value": "() => DOMRect", - "description": "The **`Element.getBoundingClientRect()`** method returns a position relative to the viewport.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getBoundingClientRect)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "MethodSignature", - "name": "getClientRects", - "value": "() => DOMRectList", - "description": "The **`getClientRects()`** method of the Element interface returns a collection of DOMRect objects that indicate the bounding rectangles for each CSS border box in a client.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getClientRects)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "MethodSignature", - "name": "getElementsByClassName", - "value": "(classNames: string) => HTMLCollectionOf", - "description": "The Element method **`getElementsByClassName()`** returns a live specified class name or names.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByClassName)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "MethodSignature", - "name": "getElementsByTagName", - "value": "{ (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: string): HTMLCollectionOf; }", - "description": "The **`Element.getElementsByTagName()`** method returns a live All descendants of the specified element are searched, but not the element itself.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagName)", - "deprecationMessage": "Deprecated" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "MethodSignature", - "name": "getElementsByTagNameNS", - "value": "{ (namespaceURI: \"http://www.w3.org/1999/xhtml\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/2000/svg\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/1998/Math/MathML\", localName: string): HTMLCollectionOf; (namespace: string, localName: string): HTMLCollectionOf; }", - "description": "The **`Element.getElementsByTagNameNS()`** method returns a live HTMLCollection of elements with the given tag name belonging to the given namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagNameNS)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "MethodSignature", - "name": "getHTML", - "value": "(options?: GetHTMLOptions) => string", - "description": "The **`getHTML()`** method of the Element interface is used to serialize an element's DOM to an HTML string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getHTML)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "MethodSignature", - "name": "getRootNode", - "value": "(options?: GetRootNodeOptions) => Node", - "description": "The **`getRootNode()`** method of the Node interface returns the context object's root, which optionally includes the shadow root if it is available.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/getRootNode)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "MethodSignature", - "name": "hasAttribute", - "value": "(qualifiedName: string) => boolean", - "description": "The **`Element.hasAttribute()`** method returns a **Boolean** value indicating whether the specified element has the specified attribute or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttribute)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "MethodSignature", - "name": "hasAttributeNS", - "value": "(namespace: string, localName: string) => boolean", - "description": "The **`hasAttributeNS()`** method of the Element interface returns a boolean value indicating whether the current element has the specified attribute with the specified namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributeNS)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "MethodSignature", - "name": "hasAttributes", - "value": "() => boolean", - "description": "The **`hasAttributes()`** method of the Element interface returns a boolean value indicating whether the current element has any attributes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributes)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "MethodSignature", - "name": "hasChildNodes", - "value": "() => boolean", - "description": "The **`hasChildNodes()`** method of the Node interface returns a boolean value indicating whether the given Node has child nodes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/hasChildNodes)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "MethodSignature", - "name": "hasPointerCapture", - "value": "(pointerId: number) => boolean", - "description": "The **`hasPointerCapture()`** method of the pointer capture for the pointer identified by the given pointer ID.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasPointerCapture)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "hidden", - "value": "boolean", - "description": "The HTMLElement property **`hidden`** reflects the value of the element's `hidden` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidden)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "MethodSignature", - "name": "hidePopover", - "value": "() => void", - "description": "The **`hidePopover()`** method of the HTMLElement interface hides a popover element (i.e., one that has a valid `popover` attribute) by removing it from the top layer and styling it with `display: none`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidePopover)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "icon", - "value": "'' | ReducedIconTypes", - "description": "The type of icon to be displayed in the badge.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "iconPosition", - "value": "'start' | 'end'", - "description": "The position of the icon in relation to the text.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the element.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "inert", - "value": "boolean", - "description": "The HTMLElement property **`inert`** reflects the value of the element's `inert` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inert)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "innerHTML", - "value": "string", - "description": "The **`innerHTML`** property of the Element interface gets or sets the HTML or XML markup contained within the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/innerHTML)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "innerText", - "value": "string", - "description": "The **`innerText`** property of the HTMLElement interface represents the rendered text content of a node and its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/innerText)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "inputMode", - "value": "string", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inputMode)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "MethodSignature", - "name": "insertAdjacentElement", - "value": "(where: InsertPosition, element: Element) => Element", - "description": "The **`insertAdjacentElement()`** method of the relative to the element it is invoked upon.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentElement)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "MethodSignature", - "name": "insertAdjacentHTML", - "value": "(position: InsertPosition, string: string) => void", - "description": "The **`insertAdjacentHTML()`** method of the the resulting nodes into the DOM tree at a specified position.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentHTML)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "MethodSignature", - "name": "insertAdjacentText", - "value": "(where: InsertPosition, data: string) => void", - "description": "The **`insertAdjacentText()`** method of the Element interface, given a relative position and a string, inserts a new text node at the given position relative to the element it is called from.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentText)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "MethodSignature", - "name": "insertBefore", - "value": "(node: T, child: Node) => T", - "description": "The **`insertBefore()`** method of the Node interface inserts a node before a _reference node_ as a child of a specified _parent node_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/insertBefore)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "isConnected", - "value": "boolean", - "description": "The read-only **`isConnected`** property of the Node interface returns a boolean indicating whether the node is connected (directly or indirectly) to a Document object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isConnected)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "isContentEditable", - "value": "boolean", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/isContentEditable)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "MethodSignature", - "name": "isDefaultNamespace", - "value": "(namespace: string) => boolean", - "description": "The **`isDefaultNamespace()`** method of the Node interface accepts a namespace URI as an argument.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isDefaultNamespace)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "MethodSignature", - "name": "isEqualNode", - "value": "(otherNode: Node) => boolean", - "description": "The **`isEqualNode()`** method of the Node interface tests whether two nodes are equal.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isEqualNode)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "MethodSignature", - "name": "isSameNode", - "value": "(otherNode: Node) => boolean", - "description": "The **`isSameNode()`** method of the Node interface is a legacy alias the for the `===` strict equality operator.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isSameNode)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "lang", - "value": "string", - "description": "The **`lang`** property of the HTMLElement interface indicates the base language of an element's attribute values and text content, in the form of a MISSING: RFC(5646, 'BCP 47 language identifier tag')].\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/lang)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "lastChild", - "value": "ChildNode | null", - "description": "The read-only **`lastChild`** property of the Node interface returns the last child of the node, or `null` if there are no child nodes.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lastChild)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "lastElementChild", - "value": "Element | null", - "description": "Returns the last child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/lastElementChild)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "localName", - "value": "string", - "description": "The **`Element.localName`** read-only property returns the local part of the qualified name of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/localName)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "MethodSignature", - "name": "lookupNamespaceURI", - "value": "(prefix: string) => string", - "description": "The **`lookupNamespaceURI()`** method of the Node interface takes a prefix as parameter and returns the namespace URI associated with it on the given node if found (and `null` if not).\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupNamespaceURI)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "MethodSignature", - "name": "lookupPrefix", - "value": "(namespace: string) => string", - "description": "The **`lookupPrefix()`** method of the Node interface returns a string containing the prefix for a given namespace URI, if present, and `null` if not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupPrefix)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "MethodSignature", - "name": "matches", - "value": "(selectors: string) => boolean", - "description": "The **`matches()`** method of the Element interface tests whether the element would be selected by the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "namespaceURI", - "value": "string | null", - "description": "The **`Element.namespaceURI`** read-only property returns the namespace URI of the element, or `null` if the element is not in a namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/namespaceURI)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "nextElementSibling", - "value": "Element | null", - "description": "Returns the first following sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/nextElementSibling)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "nextSibling", - "value": "ChildNode | null", - "description": "The read-only **`nextSibling`** property of the Node interface returns the node immediately following the specified one in their parent's Node.childNodes, or returns `null` if the specified node is the last child in the parent element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nextSibling)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "nodeName", - "value": "string", - "description": "The read-only **`nodeName`** property of Node returns the name of the current node as a string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeName)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "nodeType", - "value": "number", - "description": "The read-only **`nodeType`** property of a Node interface is an integer that identifies what the node is.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeType)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "nodeValue", - "value": "string | null", - "description": "The **`nodeValue`** property of the Node interface returns or sets the value of the current node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeValue)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "nonce", - "value": "string", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/nonce)", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "MethodSignature", - "name": "normalize", - "value": "() => void", - "description": "The **`normalize()`** method of the Node interface puts the specified node and all of its sub-tree into a _normalized_ form.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/normalize)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "NOTATION_NODE", - "value": "12", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "offsetHeight", - "value": "number", - "description": "The **`offsetHeight`** read-only property of the HTMLElement interface returns the height of an element, including vertical padding and borders, as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetHeight)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "offsetLeft", - "value": "number", - "description": "The **`offsetLeft`** read-only property of the HTMLElement interface returns the number of pixels that the _upper left corner_ of the current element is offset to the left within the HTMLElement.offsetParent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetLeft)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "offsetParent", - "value": "Element | null", - "description": "The **`HTMLElement.offsetParent`** read-only property returns a reference to the element which is the closest (nearest in the containment hierarchy) positioned ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetParent)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "offsetTop", - "value": "number", - "description": "The **`offsetTop`** read-only property of the HTMLElement interface returns the distance from the outer border of the current element (including its margin) to the top padding edge of the HTMLelement.offsetParent, the _closest positioned_ ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetTop)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "offsetWidth", - "value": "number", - "description": "The **`offsetWidth`** read-only property of the HTMLElement interface returns the layout width of an element as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetWidth)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "onabort", - "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/abort_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "onanimationcancel", - "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationcancel_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "onanimationend", - "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "onanimationiteration", - "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "onanimationstart", - "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "onauxclick", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/auxclick_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "onbeforeinput", - "value": "((this: GlobalEventHandlers, ev: InputEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforeinput_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "onbeforematch", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforematch_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "onbeforetoggle", - "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/beforetoggle_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "onblur", - "value": "((this: GlobalEventHandlers, ev: FocusEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/blur_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "oncancel", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/cancel_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "oncanplay", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplay_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "oncanplaythrough", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplaythrough_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "onchange", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/change_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "onclick", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/click_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "onclose", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/close_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "oncontextlost", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextlost_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "oncontextmenu", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/contextmenu_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "oncontextrestored", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextrestored_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "oncopy", - "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/copy_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "oncuechange", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLTrackElement/cuechange_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "oncut", - "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/cut_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "ondblclick", - "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/dblclick_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "ondrag", - "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drag_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "ondragend", - "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragend_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "ondragenter", - "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragenter_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "ondragleave", - "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragleave_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "ondragover", - "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragover_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "ondragstart", - "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragstart_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "ondrop", - "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drop_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "ondurationchange", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/durationchange_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "onemptied", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/emptied_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "onended", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ended_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "onerror", - "value": "OnErrorEventHandler", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/error_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "onfocus", - "value": "((this: GlobalEventHandlers, ev: FocusEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/focus_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "onformdata", - "value": "((this: GlobalEventHandlers, ev: FormDataEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/formdata_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "onfullscreenchange", - "value": "((this: Element, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenchange_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "onfullscreenerror", - "value": "((this: Element, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenerror_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "ongotpointercapture", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/gotpointercapture_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "oninput", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/input_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "oninvalid", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/invalid_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "onkeydown", - "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keydown_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "onkeypress", - "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", - "description": "", - "deprecationMessage": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keypress_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "onkeyup", - "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keyup_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "onload", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/load_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "onloadeddata", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadeddata_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "onloadedmetadata", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadedmetadata_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "onloadstart", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadstart_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "onlostpointercapture", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/lostpointercapture_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "onmousedown", - "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousedown_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "onmouseenter", - "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseenter_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "onmouseleave", - "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseleave_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "onmousemove", - "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousemove_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "onmouseout", - "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseout_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "onmouseover", - "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseover_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "onmouseup", - "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseup_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "onpaste", - "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/paste_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "onpause", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/pause_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "onplay", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/play_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "onplaying", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/playing_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "onpointercancel", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointercancel_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "onpointerdown", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerdown_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "onpointerenter", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerenter_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "onpointerleave", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerleave_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "onpointermove", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointermove_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "onpointerout", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerout_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "onpointerover", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerover_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "onpointerrawupdate", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "Available only in secure contexts.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerrawupdate_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "onpointerup", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerup_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "onprogress", - "value": "((this: GlobalEventHandlers, ev: ProgressEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/progress_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "onratechange", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ratechange_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "onreset", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/reset_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "onresize", - "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLVideoElement/resize_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "onscroll", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scroll_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "onscrollend", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scrollend_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "onsecuritypolicyviolation", - "value": "((this: GlobalEventHandlers, ev: SecurityPolicyViolationEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/securitypolicyviolation_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "onseeked", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeked_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "onseeking", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeking_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "onselect", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/select_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "onselectionchange", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/selectionchange_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "onselectstart", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/selectstart_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "onslotchange", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLSlotElement/slotchange_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "onstalled", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/stalled_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "onsubmit", - "value": "((this: GlobalEventHandlers, ev: SubmitEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/submit_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "onsuspend", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/suspend_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "ontimeupdate", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/timeupdate_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "ontoggle", - "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/toggle_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "ontouchcancel", - "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchcancel_event)", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "ontouchend", - "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchend_event)", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "ontouchmove", - "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchmove_event)", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "ontouchstart", - "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchstart_event)", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "ontransitioncancel", - "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitioncancel_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "ontransitionend", - "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "ontransitionrun", - "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionrun_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "ontransitionstart", - "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionstart_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "onvolumechange", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/volumechange_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "onwaiting", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/waiting_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "onwebkitanimationend", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "", - "deprecationMessage": "This is a legacy alias of `onanimationend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "onwebkitanimationiteration", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "", - "deprecationMessage": "This is a legacy alias of `onanimationiteration`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "onwebkitanimationstart", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "", - "deprecationMessage": "This is a legacy alias of `onanimationstart`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "onwebkittransitionend", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "", - "deprecationMessage": "This is a legacy alias of `ontransitionend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "onwheel", - "value": "((this: GlobalEventHandlers, ev: WheelEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/wheel_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "outerHTML", - "value": "string", - "description": "The **`outerHTML`** attribute of the Element DOM interface gets the serialized HTML fragment describing the element including its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/outerHTML)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "outerText", - "value": "string", - "description": "The **`outerText`** property of the HTMLElement interface returns the same value as HTMLElement.innerText.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/outerText)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "ownerDocument", - "value": "Document", - "description": "The read-only **`ownerDocument`** property of the Node interface returns the top-level document object of the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/ownerDocument)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "parentElement", - "value": "HTMLElement | null", - "description": "The read-only **`parentElement`** property of Node interface returns the DOM node's parent Element, or `null` if the node either has no parent, or its parent isn't a DOM Element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentElement)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "parentNode", - "value": "ParentNode | null", - "description": "The read-only **`parentNode`** property of the Node interface returns the parent of the specified node in the DOM tree.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentNode)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "GetAccessor", - "name": "part", - "value": "DOMTokenList", - "description": "The **`part`** property of the Element interface represents the part identifier(s) of the element (i.e., set using the `part` attribute), returned as a DOMTokenList.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/part)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "popover", - "value": "string | null", - "description": "The **`popover`** property of the HTMLElement interface gets and sets an element's popover state via JavaScript (`'auto'`, `'hint'`, or `'manual'`), and can be used for feature detection.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/popover)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "prefix", - "value": "string | null", - "description": "The **`Element.prefix`** read-only property returns the namespace prefix of the specified element, or `null` if no prefix is specified.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/prefix)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "MethodSignature", - "name": "prepend", - "value": "(...nodes: (string | Node)[]) => void", - "description": "Inserts nodes before the first child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/prepend)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "previousElementSibling", - "value": "Element | null", - "description": "Returns the first preceding sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/previousElementSibling)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "previousSibling", - "value": "ChildNode | null", - "description": "The read-only **`previousSibling`** property of the Node interface returns the node immediately preceding the specified one in its parent's or `null` if the specified node is the first in that list.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/previousSibling)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "PROCESSING_INSTRUCTION_NODE", - "value": "7", - "description": "node is a ProcessingInstruction node." - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "MethodSignature", - "name": "querySelector", - "value": "{ (selectors: K): HTMLElementTagNameMap[K]; (selectors: K): SVGElementTagNameMap[K]; (selectors: K): MathMLElementTagNameMap[K]; (selectors: K): HTMLElementDeprecatedTagNameMap[K]; (selectors: string): E; }", - "description": "Returns the first element that is a descendant of node that matches selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelector)", - "deprecationMessage": "Deprecated" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "MethodSignature", - "name": "querySelectorAll", - "value": "{ (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: string): NodeListOf; }", - "description": "Returns all element descendants of node that match selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelectorAll)", - "deprecationMessage": "Deprecated" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "MethodSignature", - "name": "releasePointerCapture", - "value": "(pointerId: number) => void", - "description": "The **`releasePointerCapture()`** method of the previously set for a specific (PointerEvent) _pointer_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/releasePointerCapture)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "MethodSignature", - "name": "remove", - "value": "() => void", - "description": "Removes node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/remove)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "MethodSignature", - "name": "removeAttribute", - "value": "(qualifiedName: string) => void", - "description": "The Element method **`removeAttribute()`** removes the attribute with the specified name from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttribute)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "MethodSignature", - "name": "removeAttributeNode", - "value": "(attr: Attr) => Attr", - "description": "The **`removeAttributeNode()`** method of the Element interface removes the specified Attr node from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNode)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "MethodSignature", - "name": "removeAttributeNS", - "value": "(namespace: string, localName: string) => void", - "description": "The **`removeAttributeNS()`** method of the If you are working with HTML and you don't need to specify the requested attribute as being part of a specific namespace, use the Element.removeAttribute() method instead.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNS)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "MethodSignature", - "name": "removeChild", - "value": "(child: T) => T", - "description": "The **`removeChild()`** method of the Node interface removes a child node from the DOM and returns the removed node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/removeChild)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "MethodSignature", - "name": "removeEventListener", - "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "MethodSignature", - "name": "replaceChild", - "value": "(node: Node, child: T) => T", - "description": "The **`replaceChild()`** method of the Node interface replaces a child node within the given (parent) node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/replaceChild)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "MethodSignature", - "name": "replaceChildren", - "value": "(...nodes: (string | Node)[]) => void", - "description": "Replace all children of node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/replaceChildren)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "MethodSignature", - "name": "replaceWith", - "value": "(...nodes: (string | Node)[]) => void", - "description": "Replaces node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/replaceWith)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "MethodSignature", - "name": "requestFullscreen", - "value": "(options?: FullscreenOptions) => Promise", - "description": "The **`Element.requestFullscreen()`** method issues an asynchronous request to make the element be displayed in fullscreen mode.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestFullscreen)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "MethodSignature", - "name": "requestPointerLock", - "value": "(options?: PointerLockOptions) => Promise", - "description": "The **`requestPointerLock()`** method of the Element interface lets you asynchronously ask for the pointer to be locked on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestPointerLock)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "role", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/role)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "MethodSignature", - "name": "scroll", - "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", - "description": "The **`scroll()`** method of the Element interface scrolls the element to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scroll)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "MethodSignature", - "name": "scrollBy", - "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", - "description": "The **`scrollBy()`** method of the Element interface scrolls an element by the given amount.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollBy)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "scrollHeight", - "value": "number", - "description": "The **`scrollHeight`** read-only property of the Element interface is a measurement of the height of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollHeight)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "MethodSignature", - "name": "scrollIntoView", - "value": "(arg?: boolean | ScrollIntoViewOptions) => void", - "description": "The Element interface's **`scrollIntoView()`** method scrolls the element's ancestor containers such that the element on which `scrollIntoView()` is called is visible to the user.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollIntoView)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "scrollLeft", - "value": "number", - "description": "The **`scrollLeft`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its left edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollLeft)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "MethodSignature", - "name": "scrollTo", - "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", - "description": "The **`scrollTo()`** method of the Element interface scrolls to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTo)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "scrollTop", - "value": "number", - "description": "The **`scrollTop`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its top edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTop)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "scrollWidth", - "value": "number", - "description": "The **`scrollWidth`** read-only property of the Element interface is a measurement of the width of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollWidth)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "MethodSignature", - "name": "setAttribute", - "value": "(qualifiedName: string, value: string) => void", - "description": "The **`setAttribute()`** method of the Element interface sets the value of an attribute on the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttribute)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "MethodSignature", - "name": "setAttributeNode", - "value": "(attr: Attr) => Attr", - "description": "The **`setAttributeNode()`** method of the Element interface adds a new Attr node to the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNode)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "MethodSignature", - "name": "setAttributeNodeNS", - "value": "(attr: Attr) => Attr", - "description": "The **`setAttributeNodeNS()`** method of the Element interface adds a new namespaced Attr node to an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNodeNS)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "MethodSignature", - "name": "setAttributeNS", - "value": "(namespace: string, qualifiedName: string, value: string) => void", - "description": "`setAttributeNS` adds a new attribute or changes the value of an attribute with the given namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNS)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "MethodSignature", - "name": "setHTMLUnsafe", - "value": "(html: string) => void", - "description": "The **`setHTMLUnsafe()`** method of the Element interface is used to parse a string of HTML into a DocumentFragment, optionally filtering out unwanted elements and attributes, and those that don't belong in the context, and then using it to replace the element's subtree in the DOM.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setHTMLUnsafe)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "MethodSignature", - "name": "setPointerCapture", - "value": "(pointerId: number) => void", - "description": "The **`setPointerCapture()`** method of the _capture target_ of future pointer events.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setPointerCapture)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "shadowRoot", - "value": "ShadowRoot | null", - "description": "The `Element.shadowRoot` read-only property represents the shadow root hosted by the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/shadowRoot)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "MethodSignature", - "name": "showPopover", - "value": "() => void", - "description": "The **`showPopover()`** method of the HTMLElement interface shows a Popover_API element (i.e., one that has a valid `popover` attribute) by adding it to the top layer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/showPopover)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "size", - "value": "'base' | 'small' | 'small-100'", - "description": "Adjusts the size.", - "isOptional": true, - "defaultValue": "'base'" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "slot", - "value": "string", - "description": "The **`slot`** property of the Element interface returns the name of the shadow DOM slot the element is inserted in.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/slot)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "spellcheck", - "value": "boolean", - "description": "The **`spellcheck`** property of the HTMLElement interface represents a boolean value that controls the spell-checking hint.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/spellcheck)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "GetAccessor", - "name": "style", - "value": "CSSStyleDeclaration", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/style)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "tabIndex", - "value": "number", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/tabIndex)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "tagName", - "value": "string", - "description": "The **`tagName`** read-only property of the Element interface returns the tag name of the element on which it's called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/tagName)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "TEXT_NODE", - "value": "3", - "description": "node is a Text node." - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "GetAccessor", - "name": "textContent", - "value": "string", - "description": "[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/Node/textContent)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The **`HTMLElement.title`** property represents the title of the element: the text usually displayed in a 'tooltip' popup when the mouse is over the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/title)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "MethodSignature", - "name": "toggleAttribute", - "value": "(qualifiedName: string, force?: boolean) => boolean", - "description": "The **`toggleAttribute()`** method of the present and adding it if it is not present) on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/toggleAttribute)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "MethodSignature", - "name": "togglePopover", - "value": "(options?: boolean) => boolean", - "description": "The **`togglePopover()`** method of the HTMLElement interface toggles a Popover_API element (i.e., one that has a valid `popover` attribute) between the hidden and showing states.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/togglePopover)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "tone", - "value": "'auto' | 'neutral' | 'critical'", - "description": "Sets the tone of the Badge, based on the intention of the information being conveyed.", - "isOptional": true, - "defaultValue": "'auto'" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "translate", - "value": "boolean", - "description": "The **`translate`** property of the HTMLElement interface indicates whether an element's attribute values and the values of its Text node children are to be translated when the page is localized, or whether to leave them unchanged.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/translate)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "MethodSignature", - "name": "webkitMatchesSelector", - "value": "(selectors: string) => boolean", - "description": "", - "deprecationMessage": "This is a legacy alias of `matches`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "writingSuggestions", - "value": "string", - "description": "The **`writingSuggestions`** property of the HTMLElement interface is a string indicating if browser-provided writing suggestions should be enabled under the scope of the element or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/writingSuggestions)" - } - ], - "value": "export interface BadgeElement extends BadgeElementProps, Omit {\n}" - } - }, - "BadgeProps": { - "src/surfaces/checkout/components/Badge.ts": { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "name": "BadgeProps", - "description": "", - "isPublicDocs": true, - "members": [ - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "color", - "value": "'base' | 'subdued'", - "description": "Modify the color to be more or less intense.", - "isOptional": true, - "defaultValue": "'base'" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "icon", - "value": "'' | ReducedIconTypes", - "description": "The type of icon to be displayed in the badge.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "iconPosition", - "value": "'start' | 'end'", - "description": "The position of the icon in relation to the text.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the element.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "size", - "value": "'base' | 'small' | 'small-100'", - "description": "Adjusts the size.", - "isOptional": true, - "defaultValue": "'base'" - }, - { - "filePath": "src/surfaces/checkout/components/Badge.ts", - "syntaxKind": "PropertySignature", - "name": "tone", - "value": "'auto' | 'neutral' | 'critical'", - "description": "Sets the tone of the Badge, based on the intention of the information being conveyed.", - "isOptional": true, - "defaultValue": "'auto'" - } - ], - "value": "export interface BadgeProps extends BadgeElementProps {\n}" - } - }, - "SpinnerElementProps": { - "src/surfaces/checkout/components/Spinner.ts": { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "name": "SpinnerElementProps", - "description": "Properties for the Spinner component element.", - "isPublicDocs": true, - "members": [ - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "A label that describes the purpose of the progress. When set, it will be announced to users using assistive technologies and will provide them with more context. Providing an `accessibilityLabel` is recommended if there is no accompanying text describing that something is loading.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the element.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "size", - "value": "'base' | 'small' | 'small-100' | 'large' | 'large-100'", - "description": "Adjusts the size of the spinner icon.", - "isOptional": true, - "defaultValue": "'base'" - } - ], - "value": "export interface SpinnerElementProps extends SpinnerProps$1 {\n size?: Extract;\n}" - } - }, - "SpinnerElement": { - "src/surfaces/checkout/components/Spinner.ts": { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "name": "SpinnerElement", - "description": "", - "isPublicDocs": true, - "members": [ - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "A label that describes the purpose of the progress. When set, it will be announced to users using assistive technologies and will provide them with more context. Providing an `accessibilityLabel` is recommended if there is no accompanying text describing that something is loading.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "accessKey", - "value": "string", - "description": "The **`HTMLElement.accessKey`** property sets the keystroke which a user can press to jump to a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKey)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "accessKeyLabel", - "value": "string", - "description": "The **`HTMLElement.accessKeyLabel`** read-only property returns a string containing the element's browser-assigned access key (if any); otherwise it returns an empty string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKeyLabel)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "MethodSignature", - "name": "addEventListener", - "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "MethodSignature", - "name": "after", - "value": "(...nodes: (string | Node)[]) => void", - "description": "Inserts nodes just after node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/after)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "MethodSignature", - "name": "animate", - "value": "(keyframes: Keyframe[] | PropertyIndexedKeyframes, options?: number | KeyframeAnimationOptions) => Animation", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animate)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "MethodSignature", - "name": "append", - "value": "(...nodes: (string | Node)[]) => void", - "description": "Inserts nodes after the last child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/append)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "MethodSignature", - "name": "appendChild", - "value": "(node: T) => T", - "description": "The **`appendChild()`** method of the Node interface adds a node to the end of the list of children of a specified parent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/appendChild)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "ariaActiveDescendantElement", - "value": "Element | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaActiveDescendantElement)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "ariaAtomic", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAtomic)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "ariaAutoComplete", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAutoComplete)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "ariaBrailleLabel", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleLabel)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "ariaBrailleRoleDescription", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleRoleDescription)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "ariaBusy", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBusy)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "ariaChecked", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaChecked)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "ariaColCount", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColCount)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "ariaColIndex", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndex)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "ariaColIndexText", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndexText)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "ariaColSpan", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColSpan)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "ariaControlsElements", - "value": "ReadonlyArray | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaControlsElements)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "ariaCurrent", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaCurrent)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "ariaDescribedByElements", - "value": "ReadonlyArray | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescribedByElements)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "ariaDescription", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescription)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "ariaDetailsElements", - "value": "ReadonlyArray | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDetailsElements)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "ariaDisabled", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDisabled)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "ariaErrorMessageElements", - "value": "ReadonlyArray | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaErrorMessageElements)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "ariaExpanded", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaExpanded)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "ariaFlowToElements", - "value": "ReadonlyArray | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaFlowToElements)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "ariaHasPopup", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHasPopup)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "ariaHidden", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHidden)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "ariaInvalid", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaInvalid)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "ariaKeyShortcuts", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaKeyShortcuts)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "ariaLabel", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabel)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "ariaLabelledByElements", - "value": "ReadonlyArray | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabelledByElements)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "ariaLevel", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLevel)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "ariaLive", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLive)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "ariaModal", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaModal)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "ariaMultiLine", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiLine)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "ariaMultiSelectable", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiSelectable)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "ariaOrientation", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOrientation)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "ariaOwnsElements", - "value": "ReadonlyArray | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOwnsElements)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "ariaPlaceholder", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPlaceholder)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "ariaPosInSet", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPosInSet)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "ariaPressed", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPressed)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "ariaReadOnly", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaReadOnly)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "ariaRelevant", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRelevant)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "ariaRequired", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRequired)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "ariaRoleDescription", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRoleDescription)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "ariaRowCount", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowCount)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "ariaRowIndex", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndex)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "ariaRowIndexText", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndexText)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "ariaRowSpan", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowSpan)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "ariaSelected", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSelected)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "ariaSetSize", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSetSize)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "ariaSort", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSort)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "ariaValueMax", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMax)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "ariaValueMin", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMin)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "ariaValueNow", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueNow)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "ariaValueText", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueText)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "assignedSlot", - "value": "HTMLSlotElement | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/assignedSlot)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "MethodSignature", - "name": "attachInternals", - "value": "() => ElementInternals", - "description": "The **`HTMLElement.attachInternals()`** method returns an ElementInternals object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attachInternals)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "MethodSignature", - "name": "attachShadow", - "value": "(init: ShadowRootInit) => ShadowRoot", - "description": "The **`Element.attachShadow()`** method attaches a shadow DOM tree to the specified element and returns a reference to its ShadowRoot.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attachShadow)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "ATTRIBUTE_NODE", - "value": "2", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "NamedNodeMap", - "description": "The **`Element.attributes`** property returns a live collection of all attribute nodes registered to the specified node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attributes)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "attributeStyleMap", - "value": "StylePropertyMap", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attributeStyleMap)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "autocapitalize", - "value": "string", - "description": "The **`autocapitalize`** property of the HTMLElement interface represents the element's capitalization behavior for user input.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocapitalize)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "autocorrect", - "value": "boolean", - "description": "The **`autocorrect`** property of the HTMLElement interface controls whether or not autocorrection of editable text is enabled for spelling and/or punctuation errors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocorrect)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "autofocus", - "value": "boolean", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autofocus)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "baseURI", - "value": "string", - "description": "The read-only **`baseURI`** property of the Node interface returns the absolute base URL of the document containing the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/baseURI)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "MethodSignature", - "name": "before", - "value": "(...nodes: (string | Node)[]) => void", - "description": "Inserts nodes just before node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/before)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "MethodSignature", - "name": "blur", - "value": "() => void", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/blur)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "CDATA_SECTION_NODE", - "value": "4", - "description": "node is a CDATASection node." - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "MethodSignature", - "name": "checkVisibility", - "value": "(options?: CheckVisibilityOptions) => boolean", - "description": "The **`checkVisibility()`** method of the Element interface checks whether the element is visible.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/checkVisibility)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "childElementCount", - "value": "number", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/childElementCount)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "childNodes", - "value": "NodeListOf", - "description": "The read-only **`childNodes`** property of the Node interface returns a live the first child node is assigned index `0`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/childNodes)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "HTMLCollection", - "description": "Returns the child elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/children)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "GetAccessor", - "name": "classList", - "value": "DOMTokenList", - "description": "The **`Element.classList`** is a read-only property that returns a live DOMTokenList collection of the `class` attributes of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/classList)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "className", - "value": "string", - "description": "The **`className`** property of the of the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/className)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "MethodSignature", - "name": "click", - "value": "() => void", - "description": "The **`HTMLElement.click()`** method simulates a mouse click on an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/click)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "clientHeight", - "value": "number", - "description": "The **`clientHeight`** read-only property of the Element interface is zero for elements with no CSS or inline layout boxes; otherwise, it's the inner height of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientHeight)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "clientLeft", - "value": "number", - "description": "The **`clientLeft`** read-only property of the Element interface returns the width of the left border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientLeft)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "clientTop", - "value": "number", - "description": "The **`clientTop`** read-only property of the Element interface returns the width of the top border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientTop)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "clientWidth", - "value": "number", - "description": "The **`clientWidth`** read-only property of the Element interface is zero for inline elements and elements with no CSS; otherwise, it's the inner width of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientWidth)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "MethodSignature", - "name": "cloneNode", - "value": "(subtree?: boolean) => Node", - "description": "The **`cloneNode()`** method of the Node interface returns a duplicate of the node on which this method was called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/cloneNode)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "MethodSignature", - "name": "closest", - "value": "{ (selector: K): HTMLElementTagNameMap[K]; (selector: K): SVGElementTagNameMap[K]; (selector: K): MathMLElementTagNameMap[K]; (selectors: string): E; }", - "description": "The **`closest()`** method of the Element interface traverses the element and its parents (heading toward the document root) until it finds a node that matches the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/closest)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "COMMENT_NODE", - "value": "8", - "description": "node is a Comment node." - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "MethodSignature", - "name": "compareDocumentPosition", - "value": "(other: Node) => number", - "description": "The **`compareDocumentPosition()`** method of the Node interface reports the position of its argument node relative to the node on which it is called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/compareDocumentPosition)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "MethodSignature", - "name": "computedStyleMap", - "value": "() => StylePropertyMapReadOnly", - "description": "The **`computedStyleMap()`** method of the Element interface returns a StylePropertyMapReadOnly interface which provides a read-only representation of a CSS declaration block that is an alternative to CSSStyleDeclaration.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/computedStyleMap)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "MethodSignature", - "name": "contains", - "value": "(other: Node) => boolean", - "description": "The **`contains()`** method of the Node interface returns a boolean value indicating whether a node is a descendant of a given node, that is the node itself, one of its direct children (Node.childNodes), one of the children's direct children, and so on.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/contains)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "contentEditable", - "value": "string", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/contentEditable)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "currentCSSZoom", - "value": "number", - "description": "The **`currentCSSZoom`** read-only property of the Element interface provides the 'effective' CSS `zoom` of an element, taking into account the zoom applied to the element and all its parent elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/currentCSSZoom)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "dataset", - "value": "DOMStringMap", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dataset)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "dir", - "value": "string", - "description": "The **`HTMLElement.dir`** property indicates the text writing directionality of the content of the current element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dir)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "MethodSignature", - "name": "dispatchEvent", - "value": "(event: Event) => boolean", - "description": "The **`dispatchEvent()`** method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/dispatchEvent)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "DOCUMENT_FRAGMENT_NODE", - "value": "11", - "description": "node is a DocumentFragment node." - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "DOCUMENT_NODE", - "value": "9", - "description": "node is a document." - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "DOCUMENT_POSITION_CONTAINED_BY", - "value": "16", - "description": "Set when other is a descendant of node." - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "DOCUMENT_POSITION_CONTAINS", - "value": "8", - "description": "Set when other is an ancestor of node." - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "DOCUMENT_POSITION_DISCONNECTED", - "value": "1", - "description": "Set when node and other are not in the same tree." - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "DOCUMENT_POSITION_FOLLOWING", - "value": "4", - "description": "Set when other is following node." - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC", - "value": "32", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "DOCUMENT_POSITION_PRECEDING", - "value": "2", - "description": "Set when other is preceding node." - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "DOCUMENT_TYPE_NODE", - "value": "10", - "description": "node is a doctype." - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "draggable", - "value": "boolean", - "description": "The **`draggable`** property of the HTMLElement interface gets and sets a Boolean primitive indicating if the element is draggable.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/draggable)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "ELEMENT_NODE", - "value": "1", - "description": "node is an element." - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "enterKeyHint", - "value": "string", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/enterKeyHint)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "ENTITY_NODE", - "value": "6", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "ENTITY_REFERENCE_NODE", - "value": "5", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "firstChild", - "value": "ChildNode | null", - "description": "The read-only **`firstChild`** property of the Node interface returns the node's first child in the tree, or `null` if the node has no children.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/firstChild)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "firstElementChild", - "value": "Element | null", - "description": "Returns the first child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/firstElementChild)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "MethodSignature", - "name": "focus", - "value": "(options?: FocusOptions) => void", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/focus)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "MethodSignature", - "name": "getAnimations", - "value": "(options?: GetAnimationsOptions) => Animation[]", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAnimations)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "MethodSignature", - "name": "getAttribute", - "value": "(qualifiedName: string) => string", - "description": "The **`getAttribute()`** method of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttribute)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "MethodSignature", - "name": "getAttributeNames", - "value": "() => string[]", - "description": "The **`getAttributeNames()`** method of the array.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNames)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "MethodSignature", - "name": "getAttributeNode", - "value": "(qualifiedName: string) => Attr", - "description": "Returns the specified attribute of the specified element, as an Attr node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNode)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "MethodSignature", - "name": "getAttributeNodeNS", - "value": "(namespace: string, localName: string) => Attr", - "description": "The **`getAttributeNodeNS()`** method of the Element interface returns the namespaced Attr node of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNodeNS)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "MethodSignature", - "name": "getAttributeNS", - "value": "(namespace: string, localName: string) => string", - "description": "The **`getAttributeNS()`** method of the Element interface returns the string value of the attribute with the specified namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNS)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "MethodSignature", - "name": "getBoundingClientRect", - "value": "() => DOMRect", - "description": "The **`Element.getBoundingClientRect()`** method returns a position relative to the viewport.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getBoundingClientRect)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "MethodSignature", - "name": "getClientRects", - "value": "() => DOMRectList", - "description": "The **`getClientRects()`** method of the Element interface returns a collection of DOMRect objects that indicate the bounding rectangles for each CSS border box in a client.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getClientRects)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "MethodSignature", - "name": "getElementsByClassName", - "value": "(classNames: string) => HTMLCollectionOf", - "description": "The Element method **`getElementsByClassName()`** returns a live specified class name or names.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByClassName)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "MethodSignature", - "name": "getElementsByTagName", - "value": "{ (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: string): HTMLCollectionOf; }", - "description": "The **`Element.getElementsByTagName()`** method returns a live All descendants of the specified element are searched, but not the element itself.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagName)", - "deprecationMessage": "Deprecated" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "MethodSignature", - "name": "getElementsByTagNameNS", - "value": "{ (namespaceURI: \"http://www.w3.org/1999/xhtml\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/2000/svg\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/1998/Math/MathML\", localName: string): HTMLCollectionOf; (namespace: string, localName: string): HTMLCollectionOf; }", - "description": "The **`Element.getElementsByTagNameNS()`** method returns a live HTMLCollection of elements with the given tag name belonging to the given namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagNameNS)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "MethodSignature", - "name": "getHTML", - "value": "(options?: GetHTMLOptions) => string", - "description": "The **`getHTML()`** method of the Element interface is used to serialize an element's DOM to an HTML string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getHTML)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "MethodSignature", - "name": "getRootNode", - "value": "(options?: GetRootNodeOptions) => Node", - "description": "The **`getRootNode()`** method of the Node interface returns the context object's root, which optionally includes the shadow root if it is available.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/getRootNode)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "MethodSignature", - "name": "hasAttribute", - "value": "(qualifiedName: string) => boolean", - "description": "The **`Element.hasAttribute()`** method returns a **Boolean** value indicating whether the specified element has the specified attribute or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttribute)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "MethodSignature", - "name": "hasAttributeNS", - "value": "(namespace: string, localName: string) => boolean", - "description": "The **`hasAttributeNS()`** method of the Element interface returns a boolean value indicating whether the current element has the specified attribute with the specified namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributeNS)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "MethodSignature", - "name": "hasAttributes", - "value": "() => boolean", - "description": "The **`hasAttributes()`** method of the Element interface returns a boolean value indicating whether the current element has any attributes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributes)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "MethodSignature", - "name": "hasChildNodes", - "value": "() => boolean", - "description": "The **`hasChildNodes()`** method of the Node interface returns a boolean value indicating whether the given Node has child nodes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/hasChildNodes)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "MethodSignature", - "name": "hasPointerCapture", - "value": "(pointerId: number) => boolean", - "description": "The **`hasPointerCapture()`** method of the pointer capture for the pointer identified by the given pointer ID.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasPointerCapture)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "hidden", - "value": "boolean", - "description": "The HTMLElement property **`hidden`** reflects the value of the element's `hidden` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidden)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "MethodSignature", - "name": "hidePopover", - "value": "() => void", - "description": "The **`hidePopover()`** method of the HTMLElement interface hides a popover element (i.e., one that has a valid `popover` attribute) by removing it from the top layer and styling it with `display: none`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidePopover)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the element.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "inert", - "value": "boolean", - "description": "The HTMLElement property **`inert`** reflects the value of the element's `inert` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inert)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "innerHTML", - "value": "string", - "description": "The **`innerHTML`** property of the Element interface gets or sets the HTML or XML markup contained within the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/innerHTML)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "innerText", - "value": "string", - "description": "The **`innerText`** property of the HTMLElement interface represents the rendered text content of a node and its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/innerText)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "inputMode", - "value": "string", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inputMode)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "MethodSignature", - "name": "insertAdjacentElement", - "value": "(where: InsertPosition, element: Element) => Element", - "description": "The **`insertAdjacentElement()`** method of the relative to the element it is invoked upon.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentElement)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "MethodSignature", - "name": "insertAdjacentHTML", - "value": "(position: InsertPosition, string: string) => void", - "description": "The **`insertAdjacentHTML()`** method of the the resulting nodes into the DOM tree at a specified position.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentHTML)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "MethodSignature", - "name": "insertAdjacentText", - "value": "(where: InsertPosition, data: string) => void", - "description": "The **`insertAdjacentText()`** method of the Element interface, given a relative position and a string, inserts a new text node at the given position relative to the element it is called from.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentText)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "MethodSignature", - "name": "insertBefore", - "value": "(node: T, child: Node) => T", - "description": "The **`insertBefore()`** method of the Node interface inserts a node before a _reference node_ as a child of a specified _parent node_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/insertBefore)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "isConnected", - "value": "boolean", - "description": "The read-only **`isConnected`** property of the Node interface returns a boolean indicating whether the node is connected (directly or indirectly) to a Document object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isConnected)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "isContentEditable", - "value": "boolean", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/isContentEditable)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "MethodSignature", - "name": "isDefaultNamespace", - "value": "(namespace: string) => boolean", - "description": "The **`isDefaultNamespace()`** method of the Node interface accepts a namespace URI as an argument.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isDefaultNamespace)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "MethodSignature", - "name": "isEqualNode", - "value": "(otherNode: Node) => boolean", - "description": "The **`isEqualNode()`** method of the Node interface tests whether two nodes are equal.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isEqualNode)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "MethodSignature", - "name": "isSameNode", - "value": "(otherNode: Node) => boolean", - "description": "The **`isSameNode()`** method of the Node interface is a legacy alias the for the `===` strict equality operator.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isSameNode)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "lang", - "value": "string", - "description": "The **`lang`** property of the HTMLElement interface indicates the base language of an element's attribute values and text content, in the form of a MISSING: RFC(5646, 'BCP 47 language identifier tag')].\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/lang)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "lastChild", - "value": "ChildNode | null", - "description": "The read-only **`lastChild`** property of the Node interface returns the last child of the node, or `null` if there are no child nodes.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lastChild)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "lastElementChild", - "value": "Element | null", - "description": "Returns the last child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/lastElementChild)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "localName", - "value": "string", - "description": "The **`Element.localName`** read-only property returns the local part of the qualified name of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/localName)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "MethodSignature", - "name": "lookupNamespaceURI", - "value": "(prefix: string) => string", - "description": "The **`lookupNamespaceURI()`** method of the Node interface takes a prefix as parameter and returns the namespace URI associated with it on the given node if found (and `null` if not).\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupNamespaceURI)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "MethodSignature", - "name": "lookupPrefix", - "value": "(namespace: string) => string", - "description": "The **`lookupPrefix()`** method of the Node interface returns a string containing the prefix for a given namespace URI, if present, and `null` if not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupPrefix)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "MethodSignature", - "name": "matches", - "value": "(selectors: string) => boolean", - "description": "The **`matches()`** method of the Element interface tests whether the element would be selected by the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "namespaceURI", - "value": "string | null", - "description": "The **`Element.namespaceURI`** read-only property returns the namespace URI of the element, or `null` if the element is not in a namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/namespaceURI)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "nextElementSibling", - "value": "Element | null", - "description": "Returns the first following sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/nextElementSibling)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "nextSibling", - "value": "ChildNode | null", - "description": "The read-only **`nextSibling`** property of the Node interface returns the node immediately following the specified one in their parent's Node.childNodes, or returns `null` if the specified node is the last child in the parent element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nextSibling)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "nodeName", - "value": "string", - "description": "The read-only **`nodeName`** property of Node returns the name of the current node as a string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeName)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "nodeType", - "value": "number", - "description": "The read-only **`nodeType`** property of a Node interface is an integer that identifies what the node is.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeType)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "nodeValue", - "value": "string | null", - "description": "The **`nodeValue`** property of the Node interface returns or sets the value of the current node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeValue)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "nonce", - "value": "string", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/nonce)", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "MethodSignature", - "name": "normalize", - "value": "() => void", - "description": "The **`normalize()`** method of the Node interface puts the specified node and all of its sub-tree into a _normalized_ form.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/normalize)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "NOTATION_NODE", - "value": "12", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "offsetHeight", - "value": "number", - "description": "The **`offsetHeight`** read-only property of the HTMLElement interface returns the height of an element, including vertical padding and borders, as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetHeight)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "offsetLeft", - "value": "number", - "description": "The **`offsetLeft`** read-only property of the HTMLElement interface returns the number of pixels that the _upper left corner_ of the current element is offset to the left within the HTMLElement.offsetParent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetLeft)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "offsetParent", - "value": "Element | null", - "description": "The **`HTMLElement.offsetParent`** read-only property returns a reference to the element which is the closest (nearest in the containment hierarchy) positioned ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetParent)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "offsetTop", - "value": "number", - "description": "The **`offsetTop`** read-only property of the HTMLElement interface returns the distance from the outer border of the current element (including its margin) to the top padding edge of the HTMLelement.offsetParent, the _closest positioned_ ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetTop)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "offsetWidth", - "value": "number", - "description": "The **`offsetWidth`** read-only property of the HTMLElement interface returns the layout width of an element as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetWidth)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "onabort", - "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/abort_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "onanimationcancel", - "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationcancel_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "onanimationend", - "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "onanimationiteration", - "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "onanimationstart", - "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "onauxclick", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/auxclick_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "onbeforeinput", - "value": "((this: GlobalEventHandlers, ev: InputEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforeinput_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "onbeforematch", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforematch_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "onbeforetoggle", - "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/beforetoggle_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "onblur", - "value": "((this: GlobalEventHandlers, ev: FocusEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/blur_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "oncancel", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/cancel_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "oncanplay", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplay_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "oncanplaythrough", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplaythrough_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "onchange", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/change_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "onclick", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/click_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "onclose", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/close_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "oncontextlost", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextlost_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "oncontextmenu", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/contextmenu_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "oncontextrestored", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextrestored_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "oncopy", - "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/copy_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "oncuechange", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLTrackElement/cuechange_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "oncut", - "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/cut_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "ondblclick", - "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/dblclick_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "ondrag", - "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drag_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "ondragend", - "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragend_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "ondragenter", - "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragenter_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "ondragleave", - "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragleave_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "ondragover", - "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragover_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "ondragstart", - "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragstart_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "ondrop", - "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drop_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "ondurationchange", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/durationchange_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "onemptied", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/emptied_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "onended", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ended_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "onerror", - "value": "OnErrorEventHandler", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/error_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "onfocus", - "value": "((this: GlobalEventHandlers, ev: FocusEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/focus_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "onformdata", - "value": "((this: GlobalEventHandlers, ev: FormDataEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/formdata_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "onfullscreenchange", - "value": "((this: Element, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenchange_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "onfullscreenerror", - "value": "((this: Element, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenerror_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "ongotpointercapture", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/gotpointercapture_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "oninput", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/input_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "oninvalid", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/invalid_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "onkeydown", - "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keydown_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "onkeypress", - "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", - "description": "", - "deprecationMessage": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keypress_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "onkeyup", - "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keyup_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "onload", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/load_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "onloadeddata", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadeddata_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "onloadedmetadata", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadedmetadata_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "onloadstart", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadstart_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "onlostpointercapture", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/lostpointercapture_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "onmousedown", - "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousedown_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "onmouseenter", - "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseenter_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "onmouseleave", - "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseleave_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "onmousemove", - "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousemove_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "onmouseout", - "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseout_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "onmouseover", - "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseover_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "onmouseup", - "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseup_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "onpaste", - "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/paste_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "onpause", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/pause_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "onplay", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/play_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "onplaying", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/playing_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "onpointercancel", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointercancel_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "onpointerdown", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerdown_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "onpointerenter", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerenter_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "onpointerleave", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerleave_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "onpointermove", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointermove_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "onpointerout", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerout_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "onpointerover", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerover_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "onpointerrawupdate", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "Available only in secure contexts.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerrawupdate_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "onpointerup", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerup_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "onprogress", - "value": "((this: GlobalEventHandlers, ev: ProgressEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/progress_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "onratechange", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ratechange_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "onreset", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/reset_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "onresize", - "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLVideoElement/resize_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "onscroll", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scroll_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "onscrollend", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scrollend_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "onsecuritypolicyviolation", - "value": "((this: GlobalEventHandlers, ev: SecurityPolicyViolationEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/securitypolicyviolation_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "onseeked", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeked_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "onseeking", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeking_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "onselect", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/select_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "onselectionchange", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/selectionchange_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "onselectstart", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/selectstart_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "onslotchange", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLSlotElement/slotchange_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "onstalled", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/stalled_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "onsubmit", - "value": "((this: GlobalEventHandlers, ev: SubmitEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/submit_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "onsuspend", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/suspend_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "ontimeupdate", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/timeupdate_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "ontoggle", - "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/toggle_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "ontouchcancel", - "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchcancel_event)", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "ontouchend", - "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchend_event)", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "ontouchmove", - "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchmove_event)", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "ontouchstart", - "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchstart_event)", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "ontransitioncancel", - "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitioncancel_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "ontransitionend", - "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "ontransitionrun", - "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionrun_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "ontransitionstart", - "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionstart_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "onvolumechange", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/volumechange_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "onwaiting", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/waiting_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "onwebkitanimationend", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "", - "deprecationMessage": "This is a legacy alias of `onanimationend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "onwebkitanimationiteration", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "", - "deprecationMessage": "This is a legacy alias of `onanimationiteration`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "onwebkitanimationstart", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "", - "deprecationMessage": "This is a legacy alias of `onanimationstart`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "onwebkittransitionend", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "", - "deprecationMessage": "This is a legacy alias of `ontransitionend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "onwheel", - "value": "((this: GlobalEventHandlers, ev: WheelEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/wheel_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "outerHTML", - "value": "string", - "description": "The **`outerHTML`** attribute of the Element DOM interface gets the serialized HTML fragment describing the element including its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/outerHTML)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "outerText", - "value": "string", - "description": "The **`outerText`** property of the HTMLElement interface returns the same value as HTMLElement.innerText.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/outerText)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "ownerDocument", - "value": "Document", - "description": "The read-only **`ownerDocument`** property of the Node interface returns the top-level document object of the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/ownerDocument)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "parentElement", - "value": "HTMLElement | null", - "description": "The read-only **`parentElement`** property of Node interface returns the DOM node's parent Element, or `null` if the node either has no parent, or its parent isn't a DOM Element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentElement)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "parentNode", - "value": "ParentNode | null", - "description": "The read-only **`parentNode`** property of the Node interface returns the parent of the specified node in the DOM tree.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentNode)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "GetAccessor", - "name": "part", - "value": "DOMTokenList", - "description": "The **`part`** property of the Element interface represents the part identifier(s) of the element (i.e., set using the `part` attribute), returned as a DOMTokenList.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/part)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "popover", - "value": "string | null", - "description": "The **`popover`** property of the HTMLElement interface gets and sets an element's popover state via JavaScript (`'auto'`, `'hint'`, or `'manual'`), and can be used for feature detection.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/popover)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "prefix", - "value": "string | null", - "description": "The **`Element.prefix`** read-only property returns the namespace prefix of the specified element, or `null` if no prefix is specified.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/prefix)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "MethodSignature", - "name": "prepend", - "value": "(...nodes: (string | Node)[]) => void", - "description": "Inserts nodes before the first child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/prepend)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "previousElementSibling", - "value": "Element | null", - "description": "Returns the first preceding sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/previousElementSibling)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "previousSibling", - "value": "ChildNode | null", - "description": "The read-only **`previousSibling`** property of the Node interface returns the node immediately preceding the specified one in its parent's or `null` if the specified node is the first in that list.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/previousSibling)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "PROCESSING_INSTRUCTION_NODE", - "value": "7", - "description": "node is a ProcessingInstruction node." - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "MethodSignature", - "name": "querySelector", - "value": "{ (selectors: K): HTMLElementTagNameMap[K]; (selectors: K): SVGElementTagNameMap[K]; (selectors: K): MathMLElementTagNameMap[K]; (selectors: K): HTMLElementDeprecatedTagNameMap[K]; (selectors: string): E; }", - "description": "Returns the first element that is a descendant of node that matches selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelector)", - "deprecationMessage": "Deprecated" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "MethodSignature", - "name": "querySelectorAll", - "value": "{ (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: string): NodeListOf; }", - "description": "Returns all element descendants of node that match selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelectorAll)", - "deprecationMessage": "Deprecated" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "MethodSignature", - "name": "releasePointerCapture", - "value": "(pointerId: number) => void", - "description": "The **`releasePointerCapture()`** method of the previously set for a specific (PointerEvent) _pointer_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/releasePointerCapture)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "MethodSignature", - "name": "remove", - "value": "() => void", - "description": "Removes node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/remove)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "MethodSignature", - "name": "removeAttribute", - "value": "(qualifiedName: string) => void", - "description": "The Element method **`removeAttribute()`** removes the attribute with the specified name from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttribute)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "MethodSignature", - "name": "removeAttributeNode", - "value": "(attr: Attr) => Attr", - "description": "The **`removeAttributeNode()`** method of the Element interface removes the specified Attr node from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNode)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "MethodSignature", - "name": "removeAttributeNS", - "value": "(namespace: string, localName: string) => void", - "description": "The **`removeAttributeNS()`** method of the If you are working with HTML and you don't need to specify the requested attribute as being part of a specific namespace, use the Element.removeAttribute() method instead.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNS)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "MethodSignature", - "name": "removeChild", - "value": "(child: T) => T", - "description": "The **`removeChild()`** method of the Node interface removes a child node from the DOM and returns the removed node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/removeChild)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "MethodSignature", - "name": "removeEventListener", - "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "MethodSignature", - "name": "replaceChild", - "value": "(node: Node, child: T) => T", - "description": "The **`replaceChild()`** method of the Node interface replaces a child node within the given (parent) node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/replaceChild)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "MethodSignature", - "name": "replaceChildren", - "value": "(...nodes: (string | Node)[]) => void", - "description": "Replace all children of node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/replaceChildren)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "MethodSignature", - "name": "replaceWith", - "value": "(...nodes: (string | Node)[]) => void", - "description": "Replaces node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/replaceWith)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "MethodSignature", - "name": "requestFullscreen", - "value": "(options?: FullscreenOptions) => Promise", - "description": "The **`Element.requestFullscreen()`** method issues an asynchronous request to make the element be displayed in fullscreen mode.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestFullscreen)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "MethodSignature", - "name": "requestPointerLock", - "value": "(options?: PointerLockOptions) => Promise", - "description": "The **`requestPointerLock()`** method of the Element interface lets you asynchronously ask for the pointer to be locked on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestPointerLock)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "role", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/role)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "MethodSignature", - "name": "scroll", - "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", - "description": "The **`scroll()`** method of the Element interface scrolls the element to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scroll)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "MethodSignature", - "name": "scrollBy", - "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", - "description": "The **`scrollBy()`** method of the Element interface scrolls an element by the given amount.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollBy)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "scrollHeight", - "value": "number", - "description": "The **`scrollHeight`** read-only property of the Element interface is a measurement of the height of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollHeight)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "MethodSignature", - "name": "scrollIntoView", - "value": "(arg?: boolean | ScrollIntoViewOptions) => void", - "description": "The Element interface's **`scrollIntoView()`** method scrolls the element's ancestor containers such that the element on which `scrollIntoView()` is called is visible to the user.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollIntoView)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "scrollLeft", - "value": "number", - "description": "The **`scrollLeft`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its left edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollLeft)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "MethodSignature", - "name": "scrollTo", - "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", - "description": "The **`scrollTo()`** method of the Element interface scrolls to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTo)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "scrollTop", - "value": "number", - "description": "The **`scrollTop`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its top edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTop)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "scrollWidth", - "value": "number", - "description": "The **`scrollWidth`** read-only property of the Element interface is a measurement of the width of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollWidth)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "MethodSignature", - "name": "setAttribute", - "value": "(qualifiedName: string, value: string) => void", - "description": "The **`setAttribute()`** method of the Element interface sets the value of an attribute on the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttribute)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "MethodSignature", - "name": "setAttributeNode", - "value": "(attr: Attr) => Attr", - "description": "The **`setAttributeNode()`** method of the Element interface adds a new Attr node to the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNode)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "MethodSignature", - "name": "setAttributeNodeNS", - "value": "(attr: Attr) => Attr", - "description": "The **`setAttributeNodeNS()`** method of the Element interface adds a new namespaced Attr node to an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNodeNS)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "MethodSignature", - "name": "setAttributeNS", - "value": "(namespace: string, qualifiedName: string, value: string) => void", - "description": "`setAttributeNS` adds a new attribute or changes the value of an attribute with the given namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNS)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "MethodSignature", - "name": "setHTMLUnsafe", - "value": "(html: string) => void", - "description": "The **`setHTMLUnsafe()`** method of the Element interface is used to parse a string of HTML into a DocumentFragment, optionally filtering out unwanted elements and attributes, and those that don't belong in the context, and then using it to replace the element's subtree in the DOM.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setHTMLUnsafe)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "MethodSignature", - "name": "setPointerCapture", - "value": "(pointerId: number) => void", - "description": "The **`setPointerCapture()`** method of the _capture target_ of future pointer events.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setPointerCapture)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "shadowRoot", - "value": "ShadowRoot | null", - "description": "The `Element.shadowRoot` read-only property represents the shadow root hosted by the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/shadowRoot)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "MethodSignature", - "name": "showPopover", - "value": "() => void", - "description": "The **`showPopover()`** method of the HTMLElement interface shows a Popover_API element (i.e., one that has a valid `popover` attribute) by adding it to the top layer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/showPopover)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "size", - "value": "'base' | 'small' | 'small-100' | 'large' | 'large-100'", - "description": "Adjusts the size of the spinner icon.", - "isOptional": true, - "defaultValue": "'base'" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "slot", - "value": "string", - "description": "The **`slot`** property of the Element interface returns the name of the shadow DOM slot the element is inserted in.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/slot)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "spellcheck", - "value": "boolean", - "description": "The **`spellcheck`** property of the HTMLElement interface represents a boolean value that controls the spell-checking hint.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/spellcheck)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "GetAccessor", - "name": "style", - "value": "CSSStyleDeclaration", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/style)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "tabIndex", - "value": "number", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/tabIndex)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "tagName", - "value": "string", - "description": "The **`tagName`** read-only property of the Element interface returns the tag name of the element on which it's called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/tagName)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "TEXT_NODE", - "value": "3", - "description": "node is a Text node." - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "GetAccessor", - "name": "textContent", - "value": "string", - "description": "[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/Node/textContent)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The **`HTMLElement.title`** property represents the title of the element: the text usually displayed in a 'tooltip' popup when the mouse is over the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/title)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "MethodSignature", - "name": "toggleAttribute", - "value": "(qualifiedName: string, force?: boolean) => boolean", - "description": "The **`toggleAttribute()`** method of the present and adding it if it is not present) on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/toggleAttribute)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "MethodSignature", - "name": "togglePopover", - "value": "(options?: boolean) => boolean", - "description": "The **`togglePopover()`** method of the HTMLElement interface toggles a Popover_API element (i.e., one that has a valid `popover` attribute) between the hidden and showing states.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/togglePopover)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "translate", - "value": "boolean", - "description": "The **`translate`** property of the HTMLElement interface indicates whether an element's attribute values and the values of its Text node children are to be translated when the page is localized, or whether to leave them unchanged.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/translate)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "MethodSignature", - "name": "webkitMatchesSelector", - "value": "(selectors: string) => boolean", - "description": "", - "deprecationMessage": "This is a legacy alias of `matches`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "writingSuggestions", - "value": "string", - "description": "The **`writingSuggestions`** property of the HTMLElement interface is a string indicating if browser-provided writing suggestions should be enabled under the scope of the element or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/writingSuggestions)" - } - ], - "value": "export interface SpinnerElement extends SpinnerElementProps, Omit {\n}" - } - }, - "SpinnerProps": { - "src/surfaces/checkout/components/Spinner.ts": { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "name": "SpinnerProps", - "description": "", - "isPublicDocs": true, - "members": [ - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "A label that describes the purpose of the progress. When set, it will be announced to users using assistive technologies and will provide them with more context. Providing an `accessibilityLabel` is recommended if there is no accompanying text describing that something is loading.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the element.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Spinner.ts", - "syntaxKind": "PropertySignature", - "name": "size", - "value": "'base' | 'small' | 'small-100' | 'large' | 'large-100'", - "description": "Adjusts the size of the spinner icon.", - "isOptional": true, - "defaultValue": "'base'" - } - ], - "value": "export interface SpinnerProps extends SpinnerElementProps {\n}" - } - }, - "TooltipElementProps": { - "src/surfaces/checkout/components/Tooltip.ts": { - "filePath": "src/surfaces/checkout/components/Tooltip.ts", - "name": "TooltipElementProps", - "description": "Properties for the Tooltip component element.", - "isPublicDocs": true, - "members": [ - { - "filePath": "src/surfaces/checkout/components/Tooltip.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the element.", - "isOptional": true - } - ], - "value": "export interface TooltipElementProps extends Pick {\n}" - } - }, - "TooltipElement": { - "src/surfaces/checkout/components/Tooltip.ts": { - "filePath": "src/surfaces/checkout/components/Tooltip.ts", - "name": "TooltipElement", - "description": "The HTML element interface for the `s-tooltip` custom element.", - "isPublicDocs": true, - "members": [ - { - "filePath": "src/surfaces/checkout/components/Tooltip.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the element.", - "isOptional": true - } - ], - "value": "export interface TooltipElement extends TooltipElementProps {\n}" - } - }, - "TooltipProps": { - "src/surfaces/checkout/components/Tooltip.ts": { - "filePath": "src/surfaces/checkout/components/Tooltip.ts", - "name": "TooltipProps", - "description": "The properties for the tooltip component when it's used in JSX.", - "isPublicDocs": true, - "members": [ - { - "filePath": "src/surfaces/checkout/components/Tooltip.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the element.", - "isOptional": true - } - ], - "value": "export interface TooltipProps extends TooltipElementProps {\n}" - } - }, - "ChipElementProps": { - "src/surfaces/checkout/components/Chip.ts": { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "name": "ChipElementProps", - "description": "Properties for the Chip component element.", - "isPublicDocs": true, - "members": [ - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "A label that describes the purpose or contents of the chip. It will be read to users using assistive technologies such as screen readers.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the element.", - "isOptional": true - } - ], - "value": "export interface ChipElementProps extends Pick {\n}" - } - }, - "ChipElementSlots": { - "src/surfaces/checkout/components/Chip.ts": { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "name": "ChipElementSlots", - "description": "Slots for the Chip component element.", - "isPublicDocs": true, - "members": [ - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "graphic", - "value": "HTMLElement", - "description": "The graphic to display inside of the chip.\n\nOnly `s-icon` element and its `type` attribute are supported.", - "isOptional": true - } - ], - "value": "export interface ChipElementSlots {\n /**\n * The graphic to display inside of the chip.\n *\n * Only `s-icon` element and its `type` attribute are supported.\n */\n graphic?: HTMLElement;\n}" - } - }, - "ChipProps": { - "src/surfaces/checkout/components/Chip.ts": { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "name": "ChipProps", - "description": "", - "isPublicDocs": true, - "members": [ - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "A label that describes the purpose or contents of the chip. It will be read to users using assistive technologies such as screen readers.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the element.", - "isOptional": true - } - ], - "value": "export interface ChipProps extends ChipElementProps {\n}" - } - }, - "ChipElement": { - "src/surfaces/checkout/components/Chip.ts": { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "name": "ChipElement", - "description": "", - "isPublicDocs": true, - "members": [ - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "accessibilityLabel", - "value": "string", - "description": "A label that describes the purpose or contents of the chip. It will be read to users using assistive technologies such as screen readers.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "accessKey", - "value": "string", - "description": "The **`HTMLElement.accessKey`** property sets the keystroke which a user can press to jump to a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKey)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "accessKeyLabel", - "value": "string", - "description": "The **`HTMLElement.accessKeyLabel`** read-only property returns a string containing the element's browser-assigned access key (if any); otherwise it returns an empty string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKeyLabel)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "MethodSignature", - "name": "addEventListener", - "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "MethodSignature", - "name": "after", - "value": "(...nodes: (string | Node)[]) => void", - "description": "Inserts nodes just after node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/after)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "MethodSignature", - "name": "animate", - "value": "(keyframes: Keyframe[] | PropertyIndexedKeyframes, options?: number | KeyframeAnimationOptions) => Animation", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animate)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "MethodSignature", - "name": "append", - "value": "(...nodes: (string | Node)[]) => void", - "description": "Inserts nodes after the last child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/append)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "MethodSignature", - "name": "appendChild", - "value": "(node: T) => T", - "description": "The **`appendChild()`** method of the Node interface adds a node to the end of the list of children of a specified parent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/appendChild)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "ariaActiveDescendantElement", - "value": "Element | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaActiveDescendantElement)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "ariaAtomic", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAtomic)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "ariaAutoComplete", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAutoComplete)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "ariaBrailleLabel", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleLabel)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "ariaBrailleRoleDescription", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleRoleDescription)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "ariaBusy", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBusy)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "ariaChecked", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaChecked)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "ariaColCount", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColCount)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "ariaColIndex", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndex)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "ariaColIndexText", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndexText)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "ariaColSpan", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColSpan)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "ariaControlsElements", - "value": "ReadonlyArray | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaControlsElements)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "ariaCurrent", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaCurrent)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "ariaDescribedByElements", - "value": "ReadonlyArray | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescribedByElements)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "ariaDescription", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescription)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "ariaDetailsElements", - "value": "ReadonlyArray | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDetailsElements)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "ariaDisabled", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDisabled)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "ariaErrorMessageElements", - "value": "ReadonlyArray | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaErrorMessageElements)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "ariaExpanded", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaExpanded)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "ariaFlowToElements", - "value": "ReadonlyArray | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaFlowToElements)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "ariaHasPopup", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHasPopup)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "ariaHidden", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHidden)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "ariaInvalid", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaInvalid)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "ariaKeyShortcuts", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaKeyShortcuts)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "ariaLabel", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabel)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "ariaLabelledByElements", - "value": "ReadonlyArray | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabelledByElements)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "ariaLevel", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLevel)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "ariaLive", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLive)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "ariaModal", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaModal)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "ariaMultiLine", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiLine)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "ariaMultiSelectable", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiSelectable)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "ariaOrientation", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOrientation)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "ariaOwnsElements", - "value": "ReadonlyArray | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOwnsElements)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "ariaPlaceholder", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPlaceholder)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "ariaPosInSet", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPosInSet)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "ariaPressed", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPressed)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "ariaReadOnly", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaReadOnly)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "ariaRelevant", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRelevant)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "ariaRequired", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRequired)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "ariaRoleDescription", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRoleDescription)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "ariaRowCount", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowCount)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "ariaRowIndex", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndex)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "ariaRowIndexText", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndexText)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "ariaRowSpan", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowSpan)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "ariaSelected", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSelected)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "ariaSetSize", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSetSize)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "ariaSort", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSort)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "ariaValueMax", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMax)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "ariaValueMin", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMin)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "ariaValueNow", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueNow)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "ariaValueText", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueText)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "assignedSlot", - "value": "HTMLSlotElement | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/assignedSlot)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "MethodSignature", - "name": "attachInternals", - "value": "() => ElementInternals", - "description": "The **`HTMLElement.attachInternals()`** method returns an ElementInternals object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attachInternals)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "MethodSignature", - "name": "attachShadow", - "value": "(init: ShadowRootInit) => ShadowRoot", - "description": "The **`Element.attachShadow()`** method attaches a shadow DOM tree to the specified element and returns a reference to its ShadowRoot.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attachShadow)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "ATTRIBUTE_NODE", - "value": "2", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "NamedNodeMap", - "description": "The **`Element.attributes`** property returns a live collection of all attribute nodes registered to the specified node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attributes)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "attributeStyleMap", - "value": "StylePropertyMap", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attributeStyleMap)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "autocapitalize", - "value": "string", - "description": "The **`autocapitalize`** property of the HTMLElement interface represents the element's capitalization behavior for user input.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocapitalize)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "autocorrect", - "value": "boolean", - "description": "The **`autocorrect`** property of the HTMLElement interface controls whether or not autocorrection of editable text is enabled for spelling and/or punctuation errors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocorrect)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "autofocus", - "value": "boolean", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autofocus)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "baseURI", - "value": "string", - "description": "The read-only **`baseURI`** property of the Node interface returns the absolute base URL of the document containing the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/baseURI)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "MethodSignature", - "name": "before", - "value": "(...nodes: (string | Node)[]) => void", - "description": "Inserts nodes just before node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/before)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "MethodSignature", - "name": "blur", - "value": "() => void", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/blur)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "CDATA_SECTION_NODE", - "value": "4", - "description": "node is a CDATASection node." - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "MethodSignature", - "name": "checkVisibility", - "value": "(options?: CheckVisibilityOptions) => boolean", - "description": "The **`checkVisibility()`** method of the Element interface checks whether the element is visible.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/checkVisibility)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "childElementCount", - "value": "number", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/childElementCount)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "childNodes", - "value": "NodeListOf", - "description": "The read-only **`childNodes`** property of the Node interface returns a live the first child node is assigned index `0`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/childNodes)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "HTMLCollection", - "description": "Returns the child elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/children)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "GetAccessor", - "name": "classList", - "value": "DOMTokenList", - "description": "The **`Element.classList`** is a read-only property that returns a live DOMTokenList collection of the `class` attributes of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/classList)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "className", - "value": "string", - "description": "The **`className`** property of the of the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/className)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "MethodSignature", - "name": "click", - "value": "() => void", - "description": "The **`HTMLElement.click()`** method simulates a mouse click on an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/click)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "clientHeight", - "value": "number", - "description": "The **`clientHeight`** read-only property of the Element interface is zero for elements with no CSS or inline layout boxes; otherwise, it's the inner height of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientHeight)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "clientLeft", - "value": "number", - "description": "The **`clientLeft`** read-only property of the Element interface returns the width of the left border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientLeft)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "clientTop", - "value": "number", - "description": "The **`clientTop`** read-only property of the Element interface returns the width of the top border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientTop)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "clientWidth", - "value": "number", - "description": "The **`clientWidth`** read-only property of the Element interface is zero for inline elements and elements with no CSS; otherwise, it's the inner width of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientWidth)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "MethodSignature", - "name": "cloneNode", - "value": "(subtree?: boolean) => Node", - "description": "The **`cloneNode()`** method of the Node interface returns a duplicate of the node on which this method was called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/cloneNode)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "MethodSignature", - "name": "closest", - "value": "{ (selector: K): HTMLElementTagNameMap[K]; (selector: K): SVGElementTagNameMap[K]; (selector: K): MathMLElementTagNameMap[K]; (selectors: string): E; }", - "description": "The **`closest()`** method of the Element interface traverses the element and its parents (heading toward the document root) until it finds a node that matches the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/closest)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "COMMENT_NODE", - "value": "8", - "description": "node is a Comment node." - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "MethodSignature", - "name": "compareDocumentPosition", - "value": "(other: Node) => number", - "description": "The **`compareDocumentPosition()`** method of the Node interface reports the position of its argument node relative to the node on which it is called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/compareDocumentPosition)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "MethodSignature", - "name": "computedStyleMap", - "value": "() => StylePropertyMapReadOnly", - "description": "The **`computedStyleMap()`** method of the Element interface returns a StylePropertyMapReadOnly interface which provides a read-only representation of a CSS declaration block that is an alternative to CSSStyleDeclaration.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/computedStyleMap)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "MethodSignature", - "name": "contains", - "value": "(other: Node) => boolean", - "description": "The **`contains()`** method of the Node interface returns a boolean value indicating whether a node is a descendant of a given node, that is the node itself, one of its direct children (Node.childNodes), one of the children's direct children, and so on.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/contains)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "contentEditable", - "value": "string", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/contentEditable)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "currentCSSZoom", - "value": "number", - "description": "The **`currentCSSZoom`** read-only property of the Element interface provides the 'effective' CSS `zoom` of an element, taking into account the zoom applied to the element and all its parent elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/currentCSSZoom)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "dataset", - "value": "DOMStringMap", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dataset)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "dir", - "value": "string", - "description": "The **`HTMLElement.dir`** property indicates the text writing directionality of the content of the current element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dir)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "MethodSignature", - "name": "dispatchEvent", - "value": "(event: Event) => boolean", - "description": "The **`dispatchEvent()`** method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/dispatchEvent)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "DOCUMENT_FRAGMENT_NODE", - "value": "11", - "description": "node is a DocumentFragment node." - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "DOCUMENT_NODE", - "value": "9", - "description": "node is a document." - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "DOCUMENT_POSITION_CONTAINED_BY", - "value": "16", - "description": "Set when other is a descendant of node." - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "DOCUMENT_POSITION_CONTAINS", - "value": "8", - "description": "Set when other is an ancestor of node." - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "DOCUMENT_POSITION_DISCONNECTED", - "value": "1", - "description": "Set when node and other are not in the same tree." - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "DOCUMENT_POSITION_FOLLOWING", - "value": "4", - "description": "Set when other is following node." - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC", - "value": "32", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "DOCUMENT_POSITION_PRECEDING", - "value": "2", - "description": "Set when other is preceding node." - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "DOCUMENT_TYPE_NODE", - "value": "10", - "description": "node is a doctype." - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "draggable", - "value": "boolean", - "description": "The **`draggable`** property of the HTMLElement interface gets and sets a Boolean primitive indicating if the element is draggable.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/draggable)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "ELEMENT_NODE", - "value": "1", - "description": "node is an element." - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "enterKeyHint", - "value": "string", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/enterKeyHint)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "ENTITY_NODE", - "value": "6", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "ENTITY_REFERENCE_NODE", - "value": "5", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "firstChild", - "value": "ChildNode | null", - "description": "The read-only **`firstChild`** property of the Node interface returns the node's first child in the tree, or `null` if the node has no children.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/firstChild)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "firstElementChild", - "value": "Element | null", - "description": "Returns the first child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/firstElementChild)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "MethodSignature", - "name": "focus", - "value": "(options?: FocusOptions) => void", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/focus)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "MethodSignature", - "name": "getAnimations", - "value": "(options?: GetAnimationsOptions) => Animation[]", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAnimations)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "MethodSignature", - "name": "getAttribute", - "value": "(qualifiedName: string) => string", - "description": "The **`getAttribute()`** method of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttribute)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "MethodSignature", - "name": "getAttributeNames", - "value": "() => string[]", - "description": "The **`getAttributeNames()`** method of the array.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNames)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "MethodSignature", - "name": "getAttributeNode", - "value": "(qualifiedName: string) => Attr", - "description": "Returns the specified attribute of the specified element, as an Attr node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNode)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "MethodSignature", - "name": "getAttributeNodeNS", - "value": "(namespace: string, localName: string) => Attr", - "description": "The **`getAttributeNodeNS()`** method of the Element interface returns the namespaced Attr node of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNodeNS)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "MethodSignature", - "name": "getAttributeNS", - "value": "(namespace: string, localName: string) => string", - "description": "The **`getAttributeNS()`** method of the Element interface returns the string value of the attribute with the specified namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNS)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "MethodSignature", - "name": "getBoundingClientRect", - "value": "() => DOMRect", - "description": "The **`Element.getBoundingClientRect()`** method returns a position relative to the viewport.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getBoundingClientRect)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "MethodSignature", - "name": "getClientRects", - "value": "() => DOMRectList", - "description": "The **`getClientRects()`** method of the Element interface returns a collection of DOMRect objects that indicate the bounding rectangles for each CSS border box in a client.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getClientRects)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "MethodSignature", - "name": "getElementsByClassName", - "value": "(classNames: string) => HTMLCollectionOf", - "description": "The Element method **`getElementsByClassName()`** returns a live specified class name or names.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByClassName)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "MethodSignature", - "name": "getElementsByTagName", - "value": "{ (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: string): HTMLCollectionOf; }", - "description": "The **`Element.getElementsByTagName()`** method returns a live All descendants of the specified element are searched, but not the element itself.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagName)", - "deprecationMessage": "Deprecated" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "MethodSignature", - "name": "getElementsByTagNameNS", - "value": "{ (namespaceURI: \"http://www.w3.org/1999/xhtml\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/2000/svg\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/1998/Math/MathML\", localName: string): HTMLCollectionOf; (namespace: string, localName: string): HTMLCollectionOf; }", - "description": "The **`Element.getElementsByTagNameNS()`** method returns a live HTMLCollection of elements with the given tag name belonging to the given namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagNameNS)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "MethodSignature", - "name": "getHTML", - "value": "(options?: GetHTMLOptions) => string", - "description": "The **`getHTML()`** method of the Element interface is used to serialize an element's DOM to an HTML string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getHTML)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "MethodSignature", - "name": "getRootNode", - "value": "(options?: GetRootNodeOptions) => Node", - "description": "The **`getRootNode()`** method of the Node interface returns the context object's root, which optionally includes the shadow root if it is available.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/getRootNode)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "MethodSignature", - "name": "hasAttribute", - "value": "(qualifiedName: string) => boolean", - "description": "The **`Element.hasAttribute()`** method returns a **Boolean** value indicating whether the specified element has the specified attribute or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttribute)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "MethodSignature", - "name": "hasAttributeNS", - "value": "(namespace: string, localName: string) => boolean", - "description": "The **`hasAttributeNS()`** method of the Element interface returns a boolean value indicating whether the current element has the specified attribute with the specified namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributeNS)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "MethodSignature", - "name": "hasAttributes", - "value": "() => boolean", - "description": "The **`hasAttributes()`** method of the Element interface returns a boolean value indicating whether the current element has any attributes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributes)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "MethodSignature", - "name": "hasChildNodes", - "value": "() => boolean", - "description": "The **`hasChildNodes()`** method of the Node interface returns a boolean value indicating whether the given Node has child nodes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/hasChildNodes)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "MethodSignature", - "name": "hasPointerCapture", - "value": "(pointerId: number) => boolean", - "description": "The **`hasPointerCapture()`** method of the pointer capture for the pointer identified by the given pointer ID.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasPointerCapture)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "hidden", - "value": "boolean", - "description": "The HTMLElement property **`hidden`** reflects the value of the element's `hidden` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidden)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "MethodSignature", - "name": "hidePopover", - "value": "() => void", - "description": "The **`hidePopover()`** method of the HTMLElement interface hides a popover element (i.e., one that has a valid `popover` attribute) by removing it from the top layer and styling it with `display: none`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidePopover)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the element.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "inert", - "value": "boolean", - "description": "The HTMLElement property **`inert`** reflects the value of the element's `inert` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inert)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "innerHTML", - "value": "string", - "description": "The **`innerHTML`** property of the Element interface gets or sets the HTML or XML markup contained within the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/innerHTML)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "innerText", - "value": "string", - "description": "The **`innerText`** property of the HTMLElement interface represents the rendered text content of a node and its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/innerText)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "inputMode", - "value": "string", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inputMode)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "MethodSignature", - "name": "insertAdjacentElement", - "value": "(where: InsertPosition, element: Element) => Element", - "description": "The **`insertAdjacentElement()`** method of the relative to the element it is invoked upon.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentElement)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "MethodSignature", - "name": "insertAdjacentHTML", - "value": "(position: InsertPosition, string: string) => void", - "description": "The **`insertAdjacentHTML()`** method of the the resulting nodes into the DOM tree at a specified position.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentHTML)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "MethodSignature", - "name": "insertAdjacentText", - "value": "(where: InsertPosition, data: string) => void", - "description": "The **`insertAdjacentText()`** method of the Element interface, given a relative position and a string, inserts a new text node at the given position relative to the element it is called from.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentText)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "MethodSignature", - "name": "insertBefore", - "value": "(node: T, child: Node) => T", - "description": "The **`insertBefore()`** method of the Node interface inserts a node before a _reference node_ as a child of a specified _parent node_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/insertBefore)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "isConnected", - "value": "boolean", - "description": "The read-only **`isConnected`** property of the Node interface returns a boolean indicating whether the node is connected (directly or indirectly) to a Document object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isConnected)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "isContentEditable", - "value": "boolean", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/isContentEditable)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "MethodSignature", - "name": "isDefaultNamespace", - "value": "(namespace: string) => boolean", - "description": "The **`isDefaultNamespace()`** method of the Node interface accepts a namespace URI as an argument.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isDefaultNamespace)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "MethodSignature", - "name": "isEqualNode", - "value": "(otherNode: Node) => boolean", - "description": "The **`isEqualNode()`** method of the Node interface tests whether two nodes are equal.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isEqualNode)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "MethodSignature", - "name": "isSameNode", - "value": "(otherNode: Node) => boolean", - "description": "The **`isSameNode()`** method of the Node interface is a legacy alias the for the `===` strict equality operator.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isSameNode)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "lang", - "value": "string", - "description": "The **`lang`** property of the HTMLElement interface indicates the base language of an element's attribute values and text content, in the form of a MISSING: RFC(5646, 'BCP 47 language identifier tag')].\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/lang)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "lastChild", - "value": "ChildNode | null", - "description": "The read-only **`lastChild`** property of the Node interface returns the last child of the node, or `null` if there are no child nodes.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lastChild)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "lastElementChild", - "value": "Element | null", - "description": "Returns the last child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/lastElementChild)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "localName", - "value": "string", - "description": "The **`Element.localName`** read-only property returns the local part of the qualified name of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/localName)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "MethodSignature", - "name": "lookupNamespaceURI", - "value": "(prefix: string) => string", - "description": "The **`lookupNamespaceURI()`** method of the Node interface takes a prefix as parameter and returns the namespace URI associated with it on the given node if found (and `null` if not).\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupNamespaceURI)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "MethodSignature", - "name": "lookupPrefix", - "value": "(namespace: string) => string", - "description": "The **`lookupPrefix()`** method of the Node interface returns a string containing the prefix for a given namespace URI, if present, and `null` if not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupPrefix)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "MethodSignature", - "name": "matches", - "value": "(selectors: string) => boolean", - "description": "The **`matches()`** method of the Element interface tests whether the element would be selected by the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "namespaceURI", - "value": "string | null", - "description": "The **`Element.namespaceURI`** read-only property returns the namespace URI of the element, or `null` if the element is not in a namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/namespaceURI)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "nextElementSibling", - "value": "Element | null", - "description": "Returns the first following sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/nextElementSibling)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "nextSibling", - "value": "ChildNode | null", - "description": "The read-only **`nextSibling`** property of the Node interface returns the node immediately following the specified one in their parent's Node.childNodes, or returns `null` if the specified node is the last child in the parent element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nextSibling)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "nodeName", - "value": "string", - "description": "The read-only **`nodeName`** property of Node returns the name of the current node as a string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeName)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "nodeType", - "value": "number", - "description": "The read-only **`nodeType`** property of a Node interface is an integer that identifies what the node is.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeType)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "nodeValue", - "value": "string | null", - "description": "The **`nodeValue`** property of the Node interface returns or sets the value of the current node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeValue)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "nonce", - "value": "string", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/nonce)", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "MethodSignature", - "name": "normalize", - "value": "() => void", - "description": "The **`normalize()`** method of the Node interface puts the specified node and all of its sub-tree into a _normalized_ form.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/normalize)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "NOTATION_NODE", - "value": "12", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "offsetHeight", - "value": "number", - "description": "The **`offsetHeight`** read-only property of the HTMLElement interface returns the height of an element, including vertical padding and borders, as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetHeight)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "offsetLeft", - "value": "number", - "description": "The **`offsetLeft`** read-only property of the HTMLElement interface returns the number of pixels that the _upper left corner_ of the current element is offset to the left within the HTMLElement.offsetParent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetLeft)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "offsetParent", - "value": "Element | null", - "description": "The **`HTMLElement.offsetParent`** read-only property returns a reference to the element which is the closest (nearest in the containment hierarchy) positioned ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetParent)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "offsetTop", - "value": "number", - "description": "The **`offsetTop`** read-only property of the HTMLElement interface returns the distance from the outer border of the current element (including its margin) to the top padding edge of the HTMLelement.offsetParent, the _closest positioned_ ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetTop)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "offsetWidth", - "value": "number", - "description": "The **`offsetWidth`** read-only property of the HTMLElement interface returns the layout width of an element as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetWidth)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "onabort", - "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/abort_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "onanimationcancel", - "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationcancel_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "onanimationend", - "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "onanimationiteration", - "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "onanimationstart", - "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "onauxclick", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/auxclick_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "onbeforeinput", - "value": "((this: GlobalEventHandlers, ev: InputEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforeinput_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "onbeforematch", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforematch_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "onbeforetoggle", - "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/beforetoggle_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "onblur", - "value": "((this: GlobalEventHandlers, ev: FocusEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/blur_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "oncancel", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/cancel_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "oncanplay", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplay_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "oncanplaythrough", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplaythrough_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "onchange", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/change_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "onclick", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/click_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "onclose", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/close_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "oncontextlost", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextlost_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "oncontextmenu", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/contextmenu_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "oncontextrestored", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextrestored_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "oncopy", - "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/copy_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "oncuechange", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLTrackElement/cuechange_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "oncut", - "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/cut_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "ondblclick", - "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/dblclick_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "ondrag", - "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drag_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "ondragend", - "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragend_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "ondragenter", - "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragenter_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "ondragleave", - "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragleave_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "ondragover", - "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragover_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "ondragstart", - "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragstart_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "ondrop", - "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drop_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "ondurationchange", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/durationchange_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "onemptied", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/emptied_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "onended", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ended_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "onerror", - "value": "OnErrorEventHandler", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/error_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "onfocus", - "value": "((this: GlobalEventHandlers, ev: FocusEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/focus_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "onformdata", - "value": "((this: GlobalEventHandlers, ev: FormDataEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/formdata_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "onfullscreenchange", - "value": "((this: Element, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenchange_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "onfullscreenerror", - "value": "((this: Element, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenerror_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "ongotpointercapture", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/gotpointercapture_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "oninput", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/input_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "oninvalid", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/invalid_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "onkeydown", - "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keydown_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "onkeypress", - "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", - "description": "", - "deprecationMessage": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keypress_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "onkeyup", - "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keyup_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "onload", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/load_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "onloadeddata", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadeddata_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "onloadedmetadata", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadedmetadata_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "onloadstart", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadstart_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "onlostpointercapture", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/lostpointercapture_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "onmousedown", - "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousedown_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "onmouseenter", - "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseenter_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "onmouseleave", - "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseleave_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "onmousemove", - "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousemove_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "onmouseout", - "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseout_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "onmouseover", - "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseover_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "onmouseup", - "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseup_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "onpaste", - "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/paste_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "onpause", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/pause_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "onplay", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/play_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "onplaying", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/playing_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "onpointercancel", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointercancel_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "onpointerdown", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerdown_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "onpointerenter", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerenter_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "onpointerleave", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerleave_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "onpointermove", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointermove_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "onpointerout", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerout_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "onpointerover", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerover_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "onpointerrawupdate", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "Available only in secure contexts.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerrawupdate_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "onpointerup", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerup_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "onprogress", - "value": "((this: GlobalEventHandlers, ev: ProgressEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/progress_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "onratechange", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ratechange_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "onreset", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/reset_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "onresize", - "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLVideoElement/resize_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "onscroll", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scroll_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "onscrollend", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scrollend_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "onsecuritypolicyviolation", - "value": "((this: GlobalEventHandlers, ev: SecurityPolicyViolationEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/securitypolicyviolation_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "onseeked", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeked_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "onseeking", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeking_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "onselect", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/select_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "onselectionchange", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/selectionchange_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "onselectstart", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/selectstart_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "onslotchange", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLSlotElement/slotchange_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "onstalled", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/stalled_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "onsubmit", - "value": "((this: GlobalEventHandlers, ev: SubmitEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/submit_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "onsuspend", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/suspend_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "ontimeupdate", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/timeupdate_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "ontoggle", - "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/toggle_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "ontouchcancel", - "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchcancel_event)", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "ontouchend", - "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchend_event)", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "ontouchmove", - "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchmove_event)", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "ontouchstart", - "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchstart_event)", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "ontransitioncancel", - "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitioncancel_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "ontransitionend", - "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "ontransitionrun", - "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionrun_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "ontransitionstart", - "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionstart_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "onvolumechange", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/volumechange_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "onwaiting", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/waiting_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "onwebkitanimationend", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "", - "deprecationMessage": "This is a legacy alias of `onanimationend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "onwebkitanimationiteration", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "", - "deprecationMessage": "This is a legacy alias of `onanimationiteration`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "onwebkitanimationstart", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "", - "deprecationMessage": "This is a legacy alias of `onanimationstart`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "onwebkittransitionend", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "", - "deprecationMessage": "This is a legacy alias of `ontransitionend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "onwheel", - "value": "((this: GlobalEventHandlers, ev: WheelEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/wheel_event)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "outerHTML", - "value": "string", - "description": "The **`outerHTML`** attribute of the Element DOM interface gets the serialized HTML fragment describing the element including its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/outerHTML)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "outerText", - "value": "string", - "description": "The **`outerText`** property of the HTMLElement interface returns the same value as HTMLElement.innerText.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/outerText)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "ownerDocument", - "value": "Document", - "description": "The read-only **`ownerDocument`** property of the Node interface returns the top-level document object of the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/ownerDocument)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "parentElement", - "value": "HTMLElement | null", - "description": "The read-only **`parentElement`** property of Node interface returns the DOM node's parent Element, or `null` if the node either has no parent, or its parent isn't a DOM Element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentElement)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "parentNode", - "value": "ParentNode | null", - "description": "The read-only **`parentNode`** property of the Node interface returns the parent of the specified node in the DOM tree.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentNode)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "GetAccessor", - "name": "part", - "value": "DOMTokenList", - "description": "The **`part`** property of the Element interface represents the part identifier(s) of the element (i.e., set using the `part` attribute), returned as a DOMTokenList.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/part)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "popover", - "value": "string | null", - "description": "The **`popover`** property of the HTMLElement interface gets and sets an element's popover state via JavaScript (`'auto'`, `'hint'`, or `'manual'`), and can be used for feature detection.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/popover)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "prefix", - "value": "string | null", - "description": "The **`Element.prefix`** read-only property returns the namespace prefix of the specified element, or `null` if no prefix is specified.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/prefix)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "MethodSignature", - "name": "prepend", - "value": "(...nodes: (string | Node)[]) => void", - "description": "Inserts nodes before the first child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/prepend)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "previousElementSibling", - "value": "Element | null", - "description": "Returns the first preceding sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/previousElementSibling)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "previousSibling", - "value": "ChildNode | null", - "description": "The read-only **`previousSibling`** property of the Node interface returns the node immediately preceding the specified one in its parent's or `null` if the specified node is the first in that list.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/previousSibling)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "PROCESSING_INSTRUCTION_NODE", - "value": "7", - "description": "node is a ProcessingInstruction node." - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "MethodSignature", - "name": "querySelector", - "value": "{ (selectors: K): HTMLElementTagNameMap[K]; (selectors: K): SVGElementTagNameMap[K]; (selectors: K): MathMLElementTagNameMap[K]; (selectors: K): HTMLElementDeprecatedTagNameMap[K]; (selectors: string): E; }", - "description": "Returns the first element that is a descendant of node that matches selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelector)", - "deprecationMessage": "Deprecated" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "MethodSignature", - "name": "querySelectorAll", - "value": "{ (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: string): NodeListOf; }", - "description": "Returns all element descendants of node that match selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelectorAll)", - "deprecationMessage": "Deprecated" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "MethodSignature", - "name": "releasePointerCapture", - "value": "(pointerId: number) => void", - "description": "The **`releasePointerCapture()`** method of the previously set for a specific (PointerEvent) _pointer_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/releasePointerCapture)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "MethodSignature", - "name": "remove", - "value": "() => void", - "description": "Removes node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/remove)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "MethodSignature", - "name": "removeAttribute", - "value": "(qualifiedName: string) => void", - "description": "The Element method **`removeAttribute()`** removes the attribute with the specified name from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttribute)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "MethodSignature", - "name": "removeAttributeNode", - "value": "(attr: Attr) => Attr", - "description": "The **`removeAttributeNode()`** method of the Element interface removes the specified Attr node from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNode)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "MethodSignature", - "name": "removeAttributeNS", - "value": "(namespace: string, localName: string) => void", - "description": "The **`removeAttributeNS()`** method of the If you are working with HTML and you don't need to specify the requested attribute as being part of a specific namespace, use the Element.removeAttribute() method instead.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNS)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "MethodSignature", - "name": "removeChild", - "value": "(child: T) => T", - "description": "The **`removeChild()`** method of the Node interface removes a child node from the DOM and returns the removed node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/removeChild)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "MethodSignature", - "name": "removeEventListener", - "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "MethodSignature", - "name": "replaceChild", - "value": "(node: Node, child: T) => T", - "description": "The **`replaceChild()`** method of the Node interface replaces a child node within the given (parent) node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/replaceChild)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "MethodSignature", - "name": "replaceChildren", - "value": "(...nodes: (string | Node)[]) => void", - "description": "Replace all children of node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/replaceChildren)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "MethodSignature", - "name": "replaceWith", - "value": "(...nodes: (string | Node)[]) => void", - "description": "Replaces node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/replaceWith)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "MethodSignature", - "name": "requestFullscreen", - "value": "(options?: FullscreenOptions) => Promise", - "description": "The **`Element.requestFullscreen()`** method issues an asynchronous request to make the element be displayed in fullscreen mode.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestFullscreen)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "MethodSignature", - "name": "requestPointerLock", - "value": "(options?: PointerLockOptions) => Promise", - "description": "The **`requestPointerLock()`** method of the Element interface lets you asynchronously ask for the pointer to be locked on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestPointerLock)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "role", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/role)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "MethodSignature", - "name": "scroll", - "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", - "description": "The **`scroll()`** method of the Element interface scrolls the element to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scroll)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "MethodSignature", - "name": "scrollBy", - "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", - "description": "The **`scrollBy()`** method of the Element interface scrolls an element by the given amount.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollBy)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "scrollHeight", - "value": "number", - "description": "The **`scrollHeight`** read-only property of the Element interface is a measurement of the height of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollHeight)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "MethodSignature", - "name": "scrollIntoView", - "value": "(arg?: boolean | ScrollIntoViewOptions) => void", - "description": "The Element interface's **`scrollIntoView()`** method scrolls the element's ancestor containers such that the element on which `scrollIntoView()` is called is visible to the user.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollIntoView)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "scrollLeft", - "value": "number", - "description": "The **`scrollLeft`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its left edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollLeft)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "MethodSignature", - "name": "scrollTo", - "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", - "description": "The **`scrollTo()`** method of the Element interface scrolls to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTo)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "scrollTop", - "value": "number", - "description": "The **`scrollTop`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its top edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTop)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "scrollWidth", - "value": "number", - "description": "The **`scrollWidth`** read-only property of the Element interface is a measurement of the width of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollWidth)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "MethodSignature", - "name": "setAttribute", - "value": "(qualifiedName: string, value: string) => void", - "description": "The **`setAttribute()`** method of the Element interface sets the value of an attribute on the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttribute)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "MethodSignature", - "name": "setAttributeNode", - "value": "(attr: Attr) => Attr", - "description": "The **`setAttributeNode()`** method of the Element interface adds a new Attr node to the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNode)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "MethodSignature", - "name": "setAttributeNodeNS", - "value": "(attr: Attr) => Attr", - "description": "The **`setAttributeNodeNS()`** method of the Element interface adds a new namespaced Attr node to an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNodeNS)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "MethodSignature", - "name": "setAttributeNS", - "value": "(namespace: string, qualifiedName: string, value: string) => void", - "description": "`setAttributeNS` adds a new attribute or changes the value of an attribute with the given namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNS)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "MethodSignature", - "name": "setHTMLUnsafe", - "value": "(html: string) => void", - "description": "The **`setHTMLUnsafe()`** method of the Element interface is used to parse a string of HTML into a DocumentFragment, optionally filtering out unwanted elements and attributes, and those that don't belong in the context, and then using it to replace the element's subtree in the DOM.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setHTMLUnsafe)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "MethodSignature", - "name": "setPointerCapture", - "value": "(pointerId: number) => void", - "description": "The **`setPointerCapture()`** method of the _capture target_ of future pointer events.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setPointerCapture)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "shadowRoot", - "value": "ShadowRoot | null", - "description": "The `Element.shadowRoot` read-only property represents the shadow root hosted by the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/shadowRoot)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "MethodSignature", - "name": "showPopover", - "value": "() => void", - "description": "The **`showPopover()`** method of the HTMLElement interface shows a Popover_API element (i.e., one that has a valid `popover` attribute) by adding it to the top layer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/showPopover)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "slot", - "value": "string", - "description": "The **`slot`** property of the Element interface returns the name of the shadow DOM slot the element is inserted in.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/slot)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "spellcheck", - "value": "boolean", - "description": "The **`spellcheck`** property of the HTMLElement interface represents a boolean value that controls the spell-checking hint.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/spellcheck)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "GetAccessor", - "name": "style", - "value": "CSSStyleDeclaration", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/style)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "tabIndex", - "value": "number", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/tabIndex)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "tagName", - "value": "string", - "description": "The **`tagName`** read-only property of the Element interface returns the tag name of the element on which it's called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/tagName)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "TEXT_NODE", - "value": "3", - "description": "node is a Text node." - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "GetAccessor", - "name": "textContent", - "value": "string", - "description": "[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/Node/textContent)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The **`HTMLElement.title`** property represents the title of the element: the text usually displayed in a 'tooltip' popup when the mouse is over the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/title)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "MethodSignature", - "name": "toggleAttribute", - "value": "(qualifiedName: string, force?: boolean) => boolean", - "description": "The **`toggleAttribute()`** method of the present and adding it if it is not present) on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/toggleAttribute)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "MethodSignature", - "name": "togglePopover", - "value": "(options?: boolean) => boolean", - "description": "The **`togglePopover()`** method of the HTMLElement interface toggles a Popover_API element (i.e., one that has a valid `popover` attribute) between the hidden and showing states.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/togglePopover)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "translate", - "value": "boolean", - "description": "The **`translate`** property of the HTMLElement interface indicates whether an element's attribute values and the values of its Text node children are to be translated when the page is localized, or whether to leave them unchanged.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/translate)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "MethodSignature", - "name": "webkitMatchesSelector", - "value": "(selectors: string) => boolean", - "description": "", - "deprecationMessage": "This is a legacy alias of `matches`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" - }, - { - "filePath": "src/surfaces/checkout/components/Chip.ts", - "syntaxKind": "PropertySignature", - "name": "writingSuggestions", - "value": "string", - "description": "The **`writingSuggestions`** property of the HTMLElement interface is a string indicating if browser-provided writing suggestions should be enabled under the scope of the element or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/writingSuggestions)" - } - ], - "value": "export interface ChipElement extends ChipProps, Omit {\n}" - } - }, - "UnorderedListElementProps": { - "src/surfaces/checkout/components/UnorderedList.ts": { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "name": "UnorderedListElementProps", - "description": "Properties for the UnorderedList component element.", - "isPublicDocs": true, - "members": [ - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the element.", - "isOptional": true - } - ], - "value": "export interface UnorderedListElementProps extends UnorderedListProps$1 {\n}" - } - }, - "UnorderedListElement": { - "src/surfaces/checkout/components/UnorderedList.ts": { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "name": "UnorderedListElement", - "description": "", - "isPublicDocs": true, - "members": [ - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "accessKey", - "value": "string", - "description": "The **`HTMLElement.accessKey`** property sets the keystroke which a user can press to jump to a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKey)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "accessKeyLabel", - "value": "string", - "description": "The **`HTMLElement.accessKeyLabel`** read-only property returns a string containing the element's browser-assigned access key (if any); otherwise it returns an empty string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKeyLabel)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "MethodSignature", - "name": "addEventListener", - "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "MethodSignature", - "name": "after", - "value": "(...nodes: (string | Node)[]) => void", - "description": "Inserts nodes just after node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/after)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "MethodSignature", - "name": "animate", - "value": "(keyframes: Keyframe[] | PropertyIndexedKeyframes, options?: number | KeyframeAnimationOptions) => Animation", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animate)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "MethodSignature", - "name": "append", - "value": "(...nodes: (string | Node)[]) => void", - "description": "Inserts nodes after the last child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/append)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "MethodSignature", - "name": "appendChild", - "value": "(node: T) => T", - "description": "The **`appendChild()`** method of the Node interface adds a node to the end of the list of children of a specified parent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/appendChild)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ariaActiveDescendantElement", - "value": "Element | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaActiveDescendantElement)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ariaAtomic", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAtomic)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ariaAutoComplete", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAutoComplete)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ariaBrailleLabel", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleLabel)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ariaBrailleRoleDescription", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleRoleDescription)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ariaBusy", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBusy)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ariaChecked", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaChecked)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ariaColCount", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColCount)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ariaColIndex", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndex)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ariaColIndexText", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndexText)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ariaColSpan", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColSpan)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ariaControlsElements", - "value": "ReadonlyArray | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaControlsElements)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ariaCurrent", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaCurrent)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ariaDescribedByElements", - "value": "ReadonlyArray | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescribedByElements)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ariaDescription", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescription)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ariaDetailsElements", - "value": "ReadonlyArray | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDetailsElements)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ariaDisabled", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDisabled)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ariaErrorMessageElements", - "value": "ReadonlyArray | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaErrorMessageElements)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ariaExpanded", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaExpanded)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ariaFlowToElements", - "value": "ReadonlyArray | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaFlowToElements)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ariaHasPopup", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHasPopup)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ariaHidden", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHidden)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ariaInvalid", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaInvalid)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ariaKeyShortcuts", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaKeyShortcuts)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ariaLabel", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabel)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ariaLabelledByElements", - "value": "ReadonlyArray | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabelledByElements)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ariaLevel", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLevel)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ariaLive", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLive)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ariaModal", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaModal)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ariaMultiLine", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiLine)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ariaMultiSelectable", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiSelectable)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ariaOrientation", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOrientation)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ariaOwnsElements", - "value": "ReadonlyArray | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOwnsElements)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ariaPlaceholder", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPlaceholder)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ariaPosInSet", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPosInSet)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ariaPressed", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPressed)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ariaReadOnly", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaReadOnly)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ariaRelevant", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRelevant)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ariaRequired", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRequired)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ariaRoleDescription", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRoleDescription)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ariaRowCount", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowCount)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ariaRowIndex", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndex)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ariaRowIndexText", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndexText)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ariaRowSpan", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowSpan)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ariaSelected", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSelected)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ariaSetSize", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSetSize)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ariaSort", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSort)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ariaValueMax", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMax)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ariaValueMin", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMin)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ariaValueNow", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueNow)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ariaValueText", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueText)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "assignedSlot", - "value": "HTMLSlotElement | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/assignedSlot)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "MethodSignature", - "name": "attachInternals", - "value": "() => ElementInternals", - "description": "The **`HTMLElement.attachInternals()`** method returns an ElementInternals object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attachInternals)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "MethodSignature", - "name": "attachShadow", - "value": "(init: ShadowRootInit) => ShadowRoot", - "description": "The **`Element.attachShadow()`** method attaches a shadow DOM tree to the specified element and returns a reference to its ShadowRoot.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attachShadow)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ATTRIBUTE_NODE", - "value": "2", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "NamedNodeMap", - "description": "The **`Element.attributes`** property returns a live collection of all attribute nodes registered to the specified node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attributes)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "attributeStyleMap", - "value": "StylePropertyMap", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attributeStyleMap)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "autocapitalize", - "value": "string", - "description": "The **`autocapitalize`** property of the HTMLElement interface represents the element's capitalization behavior for user input.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocapitalize)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "autocorrect", - "value": "boolean", - "description": "The **`autocorrect`** property of the HTMLElement interface controls whether or not autocorrection of editable text is enabled for spelling and/or punctuation errors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocorrect)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "autofocus", - "value": "boolean", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autofocus)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "baseURI", - "value": "string", - "description": "The read-only **`baseURI`** property of the Node interface returns the absolute base URL of the document containing the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/baseURI)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "MethodSignature", - "name": "before", - "value": "(...nodes: (string | Node)[]) => void", - "description": "Inserts nodes just before node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/before)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "MethodSignature", - "name": "blur", - "value": "() => void", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/blur)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "CDATA_SECTION_NODE", - "value": "4", - "description": "node is a CDATASection node." - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "MethodSignature", - "name": "checkVisibility", - "value": "(options?: CheckVisibilityOptions) => boolean", - "description": "The **`checkVisibility()`** method of the Element interface checks whether the element is visible.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/checkVisibility)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "childElementCount", - "value": "number", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/childElementCount)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "childNodes", - "value": "NodeListOf", - "description": "The read-only **`childNodes`** property of the Node interface returns a live the first child node is assigned index `0`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/childNodes)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "HTMLCollection", - "description": "Returns the child elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/children)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "GetAccessor", - "name": "classList", - "value": "DOMTokenList", - "description": "The **`Element.classList`** is a read-only property that returns a live DOMTokenList collection of the `class` attributes of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/classList)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "className", - "value": "string", - "description": "The **`className`** property of the of the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/className)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "MethodSignature", - "name": "click", - "value": "() => void", - "description": "The **`HTMLElement.click()`** method simulates a mouse click on an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/click)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "clientHeight", - "value": "number", - "description": "The **`clientHeight`** read-only property of the Element interface is zero for elements with no CSS or inline layout boxes; otherwise, it's the inner height of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientHeight)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "clientLeft", - "value": "number", - "description": "The **`clientLeft`** read-only property of the Element interface returns the width of the left border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientLeft)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "clientTop", - "value": "number", - "description": "The **`clientTop`** read-only property of the Element interface returns the width of the top border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientTop)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "clientWidth", - "value": "number", - "description": "The **`clientWidth`** read-only property of the Element interface is zero for inline elements and elements with no CSS; otherwise, it's the inner width of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientWidth)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "MethodSignature", - "name": "cloneNode", - "value": "(subtree?: boolean) => Node", - "description": "The **`cloneNode()`** method of the Node interface returns a duplicate of the node on which this method was called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/cloneNode)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "MethodSignature", - "name": "closest", - "value": "{ (selector: K): HTMLElementTagNameMap[K]; (selector: K): SVGElementTagNameMap[K]; (selector: K): MathMLElementTagNameMap[K]; (selectors: string): E; }", - "description": "The **`closest()`** method of the Element interface traverses the element and its parents (heading toward the document root) until it finds a node that matches the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/closest)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "COMMENT_NODE", - "value": "8", - "description": "node is a Comment node." - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "MethodSignature", - "name": "compareDocumentPosition", - "value": "(other: Node) => number", - "description": "The **`compareDocumentPosition()`** method of the Node interface reports the position of its argument node relative to the node on which it is called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/compareDocumentPosition)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "MethodSignature", - "name": "computedStyleMap", - "value": "() => StylePropertyMapReadOnly", - "description": "The **`computedStyleMap()`** method of the Element interface returns a StylePropertyMapReadOnly interface which provides a read-only representation of a CSS declaration block that is an alternative to CSSStyleDeclaration.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/computedStyleMap)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "MethodSignature", - "name": "contains", - "value": "(other: Node) => boolean", - "description": "The **`contains()`** method of the Node interface returns a boolean value indicating whether a node is a descendant of a given node, that is the node itself, one of its direct children (Node.childNodes), one of the children's direct children, and so on.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/contains)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "contentEditable", - "value": "string", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/contentEditable)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "currentCSSZoom", - "value": "number", - "description": "The **`currentCSSZoom`** read-only property of the Element interface provides the 'effective' CSS `zoom` of an element, taking into account the zoom applied to the element and all its parent elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/currentCSSZoom)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "dataset", - "value": "DOMStringMap", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dataset)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "dir", - "value": "string", - "description": "The **`HTMLElement.dir`** property indicates the text writing directionality of the content of the current element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dir)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "MethodSignature", - "name": "dispatchEvent", - "value": "(event: Event) => boolean", - "description": "The **`dispatchEvent()`** method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/dispatchEvent)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "DOCUMENT_FRAGMENT_NODE", - "value": "11", - "description": "node is a DocumentFragment node." - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "DOCUMENT_NODE", - "value": "9", - "description": "node is a document." - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "DOCUMENT_POSITION_CONTAINED_BY", - "value": "16", - "description": "Set when other is a descendant of node." - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "DOCUMENT_POSITION_CONTAINS", - "value": "8", - "description": "Set when other is an ancestor of node." - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "DOCUMENT_POSITION_DISCONNECTED", - "value": "1", - "description": "Set when node and other are not in the same tree." - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "DOCUMENT_POSITION_FOLLOWING", - "value": "4", - "description": "Set when other is following node." - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC", - "value": "32", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "DOCUMENT_POSITION_PRECEDING", - "value": "2", - "description": "Set when other is preceding node." - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "DOCUMENT_TYPE_NODE", - "value": "10", - "description": "node is a doctype." - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "draggable", - "value": "boolean", - "description": "The **`draggable`** property of the HTMLElement interface gets and sets a Boolean primitive indicating if the element is draggable.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/draggable)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ELEMENT_NODE", - "value": "1", - "description": "node is an element." - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "enterKeyHint", - "value": "string", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/enterKeyHint)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ENTITY_NODE", - "value": "6", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ENTITY_REFERENCE_NODE", - "value": "5", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "firstChild", - "value": "ChildNode | null", - "description": "The read-only **`firstChild`** property of the Node interface returns the node's first child in the tree, or `null` if the node has no children.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/firstChild)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "firstElementChild", - "value": "Element | null", - "description": "Returns the first child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/firstElementChild)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "MethodSignature", - "name": "focus", - "value": "(options?: FocusOptions) => void", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/focus)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "MethodSignature", - "name": "getAnimations", - "value": "(options?: GetAnimationsOptions) => Animation[]", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAnimations)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "MethodSignature", - "name": "getAttribute", - "value": "(qualifiedName: string) => string", - "description": "The **`getAttribute()`** method of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttribute)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "MethodSignature", - "name": "getAttributeNames", - "value": "() => string[]", - "description": "The **`getAttributeNames()`** method of the array.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNames)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "MethodSignature", - "name": "getAttributeNode", - "value": "(qualifiedName: string) => Attr", - "description": "Returns the specified attribute of the specified element, as an Attr node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNode)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "MethodSignature", - "name": "getAttributeNodeNS", - "value": "(namespace: string, localName: string) => Attr", - "description": "The **`getAttributeNodeNS()`** method of the Element interface returns the namespaced Attr node of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNodeNS)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "MethodSignature", - "name": "getAttributeNS", - "value": "(namespace: string, localName: string) => string", - "description": "The **`getAttributeNS()`** method of the Element interface returns the string value of the attribute with the specified namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNS)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "MethodSignature", - "name": "getBoundingClientRect", - "value": "() => DOMRect", - "description": "The **`Element.getBoundingClientRect()`** method returns a position relative to the viewport.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getBoundingClientRect)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "MethodSignature", - "name": "getClientRects", - "value": "() => DOMRectList", - "description": "The **`getClientRects()`** method of the Element interface returns a collection of DOMRect objects that indicate the bounding rectangles for each CSS border box in a client.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getClientRects)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "MethodSignature", - "name": "getElementsByClassName", - "value": "(classNames: string) => HTMLCollectionOf", - "description": "The Element method **`getElementsByClassName()`** returns a live specified class name or names.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByClassName)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "MethodSignature", - "name": "getElementsByTagName", - "value": "{ (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: string): HTMLCollectionOf; }", - "description": "The **`Element.getElementsByTagName()`** method returns a live All descendants of the specified element are searched, but not the element itself.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagName)", - "deprecationMessage": "Deprecated" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "MethodSignature", - "name": "getElementsByTagNameNS", - "value": "{ (namespaceURI: \"http://www.w3.org/1999/xhtml\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/2000/svg\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/1998/Math/MathML\", localName: string): HTMLCollectionOf; (namespace: string, localName: string): HTMLCollectionOf; }", - "description": "The **`Element.getElementsByTagNameNS()`** method returns a live HTMLCollection of elements with the given tag name belonging to the given namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagNameNS)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "MethodSignature", - "name": "getHTML", - "value": "(options?: GetHTMLOptions) => string", - "description": "The **`getHTML()`** method of the Element interface is used to serialize an element's DOM to an HTML string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getHTML)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "MethodSignature", - "name": "getRootNode", - "value": "(options?: GetRootNodeOptions) => Node", - "description": "The **`getRootNode()`** method of the Node interface returns the context object's root, which optionally includes the shadow root if it is available.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/getRootNode)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "MethodSignature", - "name": "hasAttribute", - "value": "(qualifiedName: string) => boolean", - "description": "The **`Element.hasAttribute()`** method returns a **Boolean** value indicating whether the specified element has the specified attribute or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttribute)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "MethodSignature", - "name": "hasAttributeNS", - "value": "(namespace: string, localName: string) => boolean", - "description": "The **`hasAttributeNS()`** method of the Element interface returns a boolean value indicating whether the current element has the specified attribute with the specified namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributeNS)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "MethodSignature", - "name": "hasAttributes", - "value": "() => boolean", - "description": "The **`hasAttributes()`** method of the Element interface returns a boolean value indicating whether the current element has any attributes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributes)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "MethodSignature", - "name": "hasChildNodes", - "value": "() => boolean", - "description": "The **`hasChildNodes()`** method of the Node interface returns a boolean value indicating whether the given Node has child nodes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/hasChildNodes)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "MethodSignature", - "name": "hasPointerCapture", - "value": "(pointerId: number) => boolean", - "description": "The **`hasPointerCapture()`** method of the pointer capture for the pointer identified by the given pointer ID.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasPointerCapture)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "hidden", - "value": "boolean", - "description": "The HTMLElement property **`hidden`** reflects the value of the element's `hidden` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidden)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "MethodSignature", - "name": "hidePopover", - "value": "() => void", - "description": "The **`hidePopover()`** method of the HTMLElement interface hides a popover element (i.e., one that has a valid `popover` attribute) by removing it from the top layer and styling it with `display: none`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidePopover)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the element.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "inert", - "value": "boolean", - "description": "The HTMLElement property **`inert`** reflects the value of the element's `inert` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inert)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "innerHTML", - "value": "string", - "description": "The **`innerHTML`** property of the Element interface gets or sets the HTML or XML markup contained within the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/innerHTML)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "innerText", - "value": "string", - "description": "The **`innerText`** property of the HTMLElement interface represents the rendered text content of a node and its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/innerText)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "inputMode", - "value": "string", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inputMode)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "MethodSignature", - "name": "insertAdjacentElement", - "value": "(where: InsertPosition, element: Element) => Element", - "description": "The **`insertAdjacentElement()`** method of the relative to the element it is invoked upon.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentElement)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "MethodSignature", - "name": "insertAdjacentHTML", - "value": "(position: InsertPosition, string: string) => void", - "description": "The **`insertAdjacentHTML()`** method of the the resulting nodes into the DOM tree at a specified position.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentHTML)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "MethodSignature", - "name": "insertAdjacentText", - "value": "(where: InsertPosition, data: string) => void", - "description": "The **`insertAdjacentText()`** method of the Element interface, given a relative position and a string, inserts a new text node at the given position relative to the element it is called from.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentText)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "MethodSignature", - "name": "insertBefore", - "value": "(node: T, child: Node) => T", - "description": "The **`insertBefore()`** method of the Node interface inserts a node before a _reference node_ as a child of a specified _parent node_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/insertBefore)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "isConnected", - "value": "boolean", - "description": "The read-only **`isConnected`** property of the Node interface returns a boolean indicating whether the node is connected (directly or indirectly) to a Document object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isConnected)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "isContentEditable", - "value": "boolean", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/isContentEditable)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "MethodSignature", - "name": "isDefaultNamespace", - "value": "(namespace: string) => boolean", - "description": "The **`isDefaultNamespace()`** method of the Node interface accepts a namespace URI as an argument.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isDefaultNamespace)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "MethodSignature", - "name": "isEqualNode", - "value": "(otherNode: Node) => boolean", - "description": "The **`isEqualNode()`** method of the Node interface tests whether two nodes are equal.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isEqualNode)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "MethodSignature", - "name": "isSameNode", - "value": "(otherNode: Node) => boolean", - "description": "The **`isSameNode()`** method of the Node interface is a legacy alias the for the `===` strict equality operator.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isSameNode)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "lang", - "value": "string", - "description": "The **`lang`** property of the HTMLElement interface indicates the base language of an element's attribute values and text content, in the form of a MISSING: RFC(5646, 'BCP 47 language identifier tag')].\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/lang)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "lastChild", - "value": "ChildNode | null", - "description": "The read-only **`lastChild`** property of the Node interface returns the last child of the node, or `null` if there are no child nodes.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lastChild)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "lastElementChild", - "value": "Element | null", - "description": "Returns the last child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/lastElementChild)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "localName", - "value": "string", - "description": "The **`Element.localName`** read-only property returns the local part of the qualified name of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/localName)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "MethodSignature", - "name": "lookupNamespaceURI", - "value": "(prefix: string) => string", - "description": "The **`lookupNamespaceURI()`** method of the Node interface takes a prefix as parameter and returns the namespace URI associated with it on the given node if found (and `null` if not).\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupNamespaceURI)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "MethodSignature", - "name": "lookupPrefix", - "value": "(namespace: string) => string", - "description": "The **`lookupPrefix()`** method of the Node interface returns a string containing the prefix for a given namespace URI, if present, and `null` if not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupPrefix)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "MethodSignature", - "name": "matches", - "value": "(selectors: string) => boolean", - "description": "The **`matches()`** method of the Element interface tests whether the element would be selected by the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "namespaceURI", - "value": "string | null", - "description": "The **`Element.namespaceURI`** read-only property returns the namespace URI of the element, or `null` if the element is not in a namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/namespaceURI)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "nextElementSibling", - "value": "Element | null", - "description": "Returns the first following sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/nextElementSibling)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "nextSibling", - "value": "ChildNode | null", - "description": "The read-only **`nextSibling`** property of the Node interface returns the node immediately following the specified one in their parent's Node.childNodes, or returns `null` if the specified node is the last child in the parent element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nextSibling)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "nodeName", - "value": "string", - "description": "The read-only **`nodeName`** property of Node returns the name of the current node as a string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeName)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "nodeType", - "value": "number", - "description": "The read-only **`nodeType`** property of a Node interface is an integer that identifies what the node is.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeType)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "nodeValue", - "value": "string | null", - "description": "The **`nodeValue`** property of the Node interface returns or sets the value of the current node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeValue)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "nonce", - "value": "string", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/nonce)", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "MethodSignature", - "name": "normalize", - "value": "() => void", - "description": "The **`normalize()`** method of the Node interface puts the specified node and all of its sub-tree into a _normalized_ form.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/normalize)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "NOTATION_NODE", - "value": "12", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "offsetHeight", - "value": "number", - "description": "The **`offsetHeight`** read-only property of the HTMLElement interface returns the height of an element, including vertical padding and borders, as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetHeight)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "offsetLeft", - "value": "number", - "description": "The **`offsetLeft`** read-only property of the HTMLElement interface returns the number of pixels that the _upper left corner_ of the current element is offset to the left within the HTMLElement.offsetParent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetLeft)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "offsetParent", - "value": "Element | null", - "description": "The **`HTMLElement.offsetParent`** read-only property returns a reference to the element which is the closest (nearest in the containment hierarchy) positioned ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetParent)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "offsetTop", - "value": "number", - "description": "The **`offsetTop`** read-only property of the HTMLElement interface returns the distance from the outer border of the current element (including its margin) to the top padding edge of the HTMLelement.offsetParent, the _closest positioned_ ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetTop)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "offsetWidth", - "value": "number", - "description": "The **`offsetWidth`** read-only property of the HTMLElement interface returns the layout width of an element as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetWidth)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onabort", - "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/abort_event)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onanimationcancel", - "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationcancel_event)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onanimationend", - "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onanimationiteration", - "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onanimationstart", - "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onauxclick", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/auxclick_event)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onbeforeinput", - "value": "((this: GlobalEventHandlers, ev: InputEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforeinput_event)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onbeforematch", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforematch_event)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onbeforetoggle", - "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/beforetoggle_event)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onblur", - "value": "((this: GlobalEventHandlers, ev: FocusEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/blur_event)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "oncancel", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/cancel_event)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "oncanplay", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplay_event)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "oncanplaythrough", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplaythrough_event)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onchange", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/change_event)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onclick", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/click_event)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onclose", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/close_event)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "oncontextlost", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextlost_event)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "oncontextmenu", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/contextmenu_event)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "oncontextrestored", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextrestored_event)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "oncopy", - "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/copy_event)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "oncuechange", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLTrackElement/cuechange_event)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "oncut", - "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/cut_event)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ondblclick", - "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/dblclick_event)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ondrag", - "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drag_event)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ondragend", - "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragend_event)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ondragenter", - "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragenter_event)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ondragleave", - "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragleave_event)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ondragover", - "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragover_event)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ondragstart", - "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragstart_event)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ondrop", - "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drop_event)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ondurationchange", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/durationchange_event)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onemptied", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/emptied_event)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onended", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ended_event)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onerror", - "value": "OnErrorEventHandler", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/error_event)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onfocus", - "value": "((this: GlobalEventHandlers, ev: FocusEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/focus_event)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onformdata", - "value": "((this: GlobalEventHandlers, ev: FormDataEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/formdata_event)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onfullscreenchange", - "value": "((this: Element, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenchange_event)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onfullscreenerror", - "value": "((this: Element, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenerror_event)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ongotpointercapture", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/gotpointercapture_event)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "oninput", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/input_event)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "oninvalid", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/invalid_event)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onkeydown", - "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keydown_event)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onkeypress", - "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", - "description": "", - "deprecationMessage": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keypress_event)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onkeyup", - "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keyup_event)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onload", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/load_event)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onloadeddata", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadeddata_event)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onloadedmetadata", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadedmetadata_event)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onloadstart", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadstart_event)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onlostpointercapture", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/lostpointercapture_event)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onmousedown", - "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousedown_event)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onmouseenter", - "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseenter_event)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onmouseleave", - "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseleave_event)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onmousemove", - "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousemove_event)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onmouseout", - "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseout_event)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onmouseover", - "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseover_event)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onmouseup", - "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseup_event)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onpaste", - "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/paste_event)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onpause", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/pause_event)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onplay", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/play_event)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onplaying", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/playing_event)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onpointercancel", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointercancel_event)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onpointerdown", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerdown_event)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onpointerenter", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerenter_event)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onpointerleave", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerleave_event)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onpointermove", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointermove_event)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onpointerout", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerout_event)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onpointerover", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerover_event)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onpointerrawupdate", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "Available only in secure contexts.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerrawupdate_event)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onpointerup", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerup_event)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onprogress", - "value": "((this: GlobalEventHandlers, ev: ProgressEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/progress_event)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onratechange", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ratechange_event)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onreset", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/reset_event)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onresize", - "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLVideoElement/resize_event)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onscroll", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scroll_event)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onscrollend", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scrollend_event)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onsecuritypolicyviolation", - "value": "((this: GlobalEventHandlers, ev: SecurityPolicyViolationEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/securitypolicyviolation_event)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onseeked", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeked_event)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onseeking", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeking_event)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onselect", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/select_event)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onselectionchange", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/selectionchange_event)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onselectstart", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/selectstart_event)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onslotchange", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLSlotElement/slotchange_event)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onstalled", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/stalled_event)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onsubmit", - "value": "((this: GlobalEventHandlers, ev: SubmitEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/submit_event)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onsuspend", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/suspend_event)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ontimeupdate", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/timeupdate_event)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ontoggle", - "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/toggle_event)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ontouchcancel", - "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchcancel_event)", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ontouchend", - "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchend_event)", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ontouchmove", - "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchmove_event)", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ontouchstart", - "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchstart_event)", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ontransitioncancel", - "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitioncancel_event)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ontransitionend", - "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ontransitionrun", - "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionrun_event)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ontransitionstart", - "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionstart_event)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onvolumechange", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/volumechange_event)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onwaiting", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/waiting_event)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onwebkitanimationend", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "", - "deprecationMessage": "This is a legacy alias of `onanimationend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onwebkitanimationiteration", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "", - "deprecationMessage": "This is a legacy alias of `onanimationiteration`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onwebkitanimationstart", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "", - "deprecationMessage": "This is a legacy alias of `onanimationstart`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onwebkittransitionend", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "", - "deprecationMessage": "This is a legacy alias of `ontransitionend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onwheel", - "value": "((this: GlobalEventHandlers, ev: WheelEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/wheel_event)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "outerHTML", - "value": "string", - "description": "The **`outerHTML`** attribute of the Element DOM interface gets the serialized HTML fragment describing the element including its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/outerHTML)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "outerText", - "value": "string", - "description": "The **`outerText`** property of the HTMLElement interface returns the same value as HTMLElement.innerText.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/outerText)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ownerDocument", - "value": "Document", - "description": "The read-only **`ownerDocument`** property of the Node interface returns the top-level document object of the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/ownerDocument)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "parentElement", - "value": "HTMLElement | null", - "description": "The read-only **`parentElement`** property of Node interface returns the DOM node's parent Element, or `null` if the node either has no parent, or its parent isn't a DOM Element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentElement)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "parentNode", - "value": "ParentNode | null", - "description": "The read-only **`parentNode`** property of the Node interface returns the parent of the specified node in the DOM tree.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentNode)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "GetAccessor", - "name": "part", - "value": "DOMTokenList", - "description": "The **`part`** property of the Element interface represents the part identifier(s) of the element (i.e., set using the `part` attribute), returned as a DOMTokenList.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/part)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "popover", - "value": "string | null", - "description": "The **`popover`** property of the HTMLElement interface gets and sets an element's popover state via JavaScript (`'auto'`, `'hint'`, or `'manual'`), and can be used for feature detection.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/popover)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "prefix", - "value": "string | null", - "description": "The **`Element.prefix`** read-only property returns the namespace prefix of the specified element, or `null` if no prefix is specified.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/prefix)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "MethodSignature", - "name": "prepend", - "value": "(...nodes: (string | Node)[]) => void", - "description": "Inserts nodes before the first child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/prepend)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "previousElementSibling", - "value": "Element | null", - "description": "Returns the first preceding sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/previousElementSibling)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "previousSibling", - "value": "ChildNode | null", - "description": "The read-only **`previousSibling`** property of the Node interface returns the node immediately preceding the specified one in its parent's or `null` if the specified node is the first in that list.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/previousSibling)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "PROCESSING_INSTRUCTION_NODE", - "value": "7", - "description": "node is a ProcessingInstruction node." - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "MethodSignature", - "name": "querySelector", - "value": "{ (selectors: K): HTMLElementTagNameMap[K]; (selectors: K): SVGElementTagNameMap[K]; (selectors: K): MathMLElementTagNameMap[K]; (selectors: K): HTMLElementDeprecatedTagNameMap[K]; (selectors: string): E; }", - "description": "Returns the first element that is a descendant of node that matches selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelector)", - "deprecationMessage": "Deprecated" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "MethodSignature", - "name": "querySelectorAll", - "value": "{ (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: string): NodeListOf; }", - "description": "Returns all element descendants of node that match selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelectorAll)", - "deprecationMessage": "Deprecated" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "MethodSignature", - "name": "releasePointerCapture", - "value": "(pointerId: number) => void", - "description": "The **`releasePointerCapture()`** method of the previously set for a specific (PointerEvent) _pointer_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/releasePointerCapture)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "MethodSignature", - "name": "remove", - "value": "() => void", - "description": "Removes node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/remove)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "MethodSignature", - "name": "removeAttribute", - "value": "(qualifiedName: string) => void", - "description": "The Element method **`removeAttribute()`** removes the attribute with the specified name from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttribute)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "MethodSignature", - "name": "removeAttributeNode", - "value": "(attr: Attr) => Attr", - "description": "The **`removeAttributeNode()`** method of the Element interface removes the specified Attr node from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNode)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "MethodSignature", - "name": "removeAttributeNS", - "value": "(namespace: string, localName: string) => void", - "description": "The **`removeAttributeNS()`** method of the If you are working with HTML and you don't need to specify the requested attribute as being part of a specific namespace, use the Element.removeAttribute() method instead.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNS)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "MethodSignature", - "name": "removeChild", - "value": "(child: T) => T", - "description": "The **`removeChild()`** method of the Node interface removes a child node from the DOM and returns the removed node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/removeChild)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "MethodSignature", - "name": "removeEventListener", - "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "MethodSignature", - "name": "replaceChild", - "value": "(node: Node, child: T) => T", - "description": "The **`replaceChild()`** method of the Node interface replaces a child node within the given (parent) node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/replaceChild)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "MethodSignature", - "name": "replaceChildren", - "value": "(...nodes: (string | Node)[]) => void", - "description": "Replace all children of node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/replaceChildren)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "MethodSignature", - "name": "replaceWith", - "value": "(...nodes: (string | Node)[]) => void", - "description": "Replaces node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/replaceWith)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "MethodSignature", - "name": "requestFullscreen", - "value": "(options?: FullscreenOptions) => Promise", - "description": "The **`Element.requestFullscreen()`** method issues an asynchronous request to make the element be displayed in fullscreen mode.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestFullscreen)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "MethodSignature", - "name": "requestPointerLock", - "value": "(options?: PointerLockOptions) => Promise", - "description": "The **`requestPointerLock()`** method of the Element interface lets you asynchronously ask for the pointer to be locked on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestPointerLock)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "role", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/role)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "MethodSignature", - "name": "scroll", - "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", - "description": "The **`scroll()`** method of the Element interface scrolls the element to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scroll)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "MethodSignature", - "name": "scrollBy", - "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", - "description": "The **`scrollBy()`** method of the Element interface scrolls an element by the given amount.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollBy)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "scrollHeight", - "value": "number", - "description": "The **`scrollHeight`** read-only property of the Element interface is a measurement of the height of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollHeight)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "MethodSignature", - "name": "scrollIntoView", - "value": "(arg?: boolean | ScrollIntoViewOptions) => void", - "description": "The Element interface's **`scrollIntoView()`** method scrolls the element's ancestor containers such that the element on which `scrollIntoView()` is called is visible to the user.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollIntoView)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "scrollLeft", - "value": "number", - "description": "The **`scrollLeft`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its left edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollLeft)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "MethodSignature", - "name": "scrollTo", - "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", - "description": "The **`scrollTo()`** method of the Element interface scrolls to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTo)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "scrollTop", - "value": "number", - "description": "The **`scrollTop`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its top edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTop)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "scrollWidth", - "value": "number", - "description": "The **`scrollWidth`** read-only property of the Element interface is a measurement of the width of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollWidth)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "MethodSignature", - "name": "setAttribute", - "value": "(qualifiedName: string, value: string) => void", - "description": "The **`setAttribute()`** method of the Element interface sets the value of an attribute on the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttribute)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "MethodSignature", - "name": "setAttributeNode", - "value": "(attr: Attr) => Attr", - "description": "The **`setAttributeNode()`** method of the Element interface adds a new Attr node to the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNode)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "MethodSignature", - "name": "setAttributeNodeNS", - "value": "(attr: Attr) => Attr", - "description": "The **`setAttributeNodeNS()`** method of the Element interface adds a new namespaced Attr node to an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNodeNS)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "MethodSignature", - "name": "setAttributeNS", - "value": "(namespace: string, qualifiedName: string, value: string) => void", - "description": "`setAttributeNS` adds a new attribute or changes the value of an attribute with the given namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNS)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "MethodSignature", - "name": "setHTMLUnsafe", - "value": "(html: string) => void", - "description": "The **`setHTMLUnsafe()`** method of the Element interface is used to parse a string of HTML into a DocumentFragment, optionally filtering out unwanted elements and attributes, and those that don't belong in the context, and then using it to replace the element's subtree in the DOM.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setHTMLUnsafe)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "MethodSignature", - "name": "setPointerCapture", - "value": "(pointerId: number) => void", - "description": "The **`setPointerCapture()`** method of the _capture target_ of future pointer events.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setPointerCapture)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "shadowRoot", - "value": "ShadowRoot | null", - "description": "The `Element.shadowRoot` read-only property represents the shadow root hosted by the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/shadowRoot)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "MethodSignature", - "name": "showPopover", - "value": "() => void", - "description": "The **`showPopover()`** method of the HTMLElement interface shows a Popover_API element (i.e., one that has a valid `popover` attribute) by adding it to the top layer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/showPopover)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "slot", - "value": "string", - "description": "The **`slot`** property of the Element interface returns the name of the shadow DOM slot the element is inserted in.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/slot)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "spellcheck", - "value": "boolean", - "description": "The **`spellcheck`** property of the HTMLElement interface represents a boolean value that controls the spell-checking hint.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/spellcheck)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "GetAccessor", - "name": "style", - "value": "CSSStyleDeclaration", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/style)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "tabIndex", - "value": "number", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/tabIndex)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "tagName", - "value": "string", - "description": "The **`tagName`** read-only property of the Element interface returns the tag name of the element on which it's called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/tagName)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "TEXT_NODE", - "value": "3", - "description": "node is a Text node." - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "GetAccessor", - "name": "textContent", - "value": "string", - "description": "[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/Node/textContent)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The **`HTMLElement.title`** property represents the title of the element: the text usually displayed in a 'tooltip' popup when the mouse is over the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/title)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "MethodSignature", - "name": "toggleAttribute", - "value": "(qualifiedName: string, force?: boolean) => boolean", - "description": "The **`toggleAttribute()`** method of the present and adding it if it is not present) on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/toggleAttribute)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "MethodSignature", - "name": "togglePopover", - "value": "(options?: boolean) => boolean", - "description": "The **`togglePopover()`** method of the HTMLElement interface toggles a Popover_API element (i.e., one that has a valid `popover` attribute) between the hidden and showing states.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/togglePopover)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "translate", - "value": "boolean", - "description": "The **`translate`** property of the HTMLElement interface indicates whether an element's attribute values and the values of its Text node children are to be translated when the page is localized, or whether to leave them unchanged.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/translate)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "MethodSignature", - "name": "webkitMatchesSelector", - "value": "(selectors: string) => boolean", - "description": "", - "deprecationMessage": "This is a legacy alias of `matches`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" - }, - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "writingSuggestions", - "value": "string", - "description": "The **`writingSuggestions`** property of the HTMLElement interface is a string indicating if browser-provided writing suggestions should be enabled under the scope of the element or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/writingSuggestions)" - } - ], - "value": "export interface UnorderedListElement extends UnorderedListElementProps, Omit {\n}" - } - }, - "UnorderedListProps": { - "src/surfaces/checkout/components/UnorderedList.ts": { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "name": "UnorderedListProps", - "description": "", - "isPublicDocs": true, - "members": [ - { - "filePath": "src/surfaces/checkout/components/UnorderedList.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the element.", - "isOptional": true - } - ], - "value": "export interface UnorderedListProps extends UnorderedListElementProps {\n}" - } - }, - "OrderedListElementProps": { - "src/surfaces/checkout/components/OrderedList.ts": { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "name": "OrderedListElementProps", - "description": "Properties for the OrderedList component element.", - "isPublicDocs": true, - "members": [ - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the element.", - "isOptional": true - } - ], - "value": "export interface OrderedListElementProps extends OrderedListProps$1 {\n}" - } - }, - "OrderedListElement": { - "src/surfaces/checkout/components/OrderedList.ts": { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "name": "OrderedListElement", - "description": "", - "isPublicDocs": true, - "members": [ - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "accessKey", - "value": "string", - "description": "The **`HTMLElement.accessKey`** property sets the keystroke which a user can press to jump to a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKey)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "accessKeyLabel", - "value": "string", - "description": "The **`HTMLElement.accessKeyLabel`** read-only property returns a string containing the element's browser-assigned access key (if any); otherwise it returns an empty string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKeyLabel)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "MethodSignature", - "name": "addEventListener", - "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "MethodSignature", - "name": "after", - "value": "(...nodes: (string | Node)[]) => void", - "description": "Inserts nodes just after node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/after)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "MethodSignature", - "name": "animate", - "value": "(keyframes: Keyframe[] | PropertyIndexedKeyframes, options?: number | KeyframeAnimationOptions) => Animation", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animate)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "MethodSignature", - "name": "append", - "value": "(...nodes: (string | Node)[]) => void", - "description": "Inserts nodes after the last child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/append)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "MethodSignature", - "name": "appendChild", - "value": "(node: T) => T", - "description": "The **`appendChild()`** method of the Node interface adds a node to the end of the list of children of a specified parent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/appendChild)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ariaActiveDescendantElement", - "value": "Element | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaActiveDescendantElement)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ariaAtomic", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAtomic)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ariaAutoComplete", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAutoComplete)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ariaBrailleLabel", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleLabel)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ariaBrailleRoleDescription", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleRoleDescription)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ariaBusy", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBusy)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ariaChecked", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaChecked)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ariaColCount", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColCount)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ariaColIndex", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndex)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ariaColIndexText", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndexText)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ariaColSpan", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColSpan)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ariaControlsElements", - "value": "ReadonlyArray | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaControlsElements)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ariaCurrent", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaCurrent)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ariaDescribedByElements", - "value": "ReadonlyArray | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescribedByElements)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ariaDescription", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescription)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ariaDetailsElements", - "value": "ReadonlyArray | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDetailsElements)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ariaDisabled", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDisabled)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ariaErrorMessageElements", - "value": "ReadonlyArray | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaErrorMessageElements)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ariaExpanded", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaExpanded)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ariaFlowToElements", - "value": "ReadonlyArray | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaFlowToElements)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ariaHasPopup", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHasPopup)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ariaHidden", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHidden)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ariaInvalid", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaInvalid)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ariaKeyShortcuts", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaKeyShortcuts)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ariaLabel", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabel)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ariaLabelledByElements", - "value": "ReadonlyArray | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabelledByElements)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ariaLevel", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLevel)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ariaLive", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLive)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ariaModal", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaModal)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ariaMultiLine", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiLine)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ariaMultiSelectable", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiSelectable)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ariaOrientation", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOrientation)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ariaOwnsElements", - "value": "ReadonlyArray | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOwnsElements)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ariaPlaceholder", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPlaceholder)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ariaPosInSet", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPosInSet)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ariaPressed", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPressed)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ariaReadOnly", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaReadOnly)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ariaRelevant", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRelevant)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ariaRequired", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRequired)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ariaRoleDescription", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRoleDescription)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ariaRowCount", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowCount)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ariaRowIndex", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndex)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ariaRowIndexText", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndexText)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ariaRowSpan", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowSpan)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ariaSelected", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSelected)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ariaSetSize", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSetSize)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ariaSort", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSort)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ariaValueMax", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMax)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ariaValueMin", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMin)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ariaValueNow", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueNow)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ariaValueText", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueText)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "assignedSlot", - "value": "HTMLSlotElement | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/assignedSlot)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "MethodSignature", - "name": "attachInternals", - "value": "() => ElementInternals", - "description": "The **`HTMLElement.attachInternals()`** method returns an ElementInternals object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attachInternals)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "MethodSignature", - "name": "attachShadow", - "value": "(init: ShadowRootInit) => ShadowRoot", - "description": "The **`Element.attachShadow()`** method attaches a shadow DOM tree to the specified element and returns a reference to its ShadowRoot.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attachShadow)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ATTRIBUTE_NODE", - "value": "2", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "NamedNodeMap", - "description": "The **`Element.attributes`** property returns a live collection of all attribute nodes registered to the specified node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attributes)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "attributeStyleMap", - "value": "StylePropertyMap", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attributeStyleMap)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "autocapitalize", - "value": "string", - "description": "The **`autocapitalize`** property of the HTMLElement interface represents the element's capitalization behavior for user input.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocapitalize)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "autocorrect", - "value": "boolean", - "description": "The **`autocorrect`** property of the HTMLElement interface controls whether or not autocorrection of editable text is enabled for spelling and/or punctuation errors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocorrect)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "autofocus", - "value": "boolean", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autofocus)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "baseURI", - "value": "string", - "description": "The read-only **`baseURI`** property of the Node interface returns the absolute base URL of the document containing the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/baseURI)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "MethodSignature", - "name": "before", - "value": "(...nodes: (string | Node)[]) => void", - "description": "Inserts nodes just before node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/before)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "MethodSignature", - "name": "blur", - "value": "() => void", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/blur)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "CDATA_SECTION_NODE", - "value": "4", - "description": "node is a CDATASection node." - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "MethodSignature", - "name": "checkVisibility", - "value": "(options?: CheckVisibilityOptions) => boolean", - "description": "The **`checkVisibility()`** method of the Element interface checks whether the element is visible.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/checkVisibility)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "childElementCount", - "value": "number", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/childElementCount)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "childNodes", - "value": "NodeListOf", - "description": "The read-only **`childNodes`** property of the Node interface returns a live the first child node is assigned index `0`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/childNodes)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "children", - "value": "HTMLCollection", - "description": "Returns the child elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/children)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "GetAccessor", - "name": "classList", - "value": "DOMTokenList", - "description": "The **`Element.classList`** is a read-only property that returns a live DOMTokenList collection of the `class` attributes of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/classList)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "className", - "value": "string", - "description": "The **`className`** property of the of the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/className)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "MethodSignature", - "name": "click", - "value": "() => void", - "description": "The **`HTMLElement.click()`** method simulates a mouse click on an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/click)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "clientHeight", - "value": "number", - "description": "The **`clientHeight`** read-only property of the Element interface is zero for elements with no CSS or inline layout boxes; otherwise, it's the inner height of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientHeight)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "clientLeft", - "value": "number", - "description": "The **`clientLeft`** read-only property of the Element interface returns the width of the left border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientLeft)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "clientTop", - "value": "number", - "description": "The **`clientTop`** read-only property of the Element interface returns the width of the top border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientTop)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "clientWidth", - "value": "number", - "description": "The **`clientWidth`** read-only property of the Element interface is zero for inline elements and elements with no CSS; otherwise, it's the inner width of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientWidth)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "MethodSignature", - "name": "cloneNode", - "value": "(subtree?: boolean) => Node", - "description": "The **`cloneNode()`** method of the Node interface returns a duplicate of the node on which this method was called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/cloneNode)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "MethodSignature", - "name": "closest", - "value": "{ (selector: K): HTMLElementTagNameMap[K]; (selector: K): SVGElementTagNameMap[K]; (selector: K): MathMLElementTagNameMap[K]; (selectors: string): E; }", - "description": "The **`closest()`** method of the Element interface traverses the element and its parents (heading toward the document root) until it finds a node that matches the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/closest)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "COMMENT_NODE", - "value": "8", - "description": "node is a Comment node." - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "MethodSignature", - "name": "compareDocumentPosition", - "value": "(other: Node) => number", - "description": "The **`compareDocumentPosition()`** method of the Node interface reports the position of its argument node relative to the node on which it is called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/compareDocumentPosition)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "MethodSignature", - "name": "computedStyleMap", - "value": "() => StylePropertyMapReadOnly", - "description": "The **`computedStyleMap()`** method of the Element interface returns a StylePropertyMapReadOnly interface which provides a read-only representation of a CSS declaration block that is an alternative to CSSStyleDeclaration.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/computedStyleMap)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "MethodSignature", - "name": "contains", - "value": "(other: Node) => boolean", - "description": "The **`contains()`** method of the Node interface returns a boolean value indicating whether a node is a descendant of a given node, that is the node itself, one of its direct children (Node.childNodes), one of the children's direct children, and so on.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/contains)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "contentEditable", - "value": "string", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/contentEditable)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "currentCSSZoom", - "value": "number", - "description": "The **`currentCSSZoom`** read-only property of the Element interface provides the 'effective' CSS `zoom` of an element, taking into account the zoom applied to the element and all its parent elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/currentCSSZoom)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "dataset", - "value": "DOMStringMap", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dataset)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "dir", - "value": "string", - "description": "The **`HTMLElement.dir`** property indicates the text writing directionality of the content of the current element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dir)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "MethodSignature", - "name": "dispatchEvent", - "value": "(event: Event) => boolean", - "description": "The **`dispatchEvent()`** method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/dispatchEvent)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "DOCUMENT_FRAGMENT_NODE", - "value": "11", - "description": "node is a DocumentFragment node." - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "DOCUMENT_NODE", - "value": "9", - "description": "node is a document." - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "DOCUMENT_POSITION_CONTAINED_BY", - "value": "16", - "description": "Set when other is a descendant of node." - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "DOCUMENT_POSITION_CONTAINS", - "value": "8", - "description": "Set when other is an ancestor of node." - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "DOCUMENT_POSITION_DISCONNECTED", - "value": "1", - "description": "Set when node and other are not in the same tree." - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "DOCUMENT_POSITION_FOLLOWING", - "value": "4", - "description": "Set when other is following node." - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC", - "value": "32", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "DOCUMENT_POSITION_PRECEDING", - "value": "2", - "description": "Set when other is preceding node." - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "DOCUMENT_TYPE_NODE", - "value": "10", - "description": "node is a doctype." - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "draggable", - "value": "boolean", - "description": "The **`draggable`** property of the HTMLElement interface gets and sets a Boolean primitive indicating if the element is draggable.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/draggable)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ELEMENT_NODE", - "value": "1", - "description": "node is an element." - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "enterKeyHint", - "value": "string", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/enterKeyHint)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ENTITY_NODE", - "value": "6", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ENTITY_REFERENCE_NODE", - "value": "5", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "firstChild", - "value": "ChildNode | null", - "description": "The read-only **`firstChild`** property of the Node interface returns the node's first child in the tree, or `null` if the node has no children.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/firstChild)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "firstElementChild", - "value": "Element | null", - "description": "Returns the first child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/firstElementChild)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "MethodSignature", - "name": "focus", - "value": "(options?: FocusOptions) => void", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/focus)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "MethodSignature", - "name": "getAnimations", - "value": "(options?: GetAnimationsOptions) => Animation[]", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAnimations)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "MethodSignature", - "name": "getAttribute", - "value": "(qualifiedName: string) => string", - "description": "The **`getAttribute()`** method of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttribute)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "MethodSignature", - "name": "getAttributeNames", - "value": "() => string[]", - "description": "The **`getAttributeNames()`** method of the array.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNames)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "MethodSignature", - "name": "getAttributeNode", - "value": "(qualifiedName: string) => Attr", - "description": "Returns the specified attribute of the specified element, as an Attr node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNode)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "MethodSignature", - "name": "getAttributeNodeNS", - "value": "(namespace: string, localName: string) => Attr", - "description": "The **`getAttributeNodeNS()`** method of the Element interface returns the namespaced Attr node of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNodeNS)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "MethodSignature", - "name": "getAttributeNS", - "value": "(namespace: string, localName: string) => string", - "description": "The **`getAttributeNS()`** method of the Element interface returns the string value of the attribute with the specified namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNS)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "MethodSignature", - "name": "getBoundingClientRect", - "value": "() => DOMRect", - "description": "The **`Element.getBoundingClientRect()`** method returns a position relative to the viewport.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getBoundingClientRect)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "MethodSignature", - "name": "getClientRects", - "value": "() => DOMRectList", - "description": "The **`getClientRects()`** method of the Element interface returns a collection of DOMRect objects that indicate the bounding rectangles for each CSS border box in a client.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getClientRects)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "MethodSignature", - "name": "getElementsByClassName", - "value": "(classNames: string) => HTMLCollectionOf", - "description": "The Element method **`getElementsByClassName()`** returns a live specified class name or names.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByClassName)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "MethodSignature", - "name": "getElementsByTagName", - "value": "{ (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: string): HTMLCollectionOf; }", - "description": "The **`Element.getElementsByTagName()`** method returns a live All descendants of the specified element are searched, but not the element itself.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagName)", - "deprecationMessage": "Deprecated" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "MethodSignature", - "name": "getElementsByTagNameNS", - "value": "{ (namespaceURI: \"http://www.w3.org/1999/xhtml\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/2000/svg\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/1998/Math/MathML\", localName: string): HTMLCollectionOf; (namespace: string, localName: string): HTMLCollectionOf; }", - "description": "The **`Element.getElementsByTagNameNS()`** method returns a live HTMLCollection of elements with the given tag name belonging to the given namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagNameNS)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "MethodSignature", - "name": "getHTML", - "value": "(options?: GetHTMLOptions) => string", - "description": "The **`getHTML()`** method of the Element interface is used to serialize an element's DOM to an HTML string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getHTML)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "MethodSignature", - "name": "getRootNode", - "value": "(options?: GetRootNodeOptions) => Node", - "description": "The **`getRootNode()`** method of the Node interface returns the context object's root, which optionally includes the shadow root if it is available.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/getRootNode)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "MethodSignature", - "name": "hasAttribute", - "value": "(qualifiedName: string) => boolean", - "description": "The **`Element.hasAttribute()`** method returns a **Boolean** value indicating whether the specified element has the specified attribute or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttribute)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "MethodSignature", - "name": "hasAttributeNS", - "value": "(namespace: string, localName: string) => boolean", - "description": "The **`hasAttributeNS()`** method of the Element interface returns a boolean value indicating whether the current element has the specified attribute with the specified namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributeNS)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "MethodSignature", - "name": "hasAttributes", - "value": "() => boolean", - "description": "The **`hasAttributes()`** method of the Element interface returns a boolean value indicating whether the current element has any attributes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributes)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "MethodSignature", - "name": "hasChildNodes", - "value": "() => boolean", - "description": "The **`hasChildNodes()`** method of the Node interface returns a boolean value indicating whether the given Node has child nodes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/hasChildNodes)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "MethodSignature", - "name": "hasPointerCapture", - "value": "(pointerId: number) => boolean", - "description": "The **`hasPointerCapture()`** method of the pointer capture for the pointer identified by the given pointer ID.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasPointerCapture)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "hidden", - "value": "boolean", - "description": "The HTMLElement property **`hidden`** reflects the value of the element's `hidden` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidden)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "MethodSignature", - "name": "hidePopover", - "value": "() => void", - "description": "The **`hidePopover()`** method of the HTMLElement interface hides a popover element (i.e., one that has a valid `popover` attribute) by removing it from the top layer and styling it with `display: none`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidePopover)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the element.", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "inert", - "value": "boolean", - "description": "The HTMLElement property **`inert`** reflects the value of the element's `inert` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inert)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "innerHTML", - "value": "string", - "description": "The **`innerHTML`** property of the Element interface gets or sets the HTML or XML markup contained within the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/innerHTML)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "innerText", - "value": "string", - "description": "The **`innerText`** property of the HTMLElement interface represents the rendered text content of a node and its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/innerText)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "inputMode", - "value": "string", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inputMode)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "MethodSignature", - "name": "insertAdjacentElement", - "value": "(where: InsertPosition, element: Element) => Element", - "description": "The **`insertAdjacentElement()`** method of the relative to the element it is invoked upon.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentElement)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "MethodSignature", - "name": "insertAdjacentHTML", - "value": "(position: InsertPosition, string: string) => void", - "description": "The **`insertAdjacentHTML()`** method of the the resulting nodes into the DOM tree at a specified position.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentHTML)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "MethodSignature", - "name": "insertAdjacentText", - "value": "(where: InsertPosition, data: string) => void", - "description": "The **`insertAdjacentText()`** method of the Element interface, given a relative position and a string, inserts a new text node at the given position relative to the element it is called from.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentText)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "MethodSignature", - "name": "insertBefore", - "value": "(node: T, child: Node) => T", - "description": "The **`insertBefore()`** method of the Node interface inserts a node before a _reference node_ as a child of a specified _parent node_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/insertBefore)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "isConnected", - "value": "boolean", - "description": "The read-only **`isConnected`** property of the Node interface returns a boolean indicating whether the node is connected (directly or indirectly) to a Document object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isConnected)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "isContentEditable", - "value": "boolean", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/isContentEditable)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "MethodSignature", - "name": "isDefaultNamespace", - "value": "(namespace: string) => boolean", - "description": "The **`isDefaultNamespace()`** method of the Node interface accepts a namespace URI as an argument.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isDefaultNamespace)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "MethodSignature", - "name": "isEqualNode", - "value": "(otherNode: Node) => boolean", - "description": "The **`isEqualNode()`** method of the Node interface tests whether two nodes are equal.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isEqualNode)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "MethodSignature", - "name": "isSameNode", - "value": "(otherNode: Node) => boolean", - "description": "The **`isSameNode()`** method of the Node interface is a legacy alias the for the `===` strict equality operator.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isSameNode)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "lang", - "value": "string", - "description": "The **`lang`** property of the HTMLElement interface indicates the base language of an element's attribute values and text content, in the form of a MISSING: RFC(5646, 'BCP 47 language identifier tag')].\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/lang)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "lastChild", - "value": "ChildNode | null", - "description": "The read-only **`lastChild`** property of the Node interface returns the last child of the node, or `null` if there are no child nodes.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lastChild)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "lastElementChild", - "value": "Element | null", - "description": "Returns the last child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/lastElementChild)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "localName", - "value": "string", - "description": "The **`Element.localName`** read-only property returns the local part of the qualified name of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/localName)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "MethodSignature", - "name": "lookupNamespaceURI", - "value": "(prefix: string) => string", - "description": "The **`lookupNamespaceURI()`** method of the Node interface takes a prefix as parameter and returns the namespace URI associated with it on the given node if found (and `null` if not).\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupNamespaceURI)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "MethodSignature", - "name": "lookupPrefix", - "value": "(namespace: string) => string", - "description": "The **`lookupPrefix()`** method of the Node interface returns a string containing the prefix for a given namespace URI, if present, and `null` if not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupPrefix)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "MethodSignature", - "name": "matches", - "value": "(selectors: string) => boolean", - "description": "The **`matches()`** method of the Element interface tests whether the element would be selected by the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "namespaceURI", - "value": "string | null", - "description": "The **`Element.namespaceURI`** read-only property returns the namespace URI of the element, or `null` if the element is not in a namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/namespaceURI)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "nextElementSibling", - "value": "Element | null", - "description": "Returns the first following sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/nextElementSibling)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "nextSibling", - "value": "ChildNode | null", - "description": "The read-only **`nextSibling`** property of the Node interface returns the node immediately following the specified one in their parent's Node.childNodes, or returns `null` if the specified node is the last child in the parent element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nextSibling)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "nodeName", - "value": "string", - "description": "The read-only **`nodeName`** property of Node returns the name of the current node as a string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeName)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "nodeType", - "value": "number", - "description": "The read-only **`nodeType`** property of a Node interface is an integer that identifies what the node is.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeType)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "nodeValue", - "value": "string | null", - "description": "The **`nodeValue`** property of the Node interface returns or sets the value of the current node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeValue)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "nonce", - "value": "string", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/nonce)", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "MethodSignature", - "name": "normalize", - "value": "() => void", - "description": "The **`normalize()`** method of the Node interface puts the specified node and all of its sub-tree into a _normalized_ form.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/normalize)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "NOTATION_NODE", - "value": "12", - "description": "" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "offsetHeight", - "value": "number", - "description": "The **`offsetHeight`** read-only property of the HTMLElement interface returns the height of an element, including vertical padding and borders, as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetHeight)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "offsetLeft", - "value": "number", - "description": "The **`offsetLeft`** read-only property of the HTMLElement interface returns the number of pixels that the _upper left corner_ of the current element is offset to the left within the HTMLElement.offsetParent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetLeft)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "offsetParent", - "value": "Element | null", - "description": "The **`HTMLElement.offsetParent`** read-only property returns a reference to the element which is the closest (nearest in the containment hierarchy) positioned ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetParent)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "offsetTop", - "value": "number", - "description": "The **`offsetTop`** read-only property of the HTMLElement interface returns the distance from the outer border of the current element (including its margin) to the top padding edge of the HTMLelement.offsetParent, the _closest positioned_ ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetTop)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "offsetWidth", - "value": "number", - "description": "The **`offsetWidth`** read-only property of the HTMLElement interface returns the layout width of an element as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetWidth)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onabort", - "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/abort_event)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onanimationcancel", - "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationcancel_event)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onanimationend", - "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onanimationiteration", - "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onanimationstart", - "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onauxclick", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/auxclick_event)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onbeforeinput", - "value": "((this: GlobalEventHandlers, ev: InputEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforeinput_event)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onbeforematch", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforematch_event)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onbeforetoggle", - "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/beforetoggle_event)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onblur", - "value": "((this: GlobalEventHandlers, ev: FocusEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/blur_event)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "oncancel", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/cancel_event)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "oncanplay", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplay_event)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "oncanplaythrough", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplaythrough_event)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onchange", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/change_event)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onclick", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/click_event)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onclose", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/close_event)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "oncontextlost", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextlost_event)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "oncontextmenu", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/contextmenu_event)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "oncontextrestored", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextrestored_event)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "oncopy", - "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/copy_event)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "oncuechange", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLTrackElement/cuechange_event)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "oncut", - "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/cut_event)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ondblclick", - "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/dblclick_event)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ondrag", - "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drag_event)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ondragend", - "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragend_event)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ondragenter", - "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragenter_event)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ondragleave", - "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragleave_event)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ondragover", - "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragover_event)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ondragstart", - "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragstart_event)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ondrop", - "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drop_event)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ondurationchange", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/durationchange_event)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onemptied", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/emptied_event)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onended", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ended_event)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onerror", - "value": "OnErrorEventHandler", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/error_event)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onfocus", - "value": "((this: GlobalEventHandlers, ev: FocusEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/focus_event)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onformdata", - "value": "((this: GlobalEventHandlers, ev: FormDataEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/formdata_event)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onfullscreenchange", - "value": "((this: Element, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenchange_event)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onfullscreenerror", - "value": "((this: Element, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenerror_event)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ongotpointercapture", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/gotpointercapture_event)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "oninput", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/input_event)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "oninvalid", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/invalid_event)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onkeydown", - "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keydown_event)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onkeypress", - "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", - "description": "", - "deprecationMessage": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keypress_event)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onkeyup", - "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keyup_event)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onload", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/load_event)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onloadeddata", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadeddata_event)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onloadedmetadata", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadedmetadata_event)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onloadstart", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadstart_event)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onlostpointercapture", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/lostpointercapture_event)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onmousedown", - "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousedown_event)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onmouseenter", - "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseenter_event)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onmouseleave", - "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseleave_event)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onmousemove", - "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousemove_event)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onmouseout", - "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseout_event)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onmouseover", - "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseover_event)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onmouseup", - "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseup_event)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onpaste", - "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/paste_event)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onpause", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/pause_event)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onplay", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/play_event)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onplaying", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/playing_event)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onpointercancel", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointercancel_event)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onpointerdown", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerdown_event)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onpointerenter", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerenter_event)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onpointerleave", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerleave_event)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onpointermove", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointermove_event)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onpointerout", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerout_event)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onpointerover", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerover_event)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onpointerrawupdate", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "Available only in secure contexts.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerrawupdate_event)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onpointerup", - "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerup_event)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onprogress", - "value": "((this: GlobalEventHandlers, ev: ProgressEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/progress_event)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onratechange", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ratechange_event)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onreset", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/reset_event)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onresize", - "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLVideoElement/resize_event)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onscroll", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scroll_event)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onscrollend", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scrollend_event)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onsecuritypolicyviolation", - "value": "((this: GlobalEventHandlers, ev: SecurityPolicyViolationEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/securitypolicyviolation_event)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onseeked", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeked_event)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onseeking", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeking_event)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onselect", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/select_event)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onselectionchange", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/selectionchange_event)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onselectstart", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/selectstart_event)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onslotchange", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLSlotElement/slotchange_event)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onstalled", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/stalled_event)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onsubmit", - "value": "((this: GlobalEventHandlers, ev: SubmitEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/submit_event)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onsuspend", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/suspend_event)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ontimeupdate", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/timeupdate_event)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ontoggle", - "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/toggle_event)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ontouchcancel", - "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchcancel_event)", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ontouchend", - "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchend_event)", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ontouchmove", - "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchmove_event)", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ontouchstart", - "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchstart_event)", - "isOptional": true - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ontransitioncancel", - "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitioncancel_event)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ontransitionend", - "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ontransitionrun", - "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionrun_event)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ontransitionstart", - "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionstart_event)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onvolumechange", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/volumechange_event)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onwaiting", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/waiting_event)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onwebkitanimationend", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "", - "deprecationMessage": "This is a legacy alias of `onanimationend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onwebkitanimationiteration", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "", - "deprecationMessage": "This is a legacy alias of `onanimationiteration`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onwebkitanimationstart", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "", - "deprecationMessage": "This is a legacy alias of `onanimationstart`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onwebkittransitionend", - "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", - "description": "", - "deprecationMessage": "This is a legacy alias of `ontransitionend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "onwheel", - "value": "((this: GlobalEventHandlers, ev: WheelEvent) => any) | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/wheel_event)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "outerHTML", - "value": "string", - "description": "The **`outerHTML`** attribute of the Element DOM interface gets the serialized HTML fragment describing the element including its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/outerHTML)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "outerText", - "value": "string", - "description": "The **`outerText`** property of the HTMLElement interface returns the same value as HTMLElement.innerText.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/outerText)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "ownerDocument", - "value": "Document", - "description": "The read-only **`ownerDocument`** property of the Node interface returns the top-level document object of the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/ownerDocument)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "parentElement", - "value": "HTMLElement | null", - "description": "The read-only **`parentElement`** property of Node interface returns the DOM node's parent Element, or `null` if the node either has no parent, or its parent isn't a DOM Element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentElement)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "parentNode", - "value": "ParentNode | null", - "description": "The read-only **`parentNode`** property of the Node interface returns the parent of the specified node in the DOM tree.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentNode)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "GetAccessor", - "name": "part", - "value": "DOMTokenList", - "description": "The **`part`** property of the Element interface represents the part identifier(s) of the element (i.e., set using the `part` attribute), returned as a DOMTokenList.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/part)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "popover", - "value": "string | null", - "description": "The **`popover`** property of the HTMLElement interface gets and sets an element's popover state via JavaScript (`'auto'`, `'hint'`, or `'manual'`), and can be used for feature detection.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/popover)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "prefix", - "value": "string | null", - "description": "The **`Element.prefix`** read-only property returns the namespace prefix of the specified element, or `null` if no prefix is specified.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/prefix)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "MethodSignature", - "name": "prepend", - "value": "(...nodes: (string | Node)[]) => void", - "description": "Inserts nodes before the first child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/prepend)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "previousElementSibling", - "value": "Element | null", - "description": "Returns the first preceding sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/previousElementSibling)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "previousSibling", - "value": "ChildNode | null", - "description": "The read-only **`previousSibling`** property of the Node interface returns the node immediately preceding the specified one in its parent's or `null` if the specified node is the first in that list.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/previousSibling)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "PROCESSING_INSTRUCTION_NODE", - "value": "7", - "description": "node is a ProcessingInstruction node." - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "MethodSignature", - "name": "querySelector", - "value": "{ (selectors: K): HTMLElementTagNameMap[K]; (selectors: K): SVGElementTagNameMap[K]; (selectors: K): MathMLElementTagNameMap[K]; (selectors: K): HTMLElementDeprecatedTagNameMap[K]; (selectors: string): E; }", - "description": "Returns the first element that is a descendant of node that matches selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelector)", - "deprecationMessage": "Deprecated" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "MethodSignature", - "name": "querySelectorAll", - "value": "{ (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: string): NodeListOf; }", - "description": "Returns all element descendants of node that match selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelectorAll)", - "deprecationMessage": "Deprecated" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "MethodSignature", - "name": "releasePointerCapture", - "value": "(pointerId: number) => void", - "description": "The **`releasePointerCapture()`** method of the previously set for a specific (PointerEvent) _pointer_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/releasePointerCapture)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "MethodSignature", - "name": "remove", - "value": "() => void", - "description": "Removes node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/remove)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "MethodSignature", - "name": "removeAttribute", - "value": "(qualifiedName: string) => void", - "description": "The Element method **`removeAttribute()`** removes the attribute with the specified name from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttribute)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "MethodSignature", - "name": "removeAttributeNode", - "value": "(attr: Attr) => Attr", - "description": "The **`removeAttributeNode()`** method of the Element interface removes the specified Attr node from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNode)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "MethodSignature", - "name": "removeAttributeNS", - "value": "(namespace: string, localName: string) => void", - "description": "The **`removeAttributeNS()`** method of the If you are working with HTML and you don't need to specify the requested attribute as being part of a specific namespace, use the Element.removeAttribute() method instead.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNS)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "MethodSignature", - "name": "removeChild", - "value": "(child: T) => T", - "description": "The **`removeChild()`** method of the Node interface removes a child node from the DOM and returns the removed node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/removeChild)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "MethodSignature", - "name": "removeEventListener", - "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "MethodSignature", - "name": "replaceChild", - "value": "(node: Node, child: T) => T", - "description": "The **`replaceChild()`** method of the Node interface replaces a child node within the given (parent) node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/replaceChild)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "MethodSignature", - "name": "replaceChildren", - "value": "(...nodes: (string | Node)[]) => void", - "description": "Replace all children of node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/replaceChildren)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "MethodSignature", - "name": "replaceWith", - "value": "(...nodes: (string | Node)[]) => void", - "description": "Replaces node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/replaceWith)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "MethodSignature", - "name": "requestFullscreen", - "value": "(options?: FullscreenOptions) => Promise", - "description": "The **`Element.requestFullscreen()`** method issues an asynchronous request to make the element be displayed in fullscreen mode.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestFullscreen)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "MethodSignature", - "name": "requestPointerLock", - "value": "(options?: PointerLockOptions) => Promise", - "description": "The **`requestPointerLock()`** method of the Element interface lets you asynchronously ask for the pointer to be locked on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestPointerLock)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "role", - "value": "string | null", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/role)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "MethodSignature", - "name": "scroll", - "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", - "description": "The **`scroll()`** method of the Element interface scrolls the element to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scroll)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "MethodSignature", - "name": "scrollBy", - "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", - "description": "The **`scrollBy()`** method of the Element interface scrolls an element by the given amount.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollBy)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "scrollHeight", - "value": "number", - "description": "The **`scrollHeight`** read-only property of the Element interface is a measurement of the height of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollHeight)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "MethodSignature", - "name": "scrollIntoView", - "value": "(arg?: boolean | ScrollIntoViewOptions) => void", - "description": "The Element interface's **`scrollIntoView()`** method scrolls the element's ancestor containers such that the element on which `scrollIntoView()` is called is visible to the user.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollIntoView)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "scrollLeft", - "value": "number", - "description": "The **`scrollLeft`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its left edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollLeft)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "MethodSignature", - "name": "scrollTo", - "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", - "description": "The **`scrollTo()`** method of the Element interface scrolls to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTo)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "scrollTop", - "value": "number", - "description": "The **`scrollTop`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its top edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTop)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "scrollWidth", - "value": "number", - "description": "The **`scrollWidth`** read-only property of the Element interface is a measurement of the width of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollWidth)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "MethodSignature", - "name": "setAttribute", - "value": "(qualifiedName: string, value: string) => void", - "description": "The **`setAttribute()`** method of the Element interface sets the value of an attribute on the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttribute)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "MethodSignature", - "name": "setAttributeNode", - "value": "(attr: Attr) => Attr", - "description": "The **`setAttributeNode()`** method of the Element interface adds a new Attr node to the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNode)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "MethodSignature", - "name": "setAttributeNodeNS", - "value": "(attr: Attr) => Attr", - "description": "The **`setAttributeNodeNS()`** method of the Element interface adds a new namespaced Attr node to an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNodeNS)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "MethodSignature", - "name": "setAttributeNS", - "value": "(namespace: string, qualifiedName: string, value: string) => void", - "description": "`setAttributeNS` adds a new attribute or changes the value of an attribute with the given namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNS)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "MethodSignature", - "name": "setHTMLUnsafe", - "value": "(html: string) => void", - "description": "The **`setHTMLUnsafe()`** method of the Element interface is used to parse a string of HTML into a DocumentFragment, optionally filtering out unwanted elements and attributes, and those that don't belong in the context, and then using it to replace the element's subtree in the DOM.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setHTMLUnsafe)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "MethodSignature", - "name": "setPointerCapture", - "value": "(pointerId: number) => void", - "description": "The **`setPointerCapture()`** method of the _capture target_ of future pointer events.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setPointerCapture)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "shadowRoot", - "value": "ShadowRoot | null", - "description": "The `Element.shadowRoot` read-only property represents the shadow root hosted by the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/shadowRoot)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "MethodSignature", - "name": "showPopover", - "value": "() => void", - "description": "The **`showPopover()`** method of the HTMLElement interface shows a Popover_API element (i.e., one that has a valid `popover` attribute) by adding it to the top layer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/showPopover)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "slot", - "value": "string", - "description": "The **`slot`** property of the Element interface returns the name of the shadow DOM slot the element is inserted in.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/slot)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "spellcheck", - "value": "boolean", - "description": "The **`spellcheck`** property of the HTMLElement interface represents a boolean value that controls the spell-checking hint.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/spellcheck)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "GetAccessor", - "name": "style", - "value": "CSSStyleDeclaration", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/style)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "tabIndex", - "value": "number", - "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/tabIndex)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "tagName", - "value": "string", - "description": "The **`tagName`** read-only property of the Element interface returns the tag name of the element on which it's called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/tagName)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "TEXT_NODE", - "value": "3", - "description": "node is a Text node." - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "GetAccessor", - "name": "textContent", - "value": "string", - "description": "[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/Node/textContent)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "title", - "value": "string", - "description": "The **`HTMLElement.title`** property represents the title of the element: the text usually displayed in a 'tooltip' popup when the mouse is over the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/title)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "MethodSignature", - "name": "toggleAttribute", - "value": "(qualifiedName: string, force?: boolean) => boolean", - "description": "The **`toggleAttribute()`** method of the present and adding it if it is not present) on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/toggleAttribute)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "MethodSignature", - "name": "togglePopover", - "value": "(options?: boolean) => boolean", - "description": "The **`togglePopover()`** method of the HTMLElement interface toggles a Popover_API element (i.e., one that has a valid `popover` attribute) between the hidden and showing states.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/togglePopover)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "translate", - "value": "boolean", - "description": "The **`translate`** property of the HTMLElement interface indicates whether an element's attribute values and the values of its Text node children are to be translated when the page is localized, or whether to leave them unchanged.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/translate)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "MethodSignature", - "name": "webkitMatchesSelector", - "value": "(selectors: string) => boolean", - "description": "", - "deprecationMessage": "This is a legacy alias of `matches`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" - }, - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "writingSuggestions", - "value": "string", - "description": "The **`writingSuggestions`** property of the HTMLElement interface is a string indicating if browser-provided writing suggestions should be enabled under the scope of the element or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/writingSuggestions)" - } - ], - "value": "export interface OrderedListElement extends OrderedListElementProps, Omit {\n}" - } - }, - "OrderedListProps": { - "src/surfaces/checkout/components/OrderedList.ts": { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "name": "OrderedListProps", - "description": "", - "isPublicDocs": true, - "members": [ - { - "filePath": "src/surfaces/checkout/components/OrderedList.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A unique identifier for the element.", - "isOptional": true - } - ], - "value": "export interface OrderedListProps extends OrderedListElementProps {\n}" -======= - "value": "interface ButtonProps {\n /**\n * A label that describes the purpose or contents of the Button. It will be read to users using assistive technologies such as screen readers.\n *\n * Use this when using only an icon or the button text is not enough context\n * for users using assistive technologies.\n */\n accessibilityLabel?: string;\n /**\n * ID of a component that should respond to activations (e.g. clicks) on this component.\n *\n * See `command` for how to control the behavior of the target.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#commandfor\n */\n commandFor?: string;\n /**\n * Sets the action the `commandFor` should take when this clickable is activated.\n *\n * See the documentation of particular components for the actions they support.\n *\n * - `--auto`: a default action for the target component.\n * - `--show`: shows the target component.\n * - `--hide`: hides the target component.\n * - `--toggle`: toggles the target component.\n * - `--copy`: copies the target ClipboardItem.\n *\n * @default '--auto'\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command\n */\n command?: '--auto' | '--show' | '--hide' | '--toggle' | '--copy';\n /**\n * Disables the button, disallowing any interaction.\n *\n * @defaultValue false\n */\n disabled?: boolean;\n /**\n * The URL to link to.\n *\n * - If set, it will navigate to the location specified by `href` after executing the `onClick` callback.\n * - If a `commandFor` is set, the `command` will be executed instead of the navigation.\n */\n href?: string;\n /**\n * A unique identifier for the element.\n */\n id?: string;\n /**\n * Replaces content with a loading indicator.\n *\n * @defaultValue false\n */\n loading?: boolean;\n /**\n * Specifies where to display the linked URL\n * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#target\n *\n * 'auto' - The target is automatically determined based on the origin of the URL. Surfaces can set specific rules on how they handle each URL.\n * It\u2019s expected that the behavior of `auto` is as `_self` except in specific cases.\n * For example, a surface could decide to open cross-origin URLs in a new window (as `_blank`).\n *\n * @default 'auto'\n */\n target?: 'auto' | '_self' | '_blank';\n /**\n * Sets the tone of the Button, based on the intention of the information being conveyed.\n *\n * @default 'auto'\n */\n tone?: 'auto' | 'neutral' | 'critical';\n /**\n * The behavior of the button.\n *\n * - `'submit'` - Used to indicate the component acts as a submit button, meaning it submits the closest form.\n * - `'button'` - Used to indicate the component acts as a button, meaning it has no default action.\n * - `'reset'` - Used to indicate the component acts as a reset button, meaning it resets the closest form (returning fields to their default values).\n *\n * This property is ignored if the component supports `href` or `commandFor`/`command` and one of them is set.\n *\n * @default 'button'\n */\n type?: 'button' | 'submit';\n /**\n * Changes the visual appearance of the Button.\n *\n * @default 'auto' - the variant is automatically determined by the Button's context\n */\n variant?: 'auto' | 'primary' | 'secondary';\n\n /**\n * Callback when the button is activated.\n * This will be called before the action indicated by `type`.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event\n */\n click?: ((event: CallbackEventListener) => void) | null;\n}" ->>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) - } - }, - "Docs_OrderStatus_MetafieldsApi": { - "src/surfaces/customer-account/api/docs.ts": { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "name": "Docs_OrderStatus_MetafieldsApi", - "description": "", - "isPublicDocs": true, - "members": [ - { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "syntaxKind": "PropertySignature", - "name": "appMetafields", - "value": "SubscribableSignalLike", - "description": "The [metafields](/docs/apps/build/custom-data/metafields) requested in the [`shopify.extension.toml`](/docs/api/customer-account-ui-extensions/latest#configuration) file. Metafields are custom data fields that store additional information on Shopify resources such as products, variants, customers, and the shop. These metafields are updated when there's a change in the merchandise items being purchased by the customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when accessing metafields attached to `customer`, `company`, or `companyLocation` resources." - }, - { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "syntaxKind": "PropertySignature", - "name": "metafields", - "value": "SubscribableSignalLike", - "description": "The [metafields](/docs/apps/build/custom-data/metafields) associated with the order. These metafields are shared across all extensions and persist throughout the checkout session.", - "deprecationMessage": "Use `appMetafields` instead, which provides richer data including the resource type and metafield content type." - } - ], - "value": "export interface Docs_OrderStatus_MetafieldsApi\n extends Pick, 'appMetafields' | 'metafields'> {}" - } - }, - "Docs_OrderStatus_AttributesApi": { - "src/surfaces/customer-account/api/docs.ts": { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "name": "Docs_OrderStatus_AttributesApi", - "description": "", - "isPublicDocs": true, - "members": [ - { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "syntaxKind": "PropertySignature", - "name": "attributes", - "value": "SubscribableSignalLike", - "description": "The custom key-value pairs attached to the order by the customer or by other extensions during cart or checkout. These are commonly used for delivery instructions, gift messages, or other information the buyer provides. The value is `undefined` if no attributes were set." - } - ], - "value": "export interface Docs_OrderStatus_AttributesApi\n extends Pick, 'attributes'> {}" - } - }, - "Docs_OrderStatus_BuyerIdentityApi": { - "src/surfaces/customer-account/api/docs.ts": { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "name": "Docs_OrderStatus_BuyerIdentityApi", - "description": "", - "isPublicDocs": true, - "members": [ - { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "syntaxKind": "PropertySignature", - "name": "buyerIdentity", - "value": "OrderStatusBuyerIdentity", - "description": "The buyer who placed the order, including their customer account, email, phone number, and B2B purchasing company. Use this to personalize the **Order status** page or identify B2B orders.", - "isOptional": true - } - ], - "value": "export interface Docs_OrderStatus_BuyerIdentityApi\n extends Pick, 'buyerIdentity'> {}" - } - }, - "OrderStatusBuyerIdentity": { - "src/surfaces/customer-account/api/order-status/order-status.ts": { - "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", - "name": "OrderStatusBuyerIdentity", - "description": "Information about the buyer who placed the order.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data). The `customer` and `purchasingCompany` properties require level 1 access. The `email` and `phone` properties require level 2 access.", - "members": [ - { - "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", - "syntaxKind": "PropertySignature", - "name": "customer", - "value": "SubscribableSignalLike", - "description": "The buyer's customer account, including their ID and whether they have accepted marketing. The value is `undefined` if the buyer is a guest or hasn't logged in yet." - }, - { - "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", - "syntaxKind": "PropertySignature", - "name": "email", - "value": "SubscribableSignalLike", - "description": "The email address associated with the order. This is the email the buyer provided during checkout for order confirmation and communication. The value is `undefined` if the app doesn't have access to customer data." - }, - { - "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "SubscribableSignalLike", - "description": "The phone number the buyer provided during checkout. The value is `undefined` if no phone number was provided or the app doesn't have access to customer data." - }, - { - "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", - "syntaxKind": "PropertySignature", - "name": "purchasingCompany", - "value": "SubscribableSignalLike<\n OrderStatusPurchasingCompany | undefined\n >", - "description": "The company and company location that a B2B (business-to-business) customer is purchasing on behalf of. Use this to identify the business context of the order. The value is `undefined` if the buyer isn't a B2B customer." - } - ], - "value": "export interface OrderStatusBuyerIdentity {\n /**\n * The buyer's customer account, including their ID and whether they have accepted marketing.\n * The value is `undefined` if the buyer is a guest or hasn't logged in yet.\n */\n customer: SubscribableSignalLike;\n\n /**\n * The email address associated with the order. This is the email the buyer provided during\n * checkout for order confirmation and communication. The value is `undefined` if the app\n * doesn't have access to customer data.\n */\n email: SubscribableSignalLike;\n\n /**\n * The phone number the buyer provided during checkout. The value is `undefined` if no phone\n * number was provided or the app doesn't have access to customer data.\n */\n phone: SubscribableSignalLike;\n\n /**\n * The company and company location that a B2B (business-to-business) customer is purchasing\n * on behalf of. Use this to identify the business context of the order. The value is\n * `undefined` if the buyer isn't a B2B customer.\n */\n purchasingCompany: SubscribableSignalLike<\n OrderStatusPurchasingCompany | undefined\n >;\n}" - } - }, - "OrderStatusCustomer": { - "src/surfaces/customer-account/api/order-status/order-status.ts": { - "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", - "name": "OrderStatusCustomer", - "description": "Information about a customer who has previously purchased from this shop.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data). The `id`, `image`, `acceptsMarketing`, and `storeCreditAccounts` properties require level 1 access. The `email`, `phone`, `fullName`, `firstName`, and `lastName` properties require level 2 access.", - "members": [ - { - "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", - "syntaxKind": "PropertySignature", - "name": "acceptsMarketing", - "value": "boolean", - "description": "Whether the customer has opted in to receiving marketing communications from the merchant, such as email campaigns and promotional offers." - }, - { - "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", - "syntaxKind": "PropertySignature", - "name": "email", - "value": "string", - "description": "The email address associated with the customer's account. The value is `undefined` if the app doesn't have the required access level.", - "isOptional": true - }, - { - "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", - "syntaxKind": "PropertySignature", - "name": "firstName", - "value": "string", - "description": "The customer's first name. The value is `undefined` if the app doesn't have the required access level.", - "isOptional": true - }, - { - "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", - "syntaxKind": "PropertySignature", - "name": "fullName", - "value": "string", - "description": "The customer's full name, typically a combination of first and last name. The value is `undefined` if the app doesn't have the required access level.", - "isOptional": true - }, - { - "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier for the customer in the format `gid://shopify/Customer/`. 'gid://shopify/Customer/123'" - }, - { - "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", - "syntaxKind": "PropertySignature", - "name": "image", - "value": "ImageDetails", - "description": "The customer's profile image, such as a Gravatar avatar. Use this to personalize the extension UI for the logged-in buyer." - }, - { - "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", - "syntaxKind": "PropertySignature", - "name": "lastName", - "value": "string", - "description": "The customer's last name. The value is `undefined` if the app doesn't have the required access level.", - "isOptional": true - }, - { - "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", - "syntaxKind": "PropertySignature", - "name": "phone", - "value": "string", - "description": "The phone number associated with the customer's account. The value is `undefined` if no phone number is on file or the app doesn't have the required access level.", - "isOptional": true - }, - { - "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", - "syntaxKind": "PropertySignature", - "name": "storeCreditAccounts", - "value": "StoreCreditAccount[]", - "description": "The store credit accounts owned by this customer that can be used as payment during checkout. Each account has a balance representing available store credit.", - "isPrivate": true - } - ], - "value": "export interface OrderStatusCustomer {\n /**\n * A globally-unique identifier for the customer in the format `gid://shopify/Customer/`. 'gid://shopify/Customer/123'\n */\n id: string;\n /**\n * The email address associated with the customer's account. The value is `undefined` if the app doesn't have the required access level.\n */\n email?: string;\n /**\n * The phone number associated with the customer's account. The value is `undefined` if no phone number is on file or the app doesn't have the required access level.\n */\n phone?: string;\n /**\n * The customer's full name, typically a combination of first and last name. The value is `undefined` if the app doesn't have the required access level.\n */\n fullName?: string;\n /**\n * The customer's first name. The value is `undefined` if the app doesn't have the required access level.\n */\n firstName?: string;\n /**\n * The customer's last name. The value is `undefined` if the app doesn't have the required access level.\n */\n lastName?: string;\n /**\n * The customer's profile image, such as a Gravatar avatar. Use this to personalize the extension UI for the logged-in buyer.\n */\n image: ImageDetails;\n /**\n * Whether the customer has opted in to receiving marketing communications from the merchant, such as email campaigns and promotional offers.\n */\n acceptsMarketing: boolean;\n /**\n * The store credit accounts owned by this customer that can be used as payment during checkout. Each account has a balance representing available store credit.\n *\n * @private\n */\n storeCreditAccounts: StoreCreditAccount[];\n}" - } - }, - "OrderStatusPurchasingCompany": { - "src/surfaces/customer-account/api/order-status/order-status.ts": { - "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", - "name": "OrderStatusPurchasingCompany", - "description": "Information about a company that the business customer is purchasing on behalf of.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "members": [ - { - "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", - "syntaxKind": "PropertySignature", - "name": "company", - "value": "OrderStatusCompany", - "description": "The company that the B2B customer is purchasing on behalf of, including the company ID, name, and optional external ID." - }, - { - "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", - "syntaxKind": "PropertySignature", - "name": "location", - "value": "OrderStatusCompanyLocation", - "description": "The specific company location where the order is being placed, including the location ID, name, and optional external ID." - } - ], - "value": "export interface OrderStatusPurchasingCompany {\n /**\n * The company that the B2B customer is purchasing on behalf of, including the company ID, name, and optional external ID.\n */\n company: OrderStatusCompany;\n /**\n * The specific company location where the order is being placed, including the location ID, name, and optional external ID.\n */\n location: OrderStatusCompanyLocation;\n}" - } - }, - "OrderStatusCompany": { - "src/surfaces/customer-account/api/order-status/order-status.ts": { - "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", - "name": "OrderStatusCompany", - "description": "{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "members": [ - { - "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", - "syntaxKind": "PropertySignature", - "name": "externalId", - "value": "string", - "description": "A merchant-defined external identifier for the company, often used to map to an ID in an external ERP or CRM system. The value is `undefined` if no external ID has been set.", - "isOptional": true - }, - { - "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier for the company in the format `gid://shopify/Company/`." - }, - { - "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The registered business name of the company, as configured by the merchant in Shopify admin." - } - ], - "value": "export interface OrderStatusCompany {\n /**\n * A globally-unique identifier for the company in the format `gid://shopify/Company/`.\n */\n id: string;\n /**\n * The registered business name of the company, as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * A merchant-defined external identifier for the company, often used to map to an ID in an external ERP or CRM system. The value is `undefined` if no external ID has been set.\n */\n externalId?: string;\n}" - } - }, - "OrderStatusCompanyLocation": { - "src/surfaces/customer-account/api/order-status/order-status.ts": { - "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", - "name": "OrderStatusCompanyLocation", - "description": "{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", - "members": [ - { - "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", - "syntaxKind": "PropertySignature", - "name": "externalId", - "value": "string", - "description": "A merchant-defined external identifier for the company location, often used to map to an ID in an external ERP or CRM system. The value is `undefined` if no external ID has been set.", - "isOptional": true - }, - { - "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier for the company location in the format `gid://shopify/CompanyLocation/`." - }, - { - "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The display name of the company location, such as a branch office or warehouse name." - } - ], - "value": "export interface OrderStatusCompanyLocation {\n /**\n * A globally-unique identifier for the company location in the format `gid://shopify/CompanyLocation/`.\n */\n id: string;\n /**\n * The display name of the company location, such as a branch office or warehouse name.\n */\n name: string;\n /**\n * A merchant-defined external identifier for the company location, often used to map to an ID in an external ERP or CRM system. The value is `undefined` if no external ID has been set.\n */\n externalId?: string;\n}" - } - }, - "Docs_OrderStatus_CheckoutSettingsApi": { - "src/surfaces/customer-account/api/docs.ts": { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "name": "Docs_OrderStatus_CheckoutSettingsApi", - "description": "", - "isPublicDocs": true, - "members": [ - { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "syntaxKind": "PropertySignature", - "name": "checkoutSettings", - "value": "SubscribableSignalLike", - "description": "The checkout settings that were active when the buyer placed the order, such as whether order notes and login are enabled." - } - ], - "value": "export interface Docs_OrderStatus_CheckoutSettingsApi\n extends Pick, 'checkoutSettings'> {}" - } - }, - "Docs_OrderStatus_CostApi": { - "src/surfaces/customer-account/api/docs.ts": { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "name": "Docs_OrderStatus_CostApi", - "description": "", - "isPublicDocs": true, - "members": [ - { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "syntaxKind": "PropertySignature", - "name": "cost", - "value": "CartCost", - "description": "A breakdown of the costs for the order, including the subtotal, shipping, tax, and total amounts." - } - ], - "value": "export interface Docs_OrderStatus_CostApi\n extends Pick, 'cost'> {}" - } - }, - "Docs_OrderStatus_LocalizationApi": { - "src/surfaces/customer-account/api/docs.ts": { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "name": "Docs_OrderStatus_LocalizationApi", - "description": "", - "isPublicDocs": true, - "members": [ - { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "syntaxKind": "PropertySignature", - "name": "localization", - "value": "OrderStatusLocalization", - "description": "The buyer's locale, currency, time zone, country, and market context for the order. Use these values to adapt your extension's content to the buyer's region. For formatted dates, numbers, and translated strings, use the [Localization API](/docs/api/customer-account-ui-extensions/target-apis/platform-apis/localization-api) instead." - } - ], - "value": "export interface Docs_OrderStatus_LocalizationApi\n extends Pick, 'localization'> {}" - } - }, - "OrderStatusLocalization": { - "src/surfaces/customer-account/api/order-status/order-status.ts": { - "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", - "name": "OrderStatusLocalization", - "description": "", - "members": [ - { - "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", - "syntaxKind": "PropertySignature", - "name": "country", - "value": "SubscribableSignalLike", - "description": "The country associated with the order, carried over from the cart context where it was used to contextualize the storefront experience. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown." - }, - { - "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", - "syntaxKind": "PropertySignature", - "name": "currency", - "value": "SubscribableSignalLike", - "description": "The currency used to display money amounts on the **Order status** page. Use this value to format prices and totals in the buyer's expected currency." - }, - { - "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", - "syntaxKind": "PropertySignature", - "name": "extensionLanguage", - "value": "SubscribableSignalLike", - "description": "The best available language match for your extension based on the buyer's language. If the buyer's language is `fr-CA` but your extension only supports `fr`, this returns `fr`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension." - }, - { - "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", - "syntaxKind": "PropertySignature", - "name": "language", - "value": "SubscribableSignalLike", - "description": "The language the buyer sees on the **Order status** page. This reflects the language selected by the buyer or determined by their browser settings, and may differ from the languages your extension supports." - }, - { - "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", - "syntaxKind": "PropertySignature", - "name": "market", - "value": "SubscribableSignalLike", - "description": "The [market](/docs/apps/build/markets) associated with the order, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. The value is `undefined` if the market is unknown." - }, - { - "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", - "syntaxKind": "PropertySignature", - "name": "timezone", - "value": "SubscribableSignalLike", - "description": "The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time." - } - ], - "value": "export interface OrderStatusLocalization {\n /**\n * The currency used to display money amounts on the **Order status** page. Use this value\n * to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, derived from their browser or account settings. Use this value\n * to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees on the **Order status** page. This reflects the language\n * selected by the buyer or determined by their browser settings, and may differ from\n * the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language.\n * If the buyer's language is `fr-CA` but your extension only supports `fr`, this\n * returns `fr`. If your extension doesn't support any variant of the buyer's language,\n * this falls back to your extension's default locale (the `.default.json` translation file).\n * Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country associated with the order, carried over from the cart context where it was\n * used to contextualize the storefront experience. Use this value to display region-specific\n * content such as local support information or regional policies. The value is `undefined`\n * if the buyer's country is unknown.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) associated with the order, carried\n * over from the cart context. Markets group countries and regions with shared pricing,\n * languages, and domains. The value is `undefined` if the market is unknown.\n */\n market: SubscribableSignalLike;\n}" - } - }, - "Docs_OrderStatus_DiscountsApi": { - "src/surfaces/customer-account/api/docs.ts": { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "name": "Docs_OrderStatus_DiscountsApi", - "description": "", - "isPublicDocs": true, - "members": [ - { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "syntaxKind": "PropertySignature", - "name": "discountAllocations", - "value": "SubscribableSignalLike", - "description": "The cart-level discount allocations applied to the order. A discount allocation represents how a discount is distributed across the order. Each allocation includes the discounted amount and one of the following types:\n\n- `CartCodeDiscountAllocation`: A discount the buyer applied by entering a code at checkout.\n- `CartAutomaticDiscountAllocation`: A discount the merchant configured in Shopify admin to apply automatically.\n- `CartCustomDiscountAllocation`: A discount created programmatically by a [Shopify Function](/docs/apps/build/functions)." - }, - { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "syntaxKind": "PropertySignature", - "name": "discountCodes", - "value": "SubscribableSignalLike", - "description": "A list of discount codes that the buyer entered during checkout and that were applied to the order." - } - ], - "value": "export interface Docs_OrderStatus_DiscountsApi\n extends Pick, 'discountAllocations' | 'discountCodes'> {}" - } - }, - "Docs_OrderStatus_GiftCardsApi": { - "src/surfaces/customer-account/api/docs.ts": { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "name": "Docs_OrderStatus_GiftCardsApi", - "description": "", - "isPublicDocs": true, - "members": [ - { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "syntaxKind": "PropertySignature", - "name": "appliedGiftCards", - "value": "SubscribableSignalLike", - "description": "The gift cards that were applied to the order. Each gift card includes the last four characters of the code, the amount used for this order, and the remaining balance." - } - ], - "value": "export interface Docs_OrderStatus_GiftCardsApi\n extends Pick, 'appliedGiftCards'> {}" - } - }, - "Docs_OrderStatus_NoteApi": { - "src/surfaces/customer-account/api/docs.ts": { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "name": "Docs_OrderStatus_NoteApi", - "description": "", - "isPublicDocs": true, - "members": [ - { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "syntaxKind": "PropertySignature", - "name": "note", - "value": "SubscribableSignalLike", - "description": "A note left by the customer to the merchant, either in their cart or during checkout. The value is `undefined` if no note was provided." - } - ], - "value": "export interface Docs_OrderStatus_NoteApi\n extends Pick, 'note'> {}" - } - }, - "Docs_OrderStatus_AddressApi": { - "src/surfaces/customer-account/api/docs.ts": { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "name": "Docs_OrderStatus_AddressApi", - "description": "", - "isPublicDocs": true, - "members": [ - { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "syntaxKind": "PropertySignature", - "name": "billingAddress", - "value": "SubscribableSignalLike", - "description": "The billing address associated with the buyer's payment method for the order. The value is `undefined` if the order doesn't have a billing address on file.", - "isOptional": true - }, - { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "syntaxKind": "PropertySignature", - "name": "shippingAddress", - "value": "SubscribableSignalLike", - "description": "The shipping address that the buyer provided for the order. This is where physical goods are delivered. The value is `undefined` if the order contains only digital products or if a shipping address wasn't required.", - "isOptional": true - } - ], - "value": "export interface Docs_OrderStatus_AddressApi\n extends Pick, 'shippingAddress' | 'billingAddress'> {}" - } - }, - "Docs_OrderStatus_ShopApi": { - "src/surfaces/customer-account/api/docs.ts": { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "name": "Docs_OrderStatus_ShopApi", - "description": "", - "isPublicDocs": true, - "members": [ - { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "syntaxKind": "PropertySignature", - "name": "shop", - "value": "Shop", - "description": "The shop where the order was placed. Includes the shop ID, name, primary storefront URL, and myshopify.com domain." - } - ], - "value": "export interface Docs_OrderStatus_ShopApi\n extends Pick, 'shop'> {}" - } - }, - "Docs_OrderStatus_RequireLoginApi": { - "src/surfaces/customer-account/api/docs.ts": { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "name": "Docs_OrderStatus_RequireLoginApi", - "description": "", - "isPublicDocs": true, - "members": [ - { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "syntaxKind": "PropertySignature", - "name": "requireLogin", - "value": "() => Promise", - "description": "Triggers a login prompt if the customer is viewing a pre-authenticated **Order status** page. Use this to require full authentication before displaying sensitive information in your extension." - } - ], - "value": "export interface Docs_OrderStatus_RequireLoginApi\n extends Pick, 'requireLogin'> {}" - } - }, - "Docs_OrderStatus_AuthenticationStateApi": { - "src/surfaces/customer-account/api/docs.ts": { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "name": "Docs_OrderStatus_AuthenticationStateApi", - "description": "", - "isPublicDocs": true, - "members": [ - { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "syntaxKind": "PropertySignature", - "name": "authenticationState", - "value": "SubscribableSignalLike", - "description": "The buyer's current authentication level on the **Order status** page. Use this to determine whether to display sensitive information or prompt the buyer to log in." - } - ], - "value": "export interface Docs_OrderStatus_AuthenticationStateApi\n extends Pick, 'authenticationState'> {}" - } - }, - "AuthenticationState": { - "src/surfaces/customer-account/api/order-status/order-status.ts": { - "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "AuthenticationState", - "value": "'fully_authenticated' | 'pre_authenticated'", - "description": "The buyer's authentication status on the **Order status** page:\n\n- `'fully_authenticated'`: The buyer has logged in to their customer account.\n- `'pre_authenticated'`: The buyer accessed the page via a direct link, such as from an order confirmation email, without logging in." - } - }, - "Docs_OrderStatus_CartLinesApi": { - "src/surfaces/customer-account/api/docs.ts": { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "name": "Docs_OrderStatus_CartLinesApi", - "description": "", - "isPublicDocs": true, - "members": [ - { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "syntaxKind": "PropertySignature", - "name": "lines", - "value": "SubscribableSignalLike", - "description": "A list of line items in the order. Each line includes the merchandise, quantity, cost, custom attributes, and discount allocations." - } - ], - "value": "export interface Docs_OrderStatus_CartLinesApi\n extends Pick, 'lines'> {}" - } - }, - "Docs_CartLineItem_CartLinesApi": { - "src/surfaces/customer-account/api/docs.ts": { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "name": "Docs_CartLineItem_CartLinesApi", - "description": "", - "isPublicDocs": true, - "members": [ - { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "syntaxKind": "PropertySignature", - "name": "target", - "value": "SubscribableSignalLike", - "description": "The cart line the extension is attached to." - } - ], - "value": "export interface Docs_CartLineItem_CartLinesApi\n extends Pick {}" - } - }, - "Docs_OrderStatus_OrderApi": { - "src/surfaces/customer-account/api/docs.ts": { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "name": "Docs_OrderStatus_OrderApi", - "description": "", - "isPublicDocs": true, - "members": [ - { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "syntaxKind": "PropertySignature", - "name": "order", - "value": "SubscribableSignalLike", - "description": "The order that was placed after checkout completion. Includes the order ID, display name, confirmation number, and timestamps for processing and cancellation. The value is `undefined` if the order hasn't been fully processed yet." - } - ], - "value": "export interface Docs_OrderStatus_OrderApi\n extends Pick, 'order'> {}" - } - }, - "Order": { - "src/surfaces/customer-account/api/order-status/order-status.ts": { - "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", - "name": "Order", - "description": "Information about an order that was placed.", - "members": [ - { - "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", - "syntaxKind": "PropertySignature", - "name": "cancelledAt", - "value": "string", - "description": "The date and time when the order was cancelled, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. The value is `undefined` if the order hasn't been cancelled. Use this to conditionally display cancellation details to the buyer.", - "isOptional": true - }, - { - "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", - "syntaxKind": "PropertySignature", - "name": "confirmationNumber", - "value": "string", - "description": "A randomly generated alphanumeric identifier for the order that the buyer can use when contacting the merchant about their purchase. This is always present for orders created in 2024 and onwards. For older orders, this value may be `undefined`.", - "isOptional": true - }, - { - "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", - "syntaxKind": "PropertySignature", - "name": "id", - "value": "string", - "description": "A globally-unique identifier for the order in the format `gid://shopify/Order/`. Use this to reference the order in the [GraphQL Admin API](/docs/api/admin-graphql).", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'gid://shopify/Order/1'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", - "syntaxKind": "PropertySignature", - "name": "name", - "value": "string", - "description": "The merchant-facing order number prefixed with `#`, such as `#1001`. This is the human-readable identifier displayed to both the merchant in Shopify admin and the buyer on the **Order status** page and in email confirmations.", - "examples": [ - { - "title": "Example", - "description": "", - "tabs": [ - { - "code": "'#1000'", - "title": "Example" - } - ] - } - ] - }, - { - "filePath": "src/surfaces/customer-account/api/order-status/order-status.ts", - "syntaxKind": "PropertySignature", - "name": "processedAt", - "value": "string", - "description": "The date and time when the order was processed, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. An order is processed after the buyer completes checkout and the payment is captured, at which point the order becomes visible in Shopify admin.", - "isOptional": true - } - ], - "value": "export interface Order {\n /**\n * A globally-unique identifier for the order in the format `gid://shopify/Order/`. Use this to reference the order in the [GraphQL Admin API](/docs/api/admin-graphql).\n *\n * @example 'gid://shopify/Order/1'\n */\n id: string;\n\n /**\n * The merchant-facing order number prefixed with `#`, such as `#1001`. This is the human-readable identifier displayed to both the merchant in Shopify admin and the buyer on the **Order status** page and in email confirmations.\n *\n * @example '#1000'\n */\n name: string;\n\n /**\n * The date and time when the order was cancelled, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. The value is `undefined` if the order hasn't been cancelled. Use this to conditionally display cancellation details to the buyer.\n */\n cancelledAt?: string;\n\n /**\n * A randomly generated alphanumeric identifier for the order that the buyer can use when contacting the merchant about their purchase. This is always present for orders created in 2024 and onwards. For older orders, this value may be `undefined`.\n */\n confirmationNumber?: string;\n\n /**\n * The date and time when the order was processed, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. An order is processed after the buyer completes checkout and the payment is captured, at which point the order becomes visible in Shopify admin.\n */\n processedAt?: string;\n}" - } - }, - "Docs_Standard_ExtensionApi": { - "src/surfaces/customer-account/api/docs.ts": { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "name": "Docs_Standard_ExtensionApi", - "description": "", - "isPublicDocs": true, - "members": [ - { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "syntaxKind": "PropertySignature", - "name": "extension", - "value": "Extension", - "description": "Metadata about the extension, including its target, version, and editor context. Use this to conditionally render content based on where the extension is running." - } - ], - "value": "export interface Docs_Standard_ExtensionApi\n extends Pick, 'extension'> {}" - } - }, - "Docs_Standard_AuthenticatedAccountApi": { - "src/surfaces/customer-account/api/docs.ts": { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "name": "Docs_Standard_AuthenticatedAccountApi", - "description": "", - "isPublicDocs": true, - "members": [ - { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "syntaxKind": "PropertySignature", - "name": "authenticatedAccount", - "value": "AuthenticatedAccount", - "description": "The logged-in customer's account information, including their customer ID and B2B company details. Use this to personalize your extension based on who is viewing the page." - } - ], - "value": "export interface Docs_Standard_AuthenticatedAccountApi\n extends Pick, 'authenticatedAccount'> {}" - } - }, - "AuthenticatedAccount": { - "src/surfaces/customer-account/api/shared.ts": { - "filePath": "src/surfaces/customer-account/api/shared.ts", - "name": "AuthenticatedAccount", - "description": "", - "members": [ - { - "filePath": "src/surfaces/customer-account/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "customer", - "value": "SubscribableSignalLike", - "description": "The authenticated customer's account information. The value is `undefined` if the customer isn't logged in." - }, - { - "filePath": "src/surfaces/customer-account/api/shared.ts", - "syntaxKind": "PropertySignature", - "name": "purchasingCompany", - "value": "SubscribableSignalLike", - "description": "The company that the authenticated B2B customer belongs to, including the company ID and location. The value is `undefined` if the customer isn't authenticated or isn't a B2B customer." - } - ], - "value": "export interface AuthenticatedAccount {\n /**\n * The company that the authenticated B2B customer belongs to, including the company ID and location. The value is `undefined` if the customer isn't authenticated or isn't a B2B customer.\n */\n purchasingCompany: SubscribableSignalLike;\n /**\n * The authenticated customer's account information. The value is `undefined` if the customer isn't logged in.\n */\n customer: SubscribableSignalLike;\n}" - } - }, - "Docs_Standard_VersionApi": { - "src/surfaces/customer-account/api/docs.ts": { - "filePath": "src/surfaces/customer-account/api/docs.ts", - "name": "Docs_Standard_VersionApi", - "description": "", - "isPublicDocs": true, - "members": [ - { - "filePath": "src/surfaces/customer-account/api/docs.ts", + "filePath": "src/surfaces/customer-account/api/docs.ts", "syntaxKind": "PropertySignature", "name": "version", "value": "Version", @@ -53031,7 +25399,7 @@ "syntaxKind": "PropertySignature", "name": "applyTrackingConsentChange", "value": "ApplyTrackingConsentChangeType", - "description": "Applies updated tracking consent preferences for the buyer, including their decisions for analytics, marketing, and data sale, along with any custom tracking consent [metafields](/docs/apps/build/custom-data/metafields). Returns a promise that resolves with the result of the consent update.\n\n{% include /apps/checkout/privacy-icon.md %} Requires the [`customer_privacy` capability](/docs/api/customer-account-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent) and access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." + "description": "Applies updated tracking consent preferences for the buyer, including their decisions for analytics, marketing, and data sale, along with any custom tracking consent [metafields](/docs/apps/build/custom-data/metafields). Returns a promise that resolves with the result of the consent update.\n\n{% include /apps/checkout/privacy-icon.md %} Requires the [`collect_buyer_consent` capability](/docs/apps/build/customer-accounts/capabilities#collect-buyer-consent) and access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." }, { "filePath": "src/surfaces/customer-account/api/docs.ts", @@ -53133,7 +25501,7 @@ "syntaxKind": "PropertySignature", "name": "applyTrackingConsentChange", "value": "ApplyTrackingConsentChangeType", - "description": "Applies updated tracking consent preferences for the buyer, including their decisions for analytics, marketing, and data sale, along with any custom tracking consent [metafields](/docs/apps/build/custom-data/metafields). Returns a promise that resolves with the result of the consent update.\n\n{% include /apps/checkout/privacy-icon.md %} Requires the [`customer_privacy` capability](/docs/api/customer-account-ui-extensions/{API_VERSION}/configuration#collect-buyer-consent) and access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." + "description": "Applies updated tracking consent preferences for the buyer, including their decisions for analytics, marketing, and data sale, along with any custom tracking consent [metafields](/docs/apps/build/custom-data/metafields). Returns a promise that resolves with the result of the consent update.\n\n{% include /apps/checkout/privacy-icon.md %} Requires the [`collect_buyer_consent` capability](/docs/apps/build/customer-accounts/capabilities#collect-buyer-consent) and access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." }, { "filePath": "src/surfaces/customer-account/api/docs.ts", @@ -53161,8 +25529,8 @@ "syntaxKind": "PropertySignature", "name": "extensionPoint", "value": "Target", - "description": "The identifier that specifies where in Shopify\u2019s UI your code is being injected. This will be one of the [targets](/docs/api/customer-account-ui-extensions/{API_VERSION}/configuration#targets) you have included in your extension\u2019s configuration file. For more information, refer to the [extension targets overview](/docs/api/customer-account-ui-extensions/{API_VERSION}/extension-targets-overview).", - "deprecationMessage": "Deprecated as of version `2023-07`, use `extension.target` instead.", + "description": "The identifier that specifies where in Shopify’s UI your code is being injected. This will be one of the [targets](/docs/api/customer-account-ui-extensions/{API_VERSION}/configuration#targets) you have included in your extension’s configuration file. For more information, refer to the [extension targets overview](/docs/api/customer-account-ui-extensions/{API_VERSION}/extension-targets-overview).", + "deprecationMessage": "Use `extension.target` instead.", "examples": [ { "title": "Example", @@ -53320,18 +25688,18 @@ "syntaxKind": "PropertySignature", "name": "type", "value": "string", - "description": "The resource type (e.g. `shopify/SubscriptionContract`)." + "description": "The resource type (such as `shopify/SubscriptionContract`)." }, { "filePath": "src/surfaces/customer-account/api/shared.ts", "syntaxKind": "PropertySignature", "name": "value", "value": "string", - "description": "The resource identifier for edit actions (e.g. `gid://shopify/SubscriptionContract/123`).", + "description": "The resource identifier for edit actions (such as `gid://shopify/SubscriptionContract/123`).", "isOptional": true } ], - "value": "export interface IntentQuery extends IntentQueryOptions {\n /**\n * Verb describing the operation to perform on the target resource.\n *\n * Common values include `create` and `open`. The set of\n * allowed verbs is intent-specific; unknown verbs will fail validation.\n */\n action: IntentAction;\n /**\n * The resource type (e.g. `shopify/SubscriptionContract`).\n */\n type: string;\n}" + "value": "export interface IntentQuery extends IntentQueryOptions {\n /**\n * Verb describing the operation to perform on the target resource.\n *\n * Common values include `create` and `open`. The set of\n * allowed verbs is intent-specific; unknown verbs will fail validation.\n */\n action: IntentAction;\n /**\n * The resource type (such as `shopify/SubscriptionContract`).\n */\n type: string;\n}" } }, "IntentAction": { @@ -53463,11 +25831,11 @@ "syntaxKind": "PropertySignature", "name": "value", "value": "string", - "description": "The resource identifier for edit actions (e.g. `gid://shopify/SubscriptionContract/123`).", + "description": "The resource identifier for edit actions (such as `gid://shopify/SubscriptionContract/123`).", "isOptional": true } ], - "value": "export interface IntentQueryOptions {\n /**\n * The resource identifier for edit actions (e.g. `gid://shopify/SubscriptionContract/123`).\n */\n value?: string;\n /**\n * Optional input payload passed to the intent. Used to seed forms or supply parameters. The accepted shape is intent-specific. For example, replacing a payment method on a subscription contract requires `{ field: 'paymentMethod' }`.\n */\n data?: Record;\n}" + "value": "export interface IntentQueryOptions {\n /**\n * The resource identifier for edit actions (such as `gid://shopify/SubscriptionContract/123`).\n */\n value?: string;\n /**\n * Optional input payload passed to the intent. Used to seed forms or supply parameters. The accepted shape is intent-specific. For example, replacing a payment method on a subscription contract requires `{ field: 'paymentMethod' }`.\n */\n data?: Record;\n}" } }, "Docs_Page_Button_PrimaryAction": { @@ -53507,7 +25875,7 @@ "syntaxKind": "PropertySignature", "name": "commandFor", "value": "string", - "description": "The `id` of a component that should respond to activations on this button. See `command` for how to control the behavior of the target.", + "description": "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).", "isOptional": true }, { @@ -53537,7 +25905,7 @@ "defaultValue": "false" } ], - "value": "export interface Docs_Page_Button_PrimaryAction\n extends Pick<\n ButtonProps,\n | 'click'\n | 'loading'\n | 'disabled'\n | 'accessibilityLabel'\n | 'href'\n | 'command'\n | 'commandFor'\n > {\n /**\n * A label that describes the button's purpose to assistive technologies. Use this when the button text alone doesn't provide enough context.\n */\n accessibilityLabel?: ButtonProps['accessibilityLabel'];\n /**\n * A callback that fires when the button is activated, before the action indicated by `type`.\n */\n click?: ButtonProps['click'];\n /**\n * The action the `commandFor` target should take when this button is activated.\n *\n * - `--auto`: A default action for the target component.\n * - `--show`: Shows the target component.\n * - `--hide`: Hides the target component.\n * - `--toggle`: Toggles the target component.\n * - `--copy`: Copies the target ClipboardItem.\n *\n * @default '--auto'\n */\n command?: ButtonProps['command'];\n /**\n * The `id` of a component that should respond to activations on this button. See `command` for how to control the behavior of the target.\n */\n commandFor?: ButtonProps['commandFor'];\n /**\n * Whether the button is disabled and non-interactive.\n *\n * @default false\n */\n disabled?: ButtonProps['disabled'];\n /**\n * The URL to navigate to when the button is activated. If a `commandFor` is set, the `command` is executed instead of the navigation.\n */\n href?: ButtonProps['href'];\n /**\n * Whether to replace the button content with a loading indicator.\n *\n * @default false\n */\n loading?: ButtonProps['loading'];\n}" + "value": "export interface Docs_Page_Button_PrimaryAction\n extends Pick<\n ButtonProps,\n | 'click'\n | 'loading'\n | 'disabled'\n | 'accessibilityLabel'\n | 'href'\n | 'command'\n | 'commandFor'\n > {\n /**\n * A label that describes the button's purpose to assistive technologies. Use this when the button text alone doesn't provide enough context.\n */\n accessibilityLabel?: ButtonProps['accessibilityLabel'];\n /**\n * A callback that fires when the button is activated, before the action indicated by `type`.\n */\n click?: ButtonProps['click'];\n /**\n * The action the `commandFor` target should take when this button is activated.\n *\n * - `--auto`: A default action for the target component.\n * - `--show`: Shows the target component.\n * - `--hide`: Hides the target component.\n * - `--toggle`: Toggles the target component.\n * - `--copy`: Copies the target ClipboardItem.\n *\n * @default '--auto'\n */\n command?: ButtonProps['command'];\n /**\n * 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).\n */\n commandFor?: ButtonProps['commandFor'];\n /**\n * Whether the button is disabled and non-interactive.\n *\n * @default false\n */\n disabled?: ButtonProps['disabled'];\n /**\n * The URL to navigate to when the button is activated. If a `commandFor` is set, the `command` is executed instead of the navigation.\n */\n href?: ButtonProps['href'];\n /**\n * Whether to replace the button content with a loading indicator.\n *\n * @default false\n */\n loading?: ButtonProps['loading'];\n}" } }, "Docs_Page_Button_SecondaryAction": { @@ -53577,7 +25945,7 @@ "syntaxKind": "PropertySignature", "name": "commandFor", "value": "string", - "description": "The `id` of a component that should respond to activations on this button. See `command` for how to control the behavior of the target.", + "description": "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).", "isOptional": true }, { @@ -53607,7 +25975,7 @@ "defaultValue": "false" } ], - "value": "export interface Docs_Page_Button_SecondaryAction\n extends Pick<\n ButtonProps,\n | 'click'\n | 'loading'\n | 'disabled'\n | 'accessibilityLabel'\n | 'href'\n | 'command'\n | 'commandFor'\n > {\n /**\n * A label that describes the button's purpose to assistive technologies. Use this when the button text alone doesn't provide enough context.\n */\n accessibilityLabel?: ButtonProps['accessibilityLabel'];\n /**\n * A callback that fires when the button is activated, before the action indicated by `type`.\n */\n click?: ButtonProps['click'];\n /**\n * The action the `commandFor` target should take when this button is activated.\n *\n * - `--auto`: A default action for the target component.\n * - `--show`: Shows the target component.\n * - `--hide`: Hides the target component.\n * - `--toggle`: Toggles the target component.\n * - `--copy`: Copies the target ClipboardItem.\n *\n * @default '--auto'\n */\n command?: ButtonProps['command'];\n /**\n * The `id` of a component that should respond to activations on this button. See `command` for how to control the behavior of the target.\n */\n commandFor?: ButtonProps['commandFor'];\n /**\n * Whether the button is disabled and non-interactive.\n *\n * @default false\n */\n disabled?: ButtonProps['disabled'];\n /**\n * The URL to navigate to when the button is activated. If a `commandFor` is set, the `command` is executed instead of the navigation.\n */\n href?: ButtonProps['href'];\n /**\n * Whether to replace the button content with a loading indicator.\n *\n * @default false\n */\n loading?: ButtonProps['loading'];\n}" + "value": "export interface Docs_Page_Button_SecondaryAction\n extends Pick<\n ButtonProps,\n | 'click'\n | 'loading'\n | 'disabled'\n | 'accessibilityLabel'\n | 'href'\n | 'command'\n | 'commandFor'\n > {\n /**\n * A label that describes the button's purpose to assistive technologies. Use this when the button text alone doesn't provide enough context.\n */\n accessibilityLabel?: ButtonProps['accessibilityLabel'];\n /**\n * A callback that fires when the button is activated, before the action indicated by `type`.\n */\n click?: ButtonProps['click'];\n /**\n * The action the `commandFor` target should take when this button is activated.\n *\n * - `--auto`: A default action for the target component.\n * - `--show`: Shows the target component.\n * - `--hide`: Hides the target component.\n * - `--toggle`: Toggles the target component.\n * - `--copy`: Copies the target ClipboardItem.\n *\n * @default '--auto'\n */\n command?: ButtonProps['command'];\n /**\n * 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).\n */\n commandFor?: ButtonProps['commandFor'];\n /**\n * Whether the button is disabled and non-interactive.\n *\n * @default false\n */\n disabled?: ButtonProps['disabled'];\n /**\n * The URL to navigate to when the button is activated. If a `commandFor` is set, the `command` is executed instead of the navigation.\n */\n href?: ButtonProps['href'];\n /**\n * Whether to replace the button content with a loading indicator.\n *\n * @default false\n */\n loading?: ButtonProps['loading'];\n}" } }, "Docs_Page_Button_BreadcrumbAction": { @@ -53672,7 +26040,7 @@ "syntaxKind": "PropertySignature", "name": "command", "value": "'--auto' | '--show' | '--hide' | '--toggle' | '--copy'", - "description": "Sets the action the `commandFor` should take when this clickable is activated.\n\nSee the documentation of particular components for the actions they support.\n\n- `--auto`: a default action for the target component.\n- `--show`: shows the target component.\n- `--hide`: hides the target component.\n- `--toggle`: toggles the target component.\n- `--copy`: copies the target ClipboardItem.", + "description": "Sets the action the `commandFor` target should take when this component is activated.\n\n- `--auto`: A default action for the target component.\n- `--show`: Shows the target component.\n- `--hide`: Hides the target component.\n- `--toggle`: Toggles the target component.\n- `--copy`: Copies the target clipboard item.\n\nLearn more about the [`command` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).", "isOptional": true, "defaultValue": "'--auto'" }, @@ -53681,7 +26049,7 @@ "syntaxKind": "PropertySignature", "name": "commandFor", "value": "string", - "description": "ID of a component that should respond to activations (e.g. clicks) on this component.\n\nSee `command` for how to control the behavior of the target.", + "description": "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).", "isOptional": true }, { @@ -53741,7 +26109,7 @@ "syntaxKind": "PropertySignature", "name": "type", "value": "'button' | 'submit'", - "description": "The behavior of the button.\n\n- `'submit'` - Used to indicate the component acts as a submit button, meaning it submits the closest form.\n- `'button'` - Used to indicate the component acts as a button, meaning it has no default action.\n- `'reset'` - Used to indicate the component acts as a reset button, meaning it resets the closest form (returning fields to their default values).\n\nThis property is ignored if the component supports `href` or `commandFor`/`command` and one of them is set.", + "description": "The behavior of the button.\n\n- `'submit'`: Submits the nearest containing form.\n- `'button'`: Performs no default action, relying on the `click` event handler for behavior.\n\nThis property is ignored if the component supports `href` or `commandFor`/`command` and one of them is set.", "isOptional": true, "defaultValue": "'button'" } @@ -53838,7 +26206,7 @@ "syntaxKind": "PropertySignature", "name": "command", "value": "'--auto' | '--show' | '--hide' | '--toggle' | '--copy'", - "description": "Sets the action the `commandFor` should take when this clickable is activated.\n\nSee the documentation of particular components for the actions they support.\n\n- `--auto`: a default action for the target component.\n- `--show`: shows the target component.\n- `--hide`: hides the target component.\n- `--toggle`: toggles the target component.\n- `--copy`: copies the target ClipboardItem.", + "description": "Sets the action the `commandFor` target should take when this component is activated.\n\n- `--auto`: A default action for the target component.\n- `--show`: Shows the target component.\n- `--hide`: Hides the target component.\n- `--toggle`: Toggles the target component.\n- `--copy`: Copies the target clipboard item.\n\nLearn more about the [`command` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).", "isOptional": true, "defaultValue": "'--auto'" }, @@ -53847,7 +26215,7 @@ "syntaxKind": "PropertySignature", "name": "commandFor", "value": "string", - "description": "ID of a component that should respond to activations (e.g. clicks) on this component.\n\nSee `command` for how to control the behavior of the target.", + "description": "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).", "isOptional": true }, { @@ -53880,13 +26248,11 @@ "value": "export interface Docs_CustomerAccountAction_SlotButton\n extends Pick<\n ButtonProps,\n | 'click'\n | 'loading'\n | 'disabled'\n | 'accessibilityLabel'\n | 'href'\n | 'command'\n | 'commandFor'\n > {}" } }, -<<<<<<< HEAD -======= "ButtonElementProps": { "src/surfaces/checkout/components/Button.ts": { "filePath": "src/surfaces/checkout/components/Button.ts", "name": "ButtonElementProps", - "description": "Properties for the Button component element.", + "description": "", "isPublicDocs": true, "members": [ { @@ -53894,7 +26260,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityLabel", "value": "string", - "description": "A label that describes the purpose or contents of the Button. It will be read to users using assistive technologies such as screen readers.\n\nUse this when using only an icon or the Button text is not enough context for users using assistive technologies.", + "description": "A label that describes the purpose or content of the button for users of assistive technologies such as screen readers. Use this when the visible content alone doesn't provide enough context.", "isOptional": true }, { @@ -53902,7 +26268,7 @@ "syntaxKind": "PropertySignature", "name": "command", "value": "'--auto' | '--show' | '--hide' | '--toggle' | '--copy'", - "description": "Sets the action the `commandFor` should take when this clickable is activated.\n\nSee the documentation of particular components for the actions they support.\n\n- `--auto`: a default action for the target component.\n- `--show`: shows the target component.\n- `--hide`: hides the target component.\n- `--toggle`: toggles the target component.\n- `--copy`: copies the target ClipboardItem.", + "description": "Sets the action the `commandFor` target should take when this component is activated.\n\n- `--auto`: Performs the default action for the target component.\n- `--show`: Displays the target component.\n- `--hide`: Conceals the target component.\n- `--toggle`: Alternates the target component.\n- `--copy`: Copies the target ClipboardItem.\n\nLearn more about the [`command` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).", "isOptional": true, "defaultValue": "'--auto'" }, @@ -53911,7 +26277,7 @@ "syntaxKind": "PropertySignature", "name": "commandFor", "value": "string", - "description": "ID of a component that should respond to activations (e.g. clicks) on this component.\n\nSee `command` for how to control the behavior of the target.", + "description": "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).\n\nWhen both `commandFor` and `href` are set, `commandFor` takes precedence. The command runs and the link doesn't navigate.", "isOptional": true }, { @@ -53919,7 +26285,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the Button meaning it cannot be clicked or receive focus.", + "description": "Whether the button is disabled, preventing it from being clicked or receiving focus.", "isOptional": true, "defaultValue": "false" }, @@ -53928,7 +26294,7 @@ "syntaxKind": "PropertySignature", "name": "href", "value": "string", - "description": "The URL to link to.\n\n- If set, it will navigate to the location specified by `href` after executing the `click` event.\n- If a `commandFor` is set, the `command` will be executed instead of the navigation.", + "description": "The URL to navigate to when clicked. The `click` event fires first, then navigation occurs.\n\n- If set, it will navigate to the location specified by `href` after executing the `click` event.\n- If a `commandFor` is set, the `command` will be executed instead of the navigation.", "isOptional": true }, { @@ -53944,7 +26310,7 @@ "syntaxKind": "PropertySignature", "name": "inlineSize", "value": "'auto' | 'fill' | 'fit-content'", - "description": "The displayed inline width of the Button.\n\n- `auto`: the size of the button depends on the surface and context.\n- `fill`: the button will takes up 100% of the available inline size.\n- `fit-content`: the button will take up the minimum inline-size required to fit its content.", + "description": "The inline width of the button component.\n\n- `auto`: The size depends on the surface and context.\n- `fill`: The button takes up 100% of the available inline size.\n- `fit-content`: The button takes up the minimum inline-size required to fit its content.", "isOptional": true, "defaultValue": "'auto'" }, @@ -53953,7 +26319,7 @@ "syntaxKind": "PropertySignature", "name": "interestFor", "value": "string", - "description": "ID of a component that should respond to interest (e.g. hover and focus) on this component.", + "description": "The ID of the component to show when users hover over or focus on this component. Pair with a target component that supports interest-based interactions. Learn more about the [interestFor attribute](https://open-ui.org/components/interest-invokers.explainer/#the-pitch-in-code).", "isOptional": true }, { @@ -53961,7 +26327,7 @@ "syntaxKind": "PropertySignature", "name": "loading", "value": "boolean", - "description": "Replaces content with a loading indicator while a background action is being performed.\n\nThis also disables the Button.", + "description": "Whether the button is in a loading state, which replaces the button content with a loading indicator while a background action is being performed.\n\nThis also disables the button.", "isOptional": true, "defaultValue": "false" }, @@ -53979,7 +26345,7 @@ "syntaxKind": "PropertySignature", "name": "tone", "value": "'auto' | 'neutral' | 'critical'", - "description": "Sets the tone of the Button based on the intention of the information being conveyed.", + "description": "The semantic meaning and color treatment of the button.\n\n- `'auto'`: Automatically determined based on context.\n- `'neutral'`: General information without specific intent.\n- `'critical'`: Urgent problems or destructive actions.", "isOptional": true, "defaultValue": "'auto'" }, @@ -53988,7 +26354,7 @@ "syntaxKind": "PropertySignature", "name": "type", "value": "'submit' | 'button'", - "description": "The behavior of the Button.\n\n- `submit`: Used to indicate the component acts as a submit button, meaning it submits the closest form.\n- `button`: Used to indicate the component acts as a button, meaning it has no default action.\n- `reset`: Used to indicate the component acts as a reset button, meaning it resets the closest form (returning fields to their default values).\n\nThis property is ignored if the component supports `href` or `commandFor`/`command` and one of them is set.", + "description": "The behavioral type of the button component, which determines what action it performs when activated.\n\n- `submit`: Submits the nearest containing form.\n- `button`: Performs no default action, relying on the `click` event handler for behavior.\n\nThis property is ignored if `href` or `commandFor`/`command` is set.", "isOptional": true, "defaultValue": "'button'" }, @@ -53997,12 +26363,12 @@ "syntaxKind": "PropertySignature", "name": "variant", "value": "'auto' | 'primary' | 'secondary'", - "description": "Changes the visual appearance of the Button.", + "description": "The visual style variant of the button component, which controls its prominence and emphasis.\n\n- `'auto'`: Automatically determined by the button's context.\n- `'primary'`: High-emphasis style for the main action.\n- `'secondary'`: Medium-emphasis style for supporting actions.\n- `'tertiary'`: Low-emphasis style for less prominent actions.", "isOptional": true, - "defaultValue": "'auto' - the variant is automatically determined by the Button's context" + "defaultValue": "'auto'" } ], - "value": "export interface ButtonElementProps extends Pick {\n target?: Extract;\n tone?: Extract;\n type?: Extract;\n variant?: Extract;\n}" + "value": "export interface ButtonElementProps extends Pick {\n target?: Extract;\n tone?: Extract;\n /**\n * The behavioral type of the button component, which determines what action it performs when activated.\n *\n * - `submit`: Submits the nearest containing form.\n * - `button`: Performs no default action, relying on the `click` event handler for behavior.\n *\n * This property is ignored if `href` or `commandFor`/`command` is set.\n *\n * @default 'button'\n */\n type?: Extract;\n variant?: Extract;\n}" } }, "ButtonEvents": { @@ -54017,7 +26383,7 @@ "syntaxKind": "PropertySignature", "name": "onClick", "value": "(event: Event) => void", - "description": "Callback when the Button is activated. This will be called before the action indicated by `type`.", + "description": "A callback fired when the button is activated, before performing the action indicated by `type`. Learn more about the [click event](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event).", "isOptional": true } ], @@ -54028,7 +26394,7 @@ "src/surfaces/checkout/components/Button.ts": { "filePath": "src/surfaces/checkout/components/Button.ts", "name": "ButtonElementEvents", - "description": "Events for the Button component element.", + "description": "", "isPublicDocs": true, "members": [ { @@ -54036,11 +26402,11 @@ "syntaxKind": "PropertySignature", "name": "click", "value": "CallbackEventListener", - "description": "Callback when the button is activated. This will be called before the action indicated by `type`.", + "description": "A callback fired when the button is clicked. This will be called before the action indicated by `type`.\n\nLearn more about the [click event](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event).", "isOptional": true } ], - "value": "export interface ButtonElementEvents {\n /**\n * Callback when the button is activated.\n * This will be called before the action indicated by `type`.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event\n */\n click?: CallbackEventListener;\n}" + "value": "export interface ButtonElementEvents {\n /**\n * A callback fired when the button is clicked. This will be called before the action indicated by `type`.\n *\n * Learn more about the [click event](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event).\n */\n click?: CallbackEventListener;\n}" } }, "ButtonElement": { @@ -54055,7 +26421,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityLabel", "value": "string", - "description": "A label that describes the purpose or contents of the Button. It will be read to users using assistive technologies such as screen readers.\n\nUse this when using only an icon or the Button text is not enough context for users using assistive technologies.", + "description": "A label that describes the purpose or content of the button for users of assistive technologies such as screen readers. Use this when the visible content alone doesn't provide enough context.", "isOptional": true }, { @@ -54077,7 +26443,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", @@ -54651,7 +27017,7 @@ "syntaxKind": "PropertySignature", "name": "command", "value": "'--auto' | '--show' | '--hide' | '--toggle' | '--copy'", - "description": "Sets the action the `commandFor` should take when this clickable is activated.\n\nSee the documentation of particular components for the actions they support.\n\n- `--auto`: a default action for the target component.\n- `--show`: shows the target component.\n- `--hide`: hides the target component.\n- `--toggle`: toggles the target component.\n- `--copy`: copies the target ClipboardItem.", + "description": "Sets the action the `commandFor` target should take when this component is activated.\n\n- `--auto`: Performs the default action for the target component.\n- `--show`: Displays the target component.\n- `--hide`: Conceals the target component.\n- `--toggle`: Alternates the target component.\n- `--copy`: Copies the target ClipboardItem.\n\nLearn more about the [`command` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).", "isOptional": true, "defaultValue": "'--auto'" }, @@ -54660,7 +27026,7 @@ "syntaxKind": "PropertySignature", "name": "commandFor", "value": "string", - "description": "ID of a component that should respond to activations (e.g. clicks) on this component.\n\nSee `command` for how to control the behavior of the target.", + "description": "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).\n\nWhen both `commandFor` and `href` are set, `commandFor` takes precedence. The command runs and the link doesn't navigate.", "isOptional": true }, { @@ -54724,7 +27090,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the Button meaning it cannot be clicked or receive focus.", + "description": "Whether the button is disabled, preventing it from being clicked or receiving focus.", "isOptional": true, "defaultValue": "false" }, @@ -55000,7 +27366,7 @@ "syntaxKind": "PropertySignature", "name": "href", "value": "string", - "description": "The URL to link to.\n\n- If set, it will navigate to the location specified by `href` after executing the `click` event.\n- If a `commandFor` is set, the `command` will be executed instead of the navigation.", + "description": "The URL to navigate to when clicked. The `click` event fires first, then navigation occurs.\n\n- If set, it will navigate to the location specified by `href` after executing the `click` event.\n- If a `commandFor` is set, the `command` will be executed instead of the navigation.", "isOptional": true }, { @@ -55023,7 +27389,7 @@ "syntaxKind": "PropertySignature", "name": "inlineSize", "value": "'auto' | 'fill' | 'fit-content'", - "description": "The displayed inline width of the Button.\n\n- `auto`: the size of the button depends on the surface and context.\n- `fill`: the button will takes up 100% of the available inline size.\n- `fit-content`: the button will take up the minimum inline-size required to fit its content.", + "description": "The inline width of the button component.\n\n- `auto`: The size depends on the surface and context.\n- `fill`: The button takes up 100% of the available inline size.\n- `fit-content`: The button takes up the minimum inline-size required to fit its content.", "isOptional": true, "defaultValue": "'auto'" }, @@ -55081,7 +27447,7 @@ "syntaxKind": "PropertySignature", "name": "interestFor", "value": "string", - "description": "ID of a component that should respond to interest (e.g. hover and focus) on this component.", + "description": "The ID of the component to show when users hover over or focus on this component. Pair with a target component that supports interest-based interactions. Learn more about the [interestFor attribute](https://open-ui.org/components/interest-invokers.explainer/#the-pitch-in-code).", "isOptional": true }, { @@ -55145,7 +27511,7 @@ "syntaxKind": "PropertySignature", "name": "loading", "value": "boolean", - "description": "Replaces content with a loading indicator while a background action is being performed.\n\nThis also disables the Button.", + "description": "Whether the button is in a loading state, which replaces the button content with a loading indicator while a background action is being performed.\n\nThis also disables the button.", "isOptional": true, "defaultValue": "false" }, @@ -56146,7 +28512,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/Button.ts", @@ -56386,7 +28752,7 @@ "syntaxKind": "PropertySignature", "name": "tone", "value": "'auto' | 'neutral' | 'critical'", - "description": "Sets the tone of the Button based on the intention of the information being conveyed.", + "description": "The semantic meaning and color treatment of the button.\n\n- `'auto'`: Automatically determined based on context.\n- `'neutral'`: General information without specific intent.\n- `'critical'`: Urgent problems or destructive actions.", "isOptional": true, "defaultValue": "'auto'" }, @@ -56402,7 +28768,7 @@ "syntaxKind": "PropertySignature", "name": "type", "value": "'submit' | 'button'", - "description": "The behavior of the Button.\n\n- `submit`: Used to indicate the component acts as a submit button, meaning it submits the closest form.\n- `button`: Used to indicate the component acts as a button, meaning it has no default action.\n- `reset`: Used to indicate the component acts as a reset button, meaning it resets the closest form (returning fields to their default values).\n\nThis property is ignored if the component supports `href` or `commandFor`/`command` and one of them is set.", + "description": "The behavioral type of the button component, which determines what action it performs when activated.\n\n- `submit`: Submits the nearest containing form.\n- `button`: Performs no default action, relying on the `click` event handler for behavior.\n\nThis property is ignored if `href` or `commandFor`/`command` is set.", "isOptional": true, "defaultValue": "'button'" }, @@ -56411,9 +28777,9 @@ "syntaxKind": "PropertySignature", "name": "variant", "value": "'auto' | 'primary' | 'secondary'", - "description": "Changes the visual appearance of the Button.", + "description": "The visual style variant of the button component, which controls its prominence and emphasis.\n\n- `'auto'`: Automatically determined by the button's context.\n- `'primary'`: High-emphasis style for the main action.\n- `'secondary'`: Medium-emphasis style for supporting actions.\n- `'tertiary'`: Low-emphasis style for less prominent actions.", "isOptional": true, - "defaultValue": "'auto' - the variant is automatically determined by the Button's context" + "defaultValue": "'auto'" }, { "filePath": "src/surfaces/checkout/components/Button.ts", @@ -56438,7 +28804,7 @@ "src/surfaces/checkout/components/Checkbox.ts": { "filePath": "src/surfaces/checkout/components/Checkbox.ts", "name": "CheckboxElementProps", - "description": "Configure the following properties on the checkbox component.", + "description": "", "isPublicDocs": true, "members": [ { @@ -56454,7 +28820,7 @@ "syntaxKind": "PropertySignature", "name": "checked", "value": "boolean", - "description": "Whether the control is active.", + "description": "Whether the control is currently checked.", "isOptional": true, "defaultValue": "false" }, @@ -56463,7 +28829,7 @@ "syntaxKind": "PropertySignature", "name": "command", "value": "'--auto' | '--show' | '--hide' | '--toggle'", - "description": "Sets the action the `commandFor` should take when this clickable is activated.\n\nSee the documentation of particular components for the actions they support.\n\n- `--auto`: a default action for the target component.\n- `--show`: shows the target component.\n- `--hide`: hides the target component.\n- `--toggle`: toggles the target component.\n- `--copy`: copies the target ClipboardItem.", + "description": "Sets the action the `commandFor` target should take when this component is activated.\n\n- `--auto`: Performs the default action for the target component.\n- `--show`: Displays the target component.\n- `--hide`: Conceals the target component.\n- `--toggle`: Alternates the target component.\n- `--copy`: Copies the target ClipboardItem.\n\nLearn more about the [`command` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).", "isOptional": true, "defaultValue": "'--auto'" }, @@ -56472,7 +28838,7 @@ "syntaxKind": "PropertySignature", "name": "commandFor", "value": "string", - "description": "ID of a component that should respond to activations (e.g. clicks) on this component.\n\nSee `command` for how to control the behavior of the target.", + "description": "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).\n\nWhen both `commandFor` and `href` are set, `commandFor` takes precedence. The command runs and the link doesn't navigate.", "isOptional": true }, { @@ -56480,7 +28846,7 @@ "syntaxKind": "PropertySignature", "name": "defaultChecked", "value": "boolean", - "description": "Whether the control is active by default.", + "description": "Whether the control is checked by default.", "isOptional": true, "defaultValue": "false" }, @@ -56489,7 +28855,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the control, disallowing any interaction.", + "description": "Whether the control is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -56514,7 +28880,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "The text displayed as the control label, which identifies the purpose of the control to users. This label is associated with the control for accessibility.", + "description": "The visual content to use as the control label. Use a string to provide a simple text label displayed to the user.\n\nIf a `label` slot is also provided, the slot content takes precedence. [Learn more about slots](/docs/api/{API_NAME}/{API_VERSION}/web-components/forms/checkbox#slots-propertydetail-label).", "isOptional": true }, { @@ -56522,7 +28888,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the control that is unique within the nearest containing `Form` component.", + "description": "The name attribute for the control, used to identify its value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -56530,7 +28896,7 @@ "syntaxKind": "PropertySignature", "name": "required", "value": "boolean", - "description": "Whether the field needs a value. This requirement adds semantic value to the field, but it will not cause an error to appear automatically. If you want to present an error when this field is empty, you can do so with the `error` property.", + "description": "Whether the field needs a value. This requirement adds semantic value to the field, but it will not cause an error to appear automatically. If you want to present an error when this field is empty, you can do so with the `error` property.\n\nAdds semantic meaning for accessibility. Doesn't trigger automatic validation or display an error. Implement validation logic yourself and use the `error` prop to show results.", "isOptional": true, "defaultValue": "false" }, @@ -56543,7 +28909,7 @@ "isOptional": true } ], - "value": "export interface CheckboxElementProps extends Pick {\n command?: Extract;\n}" + "value": "export interface CheckboxElementProps extends Pick {\n command?: Extract;\n /**\n * The visual content to use as the control label. Use a string to provide a simple text label displayed to the user.\n *\n * If a `label` slot is also provided, the slot content takes precedence. [Learn more about slots](/docs/api/{API_NAME}/{API_VERSION}/web-components/forms/checkbox#slots-propertydetail-label).\n */\n label?: string;\n}" } }, "CheckboxEvents": { @@ -56569,7 +28935,7 @@ "src/surfaces/checkout/components/Checkbox.ts": { "filePath": "src/surfaces/checkout/components/Checkbox.ts", "name": "CheckboxElementEvents", - "description": "The checkbox component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", + "description": "", "isPublicDocs": true, "members": [ { @@ -56618,7 +28984,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/Checkbox.ts", @@ -57101,7 +29467,7 @@ "syntaxKind": "PropertySignature", "name": "checked", "value": "boolean", - "description": "Whether the control is active.", + "description": "Whether the control is currently checked.", "isOptional": true, "defaultValue": "false" }, @@ -57201,7 +29567,7 @@ "syntaxKind": "PropertySignature", "name": "command", "value": "'--auto' | '--show' | '--hide' | '--toggle'", - "description": "Sets the action the `commandFor` should take when this clickable is activated.\n\nSee the documentation of particular components for the actions they support.\n\n- `--auto`: a default action for the target component.\n- `--show`: shows the target component.\n- `--hide`: hides the target component.\n- `--toggle`: toggles the target component.\n- `--copy`: copies the target ClipboardItem.", + "description": "Sets the action the `commandFor` target should take when this component is activated.\n\n- `--auto`: Performs the default action for the target component.\n- `--show`: Displays the target component.\n- `--hide`: Conceals the target component.\n- `--toggle`: Alternates the target component.\n- `--copy`: Copies the target ClipboardItem.\n\nLearn more about the [`command` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).", "isOptional": true, "defaultValue": "'--auto'" }, @@ -57210,7 +29576,7 @@ "syntaxKind": "PropertySignature", "name": "commandFor", "value": "string", - "description": "ID of a component that should respond to activations (e.g. clicks) on this component.\n\nSee `command` for how to control the behavior of the target.", + "description": "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).\n\nWhen both `commandFor` and `href` are set, `commandFor` takes precedence. The command runs and the link doesn't navigate.", "isOptional": true }, { @@ -57267,7 +29633,7 @@ "syntaxKind": "PropertySignature", "name": "defaultChecked", "value": "boolean", - "description": "Whether the control is active by default.", + "description": "Whether the control is checked by default.", "isOptional": true, "defaultValue": "false" }, @@ -57283,7 +29649,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the control, disallowing any interaction.", + "description": "Whether the control is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -57666,7 +30032,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "The text displayed as the control label, which identifies the purpose of the control to users. This label is associated with the control for accessibility.", + "description": "The visual content to use as the control label. Use a string to provide a simple text label displayed to the user.\n\nIf a `label` slot is also provided, the slot content takes precedence. [Learn more about slots](/docs/api/{API_NAME}/{API_VERSION}/web-components/forms/checkbox#slots-propertydetail-label).", "isOptional": true }, { @@ -57723,7 +30089,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the control that is unique within the nearest containing `Form` component.", + "description": "The name attribute for the control, used to identify its value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -58695,7 +31061,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/Checkbox.ts", @@ -58737,7 +31103,7 @@ "syntaxKind": "PropertySignature", "name": "required", "value": "boolean", - "description": "Whether the field needs a value. This requirement adds semantic value to the field, but it will not cause an error to appear automatically. If you want to present an error when this field is empty, you can do so with the `error` property.", + "description": "Whether the field needs a value. This requirement adds semantic value to the field, but it will not cause an error to appear automatically. If you want to present an error when this field is empty, you can do so with the `error` property.\n\nAdds semantic meaning for accessibility. Doesn't trigger automatic validation or display an error. Implement validation logic yourself and use the `error` prop to show results.", "isOptional": true, "defaultValue": "false" }, @@ -58964,6 +31330,25 @@ "value": "export interface CheckboxElement extends CheckboxElementProps, Omit {\n onchange: CheckboxEvents['onChange'];\n}" } }, + "CheckboxElementSlots": { + "src/surfaces/checkout/components/Checkbox.ts": { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "name": "CheckboxElementSlots", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "label", + "value": "HTMLElement", + "description": "The visual content to use as the control label.\n\nUse an `HTMLElement` as a rich control label composed of elements. Only an `s-text` element is supported with plain text and `s-link` as its only allowed children. Any other elements are stripped while preserving their text content.", + "isOptional": true + } + ], + "value": "export interface CheckboxElementSlots {\n /**\n * The visual content to use as the control label.\n *\n * Use an `HTMLElement` as a rich control label composed of elements. Only an `s-text` element is supported with plain text and `s-link` as its only allowed children. Any other elements are stripped while preserving their text content.\n */\n label?: HTMLElement;\n}" + } + }, "CheckboxProps": { "src/surfaces/checkout/components/Checkbox.ts": { "filePath": "src/surfaces/checkout/components/Checkbox.ts", @@ -58984,7 +31369,7 @@ "syntaxKind": "PropertySignature", "name": "checked", "value": "boolean", - "description": "Whether the control is active.", + "description": "Whether the control is currently checked.", "isOptional": true, "defaultValue": "false" }, @@ -58993,7 +31378,7 @@ "syntaxKind": "PropertySignature", "name": "command", "value": "'--auto' | '--show' | '--hide' | '--toggle'", - "description": "Sets the action the `commandFor` should take when this clickable is activated.\n\nSee the documentation of particular components for the actions they support.\n\n- `--auto`: a default action for the target component.\n- `--show`: shows the target component.\n- `--hide`: hides the target component.\n- `--toggle`: toggles the target component.\n- `--copy`: copies the target ClipboardItem.", + "description": "Sets the action the `commandFor` target should take when this component is activated.\n\n- `--auto`: Performs the default action for the target component.\n- `--show`: Displays the target component.\n- `--hide`: Conceals the target component.\n- `--toggle`: Alternates the target component.\n- `--copy`: Copies the target ClipboardItem.\n\nLearn more about the [`command` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).", "isOptional": true, "defaultValue": "'--auto'" }, @@ -59002,7 +31387,7 @@ "syntaxKind": "PropertySignature", "name": "commandFor", "value": "string", - "description": "ID of a component that should respond to activations (e.g. clicks) on this component.\n\nSee `command` for how to control the behavior of the target.", + "description": "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).\n\nWhen both `commandFor` and `href` are set, `commandFor` takes precedence. The command runs and the link doesn't navigate.", "isOptional": true }, { @@ -59010,7 +31395,7 @@ "syntaxKind": "PropertySignature", "name": "defaultChecked", "value": "boolean", - "description": "Whether the control is active by default.", + "description": "Whether the control is checked by default.", "isOptional": true, "defaultValue": "false" }, @@ -59019,7 +31404,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the control, disallowing any interaction.", + "description": "Whether the control is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -59044,7 +31429,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "The text displayed as the control label, which identifies the purpose of the control to users. This label is associated with the control for accessibility.", + "description": "The visual content to use as the control label. Use a string to provide a simple text label displayed to the user.\n\nIf a `label` slot is also provided, the slot content takes precedence. [Learn more about slots](/docs/api/{API_NAME}/{API_VERSION}/web-components/forms/checkbox#slots-propertydetail-label).", "isOptional": true }, { @@ -59052,7 +31437,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the control that is unique within the nearest containing `Form` component.", + "description": "The name attribute for the control, used to identify its value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -59068,7 +31453,7 @@ "syntaxKind": "PropertySignature", "name": "required", "value": "boolean", - "description": "Whether the field needs a value. This requirement adds semantic value to the field, but it will not cause an error to appear automatically. If you want to present an error when this field is empty, you can do so with the `error` property.", + "description": "Whether the field needs a value. This requirement adds semantic value to the field, but it will not cause an error to appear automatically. If you want to present an error when this field is empty, you can do so with the `error` property.\n\nAdds semantic meaning for accessibility. Doesn't trigger automatic validation or display an error. Implement validation logic yourself and use the `error` prop to show results.", "isOptional": true, "defaultValue": "false" }, @@ -59165,7 +31550,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/TextField.ts", @@ -61174,7 +33559,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/TextField.ts", @@ -61501,7 +33886,7 @@ "src/surfaces/checkout/components/TextField.ts": { "filePath": "src/surfaces/checkout/components/TextField.ts", "name": "TextFieldElementProps", - "description": "Configure the following properties on the text field component.", + "description": "", "isPublicDocs": true, "members": [ { @@ -61509,7 +33894,7 @@ "syntaxKind": "PropertySignature", "name": "autocomplete", "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", "isOptional": true, "defaultValue": "'on' for everything else" }, @@ -61526,7 +33911,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -61586,7 +33971,7 @@ "syntaxKind": "PropertySignature", "name": "minLength", "value": "number", - "description": "Specifies the min number of characters allowed.", + "description": "Specifies the minimum number of characters allowed.", "isOptional": true, "defaultValue": "0" }, @@ -61613,7 +33998,7 @@ "syntaxKind": "PropertySignature", "name": "prefix", "value": "string", - "description": "A value to be displayed immediately before the editable portion of the field.\n\nThis is useful for displaying an implied part of the value, such as \"https://\" or \"+353\".\n\nThis cannot be edited by the user, and it isn't included in the value of the field.\n\nIt may not be displayed until the user has interacted with the input. For example, an inline label may take the place of the prefix until the user focuses the input.", + "description": "A value to be displayed immediately before the editable portion of the field.\n\nThis is useful for displaying an implied part of the value, such as \"https://\" or \"+353\".\n\nThis can't be edited by the user, and it isn't included in the value of the field.\n\nIt may not be displayed until the user has interacted with the input. For example, an inline label may take the place of the prefix until the user focuses the input.", "isOptional": true, "defaultValue": "''" }, @@ -61640,7 +34025,7 @@ "syntaxKind": "PropertySignature", "name": "suffix", "value": "string", - "description": "A value to be displayed immediately after the editable portion of the field.\n\nThis is useful for displaying an implied part of the value, such as \"@shopify.com\", or \"%\".\n\nThis cannot be edited by the user, and it isn't included in the value of the field.\n\nIt may not be displayed until the user has interacted with the input. For example, an inline label may take the place of the suffix until the user focuses the input.", + "description": "A value to be displayed immediately after the editable portion of the field.\n\nThis is useful for displaying an implied part of the value, such as \"@shopify.com\", or \"%\".\n\nThis can't be edited by the user, and it isn't included in the value of the field.\n\nIt may not be displayed until the user has interacted with the input. For example, an inline label may take the place of the suffix until the user focuses the input.", "isOptional": true, "defaultValue": "''" }, @@ -61676,7 +34061,7 @@ "syntaxKind": "PropertySignature", "name": "onChange", "value": "(event: Event) => void", - "description": "A callback fired when the user has **finished editing** a field, such as when they blur the field or press Enter. Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", + "description": "A callback fired when the user has **finished editing** a field, such as when they blur the field or press Enter.", "isOptional": true }, { @@ -61692,7 +34077,7 @@ "syntaxKind": "PropertySignature", "name": "onInput", "value": "(event: Event) => void", - "description": "A callback fired when the user makes any changes in the field, such as typing a character. Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).", + "description": "A callback fired when the user makes any changes in the field, such as typing a character.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).", "isOptional": true } ], @@ -61703,7 +34088,7 @@ "src/surfaces/checkout/components/TextField.ts": { "filePath": "src/surfaces/checkout/components/TextField.ts", "name": "TextFieldElementEvents", - "description": "The text field component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", + "description": "", "isPublicDocs": true, "members": [ { @@ -61711,7 +34096,7 @@ "syntaxKind": "PropertySignature", "name": "blur", "value": "CallbackEventListener", - "description": "A callback fired when the text field loses focus.\n\nLearn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "description": "<<<<<<< HEAD A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n======= A callback fired when the text field loses focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) \n Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", "isOptional": true }, { @@ -61719,7 +34104,7 @@ "syntaxKind": "PropertySignature", "name": "change", "value": "CallbackEventListener", - "description": "A callback fired when the text field value changes.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", + "description": "<<<<<<< HEAD Callback when the user has **finished editing** a field, for example, once they have blurred the field.\n======= A callback fired when the text field value changes.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) \n Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", "isOptional": true }, { @@ -61727,7 +34112,7 @@ "syntaxKind": "PropertySignature", "name": "focus", "value": "CallbackEventListener", - "description": "A callback fired when the text field receives focus.\n\nLearn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "description": "<<<<<<< HEAD A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n======= A callback fired when the text field receives focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) \n Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", "isOptional": true }, { @@ -61739,14 +34124,14 @@ "isOptional": true } ], - "value": "export interface TextFieldElementEvents {\n /**\n * A callback fired when the text field loses focus.\n *\n * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur?: CallbackEventListener;\n /**\n * A callback fired when the text field value changes.\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change?: CallbackEventListener;\n /**\n * A callback fired when the text field receives focus.\n *\n * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus?: CallbackEventListener;\n /**\n * A callback fired when the user inputs data into the text field.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input?: CallbackEventListener;\n}" + "value": "export interface TextFieldElementEvents {\n /**\n<<<<<<< HEAD\n * A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n=======\n * A callback fired when the text field loses focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality)\n *\n * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur?: CallbackEventListener;\n /**\n<<<<<<< HEAD\n * Callback when the user has **finished editing** a field, for example, once they have blurred the field.\n=======\n * A callback fired when the text field value changes.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality)\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change?: CallbackEventListener;\n /**\n<<<<<<< HEAD\n * A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n=======\n * A callback fired when the text field receives focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality)\n *\n * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus?: CallbackEventListener;\n /**\n * A callback fired when the user inputs data into the text field.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input?: CallbackEventListener;\n}" } }, "TextFieldElementSlots": { "src/surfaces/checkout/components/TextField.ts": { "filePath": "src/surfaces/checkout/components/TextField.ts", "name": "TextFieldElementSlots", - "description": "The text field component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", + "description": "", "isPublicDocs": true, "members": [ { @@ -61787,7 +34172,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/TextField.ts", @@ -62228,7 +34613,7 @@ "syntaxKind": "PropertySignature", "name": "autocomplete", "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", "isOptional": true, "defaultValue": "'on' for everything else" }, @@ -62434,7 +34819,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -62900,7 +35285,7 @@ "syntaxKind": "PropertySignature", "name": "minLength", "value": "number", - "description": "Specifies the min number of characters allowed.", + "description": "Specifies the minimum number of characters allowed.", "isOptional": true, "defaultValue": "0" }, @@ -63798,7 +36183,7 @@ "syntaxKind": "PropertySignature", "name": "prefix", "value": "string", - "description": "A value to be displayed immediately before the editable portion of the field.\n\nThis is useful for displaying an implied part of the value, such as \"https://\" or \"+353\".\n\nThis cannot be edited by the user, and it isn't included in the value of the field.\n\nIt may not be displayed until the user has interacted with the input. For example, an inline label may take the place of the prefix until the user focuses the input.", + "description": "A value to be displayed immediately before the editable portion of the field.\n\nThis is useful for displaying an implied part of the value, such as \"https://\" or \"+353\".\n\nThis can't be edited by the user, and it isn't included in the value of the field.\n\nIt may not be displayed until the user has interacted with the input. For example, an inline label may take the place of the prefix until the user focuses the input.", "isOptional": true, "defaultValue": "''" }, @@ -63902,7 +36287,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/TextField.ts", @@ -64093,7 +36478,7 @@ "syntaxKind": "PropertySignature", "name": "suffix", "value": "string", - "description": "A value to be displayed immediately after the editable portion of the field.\n\nThis is useful for displaying an implied part of the value, such as \"@shopify.com\", or \"%\".\n\nThis cannot be edited by the user, and it isn't included in the value of the field.\n\nIt may not be displayed until the user has interacted with the input. For example, an inline label may take the place of the suffix until the user focuses the input.", + "description": "A value to be displayed immediately after the editable portion of the field.\n\nThis is useful for displaying an implied part of the value, such as \"@shopify.com\", or \"%\".\n\nThis can't be edited by the user, and it isn't included in the value of the field.\n\nIt may not be displayed until the user has interacted with the input. For example, an inline label may take the place of the suffix until the user focuses the input.", "isOptional": true, "defaultValue": "''" }, @@ -64192,7 +36577,7 @@ "syntaxKind": "PropertySignature", "name": "autocomplete", "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", "isOptional": true, "defaultValue": "'on' for everything else" }, @@ -64209,7 +36594,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -64268,7 +36653,7 @@ "syntaxKind": "PropertySignature", "name": "minLength", "value": "number", - "description": "Specifies the min number of characters allowed.", + "description": "Specifies the minimum number of characters allowed.", "isOptional": true, "defaultValue": "0" }, @@ -64293,7 +36678,7 @@ "syntaxKind": "PropertySignature", "name": "onChange", "value": "(event: Event) => void", - "description": "A callback fired when the user has **finished editing** a field, such as when they blur the field or press Enter. Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", + "description": "A callback fired when the user has **finished editing** a field, such as when they blur the field or press Enter.", "isOptional": true }, { @@ -64309,7 +36694,7 @@ "syntaxKind": "PropertySignature", "name": "onInput", "value": "(event: Event) => void", - "description": "A callback fired when the user makes any changes in the field, such as typing a character. Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).", + "description": "A callback fired when the user makes any changes in the field, such as typing a character.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).", "isOptional": true }, { @@ -64327,7 +36712,7 @@ "syntaxKind": "PropertySignature", "name": "prefix", "value": "string", - "description": "A value to be displayed immediately before the editable portion of the field.\n\nThis is useful for displaying an implied part of the value, such as \"https://\" or \"+353\".\n\nThis cannot be edited by the user, and it isn't included in the value of the field.\n\nIt may not be displayed until the user has interacted with the input. For example, an inline label may take the place of the prefix until the user focuses the input.", + "description": "A value to be displayed immediately before the editable portion of the field.\n\nThis is useful for displaying an implied part of the value, such as \"https://\" or \"+353\".\n\nThis can't be edited by the user, and it isn't included in the value of the field.\n\nIt may not be displayed until the user has interacted with the input. For example, an inline label may take the place of the prefix until the user focuses the input.", "isOptional": true, "defaultValue": "''" }, @@ -64354,7 +36739,7 @@ "syntaxKind": "PropertySignature", "name": "suffix", "value": "string", - "description": "A value to be displayed immediately after the editable portion of the field.\n\nThis is useful for displaying an implied part of the value, such as \"@shopify.com\", or \"%\".\n\nThis cannot be edited by the user, and it isn't included in the value of the field.\n\nIt may not be displayed until the user has interacted with the input. For example, an inline label may take the place of the suffix until the user focuses the input.", + "description": "A value to be displayed immediately after the editable portion of the field.\n\nThis is useful for displaying an implied part of the value, such as \"@shopify.com\", or \"%\".\n\nThis can't be edited by the user, and it isn't included in the value of the field.\n\nIt may not be displayed until the user has interacted with the input. For example, an inline label may take the place of the suffix until the user focuses the input.", "isOptional": true, "defaultValue": "''" }, @@ -64374,7 +36759,7 @@ "src/surfaces/checkout/components/Select.ts": { "filePath": "src/surfaces/checkout/components/Select.ts", "name": "SelectElementProps", - "description": "Configure the following properties on the select component.", + "description": "", "isPublicDocs": true, "members": [ { @@ -64382,7 +36767,7 @@ "syntaxKind": "PropertySignature", "name": "autocomplete", "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", "isOptional": true, "defaultValue": "'on' for everything else" }, @@ -64391,7 +36776,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -64476,7 +36861,7 @@ "syntaxKind": "PropertySignature", "name": "onChange", "value": "(event: Event) => void", - "description": "A callback fired when the user has **finished editing** a field, such as when they blur the field or press Enter. Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", + "description": "A callback fired when the user has **finished editing** a field, such as when they blur the field or press Enter.", "isOptional": true }, { @@ -64495,7 +36880,7 @@ "src/surfaces/checkout/components/Select.ts": { "filePath": "src/surfaces/checkout/components/Select.ts", "name": "SelectElementEvents", - "description": "The select component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", + "description": "", "isPublicDocs": true, "members": [ { @@ -64503,7 +36888,7 @@ "syntaxKind": "PropertySignature", "name": "blur", "value": "CallbackEventListener", - "description": "A callback fired when the select loses focus.\n\nLearn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "description": "<<<<<<< HEAD A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n======= A callback fired when the select loses focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) \n Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", "isOptional": true }, { @@ -64511,7 +36896,7 @@ "syntaxKind": "PropertySignature", "name": "change", "value": "CallbackEventListener", - "description": "A callback fired when the select value changes.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", + "description": "<<<<<<< HEAD Callback when the user has **finished editing** a field, for example, once they have blurred the field.\n======= A callback fired when the select value changes.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) \n Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", "isOptional": true }, { @@ -64519,11 +36904,11 @@ "syntaxKind": "PropertySignature", "name": "focus", "value": "CallbackEventListener", - "description": "A callback fired when the select receives focus.\n\nLearn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "description": "<<<<<<< HEAD A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n======= A callback fired when the select receives focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) \n Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", "isOptional": true } ], - "value": "export interface SelectElementEvents {\n /**\n * A callback fired when the select loses focus.\n *\n * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur?: CallbackEventListener;\n /**\n * A callback fired when the select value changes.\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change?: CallbackEventListener;\n /**\n * A callback fired when the select receives focus.\n *\n * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus?: CallbackEventListener;\n}" + "value": "export interface SelectElementEvents {\n /**\n<<<<<<< HEAD\n * A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n=======\n * A callback fired when the select loses focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality)\n *\n * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur?: CallbackEventListener;\n /**\n<<<<<<< HEAD\n * Callback when the user has **finished editing** a field, for example, once they have blurred the field.\n=======\n * A callback fired when the select value changes.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality)\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change?: CallbackEventListener;\n /**\n<<<<<<< HEAD\n * A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n=======\n * A callback fired when the select receives focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality)\n *\n * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus?: CallbackEventListener;\n}" } }, "SelectElement": { @@ -64552,7 +36937,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/Select.ts", @@ -64993,7 +37378,7 @@ "syntaxKind": "PropertySignature", "name": "autocomplete", "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", "isOptional": true, "defaultValue": "'on' for everything else" }, @@ -65191,7 +37576,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -66611,7 +38996,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/Select.ts", @@ -66892,7 +39277,7 @@ "syntaxKind": "PropertySignature", "name": "autocomplete", "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", "isOptional": true, "defaultValue": "'on' for everything else" }, @@ -66901,7 +39286,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -66950,7 +39335,7 @@ "syntaxKind": "PropertySignature", "name": "onChange", "value": "(event: Event) => void", - "description": "A callback fired when the user has **finished editing** a field, such as when they blur the field or press Enter. Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", + "description": "A callback fired when the user has **finished editing** a field, such as when they blur the field or press Enter.", "isOptional": true }, { @@ -66994,7 +39379,7 @@ "src/surfaces/checkout/components/ClickableChip.ts": { "filePath": "src/surfaces/checkout/components/ClickableChip.ts", "name": "ClickableChipElementProps", - "description": "The clickable chip component displays interactive labels or categories that users can click or remove. Use clickable chip to show filter tags, selected options, or merchant-created labels that users need to interact with or dismiss.\n\nClickable chips support multiple visual variants, optional icons, and can function as both clickable buttons and removable tags for flexible interaction patterns. For non-interactive labels, use [chip](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/typography-and-content/chip).", + "description": "", "isPublicDocs": true, "members": [ { @@ -67002,7 +39387,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityLabel", "value": "string", - "description": "A label that describes the purpose or contents of the Chip. It will be read to users using assistive technologies such as screen readers.", + "description": "A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.", "isOptional": true }, { @@ -67010,7 +39395,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the chip, disallowing any interaction.", + "description": "Disables the chip, preventing all user interaction including clicks and removal. Disabled chips are visually dimmed to indicate they are not interactive.", "isOptional": true, "defaultValue": "false" }, @@ -67019,7 +39404,7 @@ "syntaxKind": "PropertySignature", "name": "hidden", "value": "boolean", - "description": "Determines whether the chip is hidden.\n\nIf this property is being set on each framework render (as in 'controlled' usage), and the chip is `removable`, ensure you update app state for this property when the `remove` event fires.\n\nIf the chip is not `removable`, it can still be hidden by setting this property.", + "description": "Determines whether the chip is hidden.\n\nIf this property is being set on each framework render (as in 'controlled' usage), and the chip is `removable`, ensure you update app state for this property when the `remove` event fires.\n\nIf the chip is not `removable`, it can still be hidden by setting this property.\n\nWhen using the `removable` variant, keep `hidden` synced with your app state. If `hidden` isn't updated after the chip is removed, the chip can become permanently hidden.", "isOptional": true, "defaultValue": "false" }, @@ -67028,7 +39413,7 @@ "syntaxKind": "PropertySignature", "name": "href", "value": "string", - "description": "The URL to link to.\n\n- If set, it will navigate to the location specified by `href` after executing the `click` event.", + "description": "The URL to link to. When set, the chip navigates to the specified location after the `click` event fires.", "isOptional": true }, { @@ -67044,7 +39429,7 @@ "syntaxKind": "PropertySignature", "name": "removable", "value": "boolean", - "description": "Whether the chip is removable.", + "description": "Whether the chip displays a remove button, allowing users to dismiss it. When `true`, clicking the remove button fires the `remove` event.", "isOptional": true, "defaultValue": "false" } @@ -67064,7 +39449,7 @@ "syntaxKind": "PropertySignature", "name": "onAfterHide", "value": "(event: Event) => void", - "description": "Event handler when the chip has fully hidden.\n\nThe `hidden` property will be `true` when this event fires.", + "description": "A callback fired when the chip has fully hidden after a removal animation.\n\nThe `hidden` property will be `true` when this event fires.", "isOptional": true }, { @@ -67072,7 +39457,7 @@ "syntaxKind": "PropertySignature", "name": "onClick", "value": "(event: Event) => void", - "description": "Callback when the chip is clicked.", + "description": "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).", "isOptional": true }, { @@ -67080,7 +39465,7 @@ "syntaxKind": "PropertySignature", "name": "onRemove", "value": "(event: Event) => void", - "description": "Callback when the chip is removed.", + "description": "A callback fired when the chip is removed by the user clicking the remove button.", "isOptional": true } ], @@ -67091,7 +39476,7 @@ "src/surfaces/checkout/components/ClickableChip.ts": { "filePath": "src/surfaces/checkout/components/ClickableChip.ts", "name": "ClickableChipElementEvents", - "description": "Learn more about [registering events](/docs/api/checkout-ui-extensions/latest/using-polaris-components#event-handling).", + "description": "", "isPublicDocs": true, "members": [ { @@ -67099,7 +39484,7 @@ "syntaxKind": "PropertySignature", "name": "afterhide", "value": "CallbackEventListener", - "description": "Event handler when the chip has fully hidden.\n\nThe `hidden` property will be `true` when this event fires.", + "description": "A callback fired after the chip is hidden. The `hidden` property will be `true` when this event fires.", "isOptional": true }, { @@ -67107,7 +39492,7 @@ "syntaxKind": "PropertySignature", "name": "click", "value": "CallbackEventListener", - "description": "Event handler when the chip is clicked.", + "description": "A callback fired when the chip is clicked.\n\nLearn more about the [click event](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event).", "isOptional": true }, { @@ -67115,18 +39500,18 @@ "syntaxKind": "PropertySignature", "name": "remove", "value": "CallbackEventListener", - "description": "Event handler when the chip is removed.", + "description": "A callback fired when the chip is removed.", "isOptional": true } ], - "value": "export interface ClickableChipElementEvents {\n /**\n * Event handler when the chip has fully hidden.\n *\n * The `hidden` property will be `true` when this event fires.\n */\n afterhide?: CallbackEventListener;\n /**\n * Event handler when the chip is clicked.\n */\n click?: CallbackEventListener;\n /**\n * Event handler when the chip is removed.\n */\n remove?: CallbackEventListener;\n}" + "value": "export interface ClickableChipElementEvents {\n /**\n * A callback fired after the chip is hidden. The `hidden` property will be `true` when this event fires.\n */\n afterhide?: CallbackEventListener;\n /**\n * A callback fired when the chip is clicked.\n *\n * Learn more about the [click event](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event).\n */\n click?: CallbackEventListener;\n /**\n * A callback fired when the chip is removed.\n */\n remove?: CallbackEventListener;\n}" } }, "ClickableChipElementSlots": { "src/surfaces/checkout/components/ClickableChip.ts": { "filePath": "src/surfaces/checkout/components/ClickableChip.ts", "name": "ClickableChipElementSlots", - "description": "Learn more about [component slots](/docs/api/checkout-ui-extensions/latest/using-polaris-components#slots).", + "description": "", "isPublicDocs": true, "members": [ { @@ -67134,11 +39519,11 @@ "syntaxKind": "PropertySignature", "name": "graphic", "value": "HTMLElement", - "description": "The graphic to display inside of the chip.\n\nOnly `s-icon` element and its `type` attribute are supported.", + "description": "An optional graphic displayed at the start of the chip, such as an icon to visually reinforce the chip's label. Only the `s-icon` element and its `type` attribute are supported.", "isOptional": true } ], - "value": "export interface ClickableChipElementSlots {\n /**\n * The graphic to display inside of the chip.\n *\n * Only `s-icon` element and its `type` attribute are supported.\n */\n graphic?: HTMLElement;\n}" + "value": "export interface ClickableChipElementSlots {\n /**\n * An optional graphic displayed at the start of the chip, such as an icon to visually reinforce the chip's label. Only the `s-icon` element and its `type` attribute are supported.\n */\n graphic?: HTMLElement;\n}" } }, "ClickableChipElement": { @@ -67153,7 +39538,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityLabel", "value": "string", - "description": "A label that describes the purpose or contents of the Chip. It will be read to users using assistive technologies such as screen readers.", + "description": "A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.", "isOptional": true }, { @@ -67175,7 +39560,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/ClickableChip.ts", @@ -67805,7 +40190,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the chip, disallowing any interaction.", + "description": "Disables the chip, preventing all user interaction including clicks and removal. Disabled chips are visually dimmed to indicate they are not interactive.", "isOptional": true, "defaultValue": "false" }, @@ -68067,7 +40452,7 @@ "syntaxKind": "PropertySignature", "name": "hidden", "value": "boolean", - "description": "Determines whether the chip is hidden.\n\nIf this property is being set on each framework render (as in 'controlled' usage), and the chip is `removable`, ensure you update app state for this property when the `remove` event fires.\n\nIf the chip is not `removable`, it can still be hidden by setting this property.", + "description": "Determines whether the chip is hidden.\n\nIf this property is being set on each framework render (as in 'controlled' usage), and the chip is `removable`, ensure you update app state for this property when the `remove` event fires.\n\nIf the chip is not `removable`, it can still be hidden by setting this property.\n\nWhen using the `removable` variant, keep `hidden` synced with your app state. If `hidden` isn't updated after the chip is removed, the chip can become permanently hidden.", "isOptional": true, "defaultValue": "false" }, @@ -68083,7 +40468,7 @@ "syntaxKind": "PropertySignature", "name": "href", "value": "string", - "description": "The URL to link to.\n\n- If set, it will navigate to the location specified by `href` after executing the `click` event.", + "description": "The URL to link to. When set, the chip navigates to the specified location after the `click` event fires.", "isOptional": true }, { @@ -69182,7 +41567,7 @@ "syntaxKind": "PropertySignature", "name": "removable", "value": "boolean", - "description": "Whether the chip is removable.", + "description": "Whether the chip displays a remove button, allowing users to dismiss it. When `true`, clicking the remove button fires the `remove` event.", "isOptional": true, "defaultValue": "false" }, @@ -69226,7 +41611,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/ClickableChip.ts", @@ -69490,7 +41875,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityLabel", "value": "string", - "description": "A label that describes the purpose or contents of the Chip. It will be read to users using assistive technologies such as screen readers.", + "description": "A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.", "isOptional": true }, { @@ -69498,7 +41883,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the chip, disallowing any interaction.", + "description": "Disables the chip, preventing all user interaction including clicks and removal. Disabled chips are visually dimmed to indicate they are not interactive.", "isOptional": true, "defaultValue": "false" }, @@ -69507,7 +41892,7 @@ "syntaxKind": "PropertySignature", "name": "hidden", "value": "boolean", - "description": "Determines whether the chip is hidden.\n\nIf this property is being set on each framework render (as in 'controlled' usage), and the chip is `removable`, ensure you update app state for this property when the `remove` event fires.\n\nIf the chip is not `removable`, it can still be hidden by setting this property.", + "description": "Determines whether the chip is hidden.\n\nIf this property is being set on each framework render (as in 'controlled' usage), and the chip is `removable`, ensure you update app state for this property when the `remove` event fires.\n\nIf the chip is not `removable`, it can still be hidden by setting this property.\n\nWhen using the `removable` variant, keep `hidden` synced with your app state. If `hidden` isn't updated after the chip is removed, the chip can become permanently hidden.", "isOptional": true, "defaultValue": "false" }, @@ -69516,7 +41901,7 @@ "syntaxKind": "PropertySignature", "name": "href", "value": "string", - "description": "The URL to link to.\n\n- If set, it will navigate to the location specified by `href` after executing the `click` event.", + "description": "The URL to link to. When set, the chip navigates to the specified location after the `click` event fires.", "isOptional": true }, { @@ -69532,7 +41917,7 @@ "syntaxKind": "PropertySignature", "name": "onAfterHide", "value": "(event: Event) => void", - "description": "Event handler when the chip has fully hidden.\n\nThe `hidden` property will be `true` when this event fires.", + "description": "A callback fired when the chip has fully hidden after a removal animation.\n\nThe `hidden` property will be `true` when this event fires.", "isOptional": true }, { @@ -69540,7 +41925,7 @@ "syntaxKind": "PropertySignature", "name": "onClick", "value": "(event: Event) => void", - "description": "Callback when the chip is clicked.", + "description": "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).", "isOptional": true }, { @@ -69548,7 +41933,7 @@ "syntaxKind": "PropertySignature", "name": "onRemove", "value": "(event: Event) => void", - "description": "Callback when the chip is removed.", + "description": "A callback fired when the chip is removed by the user clicking the remove button.", "isOptional": true }, { @@ -69556,7 +41941,7 @@ "syntaxKind": "PropertySignature", "name": "removable", "value": "boolean", - "description": "Whether the chip is removable.", + "description": "Whether the chip displays a remove button, allowing users to dismiss it. When `true`, clicking the remove button fires the `remove` event.", "isOptional": true, "defaultValue": "false" } @@ -69653,7 +42038,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/Badge.ts", @@ -71688,7 +44073,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/Badge.ts", @@ -72091,7 +44476,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/Spinner.ts", @@ -74100,7 +46485,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/Spinner.ts", @@ -74439,7 +46824,7 @@ "src/surfaces/checkout/components/Tooltip.ts": { "filePath": "src/surfaces/checkout/components/Tooltip.ts", "name": "TooltipProps", - "description": "The properties for the tooltip component when it's used in JSX.", + "description": "", "isPublicDocs": true, "members": [ { @@ -74458,7 +46843,7 @@ "src/surfaces/checkout/components/Chip.ts": { "filePath": "src/surfaces/checkout/components/Chip.ts", "name": "ChipElementProps", - "description": "Configure the following properties on the chip component.", + "description": "", "isPublicDocs": true, "members": [ { @@ -74466,7 +46851,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityLabel", "value": "string", - "description": "A label that describes the purpose or contents of the Chip. It will be read to users using assistive technologies such as screen readers.", + "description": "A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.", "isOptional": true }, { @@ -74485,7 +46870,7 @@ "src/surfaces/checkout/components/Chip.ts": { "filePath": "src/surfaces/checkout/components/Chip.ts", "name": "ChipElementSlots", - "description": "The chip component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", + "description": "", "isPublicDocs": true, "members": [ { @@ -74493,11 +46878,11 @@ "syntaxKind": "PropertySignature", "name": "graphic", "value": "HTMLElement", - "description": "The graphic to display inside of the chip.\n\nOnly `s-icon` element and its `type` attribute are supported.", + "description": "An optional graphic displayed at the start of the chip, such as an icon to visually reinforce the chip's label. Only the `s-icon` element and its `type` attribute are supported.", "isOptional": true } ], - "value": "export interface ChipElementSlots {\n /**\n * The graphic to display inside of the chip.\n *\n * Only `s-icon` element and its `type` attribute are supported.\n */\n graphic?: HTMLElement;\n}" + "value": "export interface ChipElementSlots {\n /**\n * An optional graphic displayed at the start of the chip, such as an icon to visually reinforce the chip's label. Only the `s-icon` element and its `type` attribute are supported.\n */\n graphic?: HTMLElement;\n}" } }, "ChipProps": { @@ -74512,7 +46897,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityLabel", "value": "string", - "description": "A label that describes the purpose or contents of the Chip. It will be read to users using assistive technologies such as screen readers.", + "description": "A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.", "isOptional": true }, { @@ -74539,7 +46924,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityLabel", "value": "string", - "description": "A label that describes the purpose or contents of the Chip. It will be read to users using assistive technologies such as screen readers.", + "description": "A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.", "isOptional": true }, { @@ -74561,7 +46946,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/Chip.ts", @@ -76570,7 +48955,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/Chip.ts", @@ -76826,7 +49211,7 @@ "src/surfaces/checkout/components/UnorderedList.ts": { "filePath": "src/surfaces/checkout/components/UnorderedList.ts", "name": "UnorderedListElementProps", - "description": "Properties for the UnorderedList component element.", + "description": "", "isPublicDocs": true, "members": [ { @@ -76867,7 +49252,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/UnorderedList.ts", @@ -78876,7 +51261,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/UnorderedList.ts", @@ -79151,7 +51536,7 @@ "src/surfaces/checkout/components/OrderedList.ts": { "filePath": "src/surfaces/checkout/components/OrderedList.ts", "name": "OrderedListElementProps", - "description": "Properties for the OrderedList component element.", + "description": "", "isPublicDocs": true, "members": [ { @@ -79192,7 +51577,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/OrderedList.ts", @@ -81201,7 +53586,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/OrderedList.ts", @@ -81472,14 +53857,13 @@ "value": "export interface OrderedListProps extends OrderedListElementProps {\n}" } }, ->>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) "SizeKeyword": { "src/surfaces/customer-account/components/shared.ts": { "filePath": "src/surfaces/customer-account/components/shared.ts", "syntaxKind": "TypeAliasDeclaration", "name": "SizeKeyword", "value": "'small-500' | 'small-400' | 'small-300' | 'small-200' | 'small-100' | 'small' | 'base' | 'large' | 'large-100' | 'large-200' | 'large-300' | 'large-400' | 'large-500'", - "description": "The design system's size scale, used to control the dimensions of components like avatars, icons, and thumbnails. Values range from `'small-500'` (smallest) through `'base'` (standard) to `'large-500'` (largest). Not all components support every size \u2014 check the component's `size` property type for its available options." + "description": "The design system's size scale, used to control the dimensions of components like avatars, icons, and thumbnails. Values range from `'small-500'` (smallest) through `'base'` (standard) to `'large-500'` (largest). Not all components support every size — check the component's `size` property type for its available options." } }, "ComponentChildren": { @@ -81498,7 +53882,7 @@ "syntaxKind": "TypeAliasDeclaration", "name": "AutocompleteSection", "value": "`section-${string}`", - "description": "The \u201csection\u201d scopes the autocomplete data that should be inserted to a specific area of the page.\n\nCommonly used when there are multiple fields with the same autocomplete needs in the same page. For example: 2 shipping address forms in the same page.", + "description": "The “section” scopes the autocomplete data that should be inserted to a specific area of the page.\n\nCommonly used when there are multiple fields with the same autocomplete needs in the same page. For example: 2 shipping address forms in the same page.", "isPublicDocs": true } }, @@ -81562,7 +53946,7 @@ "src/surfaces/checkout/components/Abbreviation.ts": { "filePath": "src/surfaces/checkout/components/Abbreviation.ts", "name": "AbbreviationElementProps", - "description": "Displays abbreviated text or acronyms, revealing their full meaning or additional context through a tooltip on hover or focus. Use to clarify shortened terms, initialisms, or technical language without interrupting the reading flow.", + "description": "", "isPublicDocs": true, "members": [ { @@ -81578,7 +53962,7 @@ "syntaxKind": "PropertySignature", "name": "title", "value": "string", - "description": "Defines the full expansion of the abbreviation or acronym.\n\nHelps user agents and users understand the meaning of the abbreviated text.", + "description": "Defines the full expansion of the abbreviation or acronym, helping user agents and users understand the meaning of the abbreviated text. Learn more about the [abbreviation element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/abbr).", "isOptional": true, "defaultValue": "''" } @@ -81612,7 +53996,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/Abbreviation.ts", @@ -83621,7 +56005,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/Abbreviation.ts", @@ -83831,7 +56215,7 @@ "syntaxKind": "PropertySignature", "name": "title", "value": "string", - "description": "Defines the full expansion of the abbreviation or acronym.\n\nHelps user agents and users understand the meaning of the abbreviated text.", + "description": "Defines the full expansion of the abbreviation or acronym, helping user agents and users understand the meaning of the abbreviated text. Learn more about the [abbreviation element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/abbr).", "isOptional": true, "defaultValue": "''" }, @@ -83895,7 +56279,7 @@ "syntaxKind": "PropertySignature", "name": "title", "value": "string", - "description": "Defines the full expansion of the abbreviation or acronym.\n\nHelps user agents and users understand the meaning of the abbreviated text.", + "description": "Defines the full expansion of the abbreviation or acronym, helping user agents and users understand the meaning of the abbreviated text. Learn more about the [abbreviation element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/abbr).", "isOptional": true, "defaultValue": "''" } @@ -83950,7 +56334,7 @@ "syntaxKind": "PropertySignature", "name": "onAfterToggle", "value": "(event: ToggleEvent$1) => void", - "description": "A callback that fires when the element state changes, after any toggle animations have finished.\n\n- If the element transitioned from hidden to showing, the `oldState` property will be set to `closed` and the `newState` property will be set to `open`.\n- If the element transitioned from showing to hidden, the `oldState` property will be set to `open` and the `newState` will be `closed`.\n\nLearn more about [ToggleEvent.newState](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/newState) and [ToggleEvent.oldState](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/oldState).", + "description": "A callback fired when the element state changes, after any toggle animations have finished.\n\n- If the element transitioned from hidden to showing, the `oldState` property will be set to `closed` and the `newState` property will be set to `open`.\n- If the element transitioned from showing to hidden, the `oldState` property will be set to `open` and the `newState` will be `closed`.\n\nLearn more about 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.", "isOptional": true }, { @@ -83958,7 +56342,7 @@ "syntaxKind": "PropertySignature", "name": "onDismiss", "value": "(event: Event) => void", - "description": "A callback that fires when the announcement is dismissed by the user clicking the close button or by calling the `dismiss()` method programmatically.", + "description": "Callback fired when the announcement is dismissed by the user (either via the built-in dismiss button or programmatically).", "isOptional": true }, { @@ -83966,7 +56350,7 @@ "syntaxKind": "PropertySignature", "name": "onToggle", "value": "(event: ToggleEvent$1) => void", - "description": "A callback that fires immediately when the element state changes, before any animations.\n\n- If the element is transitioning from hidden to showing, the `oldState` property will be set to `closed` and the `newState` property will be set to `open`.\n- If the element is transitioning from showing to hidden, then `oldState` property will be set to `open` and the `newState` will be `closed`.\n\nLearn more about the [toggle event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/toggle_event), [ToggleEvent.newState](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/newState), and [ToggleEvent.oldState](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/oldState).", + "description": "A callback fired immediately when the element state changes, before any animations.\n\n- If the element is transitioning from hidden to showing, the `oldState` property will be set to `closed` and the `newState` property will be set to `open`.\n- If the element is transitioning from showing to hidden, then the `oldState` property will be set to `open` and the `newState` will be `closed`.\n\nLearn 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.", "isOptional": true } ], @@ -83985,7 +56369,7 @@ "syntaxKind": "PropertySignature", "name": "aftertoggle", "value": "CallbackEventListener", - "description": "A callback that fires when the element state changes, after any toggle animations have finished.\n\n- If the element transitioned from hidden to showing, the `oldState` property will be set to `closed` and the `newState` property will be set to `open`.\n- If the element transitioned from showing to hidden, the `oldState` property will be set to `open` and the `newState` will be `closed`.\n\nLearn more about [ToggleEvent.newState](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/newState) and [ToggleEvent.oldState](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/oldState).", + "description": "A callback that fires when the element state changes, after any toggle animations have finished.\n\n- If the element transitioned from hidden to showing, the `oldState` property will be set to `closed` and the `newState` property will be set to `open`.\n- If the element transitioned from showing to hidden, the `oldState` property will be set to `open` and the `newState` will be `closed`.\n\nLearn more about [`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).", "isOptional": true }, { @@ -84001,11 +56385,11 @@ "syntaxKind": "PropertySignature", "name": "toggle", "value": "CallbackEventListener", - "description": "A callback that fires immediately when the element state changes, before any animations.\n\n- If the element is transitioning from hidden to showing, the `oldState` property will be set to `closed` and the `newState` property will be set to `open`.\n- If the element is transitioning from showing to hidden, then `oldState` property will be set to `open` and the `newState` will be `closed`.\n\nLearn more about the [toggle event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/toggle_event), [ToggleEvent.newState](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/newState), and [ToggleEvent.oldState](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/oldState).", + "description": "A callback that fires immediately when the element state changes, before any animations.\n\n- If the element is transitioning from hidden to showing, the `oldState` property will be set to `closed` and the `newState` property will be set to `open`.\n- If the element is transitioning from showing to hidden, then the `oldState` property will be set to `open` and the `newState` will be `closed`.\n\nLearn more about the [`toggle` event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/toggle_event), [`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).", "isOptional": true } ], - "value": "export interface AnnouncementElementEvents {\n /**\n * A callback that fires when the element state changes, after any toggle animations have finished.\n *\n * - If the element transitioned from hidden to showing, the `oldState` property will be set to `closed` and the\n * `newState` property will be set to `open`.\n * - If the element transitioned from showing to hidden, the `oldState` property will be set to `open` and the\n * `newState` will be `closed`.\n *\n * Learn more about [ToggleEvent.newState](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/newState) and [ToggleEvent.oldState](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/oldState).\n */\n aftertoggle?: CallbackEventListener;\n /**\n * A callback that fires when the announcement is dismissed by the user clicking the close button or by calling the `dismiss()` method programmatically.\n */\n dismiss?: CallbackEventListener;\n /**\n * A callback that fires immediately when the element state changes, before any animations.\n *\n * - If the element is transitioning from hidden to showing, the `oldState` property will be set to `closed` and the\n * `newState` property will be set to `open`.\n * - If the element is transitioning from showing to hidden, then `oldState` property will be set to `open` and the\n * `newState` will be `closed`.\n *\n * Learn more about the [toggle event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/toggle_event), [ToggleEvent.newState](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/newState), and [ToggleEvent.oldState](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/oldState).\n */\n toggle?: CallbackEventListener;\n}" + "value": "export interface AnnouncementElementEvents {\n /**\n * A callback that fires when the element state changes, after any toggle animations have finished.\n *\n * - If the element transitioned from hidden to showing, the `oldState` property will be set to `closed` and the\n * `newState` property will be set to `open`.\n * - If the element transitioned from showing to hidden, the `oldState` property will be set to `open` and the\n * `newState` will be `closed`.\n *\n * Learn more about [`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).\n */\n aftertoggle?: CallbackEventListener;\n /**\n * A callback that fires when the announcement is dismissed by the user clicking the close button or by calling the `dismiss()` method programmatically.\n */\n dismiss?: CallbackEventListener;\n /**\n * A callback that fires immediately when the element state changes, before any animations.\n *\n * - If the element is transitioning from hidden to showing, the `oldState` property will be set to `closed` and the\n * `newState` property will be set to `open`.\n * - If the element is transitioning from showing to hidden, then the `oldState` property will be set to `open` and the\n * `newState` will be `closed`.\n *\n * Learn more about the [`toggle` event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/toggle_event), [`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).\n */\n toggle?: CallbackEventListener;\n}" } }, "AnnouncementElement": { @@ -84034,7 +56418,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/Announcement.ts", @@ -86059,7 +58443,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/Announcement.ts", @@ -86323,7 +58707,7 @@ "syntaxKind": "PropertySignature", "name": "onAfterToggle", "value": "(event: ToggleEvent$1) => void", - "description": "A callback that fires when the element state changes, after any toggle animations have finished.\n\n- If the element transitioned from hidden to showing, the `oldState` property will be set to `closed` and the `newState` property will be set to `open`.\n- If the element transitioned from showing to hidden, the `oldState` property will be set to `open` and the `newState` will be `closed`.\n\nLearn more about [ToggleEvent.newState](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/newState) and [ToggleEvent.oldState](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/oldState).", + "description": "A callback fired when the element state changes, after any toggle animations have finished.\n\n- If the element transitioned from hidden to showing, the `oldState` property will be set to `closed` and the `newState` property will be set to `open`.\n- If the element transitioned from showing to hidden, the `oldState` property will be set to `open` and the `newState` will be `closed`.\n\nLearn more about 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.", "isOptional": true }, { @@ -86331,7 +58715,7 @@ "syntaxKind": "PropertySignature", "name": "onDismiss", "value": "(event: Event) => void", - "description": "A callback that fires when the announcement is dismissed by the user clicking the close button or by calling the `dismiss()` method programmatically.", + "description": "Callback fired when the announcement is dismissed by the user (either via the built-in dismiss button or programmatically).", "isOptional": true }, { @@ -86339,7 +58723,7 @@ "syntaxKind": "PropertySignature", "name": "onToggle", "value": "(event: ToggleEvent$1) => void", - "description": "A callback that fires immediately when the element state changes, before any animations.\n\n- If the element is transitioning from hidden to showing, the `oldState` property will be set to `closed` and the `newState` property will be set to `open`.\n- If the element is transitioning from showing to hidden, then `oldState` property will be set to `open` and the `newState` will be `closed`.\n\nLearn more about the [toggle event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/toggle_event), [ToggleEvent.newState](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/newState), and [ToggleEvent.oldState](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/oldState).", + "description": "A callback fired immediately when the element state changes, before any animations.\n\n- If the element is transitioning from hidden to showing, the `oldState` property will be set to `closed` and the `newState` property will be set to `open`.\n- If the element is transitioning from showing to hidden, then the `oldState` property will be set to `open` and the `newState` will be `closed`.\n\nLearn 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.", "isOptional": true } ], @@ -86458,7 +58842,7 @@ "syntaxKind": "PropertySignature", "name": "onAfterHide", "value": "(event: Event) => void", - "description": "A callback that fires when the banner has fully hidden, including after any hide animations have completed.\n\nThe `hidden` property is `true` when this event fires.", + "description": "Event handler when the banner has fully hidden.\n\nThe `hidden` property will be `true` when this event fires.", "isOptional": true }, { @@ -86466,7 +58850,7 @@ "syntaxKind": "PropertySignature", "name": "onDismiss", "value": "(event: Event) => void", - "description": "A callback that fires when the banner is dismissed by the user clicking the close button.\n\nThis doesn't fire when setting `hidden` manually.\n\nThe `hidden` property is `false` when this event fires.", + "description": "Event handler when the banner is dismissed by the user.\n\nThis does not fire when setting `hidden` manually.\n\nThe `hidden` property will be `false` when this event fires.", "isOptional": true } ], @@ -86526,7 +58910,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/Banner.ts", @@ -88578,7 +60962,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/Banner.ts", @@ -88888,7 +61272,7 @@ "syntaxKind": "PropertySignature", "name": "onAfterHide", "value": "(event: Event) => void", - "description": "A callback that fires when the banner has fully hidden, including after any hide animations have completed.\n\nThe `hidden` property is `true` when this event fires.", + "description": "Event handler when the banner has fully hidden.\n\nThe `hidden` property will be `true` when this event fires.", "isOptional": true }, { @@ -88896,7 +61280,7 @@ "syntaxKind": "PropertySignature", "name": "onDismiss", "value": "(event: Event) => void", - "description": "A callback that fires when the banner is dismissed by the user clicking the close button.\n\nThis doesn't fire when setting `hidden` manually.\n\nThe `hidden` property is `false` when this event fires.", + "description": "Event handler when the banner is dismissed by the user.\n\nThis does not fire when setting `hidden` manually.\n\nThe `hidden` property will be `false` when this event fires.", "isOptional": true }, { @@ -88964,7 +61348,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityLabel", "value": "string", - "description": "A label announced by assistive technologies that describes the purpose or contents of the element. Only set this when the element's visible content doesn't provide enough context on its own.", + "description": "A label that describes the purpose or contents of the element. When set, it will be announced to users using assistive technologies and will provide them with more context.\n\nOnly use this when the element's content is not enough context for users using assistive technologies.", "isOptional": true }, { @@ -88972,7 +61356,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityRole", "value": "AccessibilityRole", - "description": "The semantic meaning of the component's content. When set, assistive technologies use this role to help users navigate the page.", + "description": "Sets the semantic meaning of the component’s content. When set, the role will be used by assistive technologies to help users navigate the page.", "isOptional": true, "defaultValue": "'generic'" }, @@ -88981,7 +61365,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityVisibility", "value": "'visible' | 'hidden' | 'exclusive'", - "description": "Changes the visibility of the element.\n\n- `visible`: the element is visible to all users.\n- `hidden`: the element is removed from the accessibility tree but remains visible.\n- `exclusive`: the element is visually hidden but remains in the accessibility tree.", + "description": "Controls how the element is exposed to sighted users and to assistive technologies such as screen readers.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", "isOptional": true, "defaultValue": "'visible'" }, @@ -88990,11 +61374,7 @@ "syntaxKind": "PropertySignature", "name": "background", "value": "'base' | 'subdued' | 'transparent'", -<<<<<<< HEAD - "description": "Adjust the background of the element.\n\n- `'transparent'`: No visible background.\n- `'subdued'`: A subtle, low-emphasis background.\n- `'base'`: The standard background color.\n- `'strong'`: A high-emphasis background for prominence.", -======= "description": "The background color of the box.\n\n- `base`: The standard background color for general content areas.\n- `subdued`: A muted background for secondary or supporting content.\n- `transparent`: No background color (the default).", ->>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) "isOptional": true, "defaultValue": "'transparent'" }, @@ -89060,7 +61440,7 @@ "syntaxKind": "PropertySignature", "name": "display", "value": "MaybeResponsive<\"auto\" | \"none\">", - "description": "Sets the outer display type of the component. The outer type sets a component\u2019s participation in [flow layout](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_flow_layout).\n\n- `auto`: the component\u2019s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.", + "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.\n\nLearn more about the [display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display).", "isOptional": true, "defaultValue": "'auto'" }, @@ -89122,7 +61502,7 @@ "syntaxKind": "PropertySignature", "name": "overflow", "value": "'hidden' | 'visible'", - "description": "The overflow behavior of the element.\n\n- `visible`: Content that extends beyond the container is visible.\n- `hidden`: Content that extends beyond the container is clipped and not scrollable.", + "description": "Sets the overflow behavior of the element.\n\n- `visible`: The content that extends beyond the element’s container is visible.\n- `hidden`: Clips the content when it is larger than the element’s container. The element will not be scrollable and users will not be able to access the clipped content by dragging or using a scroll wheel on a mouse.", "isOptional": true, "defaultValue": "'visible'" }, @@ -89199,7 +61579,7 @@ "syntaxKind": "TypeAliasDeclaration", "name": "AccessibilityRole", "value": "\"main\" | \"header\" | \"footer\" | \"section\" | \"aside\" | \"navigation\" | \"ordered-list\" | \"list-item\" | \"list-item-separator\" | \"unordered-list\" | \"separator\" | \"status\" | \"alert\" | \"generic\" | \"presentation\" | \"none\"", - "description": "The semantic role of a component, used by assistive technologies to convey the element\u2019s purpose to users. Each role maps to a specific HTML element or ARIA role.\n\n- `main`: The primary content of the page.\n- `header`: A page or section header.\n- `footer`: Information such as copyright, navigation links, and privacy statements.\n- `section`: A generic section that should have a heading or `accessibilityLabel`.\n- `aside`: Supporting content related to the main content.\n- `navigation`: A major group of navigation links.\n- `ordered-list`: A list of ordered items.\n- `list-item`: An item inside a list.\n- `list-item-separator`: A divider between list items.\n- `unordered-list`: A list of unordered items.\n- `separator`: A divider that separates sections of content.\n- `status`: A live region with advisory information that is not urgent.\n- `alert`: Important, usually time-sensitive information.\n- `generic`: A nameless container with no semantic meaning (renders a `
`).\n- `presentation`: Strips semantic meaning while keeping visual styling. Synonym for `none`.\n- `none`: Strips semantic meaning while keeping visual styling. Synonym for `presentation`.", + "description": "The semantic role of a component, used by assistive technologies to convey the element’s purpose to users. Each role maps to a specific HTML element or ARIA role.\n\n- `main`: The primary content of the page.\n- `header`: A page or section header.\n- `footer`: Information such as copyright, navigation links, and privacy statements.\n- `section`: A generic section that should have a heading or `accessibilityLabel`.\n- `aside`: Supporting content related to the main content.\n- `navigation`: A major group of navigation links.\n- `ordered-list`: A list of ordered items.\n- `list-item`: An item inside a list.\n- `list-item-separator`: A divider between list items.\n- `unordered-list`: A list of unordered items.\n- `separator`: A divider that separates sections of content.\n- `status`: A live region with advisory information that is not urgent.\n- `alert`: Important, usually time-sensitive information.\n- `generic`: A nameless container with no semantic meaning (renders a `
`).\n- `presentation`: Strips semantic meaning while keeping visual styling. Synonym for `none`.\n- `none`: Strips semantic meaning while keeping visual styling. Synonym for `presentation`.", "isPublicDocs": true } }, @@ -89255,7 +61635,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityLabel", "value": "string", - "description": "A label announced by assistive technologies that describes the purpose or contents of the element. Only set this when the element's visible content doesn't provide enough context on its own.", + "description": "A label that describes the purpose or contents of the element. When set, it will be announced to users using assistive technologies and will provide them with more context.\n\nOnly use this when the element's content is not enough context for users using assistive technologies.", "isOptional": true }, { @@ -89263,7 +61643,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityRole", "value": "AccessibilityRole", - "description": "The semantic meaning of the component's content. When set, assistive technologies use this role to help users navigate the page.", + "description": "Sets the semantic meaning of the component’s content. When set, the role will be used by assistive technologies to help users navigate the page.", "isOptional": true, "defaultValue": "'generic'" }, @@ -89272,7 +61652,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityVisibility", "value": "'visible' | 'hidden' | 'exclusive'", - "description": "Changes the visibility of the element.\n\n- `visible`: the element is visible to all users.\n- `hidden`: the element is removed from the accessibility tree but remains visible.\n- `exclusive`: the element is visually hidden but remains in the accessibility tree.", + "description": "Controls how the element is exposed to sighted users and to assistive technologies such as screen readers.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", "isOptional": true, "defaultValue": "'visible'" }, @@ -89281,11 +61661,7 @@ "syntaxKind": "PropertySignature", "name": "background", "value": "'base' | 'subdued' | 'transparent'", -<<<<<<< HEAD - "description": "Adjust the background of the element.\n\n- `'transparent'`: No visible background.\n- `'subdued'`: A subtle, low-emphasis background.\n- `'base'`: The standard background color.\n- `'strong'`: A high-emphasis background for prominence.", -======= "description": "The background color of the box.\n\n- `base`: The standard background color for general content areas.\n- `subdued`: A muted background for secondary or supporting content.\n- `transparent`: No background color (the default).", ->>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) "isOptional": true, "defaultValue": "'transparent'" }, @@ -89339,7 +61715,7 @@ "syntaxKind": "PropertySignature", "name": "display", "value": "MaybeResponsive<\"auto\" | \"none\">", - "description": "Sets the outer display type of the component. The outer type sets a component\u2019s participation in [flow layout](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_flow_layout).\n\n- `auto`: the component\u2019s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.", + "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.\n\nLearn more about the [display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display).", "isOptional": true, "defaultValue": "'auto'" }, @@ -89401,7 +61777,7 @@ "syntaxKind": "PropertySignature", "name": "overflow", "value": "'hidden' | 'visible'", - "description": "The overflow behavior of the element.\n\n- `visible`: Content that extends beyond the container is visible.\n- `hidden`: Content that extends beyond the container is clipped and not scrollable.", + "description": "Sets the overflow behavior of the element.\n\n- `visible`: The content that extends beyond the element’s container is visible.\n- `hidden`: Clips the content when it is larger than the element’s container. The element will not be scrollable and users will not be able to access the clipped content by dragging or using a scroll wheel on a mouse.", "isOptional": true, "defaultValue": "'visible'" }, @@ -89514,7 +61890,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityLabel", "value": "string", - "description": "A label announced by assistive technologies that describes the purpose or contents of the element. Only set this when the element's visible content doesn't provide enough context on its own.", + "description": "A label that describes the purpose or contents of the element. When set, it will be announced to users using assistive technologies and will provide them with more context.\n\nOnly use this when the element's content is not enough context for users using assistive technologies.", "isOptional": true }, { @@ -89522,7 +61898,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityRole", "value": "AccessibilityRole", - "description": "The semantic meaning of the component's content. When set, assistive technologies use this role to help users navigate the page.", + "description": "Sets the semantic meaning of the component’s content. When set, the role will be used by assistive technologies to help users navigate the page.", "isOptional": true, "defaultValue": "'generic'" }, @@ -89531,7 +61907,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityVisibility", "value": "'visible' | 'hidden' | 'exclusive'", - "description": "Changes the visibility of the element.\n\n- `visible`: the element is visible to all users.\n- `hidden`: the element is removed from the accessibility tree but remains visible.\n- `exclusive`: the element is visually hidden but remains in the accessibility tree.", + "description": "Controls how the element is exposed to sighted users and to assistive technologies such as screen readers.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", "isOptional": true, "defaultValue": "'visible'" }, @@ -89554,7 +61930,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/Box.ts", @@ -90009,11 +62385,7 @@ "syntaxKind": "PropertySignature", "name": "background", "value": "'base' | 'subdued' | 'transparent'", -<<<<<<< HEAD - "description": "Adjust the background of the element.\n\n- `'transparent'`: No visible background.\n- `'subdued'`: A subtle, low-emphasis background.\n- `'base'`: The standard background color.\n- `'strong'`: A high-emphasis background for prominence.", -======= "description": "The background color of the box.\n\n- `base`: The standard background color for general content areas.\n- `subdued`: A muted background for secondary or supporting content.\n- `transparent`: No background color (the default).", ->>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) "isOptional": true, "defaultValue": "'transparent'" }, @@ -90249,7 +62621,7 @@ "syntaxKind": "PropertySignature", "name": "display", "value": "MaybeResponsive<\"auto\" | \"none\">", - "description": "Sets the outer display type of the component. The outer type sets a component\u2019s participation in [flow layout](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_flow_layout).\n\n- `auto`: the component\u2019s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.", + "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.\n\nLearn more about the [display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display).", "isOptional": true, "defaultValue": "'auto'" }, @@ -91547,7 +63919,7 @@ "syntaxKind": "PropertySignature", "name": "overflow", "value": "'hidden' | 'visible'", - "description": "The overflow behavior of the element.\n\n- `visible`: Content that extends beyond the container is visible.\n- `hidden`: Content that extends beyond the container is clipped and not scrollable.", + "description": "Sets the overflow behavior of the element.\n\n- `visible`: The content that extends beyond the element’s container is visible.\n- `hidden`: Clips the content when it is larger than the element’s container. The element will not be scrollable and users will not be able to access the clipped content by dragging or using a scroll wheel on a mouse.", "isOptional": true, "defaultValue": "'visible'" }, @@ -91747,7 +64119,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/Box.ts", @@ -92003,7 +64375,7 @@ "src/surfaces/checkout/components/Choice.ts": { "filePath": "src/surfaces/checkout/components/Choice.ts", "name": "ChoiceElementProps", - "description": "Configure the following properties on the choice component.", + "description": "", "isPublicDocs": true, "members": [ { @@ -92019,7 +64391,7 @@ "syntaxKind": "PropertySignature", "name": "defaultSelected", "value": "boolean", - "description": "Whether the control is active by default.", + "description": "Whether the control is selected by default.", "isOptional": true, "defaultValue": "false" }, @@ -92028,7 +64400,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the control, disallowing any interaction.", + "description": "Whether the control is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -92037,7 +64409,7 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "boolean", - "description": "Set to `true` to associate a choice with the error passed to `ChoiceList`", + "description": "Whether this choice is associated with the error state of the parent choice list. When `true`, the choice is visually marked as having an error.", "isOptional": true, "defaultValue": "false" }, @@ -92054,7 +64426,7 @@ "syntaxKind": "PropertySignature", "name": "selected", "value": "boolean", - "description": "Whether the control is active.", + "description": "Whether the control is currently selected.", "isOptional": true, "defaultValue": "false" }, @@ -92074,7 +64446,7 @@ "src/surfaces/checkout/components/Choice.ts": { "filePath": "src/surfaces/checkout/components/Choice.ts", "name": "ChoiceElementSlots", - "description": "The choice component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", + "description": "", "isPublicDocs": true, "members": [ { @@ -92139,7 +64511,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/Choice.ts", @@ -92762,7 +65134,7 @@ "syntaxKind": "PropertySignature", "name": "defaultSelected", "value": "boolean", - "description": "Whether the control is active by default.", + "description": "Whether the control is selected by default.", "isOptional": true, "defaultValue": "false" }, @@ -92778,7 +65150,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the control, disallowing any interaction.", + "description": "Whether the control is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -92892,7 +65264,7 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "boolean", - "description": "Set to `true` to associate a choice with the error passed to `ChoiceList`", + "description": "Whether this choice is associated with the error state of the parent choice list. When `true`, the choice is visually marked as having an error.", "isOptional": true, "defaultValue": "false" }, @@ -94175,7 +66547,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/Choice.ts", @@ -94280,7 +66652,7 @@ "syntaxKind": "PropertySignature", "name": "selected", "value": "boolean", - "description": "Whether the control is active.", + "description": "Whether the control is currently selected.", "isOptional": true, "defaultValue": "false" }, @@ -94464,7 +66836,7 @@ "syntaxKind": "PropertySignature", "name": "defaultSelected", "value": "boolean", - "description": "Whether the control is active by default.", + "description": "Whether the control is selected by default.", "isOptional": true, "defaultValue": "false" }, @@ -94473,7 +66845,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the control, disallowing any interaction.", + "description": "Whether the control is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -94482,7 +66854,7 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "boolean", - "description": "Set to `true` to associate a choice with the error passed to `ChoiceList`", + "description": "Whether this choice is associated with the error state of the parent choice list. When `true`, the choice is visually marked as having an error.", "isOptional": true, "defaultValue": "false" }, @@ -94499,7 +66871,7 @@ "syntaxKind": "PropertySignature", "name": "selected", "value": "boolean", - "description": "Whether the control is active.", + "description": "Whether the control is currently selected.", "isOptional": true, "defaultValue": "false" }, @@ -94519,7 +66891,7 @@ "src/surfaces/checkout/components/ChoiceList.ts": { "filePath": "src/surfaces/checkout/components/ChoiceList.ts", "name": "ChoiceListElementProps", - "description": "Configure the following properties on the choice list component.", + "description": "", "isPublicDocs": true, "members": [ { @@ -94527,7 +66899,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.\n\n`disabled` on any child choices is ignored when this is true.", + "description": "Whether the field is disabled, preventing any user interaction.\n\n`disabled` on any child choices is ignored when this is true.", "isOptional": true, "defaultValue": "false" }, @@ -94586,7 +66958,7 @@ "syntaxKind": "PropertySignature", "name": "values", "value": "string[]", - "description": "An array of the `value`s of the selected options.\n\nThis is a convenience prop for setting the `selected` prop on child options.", + "description": "An array of `value` attributes for the currently selected options.\n\nThis is a convenience prop for setting the `selected` prop on child options.\n\nForm data captures the selected value strings only. Complex nested content inside choices is for display purposes and isn't included in form submissions.", "isOptional": true }, { @@ -94594,7 +66966,7 @@ "syntaxKind": "PropertySignature", "name": "variant", "value": "'auto' | 'list' | 'inline' | 'block' | 'grid'", - "description": "The variant of the choice grid.\n\n- `auto`: The variant is determined by the context.\n- `list`: The choices are displayed in a list.\n- `inline`: The choices are displayed on the inline axis.\n- `block`: The choices are displayed on the block axis.\n- `grid`: The choices are displayed in a grid.", + "description": "The variant of the choice grid.\n\n- `auto`: The variant is determined by the context.\n- `list`: The choices are displayed in a list.\n- `inline`: The choices are displayed on the inline axis.\n- `block`: The choices are displayed on the block axis.\n- `grid`: The choices are displayed in a grid.\n\nThe selected content slot is supported only in the default (stacked) variant. `inline` and `grid` ignore it.", "isOptional": true, "defaultValue": "'auto'" } @@ -94614,7 +66986,7 @@ "syntaxKind": "PropertySignature", "name": "onChange", "value": "(event: Event) => void", - "description": "A callback fired when the user has selected one or more options. Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", + "description": "A callback fired when the user has selected one or more options.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", "isOptional": true } ], @@ -94625,7 +66997,7 @@ "src/surfaces/checkout/components/ChoiceList.ts": { "filePath": "src/surfaces/checkout/components/ChoiceList.ts", "name": "ChoiceListElementEvents", - "description": "The choice list component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", + "description": "", "isPublicDocs": true, "members": [ { @@ -94666,7 +67038,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/ChoiceList.ts", @@ -95296,7 +67668,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.\n\n`disabled` on any child choices is ignored when this is true.", + "description": "Whether the field is disabled, preventing any user interaction.\n\n`disabled` on any child choices is ignored when this is true.", "isOptional": true, "defaultValue": "false" }, @@ -96726,7 +69098,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/ChoiceList.ts", @@ -96964,7 +69336,7 @@ "syntaxKind": "PropertySignature", "name": "values", "value": "string[]", - "description": "An array of the `value`s of the selected options.\n\nThis is a convenience prop for setting the `selected` prop on child options.", + "description": "An array of `value` attributes for the currently selected options.\n\nThis is a convenience prop for setting the `selected` prop on child options.\n\nForm data captures the selected value strings only. Complex nested content inside choices is for display purposes and isn't included in form submissions.", "isOptional": true }, { @@ -96972,7 +69344,7 @@ "syntaxKind": "PropertySignature", "name": "variant", "value": "'auto' | 'list' | 'inline' | 'block' | 'grid'", - "description": "The variant of the choice grid.\n\n- `auto`: The variant is determined by the context.\n- `list`: The choices are displayed in a list.\n- `inline`: The choices are displayed on the inline axis.\n- `block`: The choices are displayed on the block axis.\n- `grid`: The choices are displayed in a grid.", + "description": "The variant of the choice grid.\n\n- `auto`: The variant is determined by the context.\n- `list`: The choices are displayed in a list.\n- `inline`: The choices are displayed on the inline axis.\n- `block`: The choices are displayed on the block axis.\n- `grid`: The choices are displayed in a grid.\n\nThe selected content slot is supported only in the default (stacked) variant. `inline` and `grid` ignore it.", "isOptional": true, "defaultValue": "'auto'" }, @@ -97007,7 +69379,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.\n\n`disabled` on any child choices is ignored when this is true.", + "description": "Whether the field is disabled, preventing any user interaction.\n\n`disabled` on any child choices is ignored when this is true.", "isOptional": true, "defaultValue": "false" }, @@ -97066,7 +69438,7 @@ "syntaxKind": "PropertySignature", "name": "onChange", "value": "(event: Event) => void", - "description": "A callback fired when the user has selected one or more options. Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", + "description": "A callback fired when the user has selected one or more options.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", "isOptional": true }, { @@ -97074,7 +69446,7 @@ "syntaxKind": "PropertySignature", "name": "values", "value": "string[]", - "description": "An array of the `value`s of the selected options.\n\nThis is a convenience prop for setting the `selected` prop on child options.", + "description": "An array of `value` attributes for the currently selected options.\n\nThis is a convenience prop for setting the `selected` prop on child options.\n\nForm data captures the selected value strings only. Complex nested content inside choices is for display purposes and isn't included in form submissions.", "isOptional": true }, { @@ -97082,7 +69454,7 @@ "syntaxKind": "PropertySignature", "name": "variant", "value": "'auto' | 'list' | 'inline' | 'block' | 'grid'", - "description": "The variant of the choice grid.\n\n- `auto`: The variant is determined by the context.\n- `list`: The choices are displayed in a list.\n- `inline`: The choices are displayed on the inline axis.\n- `block`: The choices are displayed on the block axis.\n- `grid`: The choices are displayed in a grid.", + "description": "The variant of the choice grid.\n\n- `auto`: The variant is determined by the context.\n- `list`: The choices are displayed in a list.\n- `inline`: The choices are displayed on the inline axis.\n- `block`: The choices are displayed on the block axis.\n- `grid`: The choices are displayed in a grid.\n\nThe selected content slot is supported only in the default (stacked) variant. `inline` and `grid` ignore it.", "isOptional": true, "defaultValue": "'auto'" } @@ -97102,7 +69474,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityLabel", "value": "string", - "description": "A label announced by assistive technologies that describes the purpose or contents of the element. Only set this when the element's visible content doesn't provide enough context on its own.", + "description": "A label that describes the purpose or contents of the element. When set, it will be announced to users using assistive technologies and will provide them with more context.\n\nOnly use this when the element's content is not enough context for users using assistive technologies.", "isOptional": true }, { @@ -97110,7 +69482,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityVisibility", "value": "'visible' | 'hidden' | 'exclusive'", - "description": "Changes the visibility of the element.\n\n- `visible`: the element is visible to all users.\n- `hidden`: the element is removed from the accessibility tree but remains visible.\n- `exclusive`: the element is visually hidden but remains in the accessibility tree.", + "description": "Controls how the element is exposed to sighted users and to assistive technologies such as screen readers.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", "isOptional": true, "defaultValue": "'visible'" }, @@ -97119,11 +69491,7 @@ "syntaxKind": "PropertySignature", "name": "background", "value": "'base' | 'subdued' | 'transparent'", -<<<<<<< HEAD "description": "Adjust the background of the element.\n\n- `'transparent'`: No visible background.\n- `'subdued'`: A subtle, low-emphasis background.\n- `'base'`: The standard background color.\n- `'strong'`: A high-emphasis background for prominence.", -======= - "description": "The background color of the element.\n\n- `base`: The standard background color for general content areas.\n- `subdued`: A muted background for secondary or supporting content.\n- `transparent`: No background color (the default).\n- `strong`: An emphasized background for prominent sections.", ->>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) "isOptional": true, "defaultValue": "'transparent'" }, @@ -97189,7 +69557,7 @@ "syntaxKind": "PropertySignature", "name": "command", "value": "'--auto' | '--show' | '--hide' | '--toggle' | '--copy'", - "description": "Sets the action the `commandFor` should take when this clickable is activated.\n\nSee the documentation of particular components for the actions they support.\n\n- `--auto`: Performs the default action for the target component.\n- `--show`: Displays the target component.\n- `--hide`: Conceals the target component.\n- `--toggle`: Alternates the target component.\n- `--copy`: Copies the target ClipboardItem.", + "description": "Sets the action the `commandFor` target should take when this component is activated.\n\n- `--auto`: Performs the default action for the target component.\n- `--show`: Displays the target component.\n- `--hide`: Conceals the target component.\n- `--toggle`: Alternates the target component.\n- `--copy`: Copies the target ClipboardItem.\n\nLearn more about the [`command` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).", "isOptional": true, "defaultValue": "'--auto'" }, @@ -97198,7 +69566,7 @@ "syntaxKind": "PropertySignature", "name": "commandFor", "value": "string", - "description": "ID of a component that should respond to activations (such as clicks) on this component.\n\nSee `command` for how to control the behavior of the target.", + "description": "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).\n\nWhen both `commandFor` and `href` are set, `commandFor` takes precedence. The command runs and the link doesn't navigate.", "isOptional": true }, { @@ -97215,7 +69583,7 @@ "syntaxKind": "PropertySignature", "name": "display", "value": "MaybeResponsive<\"auto\" | \"none\">", - "description": "Sets the outer display type of the component. The outer type sets a component\u2019s participation in [flow layout](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_flow_layout).\n\n- `auto`: the component\u2019s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.", + "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.\n\nLearn more about the [display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display).", "isOptional": true, "defaultValue": "'auto'" }, @@ -97311,7 +69679,7 @@ "syntaxKind": "PropertySignature", "name": "overflow", "value": "'hidden' | 'visible'", - "description": "The overflow behavior of the element.\n\n- `visible`: Content that extends beyond the container is visible.\n- `hidden`: Content that extends beyond the container is clipped and not scrollable.", + "description": "Sets the overflow behavior of the element.\n\n- `visible`: The content that extends beyond the element’s container is visible.\n- `hidden`: Clips the content when it is larger than the element’s container. The element will not be scrollable and users will not be able to access the clipped content by dragging or using a scroll wheel on a mouse.", "isOptional": true, "defaultValue": "'visible'" }, @@ -97392,12 +69760,12 @@ "syntaxKind": "PropertySignature", "name": "type", "value": "'submit' | 'button'", - "description": "The behavioral type of the button component, which determines what action it performs when activated.\n\n- `submit`: Submits the closest form.\n- `button`: Performs no default action when activated.\n- `reset`: Resets the closest form (returning fields to their default values).\n\nThis property is ignored if the component supports `href` or `commandFor`/`command` and one of them is set.", + "description": "The behavioral type of the clickable component, which determines what action it performs when activated.\n\n- `submit`: Submits the nearest containing form.\n- `button`: Performs no default action, relying on the `click` event handler for behavior.\n\nThis property is ignored if `href` or `commandFor`/`command` is set.", "isOptional": true, "defaultValue": "'button'" } ], - "value": "export interface ClickableElementProps extends Pick {\n background?: Extract;\n border?: BorderShorthand;\n borderWidth?: MaybeAllValuesShorthandProperty | '';\n borderRadius?: MaybeAllValuesShorthandProperty>;\n target?: Extract;\n type?: Extract;\n}" + "value": "export interface ClickableElementProps extends Pick {\n background?: Extract;\n border?: BorderShorthand;\n borderWidth?: MaybeAllValuesShorthandProperty | '';\n borderRadius?: MaybeAllValuesShorthandProperty>;\n target?: Extract;\n /**\n * The behavioral type of the clickable component, which determines what action it performs when activated.\n *\n * - `submit`: Submits the nearest containing form.\n * - `button`: Performs no default action, relying on the `click` event handler for behavior.\n *\n * This property is ignored if `href` or `commandFor`/`command` is set.\n *\n * @default 'button'\n */\n type?: Extract;\n}" } }, "ClickableProps": { @@ -97412,7 +69780,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityLabel", "value": "string", - "description": "A label announced by assistive technologies that describes the purpose or contents of the element. Only set this when the element's visible content doesn't provide enough context on its own.", + "description": "A label that describes the purpose or contents of the element. When set, it will be announced to users using assistive technologies and will provide them with more context.\n\nOnly use this when the element's content is not enough context for users using assistive technologies.", "isOptional": true }, { @@ -97420,7 +69788,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityVisibility", "value": "'visible' | 'hidden' | 'exclusive'", - "description": "Changes the visibility of the element.\n\n- `visible`: the element is visible to all users.\n- `hidden`: the element is removed from the accessibility tree but remains visible.\n- `exclusive`: the element is visually hidden but remains in the accessibility tree.", + "description": "Controls how the element is exposed to sighted users and to assistive technologies such as screen readers.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", "isOptional": true, "defaultValue": "'visible'" }, @@ -97429,11 +69797,7 @@ "syntaxKind": "PropertySignature", "name": "background", "value": "'base' | 'subdued' | 'transparent'", -<<<<<<< HEAD "description": "Adjust the background of the element.\n\n- `'transparent'`: No visible background.\n- `'subdued'`: A subtle, low-emphasis background.\n- `'base'`: The standard background color.\n- `'strong'`: A high-emphasis background for prominence.", -======= - "description": "The background color of the element.\n\n- `base`: The standard background color for general content areas.\n- `subdued`: A muted background for secondary or supporting content.\n- `transparent`: No background color (the default).\n- `strong`: An emphasized background for prominent sections.", ->>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) "isOptional": true, "defaultValue": "'transparent'" }, @@ -97485,7 +69849,7 @@ "syntaxKind": "PropertySignature", "name": "command", "value": "'--auto' | '--show' | '--hide' | '--toggle' | '--copy'", - "description": "Sets the action the `commandFor` should take when this clickable is activated.\n\nSee the documentation of particular components for the actions they support.\n\n- `--auto`: Performs the default action for the target component.\n- `--show`: Displays the target component.\n- `--hide`: Conceals the target component.\n- `--toggle`: Alternates the target component.\n- `--copy`: Copies the target ClipboardItem.", + "description": "Sets the action the `commandFor` target should take when this component is activated.\n\n- `--auto`: Performs the default action for the target component.\n- `--show`: Displays the target component.\n- `--hide`: Conceals the target component.\n- `--toggle`: Alternates the target component.\n- `--copy`: Copies the target ClipboardItem.\n\nLearn more about the [`command` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).", "isOptional": true, "defaultValue": "'--auto'" }, @@ -97494,7 +69858,7 @@ "syntaxKind": "PropertySignature", "name": "commandFor", "value": "string", - "description": "ID of a component that should respond to activations (such as clicks) on this component.\n\nSee `command` for how to control the behavior of the target.", + "description": "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).\n\nWhen both `commandFor` and `href` are set, `commandFor` takes precedence. The command runs and the link doesn't navigate.", "isOptional": true }, { @@ -97511,7 +69875,7 @@ "syntaxKind": "PropertySignature", "name": "display", "value": "MaybeResponsive<\"auto\" | \"none\">", - "description": "Sets the outer display type of the component. The outer type sets a component\u2019s participation in [flow layout](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_flow_layout).\n\n- `auto`: the component\u2019s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.", + "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.\n\nLearn more about the [display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display).", "isOptional": true, "defaultValue": "'auto'" }, @@ -97631,7 +69995,7 @@ "syntaxKind": "PropertySignature", "name": "overflow", "value": "'hidden' | 'visible'", - "description": "The overflow behavior of the element.\n\n- `visible`: Content that extends beyond the container is visible.\n- `hidden`: Content that extends beyond the container is clipped and not scrollable.", + "description": "Sets the overflow behavior of the element.\n\n- `visible`: The content that extends beyond the element’s container is visible.\n- `hidden`: Clips the content when it is larger than the element’s container. The element will not be scrollable and users will not be able to access the clipped content by dragging or using a scroll wheel on a mouse.", "isOptional": true, "defaultValue": "'visible'" }, @@ -97712,7 +70076,7 @@ "syntaxKind": "PropertySignature", "name": "type", "value": "'submit' | 'button'", - "description": "The behavioral type of the button component, which determines what action it performs when activated.\n\n- `submit`: Submits the closest form.\n- `button`: Performs no default action when activated.\n- `reset`: Resets the closest form (returning fields to their default values).\n\nThis property is ignored if the component supports `href` or `commandFor`/`command` and one of them is set.", + "description": "The behavioral type of the clickable component, which determines what action it performs when activated.\n\n- `submit`: Submits the nearest containing form.\n- `button`: Performs no default action, relying on the `click` event handler for behavior.\n\nThis property is ignored if `href` or `commandFor`/`command` is set.", "isOptional": true, "defaultValue": "'button'" } @@ -97759,7 +70123,7 @@ "src/surfaces/checkout/components/Clickable.ts": { "filePath": "src/surfaces/checkout/components/Clickable.ts", "name": "ClickableElementEvents", - "description": "The clickable component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", + "description": "", "isPublicDocs": true, "members": [ { @@ -97802,7 +70166,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityLabel", "value": "string", - "description": "A label announced by assistive technologies that describes the purpose or contents of the element. Only set this when the element's visible content doesn't provide enough context on its own.", + "description": "A label that describes the purpose or contents of the element. When set, it will be announced to users using assistive technologies and will provide them with more context.\n\nOnly use this when the element's content is not enough context for users using assistive technologies.", "isOptional": true }, { @@ -97810,7 +70174,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityVisibility", "value": "'visible' | 'hidden' | 'exclusive'", - "description": "Changes the visibility of the element.\n\n- `visible`: the element is visible to all users.\n- `hidden`: the element is removed from the accessibility tree but remains visible.\n- `exclusive`: the element is visually hidden but remains in the accessibility tree.", + "description": "Controls how the element is exposed to sighted users and to assistive technologies such as screen readers.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", "isOptional": true, "defaultValue": "'visible'" }, @@ -97833,7 +70197,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/Clickable.ts", @@ -98288,11 +70652,7 @@ "syntaxKind": "PropertySignature", "name": "background", "value": "'base' | 'subdued' | 'transparent'", -<<<<<<< HEAD "description": "Adjust the background of the element.\n\n- `'transparent'`: No visible background.\n- `'subdued'`: A subtle, low-emphasis background.\n- `'base'`: The standard background color.\n- `'strong'`: A high-emphasis background for prominence.", -======= - "description": "The background color of the element.\n\n- `base`: The standard background color for general content areas.\n- `subdued`: A muted background for secondary or supporting content.\n- `transparent`: No background color (the default).\n- `strong`: An emphasized background for prominent sections.", ->>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) "isOptional": true, "defaultValue": "'transparent'" }, @@ -98463,7 +70823,7 @@ "syntaxKind": "PropertySignature", "name": "command", "value": "'--auto' | '--show' | '--hide' | '--toggle' | '--copy'", - "description": "Sets the action the `commandFor` should take when this clickable is activated.\n\nSee the documentation of particular components for the actions they support.\n\n- `--auto`: Performs the default action for the target component.\n- `--show`: Displays the target component.\n- `--hide`: Conceals the target component.\n- `--toggle`: Alternates the target component.\n- `--copy`: Copies the target ClipboardItem.", + "description": "Sets the action the `commandFor` target should take when this component is activated.\n\n- `--auto`: Performs the default action for the target component.\n- `--show`: Displays the target component.\n- `--hide`: Conceals the target component.\n- `--toggle`: Alternates the target component.\n- `--copy`: Copies the target ClipboardItem.\n\nLearn more about the [`command` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).", "isOptional": true, "defaultValue": "'--auto'" }, @@ -98472,7 +70832,7 @@ "syntaxKind": "PropertySignature", "name": "commandFor", "value": "string", - "description": "ID of a component that should respond to activations (such as clicks) on this component.\n\nSee `command` for how to control the behavior of the target.", + "description": "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).\n\nWhen both `commandFor` and `href` are set, `commandFor` takes precedence. The command runs and the link doesn't navigate.", "isOptional": true }, { @@ -98552,7 +70912,7 @@ "syntaxKind": "PropertySignature", "name": "display", "value": "MaybeResponsive<\"auto\" | \"none\">", - "description": "Sets the outer display type of the component. The outer type sets a component\u2019s participation in [flow layout](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_flow_layout).\n\n- `auto`: the component\u2019s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.", + "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.\n\nLearn more about the [display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display).", "isOptional": true, "defaultValue": "'auto'" }, @@ -99877,7 +72237,7 @@ "syntaxKind": "PropertySignature", "name": "overflow", "value": "'hidden' | 'visible'", - "description": "The overflow behavior of the element.\n\n- `visible`: Content that extends beyond the container is visible.\n- `hidden`: Content that extends beyond the container is clipped and not scrollable.", + "description": "Sets the overflow behavior of the element.\n\n- `visible`: The content that extends beyond the element’s container is visible.\n- `hidden`: Clips the content when it is larger than the element’s container. The element will not be scrollable and users will not be able to access the clipped content by dragging or using a scroll wheel on a mouse.", "isOptional": true, "defaultValue": "'visible'" }, @@ -100077,7 +72437,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/Clickable.ts", @@ -100324,7 +72684,7 @@ "syntaxKind": "PropertySignature", "name": "type", "value": "'submit' | 'button'", - "description": "The behavioral type of the button component, which determines what action it performs when activated.\n\n- `submit`: Submits the closest form.\n- `button`: Performs no default action when activated.\n- `reset`: Resets the closest form (returning fields to their default values).\n\nThis property is ignored if the component supports `href` or `commandFor`/`command` and one of them is set.", + "description": "The behavioral type of the clickable component, which determines what action it performs when activated.\n\n- `submit`: Submits the nearest containing form.\n- `button`: Performs no default action, relying on the `click` event handler for behavior.\n\nThis property is ignored if `href` or `commandFor`/`command` is set.", "isOptional": true, "defaultValue": "'button'" }, @@ -100351,7 +72711,7 @@ "src/surfaces/checkout/components/ClipboardItem.ts": { "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", "name": "ClipboardItemElementProps", - "description": "Enables copying text to the user\u2019s clipboard. Use alongside Button or Link components to let users easily copy content. `` doesn\u2019t render visually.", + "description": "", "isPublicDocs": true, "members": [ { @@ -100367,7 +72727,7 @@ "syntaxKind": "PropertySignature", "name": "text", "value": "string", - "description": "Plain text to be written to the clipboard.", + "description": "Plain text to be written to the clipboard.\n\nRich text, HTML, and binary content aren't supported.", "isOptional": true, "defaultValue": "''" } @@ -100406,7 +72766,7 @@ "src/surfaces/checkout/components/ClipboardItem.ts": { "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", "name": "ClipboardItemElementEvents", - "description": "The clipboard item component provides event callbacks for handling copy interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", + "description": "", "isPublicDocs": true, "members": [ { @@ -100455,7 +72815,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", @@ -102471,7 +74831,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", @@ -102667,7 +75027,7 @@ "syntaxKind": "PropertySignature", "name": "text", "value": "string", - "description": "Plain text to be written to the clipboard.", + "description": "Plain text to be written to the clipboard.\n\nRich text, HTML, and binary content aren't supported.", "isOptional": true, "defaultValue": "''" }, @@ -102768,7 +75128,7 @@ "syntaxKind": "PropertySignature", "name": "text", "value": "string", - "description": "Plain text to be written to the clipboard.", + "description": "Plain text to be written to the clipboard.\n\nRich text, HTML, and binary content aren't supported.", "isOptional": true, "defaultValue": "''" } @@ -102780,7 +75140,7 @@ "src/surfaces/checkout/components/ConsentCheckbox.ts": { "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", "name": "ConsentCheckboxElementProps", - "description": "Configure the following properties on the consent checkbox component.", + "description": "", "isPublicDocs": true, "members": [ { @@ -102796,7 +75156,7 @@ "syntaxKind": "PropertySignature", "name": "checked", "value": "boolean", - "description": "Whether the control is active.", + "description": "Whether the control is currently checked.", "isOptional": true, "defaultValue": "false" }, @@ -102805,7 +75165,7 @@ "syntaxKind": "PropertySignature", "name": "command", "value": "'--auto' | '--show' | '--hide' | '--toggle'", - "description": "Sets the action the `commandFor` should take when this clickable is activated.\n\nSee the documentation of particular components for the actions they support.\n\n- `--auto`: Performs the default action for the target component.\n- `--show`: Displays the target component.\n- `--hide`: Conceals the target component.\n- `--toggle`: Alternates the target component.\n- `--copy`: Copies the target ClipboardItem.", + "description": "Sets the action the `commandFor` target should take when this component is activated.\n\n- `--auto`: Performs the default action for the target component.\n- `--show`: Displays the target component.\n- `--hide`: Conceals the target component.\n- `--toggle`: Alternates the target component.\n- `--copy`: Copies the target ClipboardItem.\n\nLearn more about the [`command` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).", "isOptional": true, "defaultValue": "'--auto'" }, @@ -102814,7 +75174,7 @@ "syntaxKind": "PropertySignature", "name": "commandFor", "value": "string", - "description": "ID of a component that should respond to activations (such as clicks) on this component.\n\nSee `command` for how to control the behavior of the target.", + "description": "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).\n\nWhen both `commandFor` and `href` are set, `commandFor` takes precedence. The command runs and the link doesn't navigate.", "isOptional": true }, { @@ -102822,7 +75182,7 @@ "syntaxKind": "PropertySignature", "name": "defaultChecked", "value": "boolean", - "description": "Whether the control is active by default.", + "description": "Whether the control is checked by default.", "isOptional": true, "defaultValue": "false" }, @@ -102831,7 +75191,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the control, disallowing any interaction.", + "description": "Whether the control is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -102864,15 +75224,15 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the control that is unique within the nearest containing `Form` component.", + "description": "The name attribute for the control, used to identify its value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", "syntaxKind": "PropertySignature", "name": "policy", - "value": "ConsentPolicy", - "description": "The policy for which user consent is being collected for.\n\n`sms-marketing`: Represents the policy for SMS marketing consent.", + "value": "'sms-marketing'", + "description": "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.\n\n- `sms-marketing`: Represents the policy for SMS marketing consent.", "isOptional": true }, { @@ -102884,17 +75244,7 @@ "isOptional": true } ], - "value": "export interface ConsentCheckboxElementProps extends Pick {\n command?: Extract;\n}" - } - }, - "ConsentPolicy": { - "src/surfaces/checkout/components/components.ts": { - "filePath": "src/surfaces/checkout/components/components.ts", - "syntaxKind": "TypeAliasDeclaration", - "name": "ConsentPolicy", - "value": "\"sms-marketing\"", - "description": "", - "isPublicDocs": true + "value": "export interface ConsentCheckboxElementProps extends Pick {\n command?: Extract;\n /**\n * 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.\n *\n * - `sms-marketing`: Represents the policy for SMS marketing consent.\n */\n policy?: ConsentCheckboxProps$1['policy'];\n}" } }, "ConsentCheckboxEvents": { @@ -102920,7 +75270,7 @@ "src/surfaces/checkout/components/ConsentCheckbox.ts": { "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", "name": "ConsentCheckboxElementEvents", - "description": "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).", + "description": "", "isPublicDocs": true, "members": [ { @@ -102969,7 +75319,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", @@ -103452,7 +75802,7 @@ "syntaxKind": "PropertySignature", "name": "checked", "value": "boolean", - "description": "Whether the control is active.", + "description": "Whether the control is currently checked.", "isOptional": true, "defaultValue": "false" }, @@ -103552,7 +75902,7 @@ "syntaxKind": "PropertySignature", "name": "command", "value": "'--auto' | '--show' | '--hide' | '--toggle'", - "description": "Sets the action the `commandFor` should take when this clickable is activated.\n\nSee the documentation of particular components for the actions they support.\n\n- `--auto`: Performs the default action for the target component.\n- `--show`: Displays the target component.\n- `--hide`: Conceals the target component.\n- `--toggle`: Alternates the target component.\n- `--copy`: Copies the target ClipboardItem.", + "description": "Sets the action the `commandFor` target should take when this component is activated.\n\n- `--auto`: Performs the default action for the target component.\n- `--show`: Displays the target component.\n- `--hide`: Conceals the target component.\n- `--toggle`: Alternates the target component.\n- `--copy`: Copies the target ClipboardItem.\n\nLearn more about the [`command` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).", "isOptional": true, "defaultValue": "'--auto'" }, @@ -103561,7 +75911,7 @@ "syntaxKind": "PropertySignature", "name": "commandFor", "value": "string", - "description": "ID of a component that should respond to activations (such as clicks) on this component.\n\nSee `command` for how to control the behavior of the target.", + "description": "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).\n\nWhen both `commandFor` and `href` are set, `commandFor` takes precedence. The command runs and the link doesn't navigate.", "isOptional": true }, { @@ -103618,7 +75968,7 @@ "syntaxKind": "PropertySignature", "name": "defaultChecked", "value": "boolean", - "description": "Whether the control is active by default.", + "description": "Whether the control is checked by default.", "isOptional": true, "defaultValue": "false" }, @@ -103634,7 +75984,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the control, disallowing any interaction.", + "description": "Whether the control is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -104074,7 +76424,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the control that is unique within the nearest containing `Form` component.", + "description": "The name attribute for the control, used to identify its value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -104945,8 +77295,8 @@ "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", "syntaxKind": "PropertySignature", "name": "policy", - "value": "ConsentPolicy", - "description": "The policy for which user consent is being collected for.\n\n`sms-marketing`: Represents the policy for SMS marketing consent.", + "value": "'sms-marketing'", + "description": "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.\n\n- `sms-marketing`: Represents the policy for SMS marketing consent.", "isOptional": true }, { @@ -105054,7 +77404,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", @@ -105334,7 +77684,7 @@ "syntaxKind": "PropertySignature", "name": "checked", "value": "boolean", - "description": "Whether the control is active.", + "description": "Whether the control is currently checked.", "isOptional": true, "defaultValue": "false" }, @@ -105343,7 +77693,7 @@ "syntaxKind": "PropertySignature", "name": "command", "value": "'--auto' | '--show' | '--hide' | '--toggle'", - "description": "Sets the action the `commandFor` should take when this clickable is activated.\n\nSee the documentation of particular components for the actions they support.\n\n- `--auto`: Performs the default action for the target component.\n- `--show`: Displays the target component.\n- `--hide`: Conceals the target component.\n- `--toggle`: Alternates the target component.\n- `--copy`: Copies the target ClipboardItem.", + "description": "Sets the action the `commandFor` target should take when this component is activated.\n\n- `--auto`: Performs the default action for the target component.\n- `--show`: Displays the target component.\n- `--hide`: Conceals the target component.\n- `--toggle`: Alternates the target component.\n- `--copy`: Copies the target ClipboardItem.\n\nLearn more about the [`command` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).", "isOptional": true, "defaultValue": "'--auto'" }, @@ -105352,7 +77702,7 @@ "syntaxKind": "PropertySignature", "name": "commandFor", "value": "string", - "description": "ID of a component that should respond to activations (such as clicks) on this component.\n\nSee `command` for how to control the behavior of the target.", + "description": "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).\n\nWhen both `commandFor` and `href` are set, `commandFor` takes precedence. The command runs and the link doesn't navigate.", "isOptional": true }, { @@ -105360,7 +77710,7 @@ "syntaxKind": "PropertySignature", "name": "defaultChecked", "value": "boolean", - "description": "Whether the control is active by default.", + "description": "Whether the control is checked by default.", "isOptional": true, "defaultValue": "false" }, @@ -105369,7 +77719,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the control, disallowing any interaction.", + "description": "Whether the control is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -105402,7 +77752,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the control that is unique within the nearest containing `Form` component.", + "description": "The name attribute for the control, used to identify its value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -105417,8 +77767,8 @@ "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", "syntaxKind": "PropertySignature", "name": "policy", - "value": "ConsentPolicy", - "description": "The policy for which user consent is being collected for.\n\n`sms-marketing`: Represents the policy for SMS marketing consent.", + "value": "'sms-marketing'", + "description": "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.\n\n- `sms-marketing`: Represents the policy for SMS marketing consent.", "isOptional": true }, { @@ -105437,7 +77787,7 @@ "src/surfaces/checkout/components/ConsentPhoneField.ts": { "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", "name": "PhoneFieldElementProps", - "description": "Configure the following properties on the phone field component.", + "description": "", "isPublicDocs": true, "members": [ { @@ -105445,7 +77795,7 @@ "syntaxKind": "PropertySignature", "name": "autocomplete", "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", "isOptional": true, "defaultValue": "'on' for everything else" }, @@ -105462,7 +77812,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -105540,9 +77890,9 @@ "syntaxKind": "PropertySignature", "name": "type", "value": "'mobile' | ''", - "description": "The type of number to collect.\n\nSpecific style may be applied to each type to provide extra guidance to users. Note that no extra validation is performed based on the type.", + "description": "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.\n\nStyling hint for the input keyboard. Doesn't validate the phone number format. Implement validation in your extension and use the `error` prop to show results.", "isOptional": true, - "defaultValue": "'' meaning no specific kind of phone number" + "defaultValue": "''" }, { "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", @@ -105576,11 +77926,7 @@ "syntaxKind": "PropertySignature", "name": "onChange", "value": "(event: Event) => void", -<<<<<<< HEAD - "description": "Callback when the user has **finished editing** a field, for example, once they have blurred the field.", -======= - "description": "A callback fired when the user has **finished editing** a field, such as when they blur the field or press Enter. Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", ->>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) + "description": "A callback fired when the user has **finished editing** a field, such as when they blur the field or press Enter.", "isOptional": true }, { @@ -105596,7 +77942,7 @@ "syntaxKind": "PropertySignature", "name": "onInput", "value": "(event: Event) => void", - "description": "A callback fired when the user makes any changes in the field, such as typing a character. Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).", + "description": "A callback fired when the user makes any changes in the field, such as typing a character.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).", "isOptional": true } ], @@ -105629,7 +77975,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", @@ -106070,7 +78416,7 @@ "syntaxKind": "PropertySignature", "name": "autocomplete", "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", "isOptional": true, "defaultValue": "'on' for everything else" }, @@ -106276,7 +78622,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -107709,7 +80055,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", @@ -107956,9 +80302,9 @@ "syntaxKind": "PropertySignature", "name": "type", "value": "'mobile' | ''", - "description": "The type of number to collect.\n\nSpecific style may be applied to each type to provide extra guidance to users. Note that no extra validation is performed based on the type.", + "description": "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.\n\nStyling hint for the input keyboard. Doesn't validate the phone number format. Implement validation in your extension and use the `error` prop to show results.", "isOptional": true, - "defaultValue": "'' meaning no specific kind of phone number" + "defaultValue": "''" }, { "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", @@ -107999,7 +80345,7 @@ "syntaxKind": "PropertySignature", "name": "autocomplete", "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", "isOptional": true, "defaultValue": "'on' for everything else" }, @@ -108016,7 +80362,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -108074,11 +80420,7 @@ "syntaxKind": "PropertySignature", "name": "onChange", "value": "(event: Event) => void", -<<<<<<< HEAD - "description": "Callback when the user has **finished editing** a field, for example, once they have blurred the field.", -======= - "description": "A callback fired when the user has **finished editing** a field, such as when they blur the field or press Enter. Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", ->>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) + "description": "A callback fired when the user has **finished editing** a field, such as when they blur the field or press Enter.", "isOptional": true }, { @@ -108094,7 +80436,7 @@ "syntaxKind": "PropertySignature", "name": "onInput", "value": "(event: Event) => void", - "description": "A callback fired when the user makes any changes in the field, such as typing a character. Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).", + "description": "A callback fired when the user makes any changes in the field, such as typing a character.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).", "isOptional": true }, { @@ -108130,9 +80472,9 @@ "syntaxKind": "PropertySignature", "name": "type", "value": "'mobile' | ''", - "description": "The type of number to collect.\n\nSpecific style may be applied to each type to provide extra guidance to users. Note that no extra validation is performed based on the type.", + "description": "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.\n\nStyling hint for the input keyboard. Doesn't validate the phone number format. Implement validation in your extension and use the `error` prop to show results.", "isOptional": true, - "defaultValue": "'' meaning no specific kind of phone number" + "defaultValue": "''" }, { "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", @@ -108150,7 +80492,7 @@ "src/surfaces/checkout/components/ConsentPhoneField.ts": { "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", "name": "ConsentPhoneFieldElementProps", - "description": "Configure the following properties on the consent phone field component.", + "description": "", "isPublicDocs": true, "members": [ { @@ -108158,7 +80500,7 @@ "syntaxKind": "PropertySignature", "name": "autocomplete", "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", "isOptional": true, "defaultValue": "'on' for everything else" }, @@ -108175,7 +80517,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -108234,8 +80576,8 @@ "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", "syntaxKind": "PropertySignature", "name": "policy", - "value": "ConsentPolicy", - "description": "The policy for which user consent is being collected for.\n\n`sms-marketing`: Represents the policy for SMS marketing consent.", + "value": "'sms-marketing'", + "description": "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.\n\n- `sms-marketing`: Represents the policy for SMS marketing consent.", "isOptional": true }, { @@ -108261,9 +80603,9 @@ "syntaxKind": "PropertySignature", "name": "type", "value": "'mobile' | ''", - "description": "The type of number to collect.\n\nSpecific style may be applied to each type to provide extra guidance to users. Note that no extra validation is performed based on the type.", + "description": "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.\n\nStyling hint for the input keyboard. Doesn't validate the phone number format. Implement validation in your extension and use the `error` prop to show results.", "isOptional": true, - "defaultValue": "'' meaning no specific kind of phone number" + "defaultValue": "''" }, { "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", @@ -108274,7 +80616,7 @@ "isOptional": true } ], - "value": "export interface ConsentPhoneFieldElementProps extends Pick {\n /**\n * @deprecated Use `label` instead.\n * @private\n */\n placeholder?: string;\n}" + "value": "export interface ConsentPhoneFieldElementProps extends Pick {\n /**\n * @deprecated Use `label` instead.\n * @private\n */\n placeholder?: string;\n /**\n * 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.\n *\n * - `sms-marketing`: Represents the policy for SMS marketing consent.\n */\n policy?: ConsentPhoneFieldProps$1['policy'];\n}" } }, "ConsentPhoneFieldEvents": { @@ -108297,11 +80639,7 @@ "syntaxKind": "PropertySignature", "name": "onChange", "value": "(event: Event) => void", -<<<<<<< HEAD - "description": "Callback when the user has **finished editing** a field, for example, once they have blurred the field.", -======= - "description": "A callback fired when the user has **finished editing** a field, such as when they blur the field or press Enter. Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", ->>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) + "description": "A callback fired when the user has **finished editing** a field, such as when they blur the field or press Enter.", "isOptional": true }, { @@ -108317,7 +80655,7 @@ "syntaxKind": "PropertySignature", "name": "onInput", "value": "(event: Event) => void", - "description": "A callback fired when the user makes any changes in the field, such as typing a character. Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).", + "description": "A callback fired when the user makes any changes in the field, such as typing a character.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).", "isOptional": true } ], @@ -108328,7 +80666,7 @@ "src/surfaces/checkout/components/ConsentPhoneField.ts": { "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", "name": "ConsentPhoneFieldElementEvents", - "description": "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).", + "description": "", "isPublicDocs": true, "members": [ { @@ -108336,11 +80674,7 @@ "syntaxKind": "PropertySignature", "name": "blur", "value": "CallbackEventListener", -<<<<<<< HEAD - "description": "A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", -======= "description": "A callback fired when the consent phone field loses focus.\n\nLearn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", ->>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) "isOptional": true }, { @@ -108348,11 +80682,7 @@ "syntaxKind": "PropertySignature", "name": "change", "value": "CallbackEventListener", -<<<<<<< HEAD - "description": "Callback when the user has **finished editing** a field, for example, once they have blurred the field.", -======= "description": "A callback fired when the consent phone field value changes.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", ->>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) "isOptional": true }, { @@ -108360,11 +80690,7 @@ "syntaxKind": "PropertySignature", "name": "focus", "value": "CallbackEventListener", -<<<<<<< HEAD - "description": "A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", -======= "description": "A callback fired when the consent phone field receives focus.\n\nLearn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", ->>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) "isOptional": true }, { @@ -108376,11 +80702,7 @@ "isOptional": true } ], -<<<<<<< HEAD - "value": "export interface ConsentPhoneFieldElementEvents {\n /**\n * A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event\n */\n blur?: CallbackEventListener;\n /**\n * Callback when the user has **finished editing** a field, for example, once they have blurred the field.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event\n */\n change?: CallbackEventListener;\n /**\n * A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event\n */\n focus?: CallbackEventListener;\n /**\n * Callback when the user makes any changes in the field.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event\n */\n input?: CallbackEventListener;\n}" -======= "value": "export interface ConsentPhoneFieldElementEvents {\n /**\n * A callback fired when the consent phone field loses focus.\n *\n * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur?: CallbackEventListener;\n /**\n * A callback fired when the consent phone field value changes.\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change?: CallbackEventListener;\n /**\n * A callback fired when the consent phone field receives focus.\n *\n * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus?: CallbackEventListener;\n /**\n * A callback fired when the user inputs data into the consent phone field.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input?: CallbackEventListener;\n}" ->>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) } }, "ConsentPhoneFieldElement": { @@ -108395,7 +80717,7 @@ "syntaxKind": "PropertySignature", "name": "autocomplete", "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", "isOptional": true, "defaultValue": "'on' for everything else" }, @@ -108412,7 +80734,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -108499,8 +80821,8 @@ "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", "syntaxKind": "PropertySignature", "name": "policy", - "value": "ConsentPolicy", - "description": "The policy for which user consent is being collected for.\n\n`sms-marketing`: Represents the policy for SMS marketing consent.", + "value": "'sms-marketing'", + "description": "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.\n\n- `sms-marketing`: Represents the policy for SMS marketing consent.", "isOptional": true }, { @@ -108526,9 +80848,9 @@ "syntaxKind": "PropertySignature", "name": "type", "value": "'mobile' | ''", - "description": "The type of number to collect.\n\nSpecific style may be applied to each type to provide extra guidance to users. Note that no extra validation is performed based on the type.", + "description": "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.\n\nStyling hint for the input keyboard. Doesn't validate the phone number format. Implement validation in your extension and use the `error` prop to show results.", "isOptional": true, - "defaultValue": "'' meaning no specific kind of phone number" + "defaultValue": "''" }, { "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", @@ -108546,7 +80868,7 @@ "src/surfaces/checkout/components/ConsentPhoneField.ts": { "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", "name": "ConsentPhoneFieldElementSlots", - "description": "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).", + "description": "", "isPublicDocs": true, "members": [ { @@ -108573,7 +80895,7 @@ "syntaxKind": "PropertySignature", "name": "autocomplete", "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", "isOptional": true, "defaultValue": "'on' for everything else" }, @@ -108590,7 +80912,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -108648,11 +80970,7 @@ "syntaxKind": "PropertySignature", "name": "onChange", "value": "(event: Event) => void", -<<<<<<< HEAD - "description": "Callback when the user has **finished editing** a field, for example, once they have blurred the field.", -======= - "description": "A callback fired when the user has **finished editing** a field, such as when they blur the field or press Enter. Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", ->>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) + "description": "A callback fired when the user has **finished editing** a field, such as when they blur the field or press Enter.", "isOptional": true }, { @@ -108668,7 +80986,7 @@ "syntaxKind": "PropertySignature", "name": "onInput", "value": "(event: Event) => void", - "description": "A callback fired when the user makes any changes in the field, such as typing a character. Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).", + "description": "A callback fired when the user makes any changes in the field, such as typing a character.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).", "isOptional": true }, { @@ -108685,8 +81003,8 @@ "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", "syntaxKind": "PropertySignature", "name": "policy", - "value": "ConsentPolicy", - "description": "The policy for which user consent is being collected for.\n\n`sms-marketing`: Represents the policy for SMS marketing consent.", + "value": "'sms-marketing'", + "description": "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.\n\n- `sms-marketing`: Represents the policy for SMS marketing consent.", "isOptional": true }, { @@ -108712,9 +81030,9 @@ "syntaxKind": "PropertySignature", "name": "type", "value": "'mobile' | ''", - "description": "The type of number to collect.\n\nSpecific style may be applied to each type to provide extra guidance to users. Note that no extra validation is performed based on the type.", + "description": "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.\n\nStyling hint for the input keyboard. Doesn't validate the phone number format. Implement validation in your extension and use the `error` prop to show results.", "isOptional": true, - "defaultValue": "'' meaning no specific kind of phone number" + "defaultValue": "''" }, { "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", @@ -108732,7 +81050,7 @@ "src/surfaces/checkout/components/DateField.ts": { "filePath": "src/surfaces/checkout/components/DateField.ts", "name": "DateFieldElementProps", - "description": "Configure the following properties on the date field component.", + "description": "", "isPublicDocs": true, "members": [ { @@ -108740,7 +81058,7 @@ "syntaxKind": "PropertySignature", "name": "allow", "value": "string", - "description": "Dates that can be selected.\n\nA comma-separated list of dates, date ranges. Whitespace is allowed after commas.\n\nThe default `''` allows all dates.\n\n- Dates in `YYYY-MM-DD` format allow a single date.\n- Dates in `YYYY-MM` format allow a whole month.\n- Dates in `YYYY` format allow a whole year.\n- Ranges are expressed as `start--end`. - Ranges are inclusive.\n - If either `start` or `end` is omitted, the range is unbounded in that direction.\n - If parts of the date are omitted for `start`, they are assumed to be the minimum possible value.\n So `2024--` is equivalent to `2024-01-01--`.\n - If parts of the date are omitted for `end`, they are assumed to be the maximum possible value.\n So `--2024` is equivalent to `--2024-12-31`.\n - Whitespace is allowed either side of `--`.", + "description": "Restricts which dates the user can select. Accepts a comma-separated list of dates and date ranges. Whitespace is allowed after commas.\n\nThe default `''` allows all dates.\n\n- Dates in `YYYY-MM-DD` format allow a single date.\n- Dates in `YYYY-MM` format allow a whole month.\n- Dates in `YYYY` format allow a whole year.\n- Ranges are expressed as `start--end`. - Ranges are inclusive.\n - If either `start` or `end` is omitted, the range is unbounded in that direction.\n - If parts of the date are omitted for `start`, they are assumed to be the minimum possible value.\n So `2024--` is equivalent to `2024-01-01--`.\n - If parts of the date are omitted for `end`, they are assumed to be the maximum possible value.\n So `--2024` is equivalent to `--2024-12-31`.\n - Whitespace is allowed either side of `--`.\n\nComma-separated list of allowed dates in `YYYY-MM-DD` format.", "isOptional": true, "defaultValue": "\"\"", "examples": [ @@ -108761,7 +81079,7 @@ "syntaxKind": "PropertySignature", "name": "allowDays", "value": "string", - "description": "Days of the week that can be selected. These intersect with the result of `allow` and `disallow`.\n\nA comma-separated list of days. Whitespace is allowed after commas.\n\nThe default `''` has no effect on the result of `allow` and `disallow`.\n\nDays are `sunday`, `monday`, `tuesday`, `wednesday`, `thursday`, `friday`, `saturday`.", + "description": "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.\n\nA comma-separated list of days. Whitespace is allowed after commas.\n\nThe default `''` has no effect on the result of `allow` and `disallow`.\n\nDays are `sunday`, `monday`, `tuesday`, `wednesday`, `thursday`, `friday`, `saturday`.", "isOptional": true, "defaultValue": "\"\"", "examples": [ @@ -108782,7 +81100,7 @@ "syntaxKind": "PropertySignature", "name": "autocomplete", "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", "isOptional": true, "defaultValue": "'on' for everything else" }, @@ -108807,7 +81125,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -108816,7 +81134,7 @@ "syntaxKind": "PropertySignature", "name": "disallow", "value": "string", - "description": "Dates that cannot be selected. These subtract from `allow`.\n\nA comma-separated list of dates, date ranges. Whitespace is allowed after commas.\n\nThe default `''` has no effect on `allow`.\n\n- Dates in `YYYY-MM-DD` format disallow a single date.\n- Dates in `YYYY-MM` format disallow a whole month.\n- Dates in `YYYY` format disallow a whole year.\n- Ranges are expressed as `start--end`. - Ranges are inclusive.\n - If either `start` or `end` is omitted, the range is unbounded in that direction.\n - If parts of the date are omitted for `start`, they are assumed to be the minimum possible value.\n So `2024--` is equivalent to `2024-01-01--`.\n - If parts of the date are omitted for `end`, they are assumed to be the maximum possible value.\n So `--2024` is equivalent to `--2024-12-31`.\n - Whitespace is allowed either side of `--`.", + "description": "Dates that cannot be selected. These subtract from `allow`.\n\nA comma-separated list of dates, date ranges. Whitespace is allowed after commas.\n\nThe default `''` has no effect on `allow`.\n\n- Dates in `YYYY-MM-DD` format disallow a single date.\n- Dates in `YYYY-MM` format disallow a whole month.\n- Dates in `YYYY` format disallow a whole year.\n- Ranges are expressed as `start--end`. - Ranges are inclusive.\n - If either `start` or `end` is omitted, the range is unbounded in that direction.\n - If parts of the date are omitted for `start`, they are assumed to be the minimum possible value.\n So `2024--` is equivalent to `2024-01-01--`.\n - If parts of the date are omitted for `end`, they are assumed to be the maximum possible value.\n So `--2024` is equivalent to `--2024-12-31`.\n - Whitespace is allowed either side of `--`.\n\nComma-separated list of disallowed dates in `YYYY-MM-DD` format.", "isOptional": true, "defaultValue": "\"\"", "examples": [ @@ -108953,11 +81271,7 @@ "syntaxKind": "PropertySignature", "name": "onChange", "value": "(event: Event) => void", -<<<<<<< HEAD - "description": "Callback when the user has **finished editing** a field, for example, once they have blurred the field.", -======= - "description": "A callback fired when the user has **finished editing** a field, such as when they blur the field or press Enter. Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", ->>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) + "description": "A callback fired when the user has **finished editing** a field, such as when they blur the field or press Enter.", "isOptional": true }, { @@ -108973,7 +81287,7 @@ "syntaxKind": "PropertySignature", "name": "onInput", "value": "(event: Event) => void", - "description": "A callback fired when the user makes any changes in the field, such as typing a character. Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).", + "description": "A callback fired when the user makes any changes in the field, such as typing a character.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).", "isOptional": true }, { @@ -108981,7 +81295,7 @@ "syntaxKind": "PropertySignature", "name": "onInvalid", "value": "(event: Event) => void", - "description": "Callback when the field has an invalid date. This callback will be called, if the date typed is invalid or disabled.\n\nDates that don\u2019t exist or have formatting errors are considered invalid. Some examples of invalid dates are:\n- 2021-02-31: February doesn\u2019t have 31 days\n- 2021-02-00: The day can\u2019t be 00\n\nDisallowed dates are considered invalid.\n\nIt\u2019s important to note that this callback will be called only when the user **finishes editing** the date, and it\u2019s called right after the `onChange` callback. The field is **not** validated on every change to the input. Once the buyer has signalled that 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.", + "description": "Callback when the field has an invalid date. This callback will be called, if the date typed is invalid or disabled.\n\nDates that don’t exist or have formatting errors are considered invalid. Some examples of invalid dates are:\n- 2021-02-31: February doesn’t have 31 days\n- 2021-02-00: The day can’t be 00\n\nDisallowed dates are considered invalid.\n\nThis callback fires only when the user finishes editing the date, right after the `change` callback. The field isn’t validated on every change to the input. Once the user has signalled that 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.", "isOptional": true }, { @@ -109000,7 +81314,7 @@ "src/surfaces/checkout/components/DateField.ts": { "filePath": "src/surfaces/checkout/components/DateField.ts", "name": "DateFieldElementEvents", - "description": "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).", + "description": "", "isPublicDocs": true, "members": [ { @@ -109008,11 +81322,7 @@ "syntaxKind": "PropertySignature", "name": "blur", "value": "CallbackEventListener", -<<<<<<< HEAD - "description": "A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", -======= "description": "A callback fired when the date field loses focus.\n\nLearn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", ->>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) "isOptional": true }, { @@ -109020,11 +81330,7 @@ "syntaxKind": "PropertySignature", "name": "change", "value": "CallbackEventListener", -<<<<<<< HEAD - "description": "Callback when the user has **finished editing** a field, for example, once they have blurred the field.", -======= "description": "A callback fired when the date field value changes.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", ->>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) "isOptional": true }, { @@ -109032,11 +81338,7 @@ "syntaxKind": "PropertySignature", "name": "focus", "value": "CallbackEventListener", -<<<<<<< HEAD - "description": "A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", -======= "description": "A callback fired when the date field receives focus.\n\nLearn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", ->>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) "isOptional": true }, { @@ -109064,11 +81366,7 @@ "isOptional": true } ], -<<<<<<< HEAD - "value": "export interface DateFieldElementEvents {\n /**\n * A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur?: CallbackEventListener;\n /**\n * Callback when the user has **finished editing** a field, for example, once they have blurred the field.\n */\n change?: CallbackEventListener;\n /**\n * A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus?: CallbackEventListener;\n /**\n * Callback when the user makes any changes in the field.\n */\n input?: CallbackEventListener;\n /**\n * Callback when the user enters an invalid date.\n */\n invalid?: CallbackEventListener;\n /**\n * Callback when the view changes.\n */\n viewChange?: CallbackEventListener;\n}" -======= "value": "export interface DateFieldElementEvents {\n /**\n * A callback fired when the date field loses focus.\n *\n * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur?: CallbackEventListener;\n /**\n * A callback fired when the date field value changes.\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change?: CallbackEventListener;\n /**\n * A callback fired when the date field receives focus.\n *\n * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus?: CallbackEventListener;\n /**\n * A callback fired when the user inputs data into the date field.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input?: CallbackEventListener;\n /**\n * A callback fired when the date field value is invalid.\n *\n * Learn more about the [invalid event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement/invalid_event).\n */\n invalid?: CallbackEventListener;\n /**\n * A callback fired when the calendar view changes, such as when navigating between months.\n */\n viewChange?: CallbackEventListener;\n}" ->>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) } }, "DateFieldElement": { @@ -109097,7 +81395,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/DateField.ts", @@ -109111,7 +81409,7 @@ "syntaxKind": "PropertySignature", "name": "allow", "value": "string", - "description": "Dates that can be selected.\n\nA comma-separated list of dates, date ranges. Whitespace is allowed after commas.\n\nThe default `''` allows all dates.\n\n- Dates in `YYYY-MM-DD` format allow a single date.\n- Dates in `YYYY-MM` format allow a whole month.\n- Dates in `YYYY` format allow a whole year.\n- Ranges are expressed as `start--end`. - Ranges are inclusive.\n - If either `start` or `end` is omitted, the range is unbounded in that direction.\n - If parts of the date are omitted for `start`, they are assumed to be the minimum possible value.\n So `2024--` is equivalent to `2024-01-01--`.\n - If parts of the date are omitted for `end`, they are assumed to be the maximum possible value.\n So `--2024` is equivalent to `--2024-12-31`.\n - Whitespace is allowed either side of `--`.", + "description": "Restricts which dates the user can select. Accepts a comma-separated list of dates and date ranges. Whitespace is allowed after commas.\n\nThe default `''` allows all dates.\n\n- Dates in `YYYY-MM-DD` format allow a single date.\n- Dates in `YYYY-MM` format allow a whole month.\n- Dates in `YYYY` format allow a whole year.\n- Ranges are expressed as `start--end`. - Ranges are inclusive.\n - If either `start` or `end` is omitted, the range is unbounded in that direction.\n - If parts of the date are omitted for `start`, they are assumed to be the minimum possible value.\n So `2024--` is equivalent to `2024-01-01--`.\n - If parts of the date are omitted for `end`, they are assumed to be the maximum possible value.\n So `--2024` is equivalent to `--2024-12-31`.\n - Whitespace is allowed either side of `--`.\n\nComma-separated list of allowed dates in `YYYY-MM-DD` format.", "isOptional": true, "defaultValue": "\"\"", "examples": [ @@ -109132,7 +81430,7 @@ "syntaxKind": "PropertySignature", "name": "allowDays", "value": "string", - "description": "Days of the week that can be selected. These intersect with the result of `allow` and `disallow`.\n\nA comma-separated list of days. Whitespace is allowed after commas.\n\nThe default `''` has no effect on the result of `allow` and `disallow`.\n\nDays are `sunday`, `monday`, `tuesday`, `wednesday`, `thursday`, `friday`, `saturday`.", + "description": "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.\n\nA comma-separated list of days. Whitespace is allowed after commas.\n\nThe default `''` has no effect on the result of `allow` and `disallow`.\n\nDays are `sunday`, `monday`, `tuesday`, `wednesday`, `thursday`, `friday`, `saturday`.", "isOptional": true, "defaultValue": "\"\"", "examples": [ @@ -109580,7 +81878,7 @@ "syntaxKind": "PropertySignature", "name": "autocomplete", "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", "isOptional": true, "defaultValue": "'on' for everything else" }, @@ -109794,7 +82092,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -109803,7 +82101,7 @@ "syntaxKind": "PropertySignature", "name": "disallow", "value": "string", - "description": "Dates that cannot be selected. These subtract from `allow`.\n\nA comma-separated list of dates, date ranges. Whitespace is allowed after commas.\n\nThe default `''` has no effect on `allow`.\n\n- Dates in `YYYY-MM-DD` format disallow a single date.\n- Dates in `YYYY-MM` format disallow a whole month.\n- Dates in `YYYY` format disallow a whole year.\n- Ranges are expressed as `start--end`. - Ranges are inclusive.\n - If either `start` or `end` is omitted, the range is unbounded in that direction.\n - If parts of the date are omitted for `start`, they are assumed to be the minimum possible value.\n So `2024--` is equivalent to `2024-01-01--`.\n - If parts of the date are omitted for `end`, they are assumed to be the maximum possible value.\n So `--2024` is equivalent to `--2024-12-31`.\n - Whitespace is allowed either side of `--`.", + "description": "Dates that cannot be selected. These subtract from `allow`.\n\nA comma-separated list of dates, date ranges. Whitespace is allowed after commas.\n\nThe default `''` has no effect on `allow`.\n\n- Dates in `YYYY-MM-DD` format disallow a single date.\n- Dates in `YYYY-MM` format disallow a whole month.\n- Dates in `YYYY` format disallow a whole year.\n- Ranges are expressed as `start--end`. - Ranges are inclusive.\n - If either `start` or `end` is omitted, the range is unbounded in that direction.\n - If parts of the date are omitted for `start`, they are assumed to be the minimum possible value.\n So `2024--` is equivalent to `2024-01-01--`.\n - If parts of the date are omitted for `end`, they are assumed to be the maximum possible value.\n So `--2024` is equivalent to `--2024-12-31`.\n - Whitespace is allowed either side of `--`.\n\nComma-separated list of disallowed dates in `YYYY-MM-DD` format.", "isOptional": true, "defaultValue": "\"\"", "examples": [ @@ -111260,7 +83558,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/DateField.ts", @@ -111549,7 +83847,7 @@ "syntaxKind": "PropertySignature", "name": "allow", "value": "string", - "description": "Dates that can be selected.\n\nA comma-separated list of dates, date ranges. Whitespace is allowed after commas.\n\nThe default `''` allows all dates.\n\n- Dates in `YYYY-MM-DD` format allow a single date.\n- Dates in `YYYY-MM` format allow a whole month.\n- Dates in `YYYY` format allow a whole year.\n- Ranges are expressed as `start--end`. - Ranges are inclusive.\n - If either `start` or `end` is omitted, the range is unbounded in that direction.\n - If parts of the date are omitted for `start`, they are assumed to be the minimum possible value.\n So `2024--` is equivalent to `2024-01-01--`.\n - If parts of the date are omitted for `end`, they are assumed to be the maximum possible value.\n So `--2024` is equivalent to `--2024-12-31`.\n - Whitespace is allowed either side of `--`.", + "description": "Restricts which dates the user can select. Accepts a comma-separated list of dates and date ranges. Whitespace is allowed after commas.\n\nThe default `''` allows all dates.\n\n- Dates in `YYYY-MM-DD` format allow a single date.\n- Dates in `YYYY-MM` format allow a whole month.\n- Dates in `YYYY` format allow a whole year.\n- Ranges are expressed as `start--end`. - Ranges are inclusive.\n - If either `start` or `end` is omitted, the range is unbounded in that direction.\n - If parts of the date are omitted for `start`, they are assumed to be the minimum possible value.\n So `2024--` is equivalent to `2024-01-01--`.\n - If parts of the date are omitted for `end`, they are assumed to be the maximum possible value.\n So `--2024` is equivalent to `--2024-12-31`.\n - Whitespace is allowed either side of `--`.\n\nComma-separated list of allowed dates in `YYYY-MM-DD` format.", "isOptional": true, "defaultValue": "\"\"", "examples": [ @@ -111570,7 +83868,7 @@ "syntaxKind": "PropertySignature", "name": "allowDays", "value": "string", - "description": "Days of the week that can be selected. These intersect with the result of `allow` and `disallow`.\n\nA comma-separated list of days. Whitespace is allowed after commas.\n\nThe default `''` has no effect on the result of `allow` and `disallow`.\n\nDays are `sunday`, `monday`, `tuesday`, `wednesday`, `thursday`, `friday`, `saturday`.", + "description": "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.\n\nA comma-separated list of days. Whitespace is allowed after commas.\n\nThe default `''` has no effect on the result of `allow` and `disallow`.\n\nDays are `sunday`, `monday`, `tuesday`, `wednesday`, `thursday`, `friday`, `saturday`.", "isOptional": true, "defaultValue": "\"\"", "examples": [ @@ -111591,7 +83889,7 @@ "syntaxKind": "PropertySignature", "name": "autocomplete", "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", "isOptional": true, "defaultValue": "'on' for everything else" }, @@ -111616,7 +83914,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -111625,7 +83923,7 @@ "syntaxKind": "PropertySignature", "name": "disallow", "value": "string", - "description": "Dates that cannot be selected. These subtract from `allow`.\n\nA comma-separated list of dates, date ranges. Whitespace is allowed after commas.\n\nThe default `''` has no effect on `allow`.\n\n- Dates in `YYYY-MM-DD` format disallow a single date.\n- Dates in `YYYY-MM` format disallow a whole month.\n- Dates in `YYYY` format disallow a whole year.\n- Ranges are expressed as `start--end`. - Ranges are inclusive.\n - If either `start` or `end` is omitted, the range is unbounded in that direction.\n - If parts of the date are omitted for `start`, they are assumed to be the minimum possible value.\n So `2024--` is equivalent to `2024-01-01--`.\n - If parts of the date are omitted for `end`, they are assumed to be the maximum possible value.\n So `--2024` is equivalent to `--2024-12-31`.\n - Whitespace is allowed either side of `--`.", + "description": "Dates that cannot be selected. These subtract from `allow`.\n\nA comma-separated list of dates, date ranges. Whitespace is allowed after commas.\n\nThe default `''` has no effect on `allow`.\n\n- Dates in `YYYY-MM-DD` format disallow a single date.\n- Dates in `YYYY-MM` format disallow a whole month.\n- Dates in `YYYY` format disallow a whole year.\n- Ranges are expressed as `start--end`. - Ranges are inclusive.\n - If either `start` or `end` is omitted, the range is unbounded in that direction.\n - If parts of the date are omitted for `start`, they are assumed to be the minimum possible value.\n So `2024--` is equivalent to `2024-01-01--`.\n - If parts of the date are omitted for `end`, they are assumed to be the maximum possible value.\n So `--2024` is equivalent to `--2024-12-31`.\n - Whitespace is allowed either side of `--`.\n\nComma-separated list of disallowed dates in `YYYY-MM-DD` format.", "isOptional": true, "defaultValue": "\"\"", "examples": [ @@ -111707,11 +84005,7 @@ "syntaxKind": "PropertySignature", "name": "onChange", "value": "(event: Event) => void", -<<<<<<< HEAD - "description": "Callback when the user has **finished editing** a field, for example, once they have blurred the field.", -======= - "description": "A callback fired when the user has **finished editing** a field, such as when they blur the field or press Enter. Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", ->>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) + "description": "A callback fired when the user has **finished editing** a field, such as when they blur the field or press Enter.", "isOptional": true }, { @@ -111727,7 +84021,7 @@ "syntaxKind": "PropertySignature", "name": "onInput", "value": "(event: Event) => void", - "description": "A callback fired when the user makes any changes in the field, such as typing a character. Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).", + "description": "A callback fired when the user makes any changes in the field, such as typing a character.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).", "isOptional": true }, { @@ -111735,7 +84029,7 @@ "syntaxKind": "PropertySignature", "name": "onInvalid", "value": "(event: Event) => void", - "description": "Callback when the field has an invalid date. This callback will be called, if the date typed is invalid or disabled.\n\nDates that don\u2019t exist or have formatting errors are considered invalid. Some examples of invalid dates are:\n- 2021-02-31: February doesn\u2019t have 31 days\n- 2021-02-00: The day can\u2019t be 00\n\nDisallowed dates are considered invalid.\n\nIt\u2019s important to note that this callback will be called only when the user **finishes editing** the date, and it\u2019s called right after the `onChange` callback. The field is **not** validated on every change to the input. Once the buyer has signalled that 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.", + "description": "Callback when the field has an invalid date. This callback will be called, if the date typed is invalid or disabled.\n\nDates that don’t exist or have formatting errors are considered invalid. Some examples of invalid dates are:\n- 2021-02-31: February doesn’t have 31 days\n- 2021-02-00: The day can’t be 00\n\nDisallowed dates are considered invalid.\n\nThis callback fires only when the user finishes editing the date, right after the `change` callback. The field isn’t validated on every change to the input. Once the user has signalled that 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.", "isOptional": true }, { @@ -111798,7 +84092,7 @@ "src/surfaces/checkout/components/DatePicker.ts": { "filePath": "src/surfaces/checkout/components/DatePicker.ts", "name": "DatePickerElementProps", - "description": "Configure the following properties on the date picker component.", + "description": "", "isPublicDocs": true, "members": [ { @@ -111806,7 +84100,7 @@ "syntaxKind": "PropertySignature", "name": "allow", "value": "string", - "description": "Dates that can be selected.\n\nA comma-separated list of dates, date ranges. Whitespace is allowed after commas.\n\nThe default `''` allows all dates.\n\n- Dates in `YYYY-MM-DD` format allow a single date.\n- Dates in `YYYY-MM` format allow a whole month.\n- Dates in `YYYY` format allow a whole year.\n- Ranges are expressed as `start--end`. - Ranges are inclusive.\n - If either `start` or `end` is omitted, the range is unbounded in that direction.\n - If parts of the date are omitted for `start`, they are assumed to be the minimum possible value.\n So `2024--` is equivalent to `2024-01-01--`.\n - If parts of the date are omitted for `end`, they are assumed to be the maximum possible value.\n So `--2024` is equivalent to `--2024-12-31`.\n - Whitespace is allowed either side of `--`.", + "description": "Restricts which dates the user can select. Accepts a comma-separated list of dates and date ranges. Whitespace is allowed after commas.\n\nThe default `''` allows all dates.\n\n- Dates in `YYYY-MM-DD` format allow a single date.\n- Dates in `YYYY-MM` format allow a whole month.\n- Dates in `YYYY` format allow a whole year.\n- Ranges are expressed as `start--end`. - Ranges are inclusive.\n - If either `start` or `end` is omitted, the range is unbounded in that direction.\n - If parts of the date are omitted for `start`, they are assumed to be the minimum possible value.\n So `2024--` is equivalent to `2024-01-01--`.\n - If parts of the date are omitted for `end`, they are assumed to be the maximum possible value.\n So `--2024` is equivalent to `--2024-12-31`.\n - Whitespace is allowed either side of `--`.\n\nComma-separated list of allowed dates in `YYYY-MM-DD` format.", "isOptional": true, "defaultValue": "\"\"", "examples": [ @@ -111827,7 +84121,7 @@ "syntaxKind": "PropertySignature", "name": "allowDays", "value": "string", - "description": "Days of the week that can be selected. These intersect with the result of `allow` and `disallow`.\n\nA comma-separated list of days. Whitespace is allowed after commas.\n\nThe default `''` has no effect on the result of `allow` and `disallow`.\n\nDays are `sunday`, `monday`, `tuesday`, `wednesday`, `thursday`, `friday`, `saturday`.", + "description": "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.\n\nA comma-separated list of days. Whitespace is allowed after commas.\n\nThe default `''` has no effect on the result of `allow` and `disallow`.\n\nDays are `sunday`, `monday`, `tuesday`, `wednesday`, `thursday`, `friday`, `saturday`.", "isOptional": true, "defaultValue": "\"\"", "examples": [ @@ -111865,7 +84159,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -111874,7 +84168,7 @@ "syntaxKind": "PropertySignature", "name": "disallow", "value": "string", - "description": "Dates that cannot be selected. These subtract from `allow`.\n\nA comma-separated list of dates, date ranges. Whitespace is allowed after commas.\n\nThe default `''` has no effect on `allow`.\n\n- Dates in `YYYY-MM-DD` format disallow a single date.\n- Dates in `YYYY-MM` format disallow a whole month.\n- Dates in `YYYY` format disallow a whole year.\n- Ranges are expressed as `start--end`. - Ranges are inclusive.\n - If either `start` or `end` is omitted, the range is unbounded in that direction.\n - If parts of the date are omitted for `start`, they are assumed to be the minimum possible value.\n So `2024--` is equivalent to `2024-01-01--`.\n - If parts of the date are omitted for `end`, they are assumed to be the maximum possible value.\n So `--2024` is equivalent to `--2024-12-31`.\n - Whitespace is allowed either side of `--`.", + "description": "Dates that cannot be selected. These subtract from `allow`.\n\nA comma-separated list of dates, date ranges. Whitespace is allowed after commas.\n\nThe default `''` has no effect on `allow`.\n\n- Dates in `YYYY-MM-DD` format disallow a single date.\n- Dates in `YYYY-MM` format disallow a whole month.\n- Dates in `YYYY` format disallow a whole year.\n- Ranges are expressed as `start--end`. - Ranges are inclusive.\n - If either `start` or `end` is omitted, the range is unbounded in that direction.\n - If parts of the date are omitted for `start`, they are assumed to be the minimum possible value.\n So `2024--` is equivalent to `2024-01-01--`.\n - If parts of the date are omitted for `end`, they are assumed to be the maximum possible value.\n So `--2024` is equivalent to `--2024-12-31`.\n - Whitespace is allowed either side of `--`.\n\nComma-separated list of disallowed dates in `YYYY-MM-DD` format.", "isOptional": true, "defaultValue": "\"\"", "examples": [ @@ -111941,7 +84235,7 @@ "syntaxKind": "PropertySignature", "name": "value", "value": "string", - "description": "Current selected value.\n\nThe default means no date is selected.\n\nIf the provided value is invalid, no date is selected.\n\nOtherwise:\n\n- If `type=\"single\"`, this is a date in `YYYY-MM-DD` format.\n- If `type=\"multiple\"`, this is a comma-separated list of dates in `YYYY-MM-DD` format.\n- If `type=\"range\"`, this is a range in `YYYY-MM-DD--YYYY-MM-DD` format. The range is inclusive.", + "description": "Current selected value.\n\nThe default means no date is selected.\n\nIf the provided value is invalid, no date is selected.\n\nOtherwise:\n\n- If `type=\"single\"`, this is a date in `YYYY-MM-DD` format.\n- If `type=\"multiple\"`, this is a comma-separated list of dates in `YYYY-MM-DD` format.\n- If `type=\"range\"`, this is a range in `YYYY-MM-DD--YYYY-MM-DD` format. The range is inclusive.\n\nSingle dates use ISO 8601 format (`YYYY-MM-DD`); ranges use `YYYY-MM-DD--YYYY-MM-DD`. Locale-specific formats aren't supported.", "isOptional": true, "defaultValue": "\"\"" }, @@ -112012,7 +84306,7 @@ "src/surfaces/checkout/components/DatePicker.ts": { "filePath": "src/surfaces/checkout/components/DatePicker.ts", "name": "DatePickerElementEvents", - "description": "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).", + "description": "", "isPublicDocs": true, "members": [ { @@ -112020,11 +84314,7 @@ "syntaxKind": "PropertySignature", "name": "blur", "value": "CallbackEventListener", -<<<<<<< HEAD - "description": "A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", -======= "description": "A callback fired when the date picker loses focus.\n\nLearn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", ->>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) "isOptional": true }, { @@ -112032,11 +84322,7 @@ "syntaxKind": "PropertySignature", "name": "change", "value": "CallbackEventListener", -<<<<<<< HEAD - "description": "Callback when the user has **finished editing** a field, for example, once they have blurred the field.", -======= "description": "A callback fired when the date picker value changes.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", ->>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) "isOptional": true }, { @@ -112044,11 +84330,7 @@ "syntaxKind": "PropertySignature", "name": "focus", "value": "CallbackEventListener", -<<<<<<< HEAD - "description": "A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", -======= "description": "A callback fired when the date picker receives focus.\n\nLearn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", ->>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) "isOptional": true }, { @@ -112068,11 +84350,7 @@ "isOptional": true } ], -<<<<<<< HEAD - "value": "export interface DatePickerElementEvents {\n /**\n * A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur?: CallbackEventListener;\n /**\n * Callback when the user has **finished editing** a field, for example, once they have blurred the field.\n */\n change?: CallbackEventListener;\n /**\n * A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus?: CallbackEventListener;\n /**\n * Callback when the user makes any changes in the field.\n */\n input?: CallbackEventListener;\n /**\n * Callback when the view changes.\n */\n viewChange?: CallbackEventListener;\n}" -======= "value": "export interface DatePickerElementEvents {\n /**\n * A callback fired when the date picker loses focus.\n *\n * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur?: CallbackEventListener;\n /**\n * A callback fired when the date picker value changes.\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change?: CallbackEventListener;\n /**\n * A callback fired when the date picker receives focus.\n *\n * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus?: CallbackEventListener;\n /**\n * A callback fired when the user inputs data into the date picker.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input?: CallbackEventListener;\n /**\n * A callback fired when the calendar view changes, such as when navigating between months.\n */\n viewChange?: CallbackEventListener;\n}" ->>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) } }, "DatePickerElement": { @@ -112101,7 +84379,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/DatePicker.ts", @@ -112115,7 +84393,7 @@ "syntaxKind": "PropertySignature", "name": "allow", "value": "string", - "description": "Dates that can be selected.\n\nA comma-separated list of dates, date ranges. Whitespace is allowed after commas.\n\nThe default `''` allows all dates.\n\n- Dates in `YYYY-MM-DD` format allow a single date.\n- Dates in `YYYY-MM` format allow a whole month.\n- Dates in `YYYY` format allow a whole year.\n- Ranges are expressed as `start--end`. - Ranges are inclusive.\n - If either `start` or `end` is omitted, the range is unbounded in that direction.\n - If parts of the date are omitted for `start`, they are assumed to be the minimum possible value.\n So `2024--` is equivalent to `2024-01-01--`.\n - If parts of the date are omitted for `end`, they are assumed to be the maximum possible value.\n So `--2024` is equivalent to `--2024-12-31`.\n - Whitespace is allowed either side of `--`.", + "description": "Restricts which dates the user can select. Accepts a comma-separated list of dates and date ranges. Whitespace is allowed after commas.\n\nThe default `''` allows all dates.\n\n- Dates in `YYYY-MM-DD` format allow a single date.\n- Dates in `YYYY-MM` format allow a whole month.\n- Dates in `YYYY` format allow a whole year.\n- Ranges are expressed as `start--end`. - Ranges are inclusive.\n - If either `start` or `end` is omitted, the range is unbounded in that direction.\n - If parts of the date are omitted for `start`, they are assumed to be the minimum possible value.\n So `2024--` is equivalent to `2024-01-01--`.\n - If parts of the date are omitted for `end`, they are assumed to be the maximum possible value.\n So `--2024` is equivalent to `--2024-12-31`.\n - Whitespace is allowed either side of `--`.\n\nComma-separated list of allowed dates in `YYYY-MM-DD` format.", "isOptional": true, "defaultValue": "\"\"", "examples": [ @@ -112136,7 +84414,7 @@ "syntaxKind": "PropertySignature", "name": "allowDays", "value": "string", - "description": "Days of the week that can be selected. These intersect with the result of `allow` and `disallow`.\n\nA comma-separated list of days. Whitespace is allowed after commas.\n\nThe default `''` has no effect on the result of `allow` and `disallow`.\n\nDays are `sunday`, `monday`, `tuesday`, `wednesday`, `thursday`, `friday`, `saturday`.", + "description": "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.\n\nA comma-separated list of days. Whitespace is allowed after commas.\n\nThe default `''` has no effect on the result of `allow` and `disallow`.\n\nDays are `sunday`, `monday`, `tuesday`, `wednesday`, `thursday`, `friday`, `saturday`.", "isOptional": true, "defaultValue": "\"\"", "examples": [ @@ -112790,7 +85068,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -112799,7 +85077,7 @@ "syntaxKind": "PropertySignature", "name": "disallow", "value": "string", - "description": "Dates that cannot be selected. These subtract from `allow`.\n\nA comma-separated list of dates, date ranges. Whitespace is allowed after commas.\n\nThe default `''` has no effect on `allow`.\n\n- Dates in `YYYY-MM-DD` format disallow a single date.\n- Dates in `YYYY-MM` format disallow a whole month.\n- Dates in `YYYY` format disallow a whole year.\n- Ranges are expressed as `start--end`. - Ranges are inclusive.\n - If either `start` or `end` is omitted, the range is unbounded in that direction.\n - If parts of the date are omitted for `start`, they are assumed to be the minimum possible value.\n So `2024--` is equivalent to `2024-01-01--`.\n - If parts of the date are omitted for `end`, they are assumed to be the maximum possible value.\n So `--2024` is equivalent to `--2024-12-31`.\n - Whitespace is allowed either side of `--`.", + "description": "Dates that cannot be selected. These subtract from `allow`.\n\nA comma-separated list of dates, date ranges. Whitespace is allowed after commas.\n\nThe default `''` has no effect on `allow`.\n\n- Dates in `YYYY-MM-DD` format disallow a single date.\n- Dates in `YYYY-MM` format disallow a whole month.\n- Dates in `YYYY` format disallow a whole year.\n- Ranges are expressed as `start--end`. - Ranges are inclusive.\n - If either `start` or `end` is omitted, the range is unbounded in that direction.\n - If parts of the date are omitted for `start`, they are assumed to be the minimum possible value.\n So `2024--` is equivalent to `2024-01-01--`.\n - If parts of the date are omitted for `end`, they are assumed to be the maximum possible value.\n So `--2024` is equivalent to `--2024-12-31`.\n - Whitespace is allowed either side of `--`.\n\nComma-separated list of disallowed dates in `YYYY-MM-DD` format.", "isOptional": true, "defaultValue": "\"\"", "examples": [ @@ -114235,7 +86513,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/DatePicker.ts", @@ -114482,7 +86760,7 @@ "syntaxKind": "PropertySignature", "name": "value", "value": "string", - "description": "Current selected value.\n\nThe default means no date is selected.\n\nIf the provided value is invalid, no date is selected.\n\nOtherwise:\n\n- If `type=\"single\"`, this is a date in `YYYY-MM-DD` format.\n- If `type=\"multiple\"`, this is a comma-separated list of dates in `YYYY-MM-DD` format.\n- If `type=\"range\"`, this is a range in `YYYY-MM-DD--YYYY-MM-DD` format. The range is inclusive.", + "description": "Current selected value.\n\nThe default means no date is selected.\n\nIf the provided value is invalid, no date is selected.\n\nOtherwise:\n\n- If `type=\"single\"`, this is a date in `YYYY-MM-DD` format.\n- If `type=\"multiple\"`, this is a comma-separated list of dates in `YYYY-MM-DD` format.\n- If `type=\"range\"`, this is a range in `YYYY-MM-DD--YYYY-MM-DD` format. The range is inclusive.\n\nSingle dates use ISO 8601 format (`YYYY-MM-DD`); ranges use `YYYY-MM-DD--YYYY-MM-DD`. Locale-specific formats aren't supported.", "isOptional": true, "defaultValue": "\"\"" }, @@ -114525,7 +86803,7 @@ "syntaxKind": "PropertySignature", "name": "allow", "value": "string", - "description": "Dates that can be selected.\n\nA comma-separated list of dates, date ranges. Whitespace is allowed after commas.\n\nThe default `''` allows all dates.\n\n- Dates in `YYYY-MM-DD` format allow a single date.\n- Dates in `YYYY-MM` format allow a whole month.\n- Dates in `YYYY` format allow a whole year.\n- Ranges are expressed as `start--end`. - Ranges are inclusive.\n - If either `start` or `end` is omitted, the range is unbounded in that direction.\n - If parts of the date are omitted for `start`, they are assumed to be the minimum possible value.\n So `2024--` is equivalent to `2024-01-01--`.\n - If parts of the date are omitted for `end`, they are assumed to be the maximum possible value.\n So `--2024` is equivalent to `--2024-12-31`.\n - Whitespace is allowed either side of `--`.", + "description": "Restricts which dates the user can select. Accepts a comma-separated list of dates and date ranges. Whitespace is allowed after commas.\n\nThe default `''` allows all dates.\n\n- Dates in `YYYY-MM-DD` format allow a single date.\n- Dates in `YYYY-MM` format allow a whole month.\n- Dates in `YYYY` format allow a whole year.\n- Ranges are expressed as `start--end`. - Ranges are inclusive.\n - If either `start` or `end` is omitted, the range is unbounded in that direction.\n - If parts of the date are omitted for `start`, they are assumed to be the minimum possible value.\n So `2024--` is equivalent to `2024-01-01--`.\n - If parts of the date are omitted for `end`, they are assumed to be the maximum possible value.\n So `--2024` is equivalent to `--2024-12-31`.\n - Whitespace is allowed either side of `--`.\n\nComma-separated list of allowed dates in `YYYY-MM-DD` format.", "isOptional": true, "defaultValue": "\"\"", "examples": [ @@ -114546,7 +86824,7 @@ "syntaxKind": "PropertySignature", "name": "allowDays", "value": "string", - "description": "Days of the week that can be selected. These intersect with the result of `allow` and `disallow`.\n\nA comma-separated list of days. Whitespace is allowed after commas.\n\nThe default `''` has no effect on the result of `allow` and `disallow`.\n\nDays are `sunday`, `monday`, `tuesday`, `wednesday`, `thursday`, `friday`, `saturday`.", + "description": "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.\n\nA comma-separated list of days. Whitespace is allowed after commas.\n\nThe default `''` has no effect on the result of `allow` and `disallow`.\n\nDays are `sunday`, `monday`, `tuesday`, `wednesday`, `thursday`, `friday`, `saturday`.", "isOptional": true, "defaultValue": "\"\"", "examples": [ @@ -114584,7 +86862,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -114593,7 +86871,7 @@ "syntaxKind": "PropertySignature", "name": "disallow", "value": "string", - "description": "Dates that cannot be selected. These subtract from `allow`.\n\nA comma-separated list of dates, date ranges. Whitespace is allowed after commas.\n\nThe default `''` has no effect on `allow`.\n\n- Dates in `YYYY-MM-DD` format disallow a single date.\n- Dates in `YYYY-MM` format disallow a whole month.\n- Dates in `YYYY` format disallow a whole year.\n- Ranges are expressed as `start--end`. - Ranges are inclusive.\n - If either `start` or `end` is omitted, the range is unbounded in that direction.\n - If parts of the date are omitted for `start`, they are assumed to be the minimum possible value.\n So `2024--` is equivalent to `2024-01-01--`.\n - If parts of the date are omitted for `end`, they are assumed to be the maximum possible value.\n So `--2024` is equivalent to `--2024-12-31`.\n - Whitespace is allowed either side of `--`.", + "description": "Dates that cannot be selected. These subtract from `allow`.\n\nA comma-separated list of dates, date ranges. Whitespace is allowed after commas.\n\nThe default `''` has no effect on `allow`.\n\n- Dates in `YYYY-MM-DD` format disallow a single date.\n- Dates in `YYYY-MM` format disallow a whole month.\n- Dates in `YYYY` format disallow a whole year.\n- Ranges are expressed as `start--end`. - Ranges are inclusive.\n - If either `start` or `end` is omitted, the range is unbounded in that direction.\n - If parts of the date are omitted for `start`, they are assumed to be the minimum possible value.\n So `2024--` is equivalent to `2024-01-01--`.\n - If parts of the date are omitted for `end`, they are assumed to be the maximum possible value.\n So `--2024` is equivalent to `--2024-12-31`.\n - Whitespace is allowed either side of `--`.\n\nComma-separated list of disallowed dates in `YYYY-MM-DD` format.", "isOptional": true, "defaultValue": "\"\"", "examples": [ @@ -114700,7 +86978,7 @@ "syntaxKind": "PropertySignature", "name": "value", "value": "string", - "description": "Current selected value.\n\nThe default means no date is selected.\n\nIf the provided value is invalid, no date is selected.\n\nOtherwise:\n\n- If `type=\"single\"`, this is a date in `YYYY-MM-DD` format.\n- If `type=\"multiple\"`, this is a comma-separated list of dates in `YYYY-MM-DD` format.\n- If `type=\"range\"`, this is a range in `YYYY-MM-DD--YYYY-MM-DD` format. The range is inclusive.", + "description": "Current selected value.\n\nThe default means no date is selected.\n\nIf the provided value is invalid, no date is selected.\n\nOtherwise:\n\n- If `type=\"single\"`, this is a date in `YYYY-MM-DD` format.\n- If `type=\"multiple\"`, this is a comma-separated list of dates in `YYYY-MM-DD` format.\n- If `type=\"range\"`, this is a range in `YYYY-MM-DD--YYYY-MM-DD` format. The range is inclusive.\n\nSingle dates use ISO 8601 format (`YYYY-MM-DD`); ranges use `YYYY-MM-DD--YYYY-MM-DD`. Locale-specific formats aren't supported.", "isOptional": true, "defaultValue": "\"\"" }, @@ -114720,7 +86998,7 @@ "src/surfaces/checkout/components/Details.ts": { "filePath": "src/surfaces/checkout/components/Details.ts", "name": "DetailsElementProps", - "description": "Creates a collapsible content area that can be expanded or collapsed by users. Use with Summary to provide expandable sections for additional information or settings.", + "description": "", "isPublicDocs": true, "members": [ { @@ -114728,7 +87006,7 @@ "syntaxKind": "PropertySignature", "name": "defaultOpen", "value": "boolean", - "description": "Indicates whether the element should be open by default.\n\nThis reflects to the `open` attribute.", + "description": "Whether the element should be open when it first renders. This reflects to the `open` attribute and only takes effect on the initial render.", "isOptional": true, "defaultValue": "false" }, @@ -114745,7 +87023,7 @@ "syntaxKind": "PropertySignature", "name": "open", "value": "boolean", - "description": "Whether the element is open.\n\nThis does not reflect to any attribute.", + "description": "Whether the element is currently open. Use this for controlled component patterns where your application manages the open state directly. This does not reflect to any attribute.", "isOptional": true, "defaultValue": "false" }, @@ -114754,7 +87032,7 @@ "syntaxKind": "PropertySignature", "name": "toggleTransition", "value": "'none' | 'auto'", - "description": "Sets the transition between the two states.", + "description": "The transition style used when toggling between open and closed states.\n\n- `none`: Switches states immediately without animation.\n- `auto`: Uses the default animated transition.", "isOptional": true, "defaultValue": "'auto'" } @@ -114774,7 +87052,7 @@ "syntaxKind": "PropertySignature", "name": "onAfterToggle", "value": "(event: ToggleEvent$1) => void", - "description": "A callback that fires when the element state changes, after any toggle animations have finished.\n\n- If the element transitioned from hidden to showing, the `oldState` property will be set to `closed` and the `newState` property will be set to `open`.\n- If the element transitioned from showing to hidden, the `oldState` property will be set to `open` and the `newState` will be `closed`.\n\nLearn more about [ToggleEvent.newState](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/newState) and [ToggleEvent.oldState](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/oldState).", + "description": "A callback fired when the element state changes, after any toggle animations have finished.\n\n- If the element transitioned from hidden to showing, the `oldState` property will be set to `closed` and the `newState` property will be set to `open`.\n- If the element transitioned from showing to hidden, the `oldState` property will be set to `open` and the `newState` will be `closed`.\n\nLearn more about 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.", "isOptional": true }, { @@ -114782,7 +87060,7 @@ "syntaxKind": "PropertySignature", "name": "onToggle", "value": "(event: ToggleEvent$1) => void", - "description": "A callback that fires immediately when the element state changes, before any animations.\n\n- If the element is transitioning from hidden to showing, the `oldState` property will be set to `closed` and the `newState` property will be set to `open`.\n- If the element is transitioning from showing to hidden, then `oldState` property will be set to `open` and the `newState` will be `closed`.\n\nLearn more about the [toggle event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/toggle_event), [ToggleEvent.newState](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/newState), and [ToggleEvent.oldState](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/oldState).", + "description": "A callback fired immediately when the element state changes, before any animations.\n\n- If the element is transitioning from hidden to showing, the `oldState` property will be set to `closed` and the `newState` property will be set to `open`.\n- If the element is transitioning from showing to hidden, then the `oldState` property will be set to `open` and the `newState` will be `closed`.\n\nLearn 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.", "isOptional": true } ], @@ -114793,7 +87071,7 @@ "src/surfaces/checkout/components/Details.ts": { "filePath": "src/surfaces/checkout/components/Details.ts", "name": "DetailsElementEvents", - "description": "Learn more about [registering events](/docs/api/checkout-ui-extensions/latest/using-polaris-components#event-handling).", + "description": "", "isPublicDocs": true, "members": [ { @@ -114801,7 +87079,7 @@ "syntaxKind": "PropertySignature", "name": "aftertoggle", "value": "CallbackEventListener", - "description": "Callback fired when the element state changes **after** any animations have finished.\n\n- If the element transitioned from hidden to showing, the `oldState` property will be set to `closed` and the `newState` property will be set to `open`.\n- If the element transitioned from showing to hidden, the `oldState` property will be set to `open` and the `newState` will be `closed`.", + "description": "A callback fired when the element state changes, after any toggle animations have finished.\n\n- If the element transitioned from hidden to showing, the `oldState` property will be set to `closed` and the `newState` property will be set to `open`.\n- If the element transitioned from showing to hidden, the `oldState` property will be set to `open` and the `newState` will be `closed`.\n\nLearn more about 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.", "isOptional": true }, { @@ -114809,11 +87087,11 @@ "syntaxKind": "PropertySignature", "name": "toggle", "value": "CallbackEventListener", - "description": "Callback straight after the element state changes.\n\n- If the element is transitioning from hidden to showing, the `oldState` property will be set to `closed` and the `newState` property will be set to `open`.\n- If the element is transitioning from showing to hidden, then `oldState` property will be set to `open` and the `newState` will be `closed`.", + "description": "A callback fired immediately when the element state changes, before any animations.\n\n- If the element is transitioning from hidden to showing, the `oldState` property will be set to `closed` and the `newState` property will be set to `open`.\n- If the element is transitioning from showing to hidden, then the `oldState` property will be set to `open` and the `newState` will be `closed`.\n\nLearn 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.", "isOptional": true } ], - "value": "export interface DetailsElementEvents {\n /**\n * Callback straight after the element state changes.\n *\n * - If the element is transitioning from hidden to showing, the `oldState` property will be set to `closed` and the\n * `newState` property will be set to `open`.\n * - If the element is transitioning from showing to hidden, then `oldState` property will be set to `open` and the\n * `newState` will be `closed`.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/toggle_event\n * @see https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/newState\n * @see https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/oldState\n */\n toggle?: CallbackEventListener;\n /**\n * Callback fired when the element state changes **after** any animations have finished.\n *\n * - If the element transitioned from hidden to showing, the `oldState` property will be set to `closed` and the\n * `newState` property will be set to `open`.\n * - If the element transitioned from showing to hidden, the `oldState` property will be set to `open` and the\n * `newState` will be `closed`.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/newState\n * @see https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/oldState\n */\n aftertoggle?: CallbackEventListener;\n}" + "value": "export interface DetailsElementEvents {\n /**\n * A callback fired immediately when the element state changes, before any animations.\n *\n * - If the element is transitioning from hidden to showing, the `oldState` property will be set to `closed` and the\n * `newState` property will be set to `open`.\n * - If the element is transitioning from showing to hidden, then the `oldState` property will be set to `open` and the\n * `newState` will be `closed`.\n *\n * 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.\n */\n toggle?: CallbackEventListener;\n /**\n * A callback fired when the element state changes, after any toggle animations have finished.\n *\n * - If the element transitioned from hidden to showing, the `oldState` property will be set to `closed` and the\n * `newState` property will be set to `open`.\n * - If the element transitioned from showing to hidden, the `oldState` property will be set to `open` and the\n * `newState` will be `closed`.\n *\n * Learn more about 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.\n */\n aftertoggle?: CallbackEventListener;\n}" } }, "DetailsElement": { @@ -114842,7 +87120,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/Details.ts", @@ -116850,7 +89128,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/Details.ts", @@ -117114,7 +89392,7 @@ "syntaxKind": "PropertySignature", "name": "defaultOpen", "value": "boolean", - "description": "Indicates whether the element should be open by default.\n\nThis reflects to the `open` attribute.", + "description": "Whether the element should be open when it first renders. This reflects to the `open` attribute and only takes effect on the initial render.", "isOptional": true, "defaultValue": "false" }, @@ -117131,7 +89409,7 @@ "syntaxKind": "PropertySignature", "name": "onAfterToggle", "value": "(event: ToggleEvent$1) => void", - "description": "A callback that fires when the element state changes, after any toggle animations have finished.\n\n- If the element transitioned from hidden to showing, the `oldState` property will be set to `closed` and the `newState` property will be set to `open`.\n- If the element transitioned from showing to hidden, the `oldState` property will be set to `open` and the `newState` will be `closed`.\n\nLearn more about [ToggleEvent.newState](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/newState) and [ToggleEvent.oldState](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/oldState).", + "description": "A callback fired when the element state changes, after any toggle animations have finished.\n\n- If the element transitioned from hidden to showing, the `oldState` property will be set to `closed` and the `newState` property will be set to `open`.\n- If the element transitioned from showing to hidden, the `oldState` property will be set to `open` and the `newState` will be `closed`.\n\nLearn more about 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.", "isOptional": true }, { @@ -117139,7 +89417,7 @@ "syntaxKind": "PropertySignature", "name": "onToggle", "value": "(event: ToggleEvent$1) => void", - "description": "A callback that fires immediately when the element state changes, before any animations.\n\n- If the element is transitioning from hidden to showing, the `oldState` property will be set to `closed` and the `newState` property will be set to `open`.\n- If the element is transitioning from showing to hidden, then `oldState` property will be set to `open` and the `newState` will be `closed`.\n\nLearn more about the [toggle event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/toggle_event), [ToggleEvent.newState](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/newState), and [ToggleEvent.oldState](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/oldState).", + "description": "A callback fired immediately when the element state changes, before any animations.\n\n- If the element is transitioning from hidden to showing, the `oldState` property will be set to `closed` and the `newState` property will be set to `open`.\n- If the element is transitioning from showing to hidden, then the `oldState` property will be set to `open` and the `newState` will be `closed`.\n\nLearn 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.", "isOptional": true }, { @@ -117147,7 +89425,7 @@ "syntaxKind": "PropertySignature", "name": "open", "value": "boolean", - "description": "Whether the element is open.\n\nThis does not reflect to any attribute.", + "description": "Whether the element is currently open. Use this for controlled component patterns where your application manages the open state directly. This does not reflect to any attribute.", "isOptional": true, "defaultValue": "false" }, @@ -117156,7 +89434,7 @@ "syntaxKind": "PropertySignature", "name": "toggleTransition", "value": "'none' | 'auto'", - "description": "Sets the transition between the two states.", + "description": "The transition style used when toggling between open and closed states.\n\n- `none`: Switches states immediately without animation.\n- `auto`: Uses the default animated transition.", "isOptional": true, "defaultValue": "'auto'" } @@ -117176,7 +89454,7 @@ "syntaxKind": "PropertySignature", "name": "direction", "value": "'inline' | 'block'", - "description": "The orientation of the divider, using [logical properties](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_logical_properties_and_values).\n\n- `inline`: A horizontal divider that separates content stacked vertically.\n- `block`: A vertical divider that separates content arranged horizontally.", + "description": "Specify the direction of the divider. This uses [logical properties](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_logical_properties_and_values).\n\nVertical dividers (`'block'` direction) require a parent with a defined height to render visibly.", "isOptional": true, "defaultValue": "'inline'" }, @@ -117218,7 +89496,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/Divider.ts", @@ -117848,7 +90126,7 @@ "syntaxKind": "PropertySignature", "name": "direction", "value": "'inline' | 'block'", - "description": "The orientation of the divider, using [logical properties](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_logical_properties_and_values).\n\n- `inline`: A horizontal divider that separates content stacked vertically.\n- `block`: A vertical divider that separates content arranged horizontally.", + "description": "Specify the direction of the divider. This uses [logical properties](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_logical_properties_and_values).\n\nVertical dividers (`'block'` direction) require a parent with a defined height to render visibly.", "isOptional": true, "defaultValue": "'inline'" }, @@ -119236,7 +91514,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/Divider.ts", @@ -119500,7 +91778,7 @@ "syntaxKind": "PropertySignature", "name": "direction", "value": "'inline' | 'block'", - "description": "The orientation of the divider, using [logical properties](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_logical_properties_and_values).\n\n- `inline`: A horizontal divider that separates content stacked vertically.\n- `block`: A vertical divider that separates content arranged horizontally.", + "description": "Specify the direction of the divider. This uses [logical properties](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_logical_properties_and_values).\n\nVertical dividers (`'block'` direction) require a parent with a defined height to render visibly.", "isOptional": true, "defaultValue": "'inline'" }, @@ -119520,7 +91798,7 @@ "src/surfaces/checkout/components/DropZone.ts": { "filePath": "src/surfaces/checkout/components/DropZone.ts", "name": "DropZoneElementProps", - "description": "Configure the following properties on the drop zone component.", + "description": "", "isPublicDocs": true, "members": [ { @@ -119545,7 +91823,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -119651,7 +91929,7 @@ "src/surfaces/checkout/components/DropZone.ts": { "filePath": "src/surfaces/checkout/components/DropZone.ts", "name": "DropZoneElementEvents", - "description": "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).", + "description": "", "isPublicDocs": true, "members": [ { @@ -119725,7 +92003,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/DropZone.ts", @@ -120355,7 +92633,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -121783,7 +94061,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/DropZone.ts", @@ -122082,7 +94360,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -122177,7 +94455,7 @@ "src/surfaces/checkout/components/EmailField.ts": { "filePath": "src/surfaces/checkout/components/EmailField.ts", "name": "EmailFieldElementProps", - "description": "Configure the following properties on the email field component.", + "description": "", "isPublicDocs": true, "members": [ { @@ -122185,7 +94463,7 @@ "syntaxKind": "PropertySignature", "name": "autocomplete", "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", "isOptional": true, "defaultValue": "'on' for everything else" }, @@ -122202,7 +94480,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -122253,7 +94531,7 @@ "syntaxKind": "PropertySignature", "name": "minLength", "value": "number", - "description": "Specifies the min number of characters allowed.", + "description": "Specifies the minimum number of characters allowed.", "isOptional": true, "defaultValue": "0" }, @@ -122325,11 +94603,7 @@ "syntaxKind": "PropertySignature", "name": "onChange", "value": "(event: Event) => void", -<<<<<<< HEAD - "description": "Callback when the user has **finished editing** a field, for example, once they have blurred the field.", -======= - "description": "A callback fired when the user has **finished editing** a field, such as when they blur the field or press Enter. Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", ->>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) + "description": "A callback fired when the user has **finished editing** a field, such as when they blur the field or press Enter.", "isOptional": true }, { @@ -122345,7 +94619,7 @@ "syntaxKind": "PropertySignature", "name": "onInput", "value": "(event: Event) => void", - "description": "A callback fired when the user makes any changes in the field, such as typing a character. Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).", + "description": "A callback fired when the user makes any changes in the field, such as typing a character.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).", "isOptional": true } ], @@ -122356,7 +94630,7 @@ "src/surfaces/checkout/components/EmailField.ts": { "filePath": "src/surfaces/checkout/components/EmailField.ts", "name": "EmailFieldElementEvents", - "description": "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).", + "description": "", "isPublicDocs": true, "members": [ { @@ -122364,11 +94638,7 @@ "syntaxKind": "PropertySignature", "name": "blur", "value": "CallbackEventListener", -<<<<<<< HEAD - "description": "A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", -======= - "description": "A callback fired when the email field loses focus.\n\nLearn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", ->>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) + "description": "<<<<<<< HEAD A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n======= A callback fired when the email field loses focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) \n Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", "isOptional": true }, { @@ -122376,11 +94646,7 @@ "syntaxKind": "PropertySignature", "name": "change", "value": "CallbackEventListener", -<<<<<<< HEAD - "description": "Callback when the user has **finished editing** a field, for example, once they have blurred the field.", -======= - "description": "A callback fired when the email field value changes.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", ->>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) + "description": "<<<<<<< HEAD Callback when the user has **finished editing** a field, for example, once they have blurred the field.\n======= A callback fired when the email field value changes.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) \n Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", "isOptional": true }, { @@ -122388,11 +94654,7 @@ "syntaxKind": "PropertySignature", "name": "focus", "value": "CallbackEventListener", -<<<<<<< HEAD - "description": "A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", -======= - "description": "A callback fired when the email field receives focus.\n\nLearn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", ->>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) + "description": "<<<<<<< HEAD A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n======= A callback fired when the email field receives focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) \n Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", "isOptional": true }, { @@ -122404,18 +94666,14 @@ "isOptional": true } ], -<<<<<<< HEAD - "value": "export interface EmailFieldElementEvents {\n /**\n * A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event\n */\n blur?: CallbackEventListener;\n /**\n * Callback when the user has **finished editing** a field, for example, once they have blurred the field.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event\n */\n change?: CallbackEventListener;\n /**\n * A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event\n */\n focus?: CallbackEventListener;\n /**\n * Callback when the user makes any changes in the field.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event\n */\n input?: CallbackEventListener;\n}" -======= - "value": "export interface EmailFieldElementEvents {\n /**\n * A callback fired when the email field loses focus.\n *\n * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur?: CallbackEventListener;\n /**\n * A callback fired when the email field value changes.\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change?: CallbackEventListener;\n /**\n * A callback fired when the email field receives focus.\n *\n * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus?: CallbackEventListener;\n /**\n * A callback fired when the user inputs data into the email field.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input?: CallbackEventListener;\n}" ->>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) + "value": "export interface EmailFieldElementEvents {\n /**\n<<<<<<< HEAD\n * A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n=======\n * A callback fired when the email field loses focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality)\n *\n * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur?: CallbackEventListener;\n /**\n<<<<<<< HEAD\n * Callback when the user has **finished editing** a field, for example, once they have blurred the field.\n=======\n * A callback fired when the email field value changes.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality)\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change?: CallbackEventListener;\n /**\n<<<<<<< HEAD\n * A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n=======\n * A callback fired when the email field receives focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality)\n *\n * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus?: CallbackEventListener;\n /**\n * A callback fired when the user inputs data into the email field.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input?: CallbackEventListener;\n}" } }, "EmailFieldElementSlots": { "src/surfaces/checkout/components/EmailField.ts": { "filePath": "src/surfaces/checkout/components/EmailField.ts", "name": "EmailFieldElementSlots", - "description": "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).", + "description": "", "isPublicDocs": true, "members": [ { @@ -122456,7 +94714,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/EmailField.ts", @@ -122897,7 +95155,7 @@ "syntaxKind": "PropertySignature", "name": "autocomplete", "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", "isOptional": true, "defaultValue": "'on' for everything else" }, @@ -123103,7 +95361,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -123561,7 +95819,7 @@ "syntaxKind": "PropertySignature", "name": "minLength", "value": "number", - "description": "Specifies the min number of characters allowed.", + "description": "Specifies the minimum number of characters allowed.", "isOptional": true, "defaultValue": "0" }, @@ -124554,7 +96812,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/EmailField.ts", @@ -124835,7 +97093,7 @@ "syntaxKind": "PropertySignature", "name": "autocomplete", "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", "isOptional": true, "defaultValue": "'on' for everything else" }, @@ -124852,7 +97110,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -124903,7 +97161,7 @@ "syntaxKind": "PropertySignature", "name": "minLength", "value": "number", - "description": "Specifies the min number of characters allowed.", + "description": "Specifies the minimum number of characters allowed.", "isOptional": true, "defaultValue": "0" }, @@ -124928,11 +97186,7 @@ "syntaxKind": "PropertySignature", "name": "onChange", "value": "(event: Event) => void", -<<<<<<< HEAD - "description": "Callback when the user has **finished editing** a field, for example, once they have blurred the field.", -======= - "description": "A callback fired when the user has **finished editing** a field, such as when they blur the field or press Enter. Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", ->>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) + "description": "A callback fired when the user has **finished editing** a field, such as when they blur the field or press Enter.", "isOptional": true }, { @@ -124948,7 +97202,7 @@ "syntaxKind": "PropertySignature", "name": "onInput", "value": "(event: Event) => void", - "description": "A callback fired when the user makes any changes in the field, such as typing a character. Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).", + "description": "A callback fired when the user makes any changes in the field, such as typing a character.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).", "isOptional": true }, { @@ -124995,7 +97249,7 @@ "src/surfaces/checkout/components/Form.ts": { "filePath": "src/surfaces/checkout/components/Form.ts", "name": "FormElementProps", - "description": "Configure the following properties on the form component.", + "description": "", "isPublicDocs": true, "members": [ { @@ -125044,7 +97298,7 @@ "src/surfaces/checkout/components/Form.ts": { "filePath": "src/surfaces/checkout/components/Form.ts", "name": "FormElementEvents", - "description": "The form component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", + "description": "", "isPublicDocs": true, "members": [ { @@ -125085,7 +97339,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/Form.ts", @@ -127105,7 +99359,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/Form.ts", @@ -127447,7 +99701,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityLabel", "value": "string", - "description": "A label announced by assistive technologies that describes the purpose or contents of the element. Only set this when the element's visible content doesn't provide enough context on its own.", + "description": "A label that describes the purpose or contents of the element. When set, it will be announced to users using assistive technologies and will provide them with more context.\n\nOnly use this when the element's content is not enough context for users using assistive technologies.", "isOptional": true }, { @@ -127455,7 +99709,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityRole", "value": "AccessibilityRole", - "description": "The semantic meaning of the component's content. When set, assistive technologies use this role to help users navigate the page.", + "description": "Sets the semantic meaning of the component’s content. When set, the role will be used by assistive technologies to help users navigate the page.", "isOptional": true, "defaultValue": "'generic'" }, @@ -127464,7 +99718,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityVisibility", "value": "'visible' | 'hidden' | 'exclusive'", - "description": "Changes the visibility of the element.\n\n- `visible`: the element is visible to all users.\n- `hidden`: the element is removed from the accessibility tree but remains visible.\n- `exclusive`: the element is visually hidden but remains in the accessibility tree.", + "description": "Controls how the element is exposed to sighted users and to assistive technologies such as screen readers.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", "isOptional": true, "defaultValue": "'visible'" }, @@ -127491,11 +99745,7 @@ "syntaxKind": "PropertySignature", "name": "background", "value": "'base' | 'subdued' | 'transparent'", -<<<<<<< HEAD - "description": "Adjust the background of the element.\n\n- `'transparent'`: No visible background.\n- `'subdued'`: A subtle, low-emphasis background.\n- `'base'`: The standard background color.\n- `'strong'`: A high-emphasis background for prominence.", -======= "description": "The background color of the grid.\n\n- `base`: The standard background color for general content areas.\n- `subdued`: A muted background for secondary or supporting content.\n- `transparent`: No background color (the default).", ->>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) "isOptional": true, "defaultValue": "'transparent'" }, @@ -127570,7 +99820,7 @@ "syntaxKind": "PropertySignature", "name": "columnGap", "value": "MaybeResponsive", - "description": "The spacing between child elements along the inline axis (horizontal in horizontal writing modes). Overrides the inline-axis value set by `gap`.", + "description": "Adjust spacing between elements in the inline axis.\n\nThis overrides the column value of `gap`.", "isOptional": true, "defaultValue": "'' - meaning no override" }, @@ -127579,7 +99829,7 @@ "syntaxKind": "PropertySignature", "name": "display", "value": "MaybeResponsive<\"auto\" | \"none\">", - "description": "Sets the outer display type of the component. The outer type sets a component\u2019s participation in [flow layout](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_flow_layout).\n\n- `auto`: the component\u2019s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.", + "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.\n\nLearn more about the [display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display).", "isOptional": true, "defaultValue": "'auto'" }, @@ -127588,7 +99838,7 @@ "syntaxKind": "PropertySignature", "name": "gap", "value": "MaybeResponsive>", - "description": "The spacing between child elements. A single value applies to both the inline and block axes. A pair of space-separated values (for example, `large-100 large-500`) sets the inline and block axes independently.", + "description": "Adjust spacing between elements.\n\nA single value applies to both axes. A pair of values (eg `large-100 large-500`) can be used to set the inline and block axes respectively.", "isOptional": true, "defaultValue": "'none'" }, @@ -127597,7 +99847,7 @@ "syntaxKind": "PropertySignature", "name": "gridTemplateColumns", "value": "MaybeResponsive", - "description": "Defines the number and size of columns in the grid. Accepts any valid CSS [`grid-template-columns`](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-template-columns) value, such as `\"1fr 2fr\"` or `\"repeat(3, 1fr)\"`.", + "description": "Define columns and specify their size.", "isOptional": true, "defaultValue": "'none'" }, @@ -127606,7 +99856,7 @@ "syntaxKind": "PropertySignature", "name": "gridTemplateRows", "value": "MaybeResponsive", - "description": "Defines the number and size of rows in the grid. Accepts any valid CSS [`grid-template-rows`](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-template-rows) value, such as `\"auto 1fr\"` or `\"repeat(2, 100px)\"`.", + "description": "Define rows and specify their size.", "isOptional": true, "defaultValue": "'none'" }, @@ -127686,7 +99936,7 @@ "syntaxKind": "PropertySignature", "name": "overflow", "value": "'hidden' | 'visible'", - "description": "The overflow behavior of the element.\n\n- `visible`: Content that extends beyond the container is visible.\n- `hidden`: Content that extends beyond the container is clipped and not scrollable.", + "description": "Sets the overflow behavior of the element.\n\n- `visible`: The content that extends beyond the element’s container is visible.\n- `hidden`: Clips the content when it is larger than the element’s container. The element will not be scrollable and users will not be able to access the clipped content by dragging or using a scroll wheel on a mouse.", "isOptional": true, "defaultValue": "'visible'" }, @@ -127776,7 +100026,7 @@ "syntaxKind": "PropertySignature", "name": "rowGap", "value": "MaybeResponsive", - "description": "The spacing between child elements along the block axis (vertical in horizontal writing modes). Overrides the block-axis value set by `gap`.", + "description": "Adjust spacing between elements in the block axis.\n\nThis overrides the row value of `gap`.", "isOptional": true, "defaultValue": "'' - meaning no override" } @@ -127796,7 +100046,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityLabel", "value": "string", - "description": "A label announced by assistive technologies that describes the purpose or contents of the element. Only set this when the element's visible content doesn't provide enough context on its own.", + "description": "A label that describes the purpose or contents of the element. When set, it will be announced to users using assistive technologies and will provide them with more context.\n\nOnly use this when the element's content is not enough context for users using assistive technologies.", "isOptional": true }, { @@ -127804,7 +100054,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityRole", "value": "AccessibilityRole", - "description": "The semantic meaning of the component's content. When set, assistive technologies use this role to help users navigate the page.", + "description": "Sets the semantic meaning of the component’s content. When set, the role will be used by assistive technologies to help users navigate the page.", "isOptional": true, "defaultValue": "'generic'" }, @@ -127813,7 +100063,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityVisibility", "value": "'visible' | 'hidden' | 'exclusive'", - "description": "Changes the visibility of the element.\n\n- `visible`: the element is visible to all users.\n- `hidden`: the element is removed from the accessibility tree but remains visible.\n- `exclusive`: the element is visually hidden but remains in the accessibility tree.", + "description": "Controls how the element is exposed to sighted users and to assistive technologies such as screen readers.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", "isOptional": true, "defaultValue": "'visible'" }, @@ -127840,11 +100090,7 @@ "syntaxKind": "PropertySignature", "name": "background", "value": "'base' | 'subdued' | 'transparent'", -<<<<<<< HEAD - "description": "Adjust the background of the element.\n\n- `'transparent'`: No visible background.\n- `'subdued'`: A subtle, low-emphasis background.\n- `'base'`: The standard background color.\n- `'strong'`: A high-emphasis background for prominence.", -======= "description": "The background color of the grid.\n\n- `base`: The standard background color for general content areas.\n- `subdued`: A muted background for secondary or supporting content.\n- `transparent`: No background color (the default).", ->>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) "isOptional": true, "defaultValue": "'transparent'" }, @@ -127907,7 +100153,7 @@ "syntaxKind": "PropertySignature", "name": "columnGap", "value": "MaybeResponsive", - "description": "The spacing between child elements along the inline axis (horizontal in horizontal writing modes). Overrides the inline-axis value set by `gap`.", + "description": "Adjust spacing between elements in the inline axis.\n\nThis overrides the column value of `gap`.", "isOptional": true, "defaultValue": "'' - meaning no override" }, @@ -127916,7 +100162,7 @@ "syntaxKind": "PropertySignature", "name": "display", "value": "MaybeResponsive<\"auto\" | \"none\">", - "description": "Sets the outer display type of the component. The outer type sets a component\u2019s participation in [flow layout](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_flow_layout).\n\n- `auto`: the component\u2019s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.", + "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.\n\nLearn more about the [display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display).", "isOptional": true, "defaultValue": "'auto'" }, @@ -127925,7 +100171,7 @@ "syntaxKind": "PropertySignature", "name": "gap", "value": "MaybeResponsive>", - "description": "The spacing between child elements. A single value applies to both the inline and block axes. A pair of space-separated values (for example, `large-100 large-500`) sets the inline and block axes independently.", + "description": "Adjust spacing between elements.\n\nA single value applies to both axes. A pair of values (eg `large-100 large-500`) can be used to set the inline and block axes respectively.", "isOptional": true, "defaultValue": "'none'" }, @@ -127934,7 +100180,7 @@ "syntaxKind": "PropertySignature", "name": "gridTemplateColumns", "value": "MaybeResponsive", - "description": "Defines the number and size of columns in the grid. Accepts any valid CSS [`grid-template-columns`](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-template-columns) value, such as `\"1fr 2fr\"` or `\"repeat(3, 1fr)\"`.", + "description": "Define columns and specify their size.", "isOptional": true, "defaultValue": "'none'" }, @@ -127943,7 +100189,7 @@ "syntaxKind": "PropertySignature", "name": "gridTemplateRows", "value": "MaybeResponsive", - "description": "Defines the number and size of rows in the grid. Accepts any valid CSS [`grid-template-rows`](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-template-rows) value, such as `\"auto 1fr\"` or `\"repeat(2, 100px)\"`.", + "description": "Define rows and specify their size.", "isOptional": true, "defaultValue": "'none'" }, @@ -128023,7 +100269,7 @@ "syntaxKind": "PropertySignature", "name": "overflow", "value": "'hidden' | 'visible'", - "description": "The overflow behavior of the element.\n\n- `visible`: Content that extends beyond the container is visible.\n- `hidden`: Content that extends beyond the container is clipped and not scrollable.", + "description": "Sets the overflow behavior of the element.\n\n- `visible`: The content that extends beyond the element’s container is visible.\n- `hidden`: Clips the content when it is larger than the element’s container. The element will not be scrollable and users will not be able to access the clipped content by dragging or using a scroll wheel on a mouse.", "isOptional": true, "defaultValue": "'visible'" }, @@ -128113,7 +100359,7 @@ "syntaxKind": "PropertySignature", "name": "rowGap", "value": "MaybeResponsive", - "description": "The spacing between child elements along the block axis (vertical in horizontal writing modes). Overrides the block-axis value set by `gap`.", + "description": "Adjust spacing between elements in the block axis.\n\nThis overrides the row value of `gap`.", "isOptional": true, "defaultValue": "'' - meaning no override" } @@ -128143,7 +100389,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityLabel", "value": "string", - "description": "A label announced by assistive technologies that describes the purpose or contents of the element. Only set this when the element's visible content doesn't provide enough context on its own.", + "description": "A label that describes the purpose or contents of the element. When set, it will be announced to users using assistive technologies and will provide them with more context.\n\nOnly use this when the element's content is not enough context for users using assistive technologies.", "isOptional": true }, { @@ -128151,7 +100397,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityRole", "value": "AccessibilityRole", - "description": "The semantic meaning of the component's content. When set, assistive technologies use this role to help users navigate the page.", + "description": "Sets the semantic meaning of the component’s content. When set, the role will be used by assistive technologies to help users navigate the page.", "isOptional": true, "defaultValue": "'generic'" }, @@ -128160,7 +100406,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityVisibility", "value": "'visible' | 'hidden' | 'exclusive'", - "description": "Changes the visibility of the element.\n\n- `visible`: the element is visible to all users.\n- `hidden`: the element is removed from the accessibility tree but remains visible.\n- `exclusive`: the element is visually hidden but remains in the accessibility tree.", + "description": "Controls how the element is exposed to sighted users and to assistive technologies such as screen readers.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", "isOptional": true, "defaultValue": "'visible'" }, @@ -128183,7 +100429,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/Grid.ts", @@ -128656,11 +100902,7 @@ "syntaxKind": "PropertySignature", "name": "background", "value": "'base' | 'subdued' | 'transparent'", -<<<<<<< HEAD - "description": "Adjust the background of the element.\n\n- `'transparent'`: No visible background.\n- `'subdued'`: A subtle, low-emphasis background.\n- `'base'`: The standard background color.\n- `'strong'`: A high-emphasis background for prominence.", -======= "description": "The background color of the grid.\n\n- `base`: The standard background color for general content areas.\n- `subdued`: A muted background for secondary or supporting content.\n- `transparent`: No background color (the default).", ->>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) "isOptional": true, "defaultValue": "'transparent'" }, @@ -128842,7 +101084,7 @@ "syntaxKind": "PropertySignature", "name": "columnGap", "value": "MaybeResponsive", - "description": "The spacing between child elements along the inline axis (horizontal in horizontal writing modes). Overrides the inline-axis value set by `gap`.", + "description": "Adjust spacing between elements in the inline axis.\n\nThis overrides the column value of `gap`.", "isOptional": true, "defaultValue": "'' - meaning no override" }, @@ -128914,7 +101156,7 @@ "syntaxKind": "PropertySignature", "name": "display", "value": "MaybeResponsive<\"auto\" | \"none\">", - "description": "Sets the outer display type of the component. The outer type sets a component\u2019s participation in [flow layout](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_flow_layout).\n\n- `auto`: the component\u2019s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.", + "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.\n\nLearn more about the [display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display).", "isOptional": true, "defaultValue": "'auto'" }, @@ -129042,7 +101284,7 @@ "syntaxKind": "PropertySignature", "name": "gap", "value": "MaybeResponsive>", - "description": "The spacing between child elements. A single value applies to both the inline and block axes. A pair of space-separated values (for example, `large-100 large-500`) sets the inline and block axes independently.", + "description": "Adjust spacing between elements.\n\nA single value applies to both axes. A pair of values (eg `large-100 large-500`) can be used to set the inline and block axes respectively.", "isOptional": true, "defaultValue": "'none'" }, @@ -129143,7 +101385,7 @@ "syntaxKind": "PropertySignature", "name": "gridTemplateColumns", "value": "MaybeResponsive", - "description": "Defines the number and size of columns in the grid. Accepts any valid CSS [`grid-template-columns`](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-template-columns) value, such as `\"1fr 2fr\"` or `\"repeat(3, 1fr)\"`.", + "description": "Define columns and specify their size.", "isOptional": true, "defaultValue": "'none'" }, @@ -129152,7 +101394,7 @@ "syntaxKind": "PropertySignature", "name": "gridTemplateRows", "value": "MaybeResponsive", - "description": "Defines the number and size of rows in the grid. Accepts any valid CSS [`grid-template-rows`](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-template-rows) value, such as `\"auto 1fr\"` or `\"repeat(2, 100px)\"`.", + "description": "Define rows and specify their size.", "isOptional": true, "defaultValue": "'none'" }, @@ -130257,7 +102499,7 @@ "syntaxKind": "PropertySignature", "name": "overflow", "value": "'hidden' | 'visible'", - "description": "The overflow behavior of the element.\n\n- `visible`: Content that extends beyond the container is visible.\n- `hidden`: Content that extends beyond the container is clipped and not scrollable.", + "description": "Sets the overflow behavior of the element.\n\n- `visible`: The content that extends beyond the element’s container is visible.\n- `hidden`: Clips the content when it is larger than the element’s container. The element will not be scrollable and users will not be able to access the clipped content by dragging or using a scroll wheel on a mouse.", "isOptional": true, "defaultValue": "'visible'" }, @@ -130475,7 +102717,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/Grid.ts", @@ -130524,7 +102766,7 @@ "syntaxKind": "PropertySignature", "name": "rowGap", "value": "MaybeResponsive", - "description": "The spacing between child elements along the block axis (vertical in horizontal writing modes). Overrides the block-axis value set by `gap`.", + "description": "Adjust spacing between elements in the block axis.\n\nThis overrides the row value of `gap`.", "isOptional": true, "defaultValue": "'' - meaning no override" }, @@ -130748,7 +102990,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityLabel", "value": "string", - "description": "A label announced by assistive technologies that describes the purpose or contents of the element. Only set this when the element's visible content doesn't provide enough context on its own.", + "description": "A label that describes the purpose or contents of the element. When set, it will be announced to users using assistive technologies and will provide them with more context.\n\nOnly use this when the element's content is not enough context for users using assistive technologies.", "isOptional": true }, { @@ -130756,7 +102998,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityRole", "value": "AccessibilityRole", - "description": "The semantic meaning of the component's content. When set, assistive technologies use this role to help users navigate the page.", + "description": "Sets the semantic meaning of the component’s content. When set, the role will be used by assistive technologies to help users navigate the page.", "isOptional": true, "defaultValue": "'generic'" }, @@ -130765,7 +103007,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityVisibility", "value": "'visible' | 'hidden' | 'exclusive'", - "description": "Changes the visibility of the element.\n\n- `visible`: the element is visible to all users.\n- `hidden`: the element is removed from the accessibility tree but remains visible.\n- `exclusive`: the element is visually hidden but remains in the accessibility tree.", + "description": "Controls how the element is exposed to sighted users and to assistive technologies such as screen readers.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", "isOptional": true, "defaultValue": "'visible'" }, @@ -130774,11 +103016,7 @@ "syntaxKind": "PropertySignature", "name": "background", "value": "'base' | 'subdued' | 'transparent'", -<<<<<<< HEAD - "description": "Adjust the background of the element.\n\n- `'transparent'`: No visible background.\n- `'subdued'`: A subtle, low-emphasis background.\n- `'base'`: The standard background color.\n- `'strong'`: A high-emphasis background for prominence.", -======= "description": "The background color of the grid item.\n\n- `base`: The standard background color for general content areas.\n- `subdued`: A muted background for secondary or supporting content.\n- `transparent`: No background color (the default).", ->>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) "isOptional": true, "defaultValue": "'transparent'" }, @@ -130853,7 +103091,7 @@ "syntaxKind": "PropertySignature", "name": "display", "value": "MaybeResponsive<\"auto\" | \"none\">", - "description": "Sets the outer display type of the component. The outer type sets a component\u2019s participation in [flow layout](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_flow_layout).\n\n- `auto`: the component\u2019s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.", + "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.\n\nLearn more about the [display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display).", "isOptional": true, "defaultValue": "'auto'" }, @@ -130862,7 +103100,7 @@ "syntaxKind": "PropertySignature", "name": "gridColumn", "value": "`span ${number}` | \"auto\"", - "description": "The number of columns this item spans within the grid. Set to `auto` to let the grid determine placement automatically, or use `span {number}` to span a specific number of columns. Learn more about [`grid-column`](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column).", + "description": "Number of columns the item will span across", "isOptional": true, "defaultValue": "'auto'" }, @@ -130871,7 +103109,7 @@ "syntaxKind": "PropertySignature", "name": "gridRow", "value": "`span ${number}` | \"auto\"", - "description": "The number of rows this item spans within the grid. Set to `auto` to let the grid determine placement automatically, or use `span {number}` to span a specific number of rows. Learn more about [`grid-row`](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-row).", + "description": "Number of rows the item will span across", "isOptional": true, "defaultValue": "'auto'" }, @@ -130933,7 +103171,7 @@ "syntaxKind": "PropertySignature", "name": "overflow", "value": "'hidden' | 'visible'", - "description": "The overflow behavior of the element.\n\n- `visible`: Content that extends beyond the container is visible.\n- `hidden`: Content that extends beyond the container is clipped and not scrollable.", + "description": "Sets the overflow behavior of the element.\n\n- `visible`: The content that extends beyond the element’s container is visible.\n- `hidden`: Clips the content when it is larger than the element’s container. The element will not be scrollable and users will not be able to access the clipped content by dragging or using a scroll wheel on a mouse.", "isOptional": true, "defaultValue": "'visible'" }, @@ -131016,7 +103254,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityLabel", "value": "string", - "description": "A label announced by assistive technologies that describes the purpose or contents of the element. Only set this when the element's visible content doesn't provide enough context on its own.", + "description": "A label that describes the purpose or contents of the element. When set, it will be announced to users using assistive technologies and will provide them with more context.\n\nOnly use this when the element's content is not enough context for users using assistive technologies.", "isOptional": true }, { @@ -131024,7 +103262,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityRole", "value": "AccessibilityRole", - "description": "The semantic meaning of the component's content. When set, assistive technologies use this role to help users navigate the page.", + "description": "Sets the semantic meaning of the component’s content. When set, the role will be used by assistive technologies to help users navigate the page.", "isOptional": true, "defaultValue": "'generic'" }, @@ -131033,7 +103271,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityVisibility", "value": "'visible' | 'hidden' | 'exclusive'", - "description": "Changes the visibility of the element.\n\n- `visible`: the element is visible to all users.\n- `hidden`: the element is removed from the accessibility tree but remains visible.\n- `exclusive`: the element is visually hidden but remains in the accessibility tree.", + "description": "Controls how the element is exposed to sighted users and to assistive technologies such as screen readers.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", "isOptional": true, "defaultValue": "'visible'" }, @@ -131042,11 +103280,7 @@ "syntaxKind": "PropertySignature", "name": "background", "value": "'base' | 'subdued' | 'transparent'", -<<<<<<< HEAD - "description": "Adjust the background of the element.\n\n- `'transparent'`: No visible background.\n- `'subdued'`: A subtle, low-emphasis background.\n- `'base'`: The standard background color.\n- `'strong'`: A high-emphasis background for prominence.", -======= "description": "The background color of the grid item.\n\n- `base`: The standard background color for general content areas.\n- `subdued`: A muted background for secondary or supporting content.\n- `transparent`: No background color (the default).", ->>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) "isOptional": true, "defaultValue": "'transparent'" }, @@ -131109,7 +103343,7 @@ "syntaxKind": "PropertySignature", "name": "display", "value": "MaybeResponsive<\"auto\" | \"none\">", - "description": "Sets the outer display type of the component. The outer type sets a component\u2019s participation in [flow layout](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_flow_layout).\n\n- `auto`: the component\u2019s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.", + "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.\n\nLearn more about the [display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display).", "isOptional": true, "defaultValue": "'auto'" }, @@ -131118,7 +103352,7 @@ "syntaxKind": "PropertySignature", "name": "gridColumn", "value": "`span ${number}` | \"auto\"", - "description": "The number of columns this item spans within the grid. Set to `auto` to let the grid determine placement automatically, or use `span {number}` to span a specific number of columns. Learn more about [`grid-column`](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column).", + "description": "Number of columns the item will span across", "isOptional": true, "defaultValue": "'auto'" }, @@ -131127,7 +103361,7 @@ "syntaxKind": "PropertySignature", "name": "gridRow", "value": "`span ${number}` | \"auto\"", - "description": "The number of rows this item spans within the grid. Set to `auto` to let the grid determine placement automatically, or use `span {number}` to span a specific number of rows. Learn more about [`grid-row`](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-row).", + "description": "Number of rows the item will span across", "isOptional": true, "defaultValue": "'auto'" }, @@ -131189,7 +103423,7 @@ "syntaxKind": "PropertySignature", "name": "overflow", "value": "'hidden' | 'visible'", - "description": "The overflow behavior of the element.\n\n- `visible`: Content that extends beyond the container is visible.\n- `hidden`: Content that extends beyond the container is clipped and not scrollable.", + "description": "Sets the overflow behavior of the element.\n\n- `visible`: The content that extends beyond the element’s container is visible.\n- `hidden`: Clips the content when it is larger than the element’s container. The element will not be scrollable and users will not be able to access the clipped content by dragging or using a scroll wheel on a mouse.", "isOptional": true, "defaultValue": "'visible'" }, @@ -131272,7 +103506,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityLabel", "value": "string", - "description": "A label announced by assistive technologies that describes the purpose or contents of the element. Only set this when the element's visible content doesn't provide enough context on its own.", + "description": "A label that describes the purpose or contents of the element. When set, it will be announced to users using assistive technologies and will provide them with more context.\n\nOnly use this when the element's content is not enough context for users using assistive technologies.", "isOptional": true }, { @@ -131280,7 +103514,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityRole", "value": "AccessibilityRole", - "description": "The semantic meaning of the component's content. When set, assistive technologies use this role to help users navigate the page.", + "description": "Sets the semantic meaning of the component’s content. When set, the role will be used by assistive technologies to help users navigate the page.", "isOptional": true, "defaultValue": "'generic'" }, @@ -131289,7 +103523,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityVisibility", "value": "'visible' | 'hidden' | 'exclusive'", - "description": "Changes the visibility of the element.\n\n- `visible`: the element is visible to all users.\n- `hidden`: the element is removed from the accessibility tree but remains visible.\n- `exclusive`: the element is visually hidden but remains in the accessibility tree.", + "description": "Controls how the element is exposed to sighted users and to assistive technologies such as screen readers.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", "isOptional": true, "defaultValue": "'visible'" }, @@ -131312,7 +103546,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/GridItem.ts", @@ -131767,11 +104001,7 @@ "syntaxKind": "PropertySignature", "name": "background", "value": "'base' | 'subdued' | 'transparent'", -<<<<<<< HEAD - "description": "Adjust the background of the element.\n\n- `'transparent'`: No visible background.\n- `'subdued'`: A subtle, low-emphasis background.\n- `'base'`: The standard background color.\n- `'strong'`: A high-emphasis background for prominence.", -======= "description": "The background color of the grid item.\n\n- `base`: The standard background color for general content areas.\n- `subdued`: A muted background for secondary or supporting content.\n- `transparent`: No background color (the default).", ->>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) "isOptional": true, "defaultValue": "'transparent'" }, @@ -132016,7 +104246,7 @@ "syntaxKind": "PropertySignature", "name": "display", "value": "MaybeResponsive<\"auto\" | \"none\">", - "description": "Sets the outer display type of the component. The outer type sets a component\u2019s participation in [flow layout](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_flow_layout).\n\n- `auto`: the component\u2019s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.", + "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.\n\nLearn more about the [display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display).", "isOptional": true, "defaultValue": "'auto'" }, @@ -132236,7 +104466,7 @@ "syntaxKind": "PropertySignature", "name": "gridColumn", "value": "`span ${number}` | \"auto\"", - "description": "The number of columns this item spans within the grid. Set to `auto` to let the grid determine placement automatically, or use `span {number}` to span a specific number of columns. Learn more about [`grid-column`](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column).", + "description": "Number of columns the item will span across", "isOptional": true, "defaultValue": "'auto'" }, @@ -132245,7 +104475,7 @@ "syntaxKind": "PropertySignature", "name": "gridRow", "value": "`span ${number}` | \"auto\"", - "description": "The number of rows this item spans within the grid. Set to `auto` to let the grid determine placement automatically, or use `span {number}` to span a specific number of rows. Learn more about [`grid-row`](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-row).", + "description": "Number of rows the item will span across", "isOptional": true, "defaultValue": "'auto'" }, @@ -133332,7 +105562,7 @@ "syntaxKind": "PropertySignature", "name": "overflow", "value": "'hidden' | 'visible'", - "description": "The overflow behavior of the element.\n\n- `visible`: Content that extends beyond the container is visible.\n- `hidden`: Content that extends beyond the container is clipped and not scrollable.", + "description": "Sets the overflow behavior of the element.\n\n- `visible`: The content that extends beyond the element’s container is visible.\n- `hidden`: Clips the content when it is larger than the element’s container. The element will not be scrollable and users will not be able to access the clipped content by dragging or using a scroll wheel on a mouse.", "isOptional": true, "defaultValue": "'visible'" }, @@ -133532,7 +105762,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/GridItem.ts", @@ -133788,7 +106018,7 @@ "src/surfaces/checkout/components/Heading.ts": { "filePath": "src/surfaces/checkout/components/Heading.ts", "name": "HeadingElementProps", - "description": "The heading component renders hierarchical titles to communicate the structure and organization of page content. Use heading to create section titles and content headers that help users understand information hierarchy and navigate content.\n\nHeading levels adjust automatically based on nesting within parent [section](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/layout-and-structure/section) components, ensuring meaningful and accessible page outlines without manual level management.", + "description": "", "isPublicDocs": true, "members": [ { @@ -133796,7 +106026,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityRole", "value": "'heading' | 'none' | 'presentation'", - "description": "Sets the semantic meaning of the component\u2019s content. When set, the role will be used by assistive technologies to help users navigate the page.\n\n- `heading`: defines the element as a heading to a page or section.\n- `presentation`: the heading level will be stripped, and will prevent the element\u2019s implicit ARIA semantics from being exposed to the accessibility tree.\n- `none`: a synonym for the `presentation` role.", + "description": "Sets the semantic meaning of the component’s content. When set, the role will be used by assistive technologies to help users navigate the page.\n\n- `heading`: defines the element as a heading to a page or section.\n- `presentation`: the heading level will be stripped, and will prevent the element’s implicit ARIA semantics from being exposed to the accessibility tree.\n- `none`: a synonym for the `presentation` role.", "isOptional": true, "defaultValue": "'heading'" }, @@ -133824,7 +106054,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityRole", "value": "'heading' | 'none' | 'presentation'", - "description": "Sets the semantic meaning of the component\u2019s content. When set, the role will be used by assistive technologies to help users navigate the page.\n\n- `heading`: defines the element as a heading to a page or section.\n- `presentation`: the heading level will be stripped, and will prevent the element\u2019s implicit ARIA semantics from being exposed to the accessibility tree.\n- `none`: a synonym for the `presentation` role.", + "description": "Sets the semantic meaning of the component’s content. When set, the role will be used by assistive technologies to help users navigate the page.\n\n- `heading`: defines the element as a heading to a page or section.\n- `presentation`: the heading level will be stripped, and will prevent the element’s implicit ARIA semantics from being exposed to the accessibility tree.\n- `none`: a synonym for the `presentation` role.", "isOptional": true, "defaultValue": "'heading'" }, @@ -133847,7 +106077,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/Heading.ts", @@ -135856,7 +108086,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/Heading.ts", @@ -136120,7 +108350,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityRole", "value": "'heading' | 'none' | 'presentation'", - "description": "Sets the semantic meaning of the component\u2019s content. When set, the role will be used by assistive technologies to help users navigate the page.\n\n- `heading`: defines the element as a heading to a page or section.\n- `presentation`: the heading level will be stripped, and will prevent the element\u2019s implicit ARIA semantics from being exposed to the accessibility tree.\n- `none`: a synonym for the `presentation` role.", + "description": "Sets the semantic meaning of the component’s content. When set, the role will be used by assistive technologies to help users navigate the page.\n\n- `heading`: defines the element as a heading to a page or section.\n- `presentation`: the heading level will be stripped, and will prevent the element’s implicit ARIA semantics from being exposed to the accessibility tree.\n- `none`: a synonym for the `presentation` role.", "isOptional": true, "defaultValue": "'heading'" }, @@ -136285,7 +108515,7 @@ "src/surfaces/checkout/components/Image.ts": { "filePath": "src/surfaces/checkout/components/Image.ts", "name": "ImageProps", - "description": "The properties for the image component when it's used in JSX.", + "description": "", "isPublicDocs": true, "members": [ { @@ -136447,7 +108677,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/Image.ts", @@ -138535,7 +110765,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/Image.ts", @@ -138815,7 +111045,7 @@ "src/surfaces/checkout/components/Link.ts": { "filePath": "src/surfaces/checkout/components/Link.ts", "name": "LinkElementProps", - "description": "The link component makes text interactive, allowing users to navigate to other pages or perform specific actions. Use link for navigation, external references, or triggering actions while maintaining standard link semantics and accessibility.\n\nLinks support standard URLs, custom protocols, navigation within Shopify admin pages, and can open in new windows for external destinations. For prominent actions or form submissions, use [button](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/actions/button) instead.", + "description": "", "isPublicDocs": true, "members": [ { @@ -138831,7 +111061,7 @@ "syntaxKind": "PropertySignature", "name": "command", "value": "'--auto' | '--show' | '--hide' | '--toggle' | '--copy'", - "description": "Sets the action the `commandFor` should take when this clickable is activated.\n\nSee the documentation of particular components for the actions they support.\n\n- `--auto`: Performs the default action for the target component.\n- `--show`: Displays the target component.\n- `--hide`: Conceals the target component.\n- `--toggle`: Alternates the target component.\n- `--copy`: Copies the target ClipboardItem.", + "description": "Sets the action the `commandFor` target should take when this component is activated.\n\n- `--auto`: Performs the default action for the target component.\n- `--show`: Displays the target component.\n- `--hide`: Conceals the target component.\n- `--toggle`: Alternates the target component.\n- `--copy`: Copies the target ClipboardItem.\n\nLearn more about the [`command` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).", "isOptional": true, "defaultValue": "'--auto'" }, @@ -138840,7 +111070,7 @@ "syntaxKind": "PropertySignature", "name": "commandFor", "value": "string", - "description": "ID of a component that should respond to activations (such as clicks) on this component.\n\nSee `command` for how to control the behavior of the target.", + "description": "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).\n\nWhen both `commandFor` and `href` are set, `commandFor` takes precedence. The command runs and the link doesn't navigate.", "isOptional": true }, { @@ -138920,7 +111150,7 @@ "src/surfaces/checkout/components/Link.ts": { "filePath": "src/surfaces/checkout/components/Link.ts", "name": "LinkElementEvents", - "description": "The link component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", + "description": "", "isPublicDocs": true, "members": [ { @@ -138969,7 +111199,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/Link.ts", @@ -139543,7 +111773,7 @@ "syntaxKind": "PropertySignature", "name": "command", "value": "'--auto' | '--show' | '--hide' | '--toggle' | '--copy'", - "description": "Sets the action the `commandFor` should take when this clickable is activated.\n\nSee the documentation of particular components for the actions they support.\n\n- `--auto`: Performs the default action for the target component.\n- `--show`: Displays the target component.\n- `--hide`: Conceals the target component.\n- `--toggle`: Alternates the target component.\n- `--copy`: Copies the target ClipboardItem.", + "description": "Sets the action the `commandFor` target should take when this component is activated.\n\n- `--auto`: Performs the default action for the target component.\n- `--show`: Displays the target component.\n- `--hide`: Conceals the target component.\n- `--toggle`: Alternates the target component.\n- `--copy`: Copies the target ClipboardItem.\n\nLearn more about the [`command` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).", "isOptional": true, "defaultValue": "'--auto'" }, @@ -139552,7 +111782,7 @@ "syntaxKind": "PropertySignature", "name": "commandFor", "value": "string", - "description": "ID of a component that should respond to activations (such as clicks) on this component.\n\nSee `command` for how to control the behavior of the target.", + "description": "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).\n\nWhen both `commandFor` and `href` are set, `commandFor` takes precedence. The command runs and the link doesn't navigate.", "isOptional": true }, { @@ -141012,7 +113242,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/Link.ts", @@ -141302,7 +113532,7 @@ "syntaxKind": "PropertySignature", "name": "command", "value": "'--auto' | '--show' | '--hide' | '--toggle' | '--copy'", - "description": "Sets the action the `commandFor` should take when this clickable is activated.\n\nSee the documentation of particular components for the actions they support.\n\n- `--auto`: Performs the default action for the target component.\n- `--show`: Displays the target component.\n- `--hide`: Conceals the target component.\n- `--toggle`: Alternates the target component.\n- `--copy`: Copies the target ClipboardItem.", + "description": "Sets the action the `commandFor` target should take when this component is activated.\n\n- `--auto`: Performs the default action for the target component.\n- `--show`: Displays the target component.\n- `--hide`: Conceals the target component.\n- `--toggle`: Alternates the target component.\n- `--copy`: Copies the target ClipboardItem.\n\nLearn more about the [`command` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).", "isOptional": true, "defaultValue": "'--auto'" }, @@ -141311,7 +113541,7 @@ "syntaxKind": "PropertySignature", "name": "commandFor", "value": "string", - "description": "ID of a component that should respond to activations (such as clicks) on this component.\n\nSee `command` for how to control the behavior of the target.", + "description": "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).\n\nWhen both `commandFor` and `href` are set, `commandFor` takes precedence. The command runs and the link doesn't navigate.", "isOptional": true }, { @@ -141380,7 +113610,7 @@ "src/surfaces/checkout/components/ListItem.ts": { "filePath": "src/surfaces/checkout/components/ListItem.ts", "name": "ListItemElementProps", - "description": "The list item component represents a single entry within an ordered list or unordered list. Use list item to structure individual points, steps, or items within a list, with each item automatically receiving appropriate list markers (bullets or numbers) from its parent list.\n\nList item must be used as a direct child of ordered list or unordered list components. Each list item can contain text, inline formatting, or other components to create rich list content.", + "description": "", "isPublicDocs": true, "members": [ { @@ -141421,7 +113651,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/ListItem.ts", @@ -143430,7 +115660,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/ListItem.ts", @@ -143839,7 +116069,7 @@ "src/surfaces/checkout/components/Map.ts": { "filePath": "src/surfaces/checkout/components/Map.ts", "name": "MapEvents", - "description": "The event handlers for the map component.", + "description": "", "isPublicDocs": true, "members": [ { @@ -144605,7 +116835,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/Map.ts", @@ -146726,7 +118956,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/Map.ts", @@ -146991,7 +119221,7 @@ "src/surfaces/checkout/components/Map.ts": { "filePath": "src/surfaces/checkout/components/Map.ts", "name": "MapProps", - "description": "The properties for the map component when it's used in JSX.", + "description": "", "isPublicDocs": true, "members": [ { @@ -147191,7 +119421,7 @@ "syntaxKind": "PropertySignature", "name": "command", "value": "'--auto' | '--show' | '--hide' | '--toggle'", - "description": "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).\n\n- `--auto`: a default action for the target component.\n- `--show`: shows the target component.\n- `--hide`: hides the target component.\n- `--toggle`: toggles the target component.", + "description": "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).\n\n- `--auto`: a default action for the target component.\n- `--show`: shows the target component.\n- `--hide`: hides the target component.\n- `--toggle`: toggles the target component.", "isOptional": true, "defaultValue": "'--auto'" }, @@ -147200,7 +119430,7 @@ "syntaxKind": "PropertySignature", "name": "commandFor", "value": "string", - "description": "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).", + "description": "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).", "isOptional": true }, { @@ -147217,7 +119447,7 @@ "syntaxKind": "PropertySignature", "name": "latitude", "value": "number", - "description": "The latitude of the marker\u2019s position in degrees. Valid values range from -90 (South Pole) to 90 (North Pole).", + "description": "The latitude of the marker’s position in degrees. Valid values range from -90 (South Pole) to 90 (North Pole).", "isOptional": true, "defaultValue": "0" }, @@ -147226,19 +119456,19 @@ "syntaxKind": "PropertySignature", "name": "longitude", "value": "number", - "description": "The longitude of the marker\u2019s position in degrees. Valid values range from -180 (west) to 180 (east).", + "description": "The longitude of the marker’s position in degrees. Valid values range from -180 (west) to 180 (east).", "isOptional": true, "defaultValue": "0" } ], - "value": "export interface MapMarkerElementProps extends Pick {\n /**\n * 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).\n *\n * - `--auto`: a default action for the target component.\n * - `--show`: shows the target component.\n * - `--hide`: hides the target component.\n * - `--toggle`: toggles the target component.\n *\n * @default '--auto'\n */\n command?: Extract;\n /**\n * 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).\n */\n commandFor?: MapMarkerProps$1['commandFor'];\n}" + "value": "export interface MapMarkerElementProps extends Pick {\n /**\n * 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).\n *\n * - `--auto`: a default action for the target component.\n * - `--show`: shows the target component.\n * - `--hide`: hides the target component.\n * - `--toggle`: toggles the target component.\n *\n * @default '--auto'\n */\n command?: Extract;\n /**\n * 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).\n */\n commandFor?: MapMarkerProps$1['commandFor'];\n}" } }, "MapMarkerEvents": { "src/surfaces/checkout/components/MapMarker.ts": { "filePath": "src/surfaces/checkout/components/MapMarker.ts", "name": "MapMarkerEvents", - "description": "The event handlers for the map marker component.", + "description": "", "isPublicDocs": true, "members": [ { @@ -147246,7 +119476,7 @@ "syntaxKind": "PropertySignature", "name": "onClick", "value": "(event: Event) => void", - "description": "A callback fired when the user clicks on the marker. This event does not propagate to the parent map \u2014 only the marker receives the click.", + "description": "A callback fired when the user clicks on the marker. This event does not propagate to the parent map — only the marker receives the click.", "isOptional": true } ], @@ -147265,18 +119495,18 @@ "syntaxKind": "PropertySignature", "name": "click", "value": "CallbackEventListener", - "description": "A callback fired when the user clicks on the marker. This event does not propagate to the parent map \u2014 only the marker receives the click.", + "description": "A callback fired when the user clicks on the marker. This event does not propagate to the parent map — only the marker receives the click.", "isOptional": true } ], - "value": "export interface MapMarkerElementEvents {\n /**\n * A callback fired when the user clicks on the marker. This event does not propagate to the parent map \u2014 only the marker receives the click.\n */\n click?: CallbackEventListener;\n}" + "value": "export interface MapMarkerElementEvents {\n /**\n * A callback fired when the user clicks on the marker. This event does not propagate to the parent map — only the marker receives the click.\n */\n click?: CallbackEventListener;\n}" } }, "MapMarkerElementSlots": { "src/surfaces/checkout/components/MapMarker.ts": { "filePath": "src/surfaces/checkout/components/MapMarker.ts", "name": "MapMarkerElementSlots", - "description": "The named slots for the map marker component. Slots allow you to insert custom content into specific areas of the marker.", + "description": "", "isPublicDocs": true, "members": [ { @@ -147284,11 +119514,11 @@ "syntaxKind": "PropertySignature", "name": "graphic", "value": "HTMLElement", - "description": "A custom graphic element to use as the marker. If not provided, the map provider\u2019s default marker pin is displayed.", + "description": "A custom graphic element to use as the marker. If not provided, the map provider’s default marker pin is displayed.", "isOptional": true } ], - "value": "export interface MapMarkerElementSlots {\n /**\n * A custom graphic element to use as the marker. If not provided, the map provider\u2019s default marker pin is displayed.\n */\n graphic?: HTMLElement;\n}" + "value": "export interface MapMarkerElementSlots {\n /**\n * A custom graphic element to use as the marker. If not provided, the map provider’s default marker pin is displayed.\n */\n graphic?: HTMLElement;\n}" } }, "MapMarkerElement": { @@ -147325,7 +119555,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/MapMarker.ts", @@ -147917,7 +120147,7 @@ "syntaxKind": "PropertySignature", "name": "command", "value": "'--auto' | '--show' | '--hide' | '--toggle'", - "description": "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).\n\n- `--auto`: a default action for the target component.\n- `--show`: shows the target component.\n- `--hide`: hides the target component.\n- `--toggle`: toggles the target component.", + "description": "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).\n\n- `--auto`: a default action for the target component.\n- `--show`: shows the target component.\n- `--hide`: hides the target component.\n- `--toggle`: toggles the target component.", "isOptional": true, "defaultValue": "'--auto'" }, @@ -147926,7 +120156,7 @@ "syntaxKind": "PropertySignature", "name": "commandFor", "value": "string", - "description": "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).", + "description": "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).", "isOptional": true }, { @@ -148378,7 +120608,7 @@ "syntaxKind": "PropertySignature", "name": "latitude", "value": "number", - "description": "The latitude of the marker\u2019s position in degrees. Valid values range from -90 (South Pole) to 90 (North Pole).", + "description": "The latitude of the marker’s position in degrees. Valid values range from -90 (South Pole) to 90 (North Pole).", "isOptional": true, "defaultValue": "0" }, @@ -148394,7 +120624,7 @@ "syntaxKind": "PropertySignature", "name": "longitude", "value": "number", - "description": "The longitude of the marker\u2019s position in degrees. Valid values range from -180 (west) to 180 (east).", + "description": "The longitude of the marker’s position in degrees. Valid values range from -180 (west) to 180 (east).", "isOptional": true, "defaultValue": "0" }, @@ -149388,7 +121618,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/MapMarker.ts", @@ -149644,7 +121874,7 @@ "src/surfaces/checkout/components/MapMarker.ts": { "filePath": "src/surfaces/checkout/components/MapMarker.ts", "name": "MapMarkerProps", - "description": "The properties for the map marker component when it's used in JSX.", + "description": "", "isPublicDocs": true, "members": [ { @@ -149678,7 +121908,7 @@ "syntaxKind": "PropertySignature", "name": "command", "value": "'--auto' | '--show' | '--hide' | '--toggle'", - "description": "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).\n\n- `--auto`: a default action for the target component.\n- `--show`: shows the target component.\n- `--hide`: hides the target component.\n- `--toggle`: toggles the target component.", + "description": "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).\n\n- `--auto`: a default action for the target component.\n- `--show`: shows the target component.\n- `--hide`: hides the target component.\n- `--toggle`: toggles the target component.", "isOptional": true, "defaultValue": "'--auto'" }, @@ -149687,7 +121917,7 @@ "syntaxKind": "PropertySignature", "name": "commandFor", "value": "string", - "description": "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).", + "description": "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).", "isOptional": true }, { @@ -149704,7 +121934,7 @@ "syntaxKind": "PropertySignature", "name": "latitude", "value": "number", - "description": "The latitude of the marker\u2019s position in degrees. Valid values range from -90 (South Pole) to 90 (North Pole).", + "description": "The latitude of the marker’s position in degrees. Valid values range from -90 (South Pole) to 90 (North Pole).", "isOptional": true, "defaultValue": "0" }, @@ -149713,7 +121943,7 @@ "syntaxKind": "PropertySignature", "name": "longitude", "value": "number", - "description": "The longitude of the marker\u2019s position in degrees. Valid values range from -180 (west) to 180 (east).", + "description": "The longitude of the marker’s position in degrees. Valid values range from -180 (west) to 180 (east).", "isOptional": true, "defaultValue": "0" }, @@ -149722,7 +121952,7 @@ "syntaxKind": "PropertySignature", "name": "onClick", "value": "(event: Event) => void", - "description": "A callback fired when the user clicks on the marker. This event does not propagate to the parent map \u2014 only the marker receives the click.", + "description": "A callback fired when the user clicks on the marker. This event does not propagate to the parent map — only the marker receives the click.", "isOptional": true } ], @@ -149813,7 +122043,7 @@ "src/surfaces/checkout/components/Modal.ts": { "filePath": "src/surfaces/checkout/components/Modal.ts", "name": "ModalEvents", - "description": "The event callbacks for monitoring modal visibility changes.", + "description": "", "isPublicDocs": true, "members": [ { @@ -149947,7 +122177,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/Modal.ts", @@ -152008,7 +124238,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/Modal.ts", @@ -152273,7 +124503,7 @@ "src/surfaces/checkout/components/Modal.ts": { "filePath": "src/surfaces/checkout/components/Modal.ts", "name": "ModalProps", - "description": "The properties for the modal component when it's used in JSX.", + "description": "", "isPublicDocs": true, "members": [ { @@ -152358,7 +124588,7 @@ "src/surfaces/checkout/components/MoneyField.ts": { "filePath": "src/surfaces/checkout/components/MoneyField.ts", "name": "MoneyFieldElementProps", - "description": "Configure the following properties on the money field component.", + "description": "", "isPublicDocs": true, "members": [ { @@ -152366,7 +124596,7 @@ "syntaxKind": "PropertySignature", "name": "autocomplete", "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", "isOptional": true, "defaultValue": "'on' for everything else" }, @@ -152383,7 +124613,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -152505,11 +124735,7 @@ "syntaxKind": "PropertySignature", "name": "onChange", "value": "(event: Event) => void", -<<<<<<< HEAD - "description": "Callback when the user has **finished editing** a field, for example, once they have blurred the field.", -======= - "description": "A callback fired when the user has **finished editing** a field, such as when they blur the field or press Enter. Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", ->>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) + "description": "A callback fired when the user has **finished editing** a field, such as when they blur the field or press Enter.", "isOptional": true }, { @@ -152525,7 +124751,7 @@ "syntaxKind": "PropertySignature", "name": "onInput", "value": "(event: Event) => void", - "description": "A callback fired when the user makes any changes in the field, such as typing a character. Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).", + "description": "A callback fired when the user makes any changes in the field, such as typing a character.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).", "isOptional": true } ], @@ -152536,7 +124762,7 @@ "src/surfaces/checkout/components/MoneyField.ts": { "filePath": "src/surfaces/checkout/components/MoneyField.ts", "name": "MoneyFieldElementEvents", - "description": "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).", + "description": "", "isPublicDocs": true, "members": [ { @@ -152544,11 +124770,7 @@ "syntaxKind": "PropertySignature", "name": "blur", "value": "CallbackEventListener", -<<<<<<< HEAD - "description": "A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", -======= - "description": "A callback fired when the money field loses focus.\n\nLearn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", ->>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) + "description": "<<<<<<< HEAD A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n======= A callback fired when the money field loses focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) \n Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", "isOptional": true }, { @@ -152556,11 +124778,7 @@ "syntaxKind": "PropertySignature", "name": "change", "value": "CallbackEventListener", -<<<<<<< HEAD - "description": "Callback when the user has **finished editing** a field, for example, once they have blurred the field.", -======= - "description": "A callback fired when the money field value changes.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", ->>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) + "description": "<<<<<<< HEAD Callback when the user has **finished editing** a field, for example, once they have blurred the field.\n======= A callback fired when the money field value changes.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) \n Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", "isOptional": true }, { @@ -152568,11 +124786,7 @@ "syntaxKind": "PropertySignature", "name": "focus", "value": "CallbackEventListener", -<<<<<<< HEAD - "description": "A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", -======= - "description": "A callback fired when the money field receives focus.\n\nLearn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", ->>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) + "description": "<<<<<<< HEAD A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n======= A callback fired when the money field receives focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) \n Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", "isOptional": true }, { @@ -152584,11 +124798,7 @@ "isOptional": true } ], -<<<<<<< HEAD - "value": "export interface MoneyFieldElementEvents {\n /**\n * A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event\n */\n blur?: CallbackEventListener;\n /**\n * Callback when the user has **finished editing** a field, for example, once they have blurred the field.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event\n */\n change?: CallbackEventListener;\n /**\n * A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event\n */\n focus?: CallbackEventListener;\n /**\n * Callback when the user makes any changes in the field.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event\n */\n input?: CallbackEventListener;\n}" -======= - "value": "export interface MoneyFieldElementEvents {\n /**\n * A callback fired when the money field loses focus.\n *\n * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur?: CallbackEventListener;\n /**\n * A callback fired when the money field value changes.\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change?: CallbackEventListener;\n /**\n * A callback fired when the money field receives focus.\n *\n * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus?: CallbackEventListener;\n /**\n * A callback fired when the user inputs data into the money field.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input?: CallbackEventListener;\n}" ->>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) + "value": "export interface MoneyFieldElementEvents {\n /**\n<<<<<<< HEAD\n * A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n=======\n * A callback fired when the money field loses focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality)\n *\n * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur?: CallbackEventListener;\n /**\n<<<<<<< HEAD\n * Callback when the user has **finished editing** a field, for example, once they have blurred the field.\n=======\n * A callback fired when the money field value changes.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality)\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change?: CallbackEventListener;\n /**\n<<<<<<< HEAD\n * A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n=======\n * A callback fired when the money field receives focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality)\n *\n * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus?: CallbackEventListener;\n /**\n * A callback fired when the user inputs data into the money field.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input?: CallbackEventListener;\n}" } }, "MoneyFieldElement": { @@ -152603,7 +124813,7 @@ "syntaxKind": "PropertySignature", "name": "autocomplete", "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", "isOptional": true, "defaultValue": "'on' for everything else" }, @@ -152620,7 +124830,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -152762,7 +124972,7 @@ "syntaxKind": "PropertySignature", "name": "autocomplete", "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", "isOptional": true, "defaultValue": "'on' for everything else" }, @@ -152779,7 +124989,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -152855,11 +125065,7 @@ "syntaxKind": "PropertySignature", "name": "onChange", "value": "(event: Event) => void", -<<<<<<< HEAD - "description": "Callback when the user has **finished editing** a field, for example, once they have blurred the field.", -======= - "description": "A callback fired when the user has **finished editing** a field, such as when they blur the field or press Enter. Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", ->>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) + "description": "A callback fired when the user has **finished editing** a field, such as when they blur the field or press Enter.", "isOptional": true }, { @@ -152875,7 +125081,7 @@ "syntaxKind": "PropertySignature", "name": "onInput", "value": "(event: Event) => void", - "description": "A callback fired when the user makes any changes in the field, such as typing a character. Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).", + "description": "A callback fired when the user makes any changes in the field, such as typing a character.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).", "isOptional": true }, { @@ -152921,7 +125127,7 @@ "src/surfaces/checkout/components/NumberField.ts": { "filePath": "src/surfaces/checkout/components/NumberField.ts", "name": "NumberFieldElementProps", - "description": "Configure the following properties on the number field component.", + "description": "", "isPublicDocs": true, "members": [ { @@ -152929,7 +125135,7 @@ "syntaxKind": "PropertySignature", "name": "autocomplete", "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", "isOptional": true, "defaultValue": "'on' for everything else" }, @@ -152938,7 +125144,7 @@ "syntaxKind": "PropertySignature", "name": "controls", "value": "'auto' | 'stepper' | 'none'", - "description": "Sets the type of controls displayed in the field.\n\n- `stepper`: displays buttons to increase or decrease the value of the field by the stepping interval defined in the `step` property. Appropriate mouse and [keyboard interactions](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/spinbutton_role#keyboard_interactions) to control the value of the field are enabled.\n- `none`: no controls are displayed and users must input the value manually. Arrow keys and scroll wheels can\u2019t be used either to avoid accidental changes.\n- `auto`: the presence of the controls depends on the surface and context.", + "description": "Sets the type of controls displayed in the field.\n\n- `stepper`: displays buttons to increase or decrease the value of the field by the stepping interval defined in the `step` property. Appropriate mouse and [keyboard interactions](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/spinbutton_role#keyboard_interactions) to control the value of the field are enabled.\n- `none`: no controls are displayed and users must input the value manually. Arrow keys and scroll wheels can’t be used either to avoid accidental changes.\n- `auto`: the presence of the controls depends on the surface and context.", "isOptional": true, "defaultValue": "'auto'" }, @@ -152955,7 +125161,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -153051,7 +125257,7 @@ "syntaxKind": "PropertySignature", "name": "prefix", "value": "string", - "description": "A value to be displayed immediately before the editable portion of the field.\n\nThis is useful for displaying an implied part of the value, such as \"https://\" or \"+353\".\n\nThis cannot be edited by the user, and it isn't included in the value of the field.\n\nIt may not be displayed until the user has interacted with the input. For example, an inline label may take the place of the prefix until the user focuses the input.", + "description": "A value to be displayed immediately before the editable portion of the field.\n\nThis is useful for displaying an implied part of the value, such as \"https://\" or \"+353\".\n\nThis can't be edited by the user, and it isn't included in the value of the field.\n\nIt may not be displayed until the user has interacted with the input. For example, an inline label may take the place of the prefix until the user focuses the input.", "isOptional": true, "defaultValue": "''" }, @@ -153087,7 +125293,7 @@ "syntaxKind": "PropertySignature", "name": "suffix", "value": "string", - "description": "A value to be displayed immediately after the editable portion of the field.\n\nThis is useful for displaying an implied part of the value, such as \"@shopify.com\", or \"%\".\n\nThis cannot be edited by the user, and it isn't included in the value of the field.\n\nIt may not be displayed until the user has interacted with the input. For example, an inline label may take the place of the suffix until the user focuses the input.", + "description": "A value to be displayed immediately after the editable portion of the field.\n\nThis is useful for displaying an implied part of the value, such as \"@shopify.com\", or \"%\".\n\nThis can't be edited by the user, and it isn't included in the value of the field.\n\nIt may not be displayed until the user has interacted with the input. For example, an inline label may take the place of the suffix until the user focuses the input.", "isOptional": true, "defaultValue": "''" }, @@ -153123,11 +125329,7 @@ "syntaxKind": "PropertySignature", "name": "onChange", "value": "(event: Event) => void", -<<<<<<< HEAD - "description": "Callback when the user has **finished editing** a field, for example, once they have blurred the field.", -======= - "description": "A callback fired when the user has **finished editing** a field, such as when they blur the field or press Enter. Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", ->>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) + "description": "A callback fired when the user has **finished editing** a field, such as when they blur the field or press Enter.", "isOptional": true }, { @@ -153143,7 +125345,7 @@ "syntaxKind": "PropertySignature", "name": "onInput", "value": "(event: Event) => void", - "description": "A callback fired when the user makes any changes in the field, such as typing a character. Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).", + "description": "A callback fired when the user makes any changes in the field, such as typing a character.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).", "isOptional": true } ], @@ -153154,7 +125356,7 @@ "src/surfaces/checkout/components/NumberField.ts": { "filePath": "src/surfaces/checkout/components/NumberField.ts", "name": "NumberFieldElementEvents", - "description": "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).", + "description": "", "isPublicDocs": true, "members": [ { @@ -153162,11 +125364,7 @@ "syntaxKind": "PropertySignature", "name": "blur", "value": "CallbackEventListener", -<<<<<<< HEAD - "description": "A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", -======= - "description": "A callback fired when the number field loses focus.\n\nLearn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", ->>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) + "description": "<<<<<<< HEAD A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n======= A callback fired when the number field loses focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) \n Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", "isOptional": true }, { @@ -153174,11 +125372,7 @@ "syntaxKind": "PropertySignature", "name": "change", "value": "CallbackEventListener", -<<<<<<< HEAD - "description": "Callback when the user has **finished editing** a field, for example, once they have blurred the field.", -======= - "description": "A callback fired when the number field value changes.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", ->>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) + "description": "<<<<<<< HEAD Callback when the user has **finished editing** a field, for example, once they have blurred the field.\n======= A callback fired when the number field value changes.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) \n Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", "isOptional": true }, { @@ -153186,11 +125380,7 @@ "syntaxKind": "PropertySignature", "name": "focus", "value": "CallbackEventListener", -<<<<<<< HEAD - "description": "A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", -======= - "description": "A callback fired when the number field receives focus.\n\nLearn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", ->>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) + "description": "<<<<<<< HEAD A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n======= A callback fired when the number field receives focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) \n Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", "isOptional": true }, { @@ -153202,18 +125392,14 @@ "isOptional": true } ], -<<<<<<< HEAD - "value": "export interface NumberFieldElementEvents {\n /**\n * A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event\n */\n blur?: CallbackEventListener;\n /**\n * Callback when the user has **finished editing** a field, for example, once they have blurred the field.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event\n */\n change?: CallbackEventListener;\n /**\n * A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event\n */\n focus?: CallbackEventListener;\n /**\n * Callback when the user makes any changes in the field.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event\n */\n input?: CallbackEventListener;\n}" -======= - "value": "export interface NumberFieldElementEvents {\n /**\n * A callback fired when the number field loses focus.\n *\n * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur?: CallbackEventListener;\n /**\n * A callback fired when the number field value changes.\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change?: CallbackEventListener;\n /**\n * A callback fired when the number field receives focus.\n *\n * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus?: CallbackEventListener;\n /**\n * A callback fired when the user inputs data into the number field.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input?: CallbackEventListener;\n}" ->>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) + "value": "export interface NumberFieldElementEvents {\n /**\n<<<<<<< HEAD\n * A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n=======\n * A callback fired when the number field loses focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality)\n *\n * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur?: CallbackEventListener;\n /**\n<<<<<<< HEAD\n * Callback when the user has **finished editing** a field, for example, once they have blurred the field.\n=======\n * A callback fired when the number field value changes.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality)\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change?: CallbackEventListener;\n /**\n<<<<<<< HEAD\n * A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n=======\n * A callback fired when the number field receives focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality)\n *\n * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus?: CallbackEventListener;\n /**\n * A callback fired when the user inputs data into the number field.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input?: CallbackEventListener;\n}" } }, "NumberFieldElementSlots": { "src/surfaces/checkout/components/NumberField.ts": { "filePath": "src/surfaces/checkout/components/NumberField.ts", "name": "NumberFieldElementSlots", - "description": "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).", + "description": "", "isPublicDocs": true, "members": [ { @@ -153254,7 +125440,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/NumberField.ts", @@ -153695,7 +125881,7 @@ "syntaxKind": "PropertySignature", "name": "autocomplete", "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", "isOptional": true, "defaultValue": "'on' for everything else" }, @@ -153872,7 +126058,7 @@ "syntaxKind": "PropertySignature", "name": "controls", "value": "'auto' | 'stepper' | 'none'", - "description": "Sets the type of controls displayed in the field.\n\n- `stepper`: displays buttons to increase or decrease the value of the field by the stepping interval defined in the `step` property. Appropriate mouse and [keyboard interactions](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/spinbutton_role#keyboard_interactions) to control the value of the field are enabled.\n- `none`: no controls are displayed and users must input the value manually. Arrow keys and scroll wheels can\u2019t be used either to avoid accidental changes.\n- `auto`: the presence of the controls depends on the surface and context.", + "description": "Sets the type of controls displayed in the field.\n\n- `stepper`: displays buttons to increase or decrease the value of the field by the stepping interval defined in the `step` property. Appropriate mouse and [keyboard interactions](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/spinbutton_role#keyboard_interactions) to control the value of the field are enabled.\n- `none`: no controls are displayed and users must input the value manually. Arrow keys and scroll wheels can’t be used either to avoid accidental changes.\n- `auto`: the presence of the controls depends on the surface and context.", "isOptional": true, "defaultValue": "'auto'" }, @@ -153910,7 +126096,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -155276,7 +127462,7 @@ "syntaxKind": "PropertySignature", "name": "prefix", "value": "string", - "description": "A value to be displayed immediately before the editable portion of the field.\n\nThis is useful for displaying an implied part of the value, such as \"https://\" or \"+353\".\n\nThis cannot be edited by the user, and it isn't included in the value of the field.\n\nIt may not be displayed until the user has interacted with the input. For example, an inline label may take the place of the prefix until the user focuses the input.", + "description": "A value to be displayed immediately before the editable portion of the field.\n\nThis is useful for displaying an implied part of the value, such as \"https://\" or \"+353\".\n\nThis can't be edited by the user, and it isn't included in the value of the field.\n\nIt may not be displayed until the user has interacted with the input. For example, an inline label may take the place of the prefix until the user focuses the input.", "isOptional": true, "defaultValue": "''" }, @@ -155380,7 +127566,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/NumberField.ts", @@ -155580,7 +127766,7 @@ "syntaxKind": "PropertySignature", "name": "suffix", "value": "string", - "description": "A value to be displayed immediately after the editable portion of the field.\n\nThis is useful for displaying an implied part of the value, such as \"@shopify.com\", or \"%\".\n\nThis cannot be edited by the user, and it isn't included in the value of the field.\n\nIt may not be displayed until the user has interacted with the input. For example, an inline label may take the place of the suffix until the user focuses the input.", + "description": "A value to be displayed immediately after the editable portion of the field.\n\nThis is useful for displaying an implied part of the value, such as \"@shopify.com\", or \"%\".\n\nThis can't be edited by the user, and it isn't included in the value of the field.\n\nIt may not be displayed until the user has interacted with the input. For example, an inline label may take the place of the suffix until the user focuses the input.", "isOptional": true, "defaultValue": "''" }, @@ -155679,7 +127865,7 @@ "syntaxKind": "PropertySignature", "name": "autocomplete", "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", "isOptional": true, "defaultValue": "'on' for everything else" }, @@ -155688,7 +127874,7 @@ "syntaxKind": "PropertySignature", "name": "controls", "value": "'auto' | 'stepper' | 'none'", - "description": "Sets the type of controls displayed in the field.\n\n- `stepper`: displays buttons to increase or decrease the value of the field by the stepping interval defined in the `step` property. Appropriate mouse and [keyboard interactions](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/spinbutton_role#keyboard_interactions) to control the value of the field are enabled.\n- `none`: no controls are displayed and users must input the value manually. Arrow keys and scroll wheels can\u2019t be used either to avoid accidental changes.\n- `auto`: the presence of the controls depends on the surface and context.", + "description": "Sets the type of controls displayed in the field.\n\n- `stepper`: displays buttons to increase or decrease the value of the field by the stepping interval defined in the `step` property. Appropriate mouse and [keyboard interactions](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/spinbutton_role#keyboard_interactions) to control the value of the field are enabled.\n- `none`: no controls are displayed and users must input the value manually. Arrow keys and scroll wheels can’t be used either to avoid accidental changes.\n- `auto`: the presence of the controls depends on the surface and context.", "isOptional": true, "defaultValue": "'auto'" }, @@ -155705,7 +127891,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -155798,11 +127984,7 @@ "syntaxKind": "PropertySignature", "name": "onChange", "value": "(event: Event) => void", -<<<<<<< HEAD - "description": "Callback when the user has **finished editing** a field, for example, once they have blurred the field.", -======= - "description": "A callback fired when the user has **finished editing** a field, such as when they blur the field or press Enter. Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", ->>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) + "description": "A callback fired when the user has **finished editing** a field, such as when they blur the field or press Enter.", "isOptional": true }, { @@ -155818,7 +128000,7 @@ "syntaxKind": "PropertySignature", "name": "onInput", "value": "(event: Event) => void", - "description": "A callback fired when the user makes any changes in the field, such as typing a character. Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).", + "description": "A callback fired when the user makes any changes in the field, such as typing a character.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).", "isOptional": true }, { @@ -155836,7 +128018,7 @@ "syntaxKind": "PropertySignature", "name": "prefix", "value": "string", - "description": "A value to be displayed immediately before the editable portion of the field.\n\nThis is useful for displaying an implied part of the value, such as \"https://\" or \"+353\".\n\nThis cannot be edited by the user, and it isn't included in the value of the field.\n\nIt may not be displayed until the user has interacted with the input. For example, an inline label may take the place of the prefix until the user focuses the input.", + "description": "A value to be displayed immediately before the editable portion of the field.\n\nThis is useful for displaying an implied part of the value, such as \"https://\" or \"+353\".\n\nThis can't be edited by the user, and it isn't included in the value of the field.\n\nIt may not be displayed until the user has interacted with the input. For example, an inline label may take the place of the prefix until the user focuses the input.", "isOptional": true, "defaultValue": "''" }, @@ -155872,7 +128054,7 @@ "syntaxKind": "PropertySignature", "name": "suffix", "value": "string", - "description": "A value to be displayed immediately after the editable portion of the field.\n\nThis is useful for displaying an implied part of the value, such as \"@shopify.com\", or \"%\".\n\nThis cannot be edited by the user, and it isn't included in the value of the field.\n\nIt may not be displayed until the user has interacted with the input. For example, an inline label may take the place of the suffix until the user focuses the input.", + "description": "A value to be displayed immediately after the editable portion of the field.\n\nThis is useful for displaying an implied part of the value, such as \"@shopify.com\", or \"%\".\n\nThis can't be edited by the user, and it isn't included in the value of the field.\n\nIt may not be displayed until the user has interacted with the input. For example, an inline label may take the place of the suffix until the user focuses the input.", "isOptional": true, "defaultValue": "''" }, @@ -155892,7 +128074,7 @@ "src/surfaces/checkout/components/Option.ts": { "filePath": "src/surfaces/checkout/components/Option.ts", "name": "OptionElementProps", - "description": "Configure the following properties on the option component.", + "description": "", "isPublicDocs": true, "members": [ { @@ -155908,7 +128090,7 @@ "syntaxKind": "PropertySignature", "name": "defaultSelected", "value": "boolean", - "description": "Whether the control is active by default.", + "description": "Whether the control is selected by default.", "isOptional": true, "defaultValue": "false" }, @@ -155917,7 +128099,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the control, disallowing any interaction.", + "description": "Whether the control is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -155934,7 +128116,7 @@ "syntaxKind": "PropertySignature", "name": "selected", "value": "boolean", - "description": "Whether the control is active.", + "description": "Whether the control is currently selected.", "isOptional": true, "defaultValue": "false" }, @@ -155984,7 +128166,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/Option.ts", @@ -156607,7 +128789,7 @@ "syntaxKind": "PropertySignature", "name": "defaultSelected", "value": "boolean", - "description": "Whether the control is active by default.", + "description": "Whether the control is selected by default.", "isOptional": true, "defaultValue": "false" }, @@ -156623,7 +128805,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the control, disallowing any interaction.", + "description": "Whether the control is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -158011,7 +130193,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/Option.ts", @@ -158116,7 +130298,7 @@ "syntaxKind": "PropertySignature", "name": "selected", "value": "boolean", - "description": "Whether the control is active.", + "description": "Whether the control is currently selected.", "isOptional": true, "defaultValue": "false" }, @@ -158300,7 +130482,7 @@ "syntaxKind": "PropertySignature", "name": "defaultSelected", "value": "boolean", - "description": "Whether the control is active by default.", + "description": "Whether the control is selected by default.", "isOptional": true, "defaultValue": "false" }, @@ -158309,7 +130491,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the control, disallowing any interaction.", + "description": "Whether the control is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -158326,7 +130508,7 @@ "syntaxKind": "PropertySignature", "name": "selected", "value": "boolean", - "description": "Whether the control is active.", + "description": "Whether the control is currently selected.", "isOptional": true, "defaultValue": "false" }, @@ -158346,7 +130528,7 @@ "src/surfaces/checkout/components/Paragraph.ts": { "filePath": "src/surfaces/checkout/components/Paragraph.ts", "name": "ParagraphElementProps", - "description": "The paragraph component displays blocks of text content and can contain inline elements like buttons, links, or emphasized text. Use paragraph to present standalone blocks of readable content, descriptions, or explanatory text.\n\nParagraphs support alignment options and can wrap inline components to create rich, formatted content blocks. For inline text styling, use [text](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/typography-and-content/text).", + "description": "", "isPublicDocs": true, "members": [ { @@ -158354,7 +130536,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityVisibility", "value": "'visible' | 'hidden' | 'exclusive'", - "description": "Changes the visibility of the element.\n\n- `visible`: the element is visible to all users.\n- `hidden`: the element is removed from the accessibility tree but remains visible.\n- `exclusive`: the element is visually hidden but remains in the accessibility tree.", + "description": "Controls how the element is exposed to sighted users and to assistive technologies such as screen readers.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", "isOptional": true, "defaultValue": "'visible'" }, @@ -158363,7 +130545,7 @@ "syntaxKind": "PropertySignature", "name": "color", "value": "'base' | 'subdued'", - "description": "Modify the color to be more or less intense.", + "description": "The color emphasis level that controls visual intensity.\n\n- `subdued`: Deemphasized color for secondary text, supporting labels, and less critical interface elements.\n- `base`: Primary color for body text, standard UI elements, and general content with good readability.\n- `strong`: Emphasized color for headings, key labels, and interactive elements that need prominence.", "isOptional": true, "defaultValue": "'base'" }, @@ -158372,11 +130554,7 @@ "syntaxKind": "PropertySignature", "name": "dir", "value": "'ltr' | 'rtl' | 'auto' | ''", -<<<<<<< HEAD - "description": "Indicates the directionality of the element’s text.\n\n- `ltr`: languages written from left to right (such as English)\n- `rtl`: languages written from right to left (such as Arabic)\n- `auto`: the user agent determines the direction based on the content\n- `''`: direction is inherited from parent elements (equivalent to not setting the attribute)", -======= - "description": "Indicates the directionality of the element\u2019s text.\n\n- `ltr`: languages written from left to right (e.g. English)\n- `rtl`: languages written from right to left (e.g. Arabic)\n- `auto`: the user agent determines the direction based on the content\n- `''`: direction is inherited from parent elements (equivalent to not setting the attribute)", ->>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) + "description": "Indicates the directionality of the element’s text.\n\n- `ltr`: The languages written from left to right (such as English).\n- `rtl`: The languages written from right to left (such as Arabic).\n- `auto`: The user agent determines the direction based on the content.\n- `\"\"`: The direction is inherited from parent elements (equivalent to not setting the attribute).\n\nLearn more about the [dir attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/dir).", "isOptional": true, "defaultValue": "''" }, @@ -158393,20 +130571,25 @@ "syntaxKind": "PropertySignature", "name": "lang", "value": "string", -<<<<<<< HEAD - "description": "The language of the button's text content. Use this when the button text is in a different language than the rest of the page, so assistive technologies can invoke the correct pronunciation. [Reference of values](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry) (`Subtag` label)\n\nIt is recommended to combine it with the `dir` attribute to ensure the text is rendered correctly if the surrounding content’s direction is different.", -======= - "description": "Indicate the text language. Useful when the text is in a different language than the rest of the page. It will allow assistive technologies such as screen readers to invoke the correct pronunciation. [Reference of values](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry) (\"subtag\" label)\n\nIt is recommended to combine it with the `dir` attribute to ensure the text is rendered correctly if the surrounding content\u2019s direction is different.", ->>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) + "description": "Indicate the text language. Useful when the text is in a different language than the rest of the page. It will allow assistive technologies such as screen readers to invoke the correct pronunciation. [Reference of values](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry) (\"subtag\" label)\n\nIt is recommended to combine it with the `dir` attribute to ensure the text is rendered correctly if the surrounding content’s direction is different.", "isOptional": true, "defaultValue": "''" }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "textAlign", + "value": "'start' | 'end' | 'center' | 'auto'", + "description": "Sets the alignment of the text.", + "isOptional": true, + "defaultValue": "'auto'" + }, { "filePath": "src/surfaces/checkout/components/Paragraph.ts", "syntaxKind": "PropertySignature", "name": "tone", "value": "'info' | 'auto' | 'neutral' | 'success' | 'warning' | 'critical' | 'custom'", - "description": "Sets the tone of the component, based on the intention of the information being conveyed.", + "description": "The semantic meaning and color treatment of the component.\n\n- `auto`: Automatically determined based on context.\n- `neutral`: General information without specific intent.\n- `info`: Informational content or helpful tips.\n- `success`: Positive outcomes or successful states.\n- `warning`: Important warnings about potential issues.\n- `critical`: Urgent problems or destructive actions.\n- `custom`: Custom styling controlled by your theme.", "isOptional": true, "defaultValue": "'auto'" }, @@ -158415,12 +130598,12 @@ "syntaxKind": "PropertySignature", "name": "type", "value": "ParagraphType", - "description": "Provide semantic meaning and default styling to the paragraph.\n\nOther presentation properties on `s-paragraph` override the default styling.", + "description": "The semantic type and styling treatment for the paragraph content.\n\nOther presentation properties on `s-paragraph` override the default styling.", "isOptional": true, "defaultValue": "'paragraph'" } ], - "value": "export interface ParagraphElementProps extends Pick {\n color?: Extract;\n tone?: Extract;\n}" + "value": "export interface ParagraphElementProps extends Pick {\n color?: Extract;\n tone?: Extract;\n /**\n * Sets the alignment of the text.\n * @see https://developer.mozilla.org/en-US/docs/Web/CSS/text-align\n *\n * @default 'auto'\n */\n textAlign?: 'start' | 'end' | 'center' | 'auto';\n}" } }, "ParagraphType": { @@ -158445,7 +130628,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityVisibility", "value": "'visible' | 'hidden' | 'exclusive'", - "description": "Changes the visibility of the element.\n\n- `visible`: the element is visible to all users.\n- `hidden`: the element is removed from the accessibility tree but remains visible.\n- `exclusive`: the element is visually hidden but remains in the accessibility tree.", + "description": "Controls how the element is exposed to sighted users and to assistive technologies such as screen readers.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", "isOptional": true, "defaultValue": "'visible'" }, @@ -158468,7 +130651,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/Paragraph.ts", @@ -159042,7 +131225,7 @@ "syntaxKind": "PropertySignature", "name": "color", "value": "'base' | 'subdued'", - "description": "Modify the color to be more or less intense.", + "description": "The color emphasis level that controls visual intensity.\n\n- `subdued`: Deemphasized color for secondary text, supporting labels, and less critical interface elements.\n- `base`: Primary color for body text, standard UI elements, and general content with good readability.\n- `strong`: Emphasized color for headings, key labels, and interactive elements that need prominence.", "isOptional": true, "defaultValue": "'base'" }, @@ -159100,11 +131283,7 @@ "syntaxKind": "PropertySignature", "name": "dir", "value": "'ltr' | 'rtl' | 'auto' | ''", -<<<<<<< HEAD - "description": "Indicates the directionality of the element’s text.\n\n- `ltr`: languages written from left to right (such as English)\n- `rtl`: languages written from right to left (such as Arabic)\n- `auto`: the user agent determines the direction based on the content\n- `''`: direction is inherited from parent elements (equivalent to not setting the attribute)", -======= - "description": "Indicates the directionality of the element\u2019s text.\n\n- `ltr`: languages written from left to right (e.g. English)\n- `rtl`: languages written from right to left (e.g. Arabic)\n- `auto`: the user agent determines the direction based on the content\n- `''`: direction is inherited from parent elements (equivalent to not setting the attribute)", ->>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) + "description": "Indicates the directionality of the element’s text.\n\n- `ltr`: The languages written from left to right (such as English).\n- `rtl`: The languages written from right to left (such as Arabic).\n- `auto`: The user agent determines the direction based on the content.\n- `\"\"`: The direction is inherited from parent elements (equivalent to not setting the attribute).\n\nLearn more about the [dir attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/dir).", "isOptional": true, "defaultValue": "''" }, @@ -159479,11 +131658,7 @@ "syntaxKind": "PropertySignature", "name": "lang", "value": "string", -<<<<<<< HEAD - "description": "The language of the button's text content. Use this when the button text is in a different language than the rest of the page, so assistive technologies can invoke the correct pronunciation. [Reference of values](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry) (`Subtag` label)\n\nIt is recommended to combine it with the `dir` attribute to ensure the text is rendered correctly if the surrounding content’s direction is different.", -======= - "description": "Indicate the text language. Useful when the text is in a different language than the rest of the page. It will allow assistive technologies such as screen readers to invoke the correct pronunciation. [Reference of values](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry) (\"subtag\" label)\n\nIt is recommended to combine it with the `dir` attribute to ensure the text is rendered correctly if the surrounding content\u2019s direction is different.", ->>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) + "description": "Indicate the text language. Useful when the text is in a different language than the rest of the page. It will allow assistive technologies such as screen readers to invoke the correct pronunciation. [Reference of values](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry) (\"subtag\" label)\n\nIt is recommended to combine it with the `dir` attribute to ensure the text is rendered correctly if the surrounding content’s direction is different.", "isOptional": true, "defaultValue": "''" }, @@ -160498,7 +132673,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/Paragraph.ts", @@ -160696,6 +132871,15 @@ "value": "3", "description": "node is a Text node." }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "textAlign", + "value": "'start' | 'end' | 'center' | 'auto'", + "description": "Sets the alignment of the text.", + "isOptional": true, + "defaultValue": "'auto'" + }, { "filePath": "src/surfaces/checkout/components/Paragraph.ts", "syntaxKind": "GetAccessor", @@ -160729,7 +132913,7 @@ "syntaxKind": "PropertySignature", "name": "tone", "value": "'info' | 'auto' | 'neutral' | 'success' | 'warning' | 'critical' | 'custom'", - "description": "Sets the tone of the component, based on the intention of the information being conveyed.", + "description": "The semantic meaning and color treatment of the component.\n\n- `auto`: Automatically determined based on context.\n- `neutral`: General information without specific intent.\n- `info`: Informational content or helpful tips.\n- `success`: Positive outcomes or successful states.\n- `warning`: Important warnings about potential issues.\n- `critical`: Urgent problems or destructive actions.\n- `custom`: Custom styling controlled by your theme.", "isOptional": true, "defaultValue": "'auto'" }, @@ -160745,7 +132929,7 @@ "syntaxKind": "PropertySignature", "name": "type", "value": "ParagraphType", - "description": "Provide semantic meaning and default styling to the paragraph.\n\nOther presentation properties on `s-paragraph` override the default styling.", + "description": "The semantic type and styling treatment for the paragraph content.\n\nOther presentation properties on `s-paragraph` override the default styling.", "isOptional": true, "defaultValue": "'paragraph'" }, @@ -160780,7 +132964,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityVisibility", "value": "'visible' | 'hidden' | 'exclusive'", - "description": "Changes the visibility of the element.\n\n- `visible`: the element is visible to all users.\n- `hidden`: the element is removed from the accessibility tree but remains visible.\n- `exclusive`: the element is visually hidden but remains in the accessibility tree.", + "description": "Controls how the element is exposed to sighted users and to assistive technologies such as screen readers.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", "isOptional": true, "defaultValue": "'visible'" }, @@ -160789,7 +132973,7 @@ "syntaxKind": "PropertySignature", "name": "color", "value": "'base' | 'subdued'", - "description": "Modify the color to be more or less intense.", + "description": "The color emphasis level that controls visual intensity.\n\n- `subdued`: Deemphasized color for secondary text, supporting labels, and less critical interface elements.\n- `base`: Primary color for body text, standard UI elements, and general content with good readability.\n- `strong`: Emphasized color for headings, key labels, and interactive elements that need prominence.", "isOptional": true, "defaultValue": "'base'" }, @@ -160798,11 +132982,7 @@ "syntaxKind": "PropertySignature", "name": "dir", "value": "'ltr' | 'rtl' | 'auto' | ''", -<<<<<<< HEAD - "description": "Indicates the directionality of the element’s text.\n\n- `ltr`: languages written from left to right (such as English)\n- `rtl`: languages written from right to left (such as Arabic)\n- `auto`: the user agent determines the direction based on the content\n- `''`: direction is inherited from parent elements (equivalent to not setting the attribute)", -======= - "description": "Indicates the directionality of the element\u2019s text.\n\n- `ltr`: languages written from left to right (e.g. English)\n- `rtl`: languages written from right to left (e.g. Arabic)\n- `auto`: the user agent determines the direction based on the content\n- `''`: direction is inherited from parent elements (equivalent to not setting the attribute)", ->>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) + "description": "Indicates the directionality of the element’s text.\n\n- `ltr`: The languages written from left to right (such as English).\n- `rtl`: The languages written from right to left (such as Arabic).\n- `auto`: The user agent determines the direction based on the content.\n- `\"\"`: The direction is inherited from parent elements (equivalent to not setting the attribute).\n\nLearn more about the [dir attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/dir).", "isOptional": true, "defaultValue": "''" }, @@ -160819,20 +132999,25 @@ "syntaxKind": "PropertySignature", "name": "lang", "value": "string", -<<<<<<< HEAD - "description": "The language of the button's text content. Use this when the button text is in a different language than the rest of the page, so assistive technologies can invoke the correct pronunciation. [Reference of values](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry) (`Subtag` label)\n\nIt is recommended to combine it with the `dir` attribute to ensure the text is rendered correctly if the surrounding content’s direction is different.", -======= - "description": "Indicate the text language. Useful when the text is in a different language than the rest of the page. It will allow assistive technologies such as screen readers to invoke the correct pronunciation. [Reference of values](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry) (\"subtag\" label)\n\nIt is recommended to combine it with the `dir` attribute to ensure the text is rendered correctly if the surrounding content\u2019s direction is different.", ->>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) + "description": "Indicate the text language. Useful when the text is in a different language than the rest of the page. It will allow assistive technologies such as screen readers to invoke the correct pronunciation. [Reference of values](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry) (\"subtag\" label)\n\nIt is recommended to combine it with the `dir` attribute to ensure the text is rendered correctly if the surrounding content’s direction is different.", "isOptional": true, "defaultValue": "''" }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "textAlign", + "value": "'start' | 'end' | 'center' | 'auto'", + "description": "Sets the alignment of the text.", + "isOptional": true, + "defaultValue": "'auto'" + }, { "filePath": "src/surfaces/checkout/components/Paragraph.ts", "syntaxKind": "PropertySignature", "name": "tone", "value": "'info' | 'auto' | 'neutral' | 'success' | 'warning' | 'critical' | 'custom'", - "description": "Sets the tone of the component, based on the intention of the information being conveyed.", + "description": "The semantic meaning and color treatment of the component.\n\n- `auto`: Automatically determined based on context.\n- `neutral`: General information without specific intent.\n- `info`: Informational content or helpful tips.\n- `success`: Positive outcomes or successful states.\n- `warning`: Important warnings about potential issues.\n- `critical`: Urgent problems or destructive actions.\n- `custom`: Custom styling controlled by your theme.", "isOptional": true, "defaultValue": "'auto'" }, @@ -160841,7 +133026,7 @@ "syntaxKind": "PropertySignature", "name": "type", "value": "ParagraphType", - "description": "Provide semantic meaning and default styling to the paragraph.\n\nOther presentation properties on `s-paragraph` override the default styling.", + "description": "The semantic type and styling treatment for the paragraph content.\n\nOther presentation properties on `s-paragraph` override the default styling.", "isOptional": true, "defaultValue": "'paragraph'" } @@ -160853,7 +133038,7 @@ "src/surfaces/checkout/components/PasswordField.ts": { "filePath": "src/surfaces/checkout/components/PasswordField.ts", "name": "PasswordFieldElementProps", - "description": "Configure the following properties on the password field component.", + "description": "", "isPublicDocs": true, "members": [ { @@ -160861,7 +133046,7 @@ "syntaxKind": "PropertySignature", "name": "autocomplete", "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", "isOptional": true, "defaultValue": "'on' for everything else" }, @@ -160878,7 +133063,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -160929,7 +133114,7 @@ "syntaxKind": "PropertySignature", "name": "minLength", "value": "number", - "description": "Specifies the min number of characters allowed.", + "description": "Specifies the minimum number of characters allowed.", "isOptional": true, "defaultValue": "0" }, @@ -160991,11 +133176,7 @@ "syntaxKind": "PropertySignature", "name": "onChange", "value": "(event: Event) => void", -<<<<<<< HEAD - "description": "Callback when the user has **finished editing** a field, for example, once they have blurred the field.", -======= - "description": "A callback fired when the user has **finished editing** a field, such as when they blur the field or press Enter. Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", ->>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) + "description": "A callback fired when the user has **finished editing** a field, such as when they blur the field or press Enter.", "isOptional": true }, { @@ -161011,7 +133192,7 @@ "syntaxKind": "PropertySignature", "name": "onInput", "value": "(event: Event) => void", - "description": "A callback fired when the user makes any changes in the field, such as typing a character. Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).", + "description": "A callback fired when the user makes any changes in the field, such as typing a character.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).", "isOptional": true } ], @@ -161022,7 +133203,7 @@ "src/surfaces/checkout/components/PasswordField.ts": { "filePath": "src/surfaces/checkout/components/PasswordField.ts", "name": "PasswordFieldElementEvents", - "description": "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).", + "description": "", "isPublicDocs": true, "members": [ { @@ -161030,11 +133211,7 @@ "syntaxKind": "PropertySignature", "name": "blur", "value": "CallbackEventListener", -<<<<<<< HEAD - "description": "A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", -======= - "description": "A callback fired when the password field loses focus.\n\nLearn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", ->>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) + "description": "<<<<<<< HEAD A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n======= A callback fired when the password field loses focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) \n Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", "isOptional": true }, { @@ -161042,11 +133219,7 @@ "syntaxKind": "PropertySignature", "name": "change", "value": "CallbackEventListener", -<<<<<<< HEAD - "description": "Callback when the user has **finished editing** a field, for example, once they have blurred the field.", -======= - "description": "A callback fired when the password field value changes.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", ->>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) + "description": "<<<<<<< HEAD Callback when the user has **finished editing** a field, for example, once they have blurred the field.\n======= A callback fired when the password field value changes.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) \n Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", "isOptional": true }, { @@ -161054,11 +133227,7 @@ "syntaxKind": "PropertySignature", "name": "focus", "value": "CallbackEventListener", -<<<<<<< HEAD - "description": "A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", -======= - "description": "A callback fired when the password field receives focus.\n\nLearn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", ->>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) + "description": "<<<<<<< HEAD A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n======= A callback fired when the password field receives focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) \n Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", "isOptional": true }, { @@ -161070,18 +133239,14 @@ "isOptional": true } ], -<<<<<<< HEAD - "value": "export interface PasswordFieldElementEvents {\n /**\n * A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event\n */\n blur?: CallbackEventListener;\n /**\n * Callback when the user has **finished editing** a field, for example, once they have blurred the field.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event\n */\n change?: CallbackEventListener;\n /**\n * A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event\n */\n focus?: CallbackEventListener;\n /**\n * Callback when the user makes any changes in the field.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event\n */\n input?: CallbackEventListener;\n}" -======= - "value": "export interface PasswordFieldElementEvents {\n /**\n * A callback fired when the password field loses focus.\n *\n * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur?: CallbackEventListener;\n /**\n * A callback fired when the password field value changes.\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change?: CallbackEventListener;\n /**\n * A callback fired when the password field receives focus.\n *\n * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus?: CallbackEventListener;\n /**\n * A callback fired when the user inputs data into the password field.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input?: CallbackEventListener;\n}" ->>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) + "value": "export interface PasswordFieldElementEvents {\n /**\n<<<<<<< HEAD\n * A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n=======\n * A callback fired when the password field loses focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality)\n *\n * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur?: CallbackEventListener;\n /**\n<<<<<<< HEAD\n * Callback when the user has **finished editing** a field, for example, once they have blurred the field.\n=======\n * A callback fired when the password field value changes.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality)\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change?: CallbackEventListener;\n /**\n<<<<<<< HEAD\n * A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n=======\n * A callback fired when the password field receives focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality)\n *\n * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus?: CallbackEventListener;\n /**\n * A callback fired when the user inputs data into the password field.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input?: CallbackEventListener;\n}" } }, "PasswordFieldElementSlots": { "src/surfaces/checkout/components/PasswordField.ts": { "filePath": "src/surfaces/checkout/components/PasswordField.ts", "name": "PasswordFieldElementSlots", - "description": "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).", + "description": "", "isPublicDocs": true, "members": [ { @@ -161122,7 +133287,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/PasswordField.ts", @@ -161563,7 +133728,7 @@ "syntaxKind": "PropertySignature", "name": "autocomplete", "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", "isOptional": true, "defaultValue": "'on' for everything else" }, @@ -161769,7 +133934,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -162220,7 +134385,7 @@ "syntaxKind": "PropertySignature", "name": "minLength", "value": "number", - "description": "Specifies the min number of characters allowed.", + "description": "Specifies the minimum number of characters allowed.", "isOptional": true, "defaultValue": "0" }, @@ -162442,11 +134607,7 @@ "syntaxKind": "PropertySignature", "name": "onChange", "value": "(event: Event) => void", -<<<<<<< HEAD - "description": "Callback when the user has **finished editing** a field, for example, once they have blurred the field.", -======= - "description": "A callback fired when the user has **finished editing** a field, such as when they blur the field or press Enter. Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", ->>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) + "description": "A callback fired when the user has **finished editing** a field, such as when they blur the field or press Enter.", "isOptional": true }, { @@ -162644,7 +134805,7 @@ "syntaxKind": "PropertySignature", "name": "onInput", "value": "(event: Event) => void", - "description": "A callback fired when the user makes any changes in the field, such as typing a character. Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).", + "description": "A callback fired when the user makes any changes in the field, such as typing a character.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).", "isOptional": true }, { @@ -163239,7 +135400,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/PasswordField.ts", @@ -163520,7 +135681,7 @@ "syntaxKind": "PropertySignature", "name": "autocomplete", "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", "isOptional": true, "defaultValue": "'on' for everything else" }, @@ -163537,7 +135698,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -163588,7 +135749,7 @@ "syntaxKind": "PropertySignature", "name": "minLength", "value": "number", - "description": "Specifies the min number of characters allowed.", + "description": "Specifies the minimum number of characters allowed.", "isOptional": true, "defaultValue": "0" }, @@ -163613,11 +135774,7 @@ "syntaxKind": "PropertySignature", "name": "onChange", "value": "(event: Event) => void", -<<<<<<< HEAD - "description": "Callback when the user has **finished editing** a field, for example, once they have blurred the field.", -======= - "description": "A callback fired when the user has **finished editing** a field, such as when they blur the field or press Enter. Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", ->>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) + "description": "A callback fired when the user has **finished editing** a field, such as when they blur the field or press Enter.", "isOptional": true }, { @@ -163633,7 +135790,7 @@ "syntaxKind": "PropertySignature", "name": "onInput", "value": "(event: Event) => void", - "description": "A callback fired when the user makes any changes in the field, such as typing a character. Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).", + "description": "A callback fired when the user makes any changes in the field, such as typing a character.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).", "isOptional": true }, { @@ -163756,7 +135913,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", @@ -165765,7 +137922,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", @@ -166030,7 +138187,7 @@ "src/surfaces/checkout/components/PaymentIcon.ts": { "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", "name": "PaymentIconProps", - "description": "The properties for the payment icon component when it's used in JSX.", + "description": "", "isPublicDocs": true, "members": [ { @@ -166066,7 +138223,7 @@ "src/surfaces/checkout/components/PhoneField.ts": { "filePath": "src/surfaces/checkout/components/PhoneField.ts", "name": "PhoneFieldElementEvents", - "description": "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).", + "description": "", "isPublicDocs": true, "members": [ { @@ -166074,11 +138231,7 @@ "syntaxKind": "PropertySignature", "name": "blur", "value": "CallbackEventListener", -<<<<<<< HEAD - "description": "A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", -======= - "description": "A callback fired when the phone field loses focus.\n\nLearn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", ->>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) + "description": "<<<<<<< HEAD A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n======= A callback fired when the phone field loses focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) \n Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", "isOptional": true }, { @@ -166086,11 +138239,7 @@ "syntaxKind": "PropertySignature", "name": "change", "value": "CallbackEventListener", -<<<<<<< HEAD - "description": "Callback when the user has **finished editing** a field, for example, once they have blurred the field.", -======= - "description": "A callback fired when the phone field value changes.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", ->>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) + "description": "<<<<<<< HEAD Callback when the user has **finished editing** a field, for example, once they have blurred the field.\n======= A callback fired when the phone field value changes.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) \n Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", "isOptional": true }, { @@ -166098,11 +138247,7 @@ "syntaxKind": "PropertySignature", "name": "focus", "value": "CallbackEventListener", -<<<<<<< HEAD - "description": "A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", -======= - "description": "A callback fired when the phone field receives focus.\n\nLearn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", ->>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) + "description": "<<<<<<< HEAD A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n======= A callback fired when the phone field receives focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) \n Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", "isOptional": true }, { @@ -166114,18 +138259,14 @@ "isOptional": true } ], -<<<<<<< HEAD - "value": "export interface PhoneFieldElementEvents {\n /**\n * A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event\n */\n blur?: CallbackEventListener;\n /**\n * Callback when the user has **finished editing** a field, for example, once they have blurred the field.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event\n */\n change?: CallbackEventListener;\n /**\n * A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event\n */\n focus?: CallbackEventListener;\n /**\n * Callback when the user makes any changes in the field.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event\n */\n input?: CallbackEventListener;\n}" -======= - "value": "export interface PhoneFieldElementEvents {\n /**\n * A callback fired when the phone field loses focus.\n *\n * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur?: CallbackEventListener;\n /**\n * A callback fired when the phone field value changes.\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change?: CallbackEventListener;\n /**\n * A callback fired when the phone field receives focus.\n *\n * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus?: CallbackEventListener;\n /**\n * A callback fired when the user inputs data into the phone field.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input?: CallbackEventListener;\n}" ->>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) + "value": "export interface PhoneFieldElementEvents {\n /**\n<<<<<<< HEAD\n * A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n=======\n * A callback fired when the phone field loses focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality)\n *\n * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur?: CallbackEventListener;\n /**\n<<<<<<< HEAD\n * Callback when the user has **finished editing** a field, for example, once they have blurred the field.\n=======\n * A callback fired when the phone field value changes.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality)\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change?: CallbackEventListener;\n /**\n<<<<<<< HEAD\n * A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n=======\n * A callback fired when the phone field receives focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality)\n *\n * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus?: CallbackEventListener;\n /**\n * A callback fired when the user inputs data into the phone field.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input?: CallbackEventListener;\n}" } }, "PhoneFieldElementSlots": { "src/surfaces/checkout/components/PhoneField.ts": { "filePath": "src/surfaces/checkout/components/PhoneField.ts", "name": "PhoneFieldElementSlots", - "description": "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).", + "description": "", "isPublicDocs": true, "members": [ { @@ -166217,7 +138358,7 @@ "src/surfaces/checkout/components/Popover.ts": { "filePath": "src/surfaces/checkout/components/Popover.ts", "name": "PopoverEvents", - "description": "The event callbacks for monitoring popover visibility changes.", + "description": "", "isPublicDocs": true, "members": [ { @@ -166293,7 +138434,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/Popover.ts", @@ -168370,7 +140511,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/Popover.ts", @@ -168626,7 +140767,7 @@ "src/surfaces/checkout/components/Popover.ts": { "filePath": "src/surfaces/checkout/components/Popover.ts", "name": "PopoverProps", - "description": "The properties for the popover component when it's used in JSX.", + "description": "", "isPublicDocs": true, "members": [ { @@ -168715,7 +140856,7 @@ "src/surfaces/checkout/components/PressButton.ts": { "filePath": "src/surfaces/checkout/components/PressButton.ts", "name": "PressButtonElementProps", - "description": "Allows users to toggle between active/inactive states. Use to represent a persistent on/off or selected/unselected status.", + "description": "", "isPublicDocs": true, "members": [ { @@ -168830,7 +140971,7 @@ "src/surfaces/checkout/components/PressButton.ts": { "filePath": "src/surfaces/checkout/components/PressButton.ts", "name": "PressButtonElementEvents", - "description": "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).", + "description": "", "isPublicDocs": true, "members": [ { @@ -168895,7 +141036,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/PressButton.ts", @@ -170943,7 +143084,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/PressButton.ts", @@ -171386,7 +143527,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", @@ -173396,7 +145537,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", @@ -173693,7 +145834,7 @@ "src/surfaces/checkout/components/ProductThumbnail.ts": { "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", "name": "ProductThumbnailProps", - "description": "The properties for the product thumbnail component when it's used in JSX.", + "description": "", "isPublicDocs": true, "members": [ { @@ -173778,7 +145919,7 @@ "syntaxKind": "PropertySignature", "name": "max", "value": "number", - "description": "The total amount of work the task requires. Must be a value greater than 0 and a valid floating point number.\n\nLearn more about the [max attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/progress#max).", + "description": "The total amount of work the task requires. Must be a value greater than `0` and a valid floating point number.\n\nLearn more about the [max attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/progress#max).", "isOptional": true, "defaultValue": "1" }, @@ -173796,11 +145937,11 @@ "syntaxKind": "PropertySignature", "name": "value", "value": "number", - "description": "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.\n\nLearn more about the [value attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/progress#value).", + "description": "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.\n\nLearn more about the [value attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/progress#value).", "isOptional": true } ], - "value": "export interface ProgressElementProps extends Pick {\n /**\n * 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\".\n */\n accessibilityLabel?: ProgressProps$1['accessibilityLabel'];\n /**\n * The total amount of work the task requires. Must be a value greater than 0 and a valid floating point number.\n *\n * Learn more about the [max attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/progress#max).\n *\n * @default 1\n */\n max?: ProgressProps$1['max'];\n /**\n * The semantic meaning and color treatment of the progress indicator.\n *\n * - `auto`: Automatically determined based on context.\n * - `critical`: Indicates an urgent or error state requiring immediate attention.\n *\n * @default 'auto'\n */\n tone?: Extract;\n /**\n * 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.\n *\n * Learn more about the [value attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/progress#value).\n */\n value?: ProgressProps$1['value'];\n}" + "value": "export interface ProgressElementProps extends Pick {\n /**\n * 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\".\n */\n accessibilityLabel?: ProgressProps$1['accessibilityLabel'];\n /**\n * The total amount of work the task requires. Must be a value greater than `0` and a valid floating point number.\n *\n * Learn more about the [max attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/progress#max).\n *\n * @default 1\n */\n max?: ProgressProps$1['max'];\n /**\n * The semantic meaning and color treatment of the progress indicator.\n *\n * - `auto`: Automatically determined based on context.\n * - `critical`: Indicates an urgent or error state requiring immediate attention.\n *\n * @default 'auto'\n */\n tone?: Extract;\n /**\n * 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.\n *\n * Learn more about the [value attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/progress#value).\n */\n value?: ProgressProps$1['value'];\n}" } }, "ProgressElement": { @@ -173837,7 +145978,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/Progress.ts", @@ -174882,7 +147023,7 @@ "syntaxKind": "PropertySignature", "name": "max", "value": "number", - "description": "The total amount of work the task requires. Must be a value greater than 0 and a valid floating point number.\n\nLearn more about the [max attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/progress#max).", + "description": "The total amount of work the task requires. Must be a value greater than `0` and a valid floating point number.\n\nLearn more about the [max attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/progress#max).", "isOptional": true, "defaultValue": "1" }, @@ -175855,7 +147996,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/Progress.ts", @@ -176102,7 +148243,7 @@ "syntaxKind": "PropertySignature", "name": "value", "value": "number", - "description": "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.\n\nLearn more about the [value attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/progress#value).", + "description": "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.\n\nLearn more about the [value attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/progress#value).", "isOptional": true }, { @@ -176152,7 +148293,7 @@ "syntaxKind": "PropertySignature", "name": "max", "value": "number", - "description": "The total amount of work the task requires. Must be a value greater than 0 and a valid floating point number.\n\nLearn more about the [max attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/progress#max).", + "description": "The total amount of work the task requires. Must be a value greater than `0` and a valid floating point number.\n\nLearn more about the [max attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/progress#max).", "isOptional": true, "defaultValue": "1" }, @@ -176170,7 +148311,7 @@ "syntaxKind": "PropertySignature", "name": "value", "value": "number", - "description": "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.\n\nLearn more about the [value attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/progress#value).", + "description": "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.\n\nLearn more about the [value attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/progress#value).", "isOptional": true } ], @@ -176207,7 +148348,7 @@ "syntaxKind": "PropertySignature", "name": "content", "value": "string", - "description": "The content to be encoded in the QR code, such as a URL, email address, or plain text. When scanned, the user's device will process this content \u2014 typically by opening a URL in a browser or prompting an action based on the content type.", + "description": "The content to be encoded in the QR code, such as a URL, email address, or plain text. When scanned, the user's device will process this content — typically by opening a URL in a browser or prompting an action based on the content type.", "isOptional": true }, { @@ -176251,7 +148392,7 @@ "src/surfaces/checkout/components/QRCode.ts": { "filePath": "src/surfaces/checkout/components/QRCode.ts", "name": "QRCodeEvents", - "description": "The event handlers for the QR code component.", + "description": "", "isPublicDocs": true, "members": [ { @@ -176320,7 +148461,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/QRCode.ts", @@ -176931,7 +149072,7 @@ "syntaxKind": "PropertySignature", "name": "content", "value": "string", - "description": "The content to be encoded in the QR code, such as a URL, email address, or plain text. When scanned, the user's device will process this content \u2014 typically by opening a URL in a browser or prompting an action based on the content type.", + "description": "The content to be encoded in the QR code, such as a URL, email address, or plain text. When scanned, the user's device will process this content — typically by opening a URL in a browser or prompting an action based on the content type.", "isOptional": true }, { @@ -178362,7 +150503,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/QRCode.ts", @@ -178627,7 +150768,7 @@ "src/surfaces/checkout/components/QRCode.ts": { "filePath": "src/surfaces/checkout/components/QRCode.ts", "name": "QRCodeProps", - "description": "The properties for the QR code component when it's used in JSX.", + "description": "", "isPublicDocs": true, "members": [ { @@ -178653,7 +150794,7 @@ "syntaxKind": "PropertySignature", "name": "content", "value": "string", - "description": "The content to be encoded in the QR code, such as a URL, email address, or plain text. When scanned, the user's device will process this content \u2014 typically by opening a URL in a browser or prompting an action based on the content type.", + "description": "The content to be encoded in the QR code, such as a URL, email address, or plain text. When scanned, the user's device will process this content — typically by opening a URL in a browser or prompting an action based on the content type.", "isOptional": true }, { @@ -178705,7 +150846,7 @@ "syntaxKind": "PropertySignature", "name": "containerName", "value": "string", - "description": "A custom name for the container, used in [container queries](https://developer.mozilla.org/en-US/docs/Web/CSS/container-name) to target this container specifically. The value is added alongside the default name `s-default`.", + "description": "The name of the container, which can be used in your container queries to target this container specifically.\n\nWe place the container name of `s-default` on every container. Because of this, it is not required to add a `containerName` identifier in your queries. For example, a `@container (inline-size <= 300px) none, auto` query is equivalent to `@container s-default (inline-size <= 300px) none, auto`.\n\nAny value set in `containerName` will be set alongside alongside `s-default`. For example, `containerName=\"my-container-name\"` will result in a value of `s-default my-container-name` set on the `container-name` CSS property of the rendered HTML.", "isOptional": true, "defaultValue": "''" }, @@ -178747,7 +150888,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/QueryContainer.ts", @@ -179342,7 +151483,7 @@ "syntaxKind": "PropertySignature", "name": "containerName", "value": "string", - "description": "A custom name for the container, used in [container queries](https://developer.mozilla.org/en-US/docs/Web/CSS/container-name) to target this container specifically. The value is added alongside the default name `s-default`.", + "description": "The name of the container, which can be used in your container queries to target this container specifically.\n\nWe place the container name of `s-default` on every container. Because of this, it is not required to add a `containerName` identifier in your queries. For example, a `@container (inline-size <= 300px) none, auto` query is equivalent to `@container s-default (inline-size <= 300px) none, auto`.\n\nAny value set in `containerName` will be set alongside alongside `s-default`. For example, `containerName=\"my-container-name\"` will result in a value of `s-default my-container-name` set on the `container-name` CSS property of the rendered HTML.", "isOptional": true, "defaultValue": "''" }, @@ -180765,7 +152906,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/QueryContainer.ts", @@ -181029,7 +153170,7 @@ "syntaxKind": "PropertySignature", "name": "containerName", "value": "string", - "description": "A custom name for the container, used in [container queries](https://developer.mozilla.org/en-US/docs/Web/CSS/container-name) to target this container specifically. The value is added alongside the default name `s-default`.", + "description": "The name of the container, which can be used in your container queries to target this container specifically.\n\nWe place the container name of `s-default` on every container. Because of this, it is not required to add a `containerName` identifier in your queries. For example, a `@container (inline-size <= 300px) none, auto` query is equivalent to `@container s-default (inline-size <= 300px) none, auto`.\n\nAny value set in `containerName` will be set alongside alongside `s-default`. For example, `containerName=\"my-container-name\"` will result in a value of `s-default my-container-name` set on the `container-name` CSS property of the rendered HTML.", "isOptional": true, "defaultValue": "''" }, @@ -181057,7 +153198,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityLabel", "value": "string", - "description": "A label announced by assistive technologies that describes the purpose or contents of the element. Only set this when the element's visible content doesn't provide enough context on its own.", + "description": "A label that describes the purpose or contents of the element. When set, it will be announced to users using assistive technologies and will provide them with more context.\n\nOnly use this when the element's content is not enough context for users using assistive technologies.", "isOptional": true }, { @@ -181065,7 +153206,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityRole", "value": "AccessibilityRole", - "description": "The semantic meaning of the component's content. When set, assistive technologies use this role to help users navigate the page.", + "description": "Sets the semantic meaning of the component’s content. When set, the role will be used by assistive technologies to help users navigate the page.", "isOptional": true, "defaultValue": "'generic'" }, @@ -181074,7 +153215,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityVisibility", "value": "'visible' | 'hidden' | 'exclusive'", - "description": "Changes the visibility of the element.\n\n- `visible`: the element is visible to all users.\n- `hidden`: the element is removed from the accessibility tree but remains visible.\n- `exclusive`: the element is visually hidden but remains in the accessibility tree.", + "description": "Controls how the element is exposed to sighted users and to assistive technologies such as screen readers.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", "isOptional": true, "defaultValue": "'visible'" }, @@ -181083,11 +153224,7 @@ "syntaxKind": "PropertySignature", "name": "background", "value": "'base' | 'subdued' | 'transparent'", -<<<<<<< HEAD - "description": "Adjust the background of the element.\n\n- `'transparent'`: No visible background.\n- `'subdued'`: A subtle, low-emphasis background.\n- `'base'`: The standard background color.\n- `'strong'`: A high-emphasis background for prominence.", -======= "description": "The background color of the scroll box.\n\n- `base`: The standard background color for general content areas.\n- `subdued`: A muted background for secondary or supporting content.\n- `transparent`: No background color (the default).", ->>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) "isOptional": true, "defaultValue": "'transparent'" }, @@ -181162,7 +153299,7 @@ "syntaxKind": "PropertySignature", "name": "display", "value": "MaybeResponsive<\"auto\" | \"none\">", - "description": "Sets the outer display type of the component. The outer type sets a component\u2019s participation in [flow layout](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_flow_layout).\n\n- `auto`: the component\u2019s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.", + "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.\n\nLearn more about the [display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display).", "isOptional": true, "defaultValue": "'auto'" }, @@ -181224,7 +153361,7 @@ "syntaxKind": "PropertySignature", "name": "overflow", "value": "OverflowKeyword | `${OverflowKeyword} ${OverflowKeyword}`", - "description": "The overflow behavior of the scroll box, controlling whether content that exceeds the container is scrollable or clipped. Learn more about [`overflow`](https://developer.mozilla.org/en-US/docs/Web/CSS/overflow).\n\n- `hidden`: Content is clipped and the element is not scrollable in that axis.\n- `auto`: Content is clipped and becomes scrollable in that axis.\n\nSupports 1-to-2-value syntax using flow-relative axes. Two values are ordered as `block inline` (for example, `hidden auto` clips vertically and scrolls horizontally).", + "description": "Sets the overflow behavior of the element.\n\n- `hidden`: clips the content when it is larger than the element’s container and the element will not be scrollable in that axis.\n- `auto`: clips the content when it is larger than the element’s container and make it scrollable in that axis.\n\n1-to-2-value syntax is supported but note that, contrary to the CSS, it uses flow-relative values and the order is:\n\n- 2 values: `block inline`", "isOptional": true, "defaultValue": "'auto'" }, @@ -181307,7 +153444,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityLabel", "value": "string", - "description": "A label announced by assistive technologies that describes the purpose or contents of the element. Only set this when the element's visible content doesn't provide enough context on its own.", + "description": "A label that describes the purpose or contents of the element. When set, it will be announced to users using assistive technologies and will provide them with more context.\n\nOnly use this when the element's content is not enough context for users using assistive technologies.", "isOptional": true }, { @@ -181315,7 +153452,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityRole", "value": "AccessibilityRole", - "description": "The semantic meaning of the component's content. When set, assistive technologies use this role to help users navigate the page.", + "description": "Sets the semantic meaning of the component’s content. When set, the role will be used by assistive technologies to help users navigate the page.", "isOptional": true, "defaultValue": "'generic'" }, @@ -181324,7 +153461,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityVisibility", "value": "'visible' | 'hidden' | 'exclusive'", - "description": "Changes the visibility of the element.\n\n- `visible`: the element is visible to all users.\n- `hidden`: the element is removed from the accessibility tree but remains visible.\n- `exclusive`: the element is visually hidden but remains in the accessibility tree.", + "description": "Controls how the element is exposed to sighted users and to assistive technologies such as screen readers.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", "isOptional": true, "defaultValue": "'visible'" }, @@ -181333,11 +153470,7 @@ "syntaxKind": "PropertySignature", "name": "background", "value": "'base' | 'subdued' | 'transparent'", -<<<<<<< HEAD - "description": "Adjust the background of the element.\n\n- `'transparent'`: No visible background.\n- `'subdued'`: A subtle, low-emphasis background.\n- `'base'`: The standard background color.\n- `'strong'`: A high-emphasis background for prominence.", -======= "description": "The background color of the scroll box.\n\n- `base`: The standard background color for general content areas.\n- `subdued`: A muted background for secondary or supporting content.\n- `transparent`: No background color (the default).", ->>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) "isOptional": true, "defaultValue": "'transparent'" }, @@ -181400,7 +153533,7 @@ "syntaxKind": "PropertySignature", "name": "display", "value": "MaybeResponsive<\"auto\" | \"none\">", - "description": "Sets the outer display type of the component. The outer type sets a component\u2019s participation in [flow layout](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_flow_layout).\n\n- `auto`: the component\u2019s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.", + "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.\n\nLearn more about the [display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display).", "isOptional": true, "defaultValue": "'auto'" }, @@ -181462,7 +153595,7 @@ "syntaxKind": "PropertySignature", "name": "overflow", "value": "OverflowKeyword | `${OverflowKeyword} ${OverflowKeyword}`", - "description": "The overflow behavior of the scroll box, controlling whether content that exceeds the container is scrollable or clipped. Learn more about [`overflow`](https://developer.mozilla.org/en-US/docs/Web/CSS/overflow).\n\n- `hidden`: Content is clipped and the element is not scrollable in that axis.\n- `auto`: Content is clipped and becomes scrollable in that axis.\n\nSupports 1-to-2-value syntax using flow-relative axes. Two values are ordered as `block inline` (for example, `hidden auto` clips vertically and scrolls horizontally).", + "description": "Sets the overflow behavior of the element.\n\n- `hidden`: clips the content when it is larger than the element’s container and the element will not be scrollable in that axis.\n- `auto`: clips the content when it is larger than the element’s container and make it scrollable in that axis.\n\n1-to-2-value syntax is supported but note that, contrary to the CSS, it uses flow-relative values and the order is:\n\n- 2 values: `block inline`", "isOptional": true, "defaultValue": "'auto'" }, @@ -181555,7 +153688,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityLabel", "value": "string", - "description": "A label announced by assistive technologies that describes the purpose or contents of the element. Only set this when the element's visible content doesn't provide enough context on its own.", + "description": "A label that describes the purpose or contents of the element. When set, it will be announced to users using assistive technologies and will provide them with more context.\n\nOnly use this when the element's content is not enough context for users using assistive technologies.", "isOptional": true }, { @@ -181563,7 +153696,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityRole", "value": "AccessibilityRole", - "description": "The semantic meaning of the component's content. When set, assistive technologies use this role to help users navigate the page.", + "description": "Sets the semantic meaning of the component’s content. When set, the role will be used by assistive technologies to help users navigate the page.", "isOptional": true, "defaultValue": "'generic'" }, @@ -181572,7 +153705,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityVisibility", "value": "'visible' | 'hidden' | 'exclusive'", - "description": "Changes the visibility of the element.\n\n- `visible`: the element is visible to all users.\n- `hidden`: the element is removed from the accessibility tree but remains visible.\n- `exclusive`: the element is visually hidden but remains in the accessibility tree.", + "description": "Controls how the element is exposed to sighted users and to assistive technologies such as screen readers.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", "isOptional": true, "defaultValue": "'visible'" }, @@ -181595,7 +153728,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/ScrollBox.ts", @@ -182050,11 +154183,7 @@ "syntaxKind": "PropertySignature", "name": "background", "value": "'base' | 'subdued' | 'transparent'", -<<<<<<< HEAD - "description": "Adjust the background of the element.\n\n- `'transparent'`: No visible background.\n- `'subdued'`: A subtle, low-emphasis background.\n- `'base'`: The standard background color.\n- `'strong'`: A high-emphasis background for prominence.", -======= "description": "The background color of the scroll box.\n\n- `base`: The standard background color for general content areas.\n- `subdued`: A muted background for secondary or supporting content.\n- `transparent`: No background color (the default).", ->>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) "isOptional": true, "defaultValue": "'transparent'" }, @@ -182299,7 +154428,7 @@ "syntaxKind": "PropertySignature", "name": "display", "value": "MaybeResponsive<\"auto\" | \"none\">", - "description": "Sets the outer display type of the component. The outer type sets a component\u2019s participation in [flow layout](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_flow_layout).\n\n- `auto`: the component\u2019s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.", + "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.\n\nLearn more about the [display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display).", "isOptional": true, "defaultValue": "'auto'" }, @@ -183597,7 +155726,7 @@ "syntaxKind": "PropertySignature", "name": "overflow", "value": "OverflowKeyword | `${OverflowKeyword} ${OverflowKeyword}`", - "description": "The overflow behavior of the scroll box, controlling whether content that exceeds the container is scrollable or clipped. Learn more about [`overflow`](https://developer.mozilla.org/en-US/docs/Web/CSS/overflow).\n\n- `hidden`: Content is clipped and the element is not scrollable in that axis.\n- `auto`: Content is clipped and becomes scrollable in that axis.\n\nSupports 1-to-2-value syntax using flow-relative axes. Two values are ordered as `block inline` (for example, `hidden auto` clips vertically and scrolls horizontally).", + "description": "Sets the overflow behavior of the element.\n\n- `hidden`: clips the content when it is larger than the element’s container and the element will not be scrollable in that axis.\n- `auto`: clips the content when it is larger than the element’s container and make it scrollable in that axis.\n\n1-to-2-value syntax is supported but note that, contrary to the CSS, it uses flow-relative values and the order is:\n\n- 2 values: `block inline`", "isOptional": true, "defaultValue": "'auto'" }, @@ -183797,7 +155926,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/ScrollBox.ts", @@ -184061,11 +156190,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityLabel", "value": "string", -<<<<<<< HEAD "description": "A label used to describe the section that will be announced by assistive technologies.\n\nWhen no `heading` property is provided or included as a child of the section, you **must** provide an `accessibilityLabel` to describe the section. This is important as it allows assistive technologies to provide the right context to users.", -======= - "description": "A label announced by assistive technologies that describes the purpose of the section. When no `heading` property is provided, you **must** set `accessibilityLabel` so screen readers can identify the section.", ->>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) "isOptional": true }, { @@ -184073,11 +156198,7 @@ "syntaxKind": "PropertySignature", "name": "heading", "value": "string", -<<<<<<< HEAD "description": "A title displayed at the top of the section. When provided, it serves as both a visible heading and the accessible name for the section. If omitted, you must provide an `accessibilityLabel` instead.", -======= - "description": "The heading text displayed at the top of the section to summarize its content.", ->>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) "isOptional": true }, { @@ -184104,11 +156225,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityLabel", "value": "string", -<<<<<<< HEAD "description": "A label used to describe the section that will be announced by assistive technologies.\n\nWhen no `heading` property is provided or included as a child of the section, you **must** provide an `accessibilityLabel` to describe the section. This is important as it allows assistive technologies to provide the right context to users.", -======= - "description": "A label announced by assistive technologies that describes the purpose of the section. When no `heading` property is provided, you **must** set `accessibilityLabel` so screen readers can identify the section.", ->>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) "isOptional": true }, { @@ -184130,7 +156247,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/Section.ts", @@ -185013,11 +157130,7 @@ "syntaxKind": "PropertySignature", "name": "heading", "value": "string", -<<<<<<< HEAD "description": "A title displayed at the top of the section. When provided, it serves as both a visible heading and the accessible name for the section. If omitted, you must provide an `accessibilityLabel` instead.", -======= - "description": "The heading text displayed at the top of the section to summarize its content.", ->>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) "isOptional": true }, { @@ -186151,7 +158264,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/Section.ts", @@ -186415,11 +158528,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityLabel", "value": "string", -<<<<<<< HEAD "description": "A label used to describe the section that will be announced by assistive technologies.\n\nWhen no `heading` property is provided or included as a child of the section, you **must** provide an `accessibilityLabel` to describe the section. This is important as it allows assistive technologies to provide the right context to users.", -======= - "description": "A label announced by assistive technologies that describes the purpose of the section. When no `heading` property is provided, you **must** set `accessibilityLabel` so screen readers can identify the section.", ->>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) "isOptional": true }, { @@ -186427,11 +158536,7 @@ "syntaxKind": "PropertySignature", "name": "heading", "value": "string", -<<<<<<< HEAD "description": "A title displayed at the top of the section. When provided, it serves as both a visible heading and the accessible name for the section. If omitted, you must provide an `accessibilityLabel` instead.", -======= - "description": "The heading text displayed at the top of the section to summarize its content.", ->>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) "isOptional": true }, { @@ -186466,7 +158571,7 @@ "syntaxKind": "PropertySignature", "name": "defaultOpen", "value": "boolean", - "description": "Whether the sheet should be open when it first renders. Use sparingly \u2014 only when the user must interact with the sheet before proceeding (for example, a privacy consent prompt). Only takes effect on the initial render.", + "description": "Whether the sheet should be open when it first renders. Use sparingly — only when the user must interact with the sheet before proceeding (for example, a privacy consent prompt). Only takes effect on the initial render.", "isOptional": true, "defaultValue": "false" }, @@ -186494,7 +158599,7 @@ "src/surfaces/checkout/components/Sheet.ts": { "filePath": "src/surfaces/checkout/components/Sheet.ts", "name": "SheetEvents", - "description": "The event callbacks for monitoring sheet visibility changes.", + "description": "", "isPublicDocs": true, "members": [ { @@ -186655,7 +158760,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/Sheet.ts", @@ -187292,7 +159397,7 @@ "syntaxKind": "PropertySignature", "name": "defaultOpen", "value": "boolean", - "description": "Whether the sheet should be open when it first renders. Use sparingly \u2014 only when the user must interact with the sheet before proceeding (for example, a privacy consent prompt). Only takes effect on the initial render.", + "description": "Whether the sheet should be open when it first renders. Use sparingly — only when the user must interact with the sheet before proceeding (for example, a privacy consent prompt). Only takes effect on the initial render.", "isOptional": true, "defaultValue": "false" }, @@ -188730,7 +160835,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/Sheet.ts", @@ -188986,7 +161091,7 @@ "src/surfaces/checkout/components/Sheet.ts": { "filePath": "src/surfaces/checkout/components/Sheet.ts", "name": "SheetProps", - "description": "The properties for the sheet component when it's used in JSX.", + "description": "", "isPublicDocs": true, "members": [ { @@ -189002,7 +161107,7 @@ "syntaxKind": "PropertySignature", "name": "defaultOpen", "value": "boolean", - "description": "Whether the sheet should be open when it first renders. Use sparingly \u2014 only when the user must interact with the sheet before proceeding (for example, a privacy consent prompt). Only takes effect on the initial render.", + "description": "Whether the sheet should be open when it first renders. Use sparingly — only when the user must interact with the sheet before proceeding (for example, a privacy consent prompt). Only takes effect on the initial render.", "isOptional": true, "defaultValue": "false" }, @@ -189062,7 +161167,7 @@ "src/surfaces/checkout/components/SkeletonParagraph.ts": { "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", "name": "SkeletonParagraphElementProps", - "description": "Displays a placeholder representation of text content while it loads. Use to improve perceived performance by showing users where text will appear.", + "description": "", "isPublicDocs": true, "members": [ { @@ -189112,7 +161217,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", @@ -191130,7 +163235,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", @@ -191422,7 +163527,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityLabel", "value": "string", - "description": "A label announced by assistive technologies that describes the purpose or contents of the element. Only set this when the element's visible content doesn't provide enough context on its own.", + "description": "A label that describes the purpose or contents of the element. When set, it will be announced to users using assistive technologies and will provide them with more context.\n\nOnly use this when the element's content is not enough context for users using assistive technologies.", "isOptional": true }, { @@ -191457,11 +163562,7 @@ "syntaxKind": "PropertySignature", "name": "background", "value": "'base' | 'subdued' | 'transparent'", -<<<<<<< HEAD - "description": "Adjust the background of the element.\n\n- `'transparent'`: No visible background.\n- `'subdued'`: A subtle, low-emphasis background.\n- `'base'`: The standard background color.\n- `'strong'`: A high-emphasis background for prominence.", -======= "description": "The background color of the stack.\n\n- `base`: The standard background color for general content areas.\n- `subdued`: A muted background for secondary or supporting content.\n- `transparent`: No background color (the default).", ->>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) "isOptional": true, "defaultValue": "'transparent'" }, @@ -191527,7 +163628,7 @@ "syntaxKind": "PropertySignature", "name": "columnGap", "value": "MaybeResponsive", - "description": "The spacing between child elements along the inline axis (horizontal in horizontal writing modes). Overrides the inline-axis value set by `gap`.", + "description": "Adjust spacing between elements in the inline axis.\n\nThis overrides the column value of `gap`.", "isOptional": true, "defaultValue": "'' - meaning no override" }, @@ -191536,7 +163637,7 @@ "syntaxKind": "PropertySignature", "name": "direction", "value": "MaybeResponsive<\"block\" | \"inline\">", - "description": "The axis along which child elements are arranged, using [logical properties](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_logical_properties_and_values).\n\n- `block`: Children are stacked vertically (in horizontal writing modes). Content does not wrap.\n- `inline`: Children are arranged horizontally (in horizontal writing modes). Content wraps when it overflows.", + "description": "Sets how the children are placed within the Stack. This uses [logical properties](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_logical_properties_and_values).", "isOptional": true, "defaultValue": "'block'" }, @@ -191545,7 +163646,7 @@ "syntaxKind": "PropertySignature", "name": "display", "value": "MaybeResponsive<\"auto\" | \"none\">", - "description": "Sets the outer display type of the component. The outer type sets a component\u2019s participation in [flow layout](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_flow_layout).\n\n- `auto`: the component\u2019s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.", + "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.\n\nLearn more about the [display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display).", "isOptional": true, "defaultValue": "'auto'" }, @@ -191554,7 +163655,7 @@ "syntaxKind": "PropertySignature", "name": "gap", "value": "MaybeResponsive>", - "description": "The spacing between child elements. A single value applies to both the inline and block axes. A pair of space-separated values (for example, `large-100 large-500`) sets the inline and block axes independently.", + "description": "Adjust spacing between elements.\n\nA single value applies to both axes. A pair of values (eg `large-100 large-500`) can be used to set the inline and block axes respectively.", "isOptional": true, "defaultValue": "'none'" }, @@ -191625,7 +163726,7 @@ "syntaxKind": "PropertySignature", "name": "overflow", "value": "'hidden' | 'visible'", - "description": "The overflow behavior of the element.\n\n- `visible`: Content that extends beyond the container is visible.\n- `hidden`: Content that extends beyond the container is clipped and not scrollable.", + "description": "Sets the overflow behavior of the element.\n\n- `visible`: The content that extends beyond the element’s container is visible.\n- `hidden`: Clips the content when it is larger than the element’s container. The element will not be scrollable and users will not be able to access the clipped content by dragging or using a scroll wheel on a mouse.", "isOptional": true, "defaultValue": "'visible'" }, @@ -191697,7 +163798,7 @@ "syntaxKind": "PropertySignature", "name": "rowGap", "value": "MaybeResponsive", - "description": "The spacing between child elements along the block axis (vertical in horizontal writing modes). Overrides the block-axis value set by `gap`.", + "description": "Adjust spacing between elements in the block axis.\n\nThis overrides the row value of `gap`.", "isOptional": true, "defaultValue": "'' - meaning no override" } @@ -191717,7 +163818,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityLabel", "value": "string", - "description": "A label announced by assistive technologies that describes the purpose or contents of the element. Only set this when the element's visible content doesn't provide enough context on its own.", + "description": "A label that describes the purpose or contents of the element. When set, it will be announced to users using assistive technologies and will provide them with more context.\n\nOnly use this when the element's content is not enough context for users using assistive technologies.", "isOptional": true }, { @@ -191752,11 +163853,7 @@ "syntaxKind": "PropertySignature", "name": "background", "value": "'base' | 'subdued' | 'transparent'", -<<<<<<< HEAD - "description": "Adjust the background of the element.\n\n- `'transparent'`: No visible background.\n- `'subdued'`: A subtle, low-emphasis background.\n- `'base'`: The standard background color.\n- `'strong'`: A high-emphasis background for prominence.", -======= "description": "The background color of the stack.\n\n- `base`: The standard background color for general content areas.\n- `subdued`: A muted background for secondary or supporting content.\n- `transparent`: No background color (the default).", ->>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) "isOptional": true, "defaultValue": "'transparent'" }, @@ -191810,7 +163907,7 @@ "syntaxKind": "PropertySignature", "name": "columnGap", "value": "MaybeResponsive", - "description": "The spacing between child elements along the inline axis (horizontal in horizontal writing modes). Overrides the inline-axis value set by `gap`.", + "description": "Adjust spacing between elements in the inline axis.\n\nThis overrides the column value of `gap`.", "isOptional": true, "defaultValue": "'' - meaning no override" }, @@ -191819,7 +163916,7 @@ "syntaxKind": "PropertySignature", "name": "direction", "value": "MaybeResponsive<\"block\" | \"inline\">", - "description": "The axis along which child elements are arranged, using [logical properties](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_logical_properties_and_values).\n\n- `block`: Children are stacked vertically (in horizontal writing modes). Content does not wrap.\n- `inline`: Children are arranged horizontally (in horizontal writing modes). Content wraps when it overflows.", + "description": "Sets how the children are placed within the Stack. This uses [logical properties](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_logical_properties_and_values).", "isOptional": true, "defaultValue": "'block'" }, @@ -191828,7 +163925,7 @@ "syntaxKind": "PropertySignature", "name": "display", "value": "MaybeResponsive<\"auto\" | \"none\">", - "description": "Sets the outer display type of the component. The outer type sets a component\u2019s participation in [flow layout](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_flow_layout).\n\n- `auto`: the component\u2019s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.", + "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.\n\nLearn more about the [display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display).", "isOptional": true, "defaultValue": "'auto'" }, @@ -191837,7 +163934,7 @@ "syntaxKind": "PropertySignature", "name": "gap", "value": "MaybeResponsive>", - "description": "The spacing between child elements. A single value applies to both the inline and block axes. A pair of space-separated values (for example, `large-100 large-500`) sets the inline and block axes independently.", + "description": "Adjust spacing between elements.\n\nA single value applies to both axes. A pair of values (eg `large-100 large-500`) can be used to set the inline and block axes respectively.", "isOptional": true, "defaultValue": "'none'" }, @@ -191908,7 +164005,7 @@ "syntaxKind": "PropertySignature", "name": "overflow", "value": "'hidden' | 'visible'", - "description": "The overflow behavior of the element.\n\n- `visible`: Content that extends beyond the container is visible.\n- `hidden`: Content that extends beyond the container is clipped and not scrollable.", + "description": "Sets the overflow behavior of the element.\n\n- `visible`: The content that extends beyond the element’s container is visible.\n- `hidden`: Clips the content when it is larger than the element’s container. The element will not be scrollable and users will not be able to access the clipped content by dragging or using a scroll wheel on a mouse.", "isOptional": true, "defaultValue": "'visible'" }, @@ -191980,7 +164077,7 @@ "syntaxKind": "PropertySignature", "name": "rowGap", "value": "MaybeResponsive", - "description": "The spacing between child elements along the block axis (vertical in horizontal writing modes). Overrides the block-axis value set by `gap`.", + "description": "Adjust spacing between elements in the block axis.\n\nThis overrides the row value of `gap`.", "isOptional": true, "defaultValue": "'' - meaning no override" } @@ -192000,7 +164097,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityLabel", "value": "string", - "description": "A label announced by assistive technologies that describes the purpose or contents of the element. Only set this when the element's visible content doesn't provide enough context on its own.", + "description": "A label that describes the purpose or contents of the element. When set, it will be announced to users using assistive technologies and will provide them with more context.\n\nOnly use this when the element's content is not enough context for users using assistive technologies.", "isOptional": true }, { @@ -192031,7 +164128,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/Stack.ts", @@ -192504,11 +164601,7 @@ "syntaxKind": "PropertySignature", "name": "background", "value": "'base' | 'subdued' | 'transparent'", -<<<<<<< HEAD - "description": "Adjust the background of the element.\n\n- `'transparent'`: No visible background.\n- `'subdued'`: A subtle, low-emphasis background.\n- `'base'`: The standard background color.\n- `'strong'`: A high-emphasis background for prominence.", -======= "description": "The background color of the stack.\n\n- `base`: The standard background color for general content areas.\n- `subdued`: A muted background for secondary or supporting content.\n- `transparent`: No background color (the default).", ->>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) "isOptional": true, "defaultValue": "'transparent'" }, @@ -192681,7 +164774,7 @@ "syntaxKind": "PropertySignature", "name": "columnGap", "value": "MaybeResponsive", - "description": "The spacing between child elements along the inline axis (horizontal in horizontal writing modes). Overrides the inline-axis value set by `gap`.", + "description": "Adjust spacing between elements in the inline axis.\n\nThis overrides the column value of `gap`.", "isOptional": true, "defaultValue": "'' - meaning no override" }, @@ -192746,7 +164839,7 @@ "syntaxKind": "PropertySignature", "name": "direction", "value": "MaybeResponsive<\"block\" | \"inline\">", - "description": "The axis along which child elements are arranged, using [logical properties](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_logical_properties_and_values).\n\n- `block`: Children are stacked vertically (in horizontal writing modes). Content does not wrap.\n- `inline`: Children are arranged horizontally (in horizontal writing modes). Content wraps when it overflows.", + "description": "Sets how the children are placed within the Stack. This uses [logical properties](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_logical_properties_and_values).", "isOptional": true, "defaultValue": "'block'" }, @@ -192762,7 +164855,7 @@ "syntaxKind": "PropertySignature", "name": "display", "value": "MaybeResponsive<\"auto\" | \"none\">", - "description": "Sets the outer display type of the component. The outer type sets a component\u2019s participation in [flow layout](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_flow_layout).\n\n- `auto`: the component\u2019s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.", + "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.\n\nLearn more about the [display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display).", "isOptional": true, "defaultValue": "'auto'" }, @@ -192890,7 +164983,7 @@ "syntaxKind": "PropertySignature", "name": "gap", "value": "MaybeResponsive>", - "description": "The spacing between child elements. A single value applies to both the inline and block axes. A pair of space-separated values (for example, `large-100 large-500`) sets the inline and block axes independently.", + "description": "Adjust spacing between elements.\n\nA single value applies to both axes. A pair of values (eg `large-100 large-500`) can be used to set the inline and block axes respectively.", "isOptional": true, "defaultValue": "'none'" }, @@ -194078,7 +166171,7 @@ "syntaxKind": "PropertySignature", "name": "overflow", "value": "'hidden' | 'visible'", - "description": "The overflow behavior of the element.\n\n- `visible`: Content that extends beyond the container is visible.\n- `hidden`: Content that extends beyond the container is clipped and not scrollable.", + "description": "Sets the overflow behavior of the element.\n\n- `visible`: The content that extends beyond the element’s container is visible.\n- `hidden`: Clips the content when it is larger than the element’s container. The element will not be scrollable and users will not be able to access the clipped content by dragging or using a scroll wheel on a mouse.", "isOptional": true, "defaultValue": "'visible'" }, @@ -194278,7 +166371,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/Stack.ts", @@ -194327,7 +166420,7 @@ "syntaxKind": "PropertySignature", "name": "rowGap", "value": "MaybeResponsive", - "description": "The spacing between child elements along the block axis (vertical in horizontal writing modes). Overrides the block-axis value set by `gap`.", + "description": "Adjust spacing between elements in the block axis.\n\nThis overrides the row value of `gap`.", "isOptional": true, "defaultValue": "'' - meaning no override" }, @@ -194543,7 +166636,7 @@ "src/surfaces/checkout/components/Summary.ts": { "filePath": "src/surfaces/checkout/components/Summary.ts", "name": "SummaryElementProps", - "description": "Provides a clickable label for collapsible Details content. Use to create clear, accessible disclosure controls that show or hide additional information.", + "description": "", "isPublicDocs": true, "members": [ { @@ -194584,7 +166677,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/Summary.ts", @@ -196593,7 +168686,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/Summary.ts", @@ -196868,7 +168961,7 @@ "src/surfaces/checkout/components/Switch.ts": { "filePath": "src/surfaces/checkout/components/Switch.ts", "name": "SwitchElementProps", - "description": "Configure the following properties on the switch component.", + "description": "", "isPublicDocs": true, "members": [ { @@ -196884,7 +168977,7 @@ "syntaxKind": "PropertySignature", "name": "checked", "value": "boolean", - "description": "Whether the control is active.", + "description": "Whether the control is currently checked.", "isOptional": true, "defaultValue": "false" }, @@ -196893,7 +168986,7 @@ "syntaxKind": "PropertySignature", "name": "command", "value": "'--auto' | '--show' | '--hide' | '--toggle'", - "description": "Sets the action the `commandFor` should take when this clickable is activated.\n\nSee the documentation of particular components for the actions they support.\n\n- `--auto`: Performs the default action for the target component.\n- `--show`: Displays the target component.\n- `--hide`: Conceals the target component.\n- `--toggle`: Alternates the target component.\n- `--copy`: Copies the target ClipboardItem.", + "description": "Sets the action the `commandFor` target should take when this component is activated.\n\n- `--auto`: Performs the default action for the target component.\n- `--show`: Displays the target component.\n- `--hide`: Conceals the target component.\n- `--toggle`: Alternates the target component.\n- `--copy`: Copies the target ClipboardItem.\n\nLearn more about the [`command` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).", "isOptional": true, "defaultValue": "'--auto'" }, @@ -196902,7 +168995,7 @@ "syntaxKind": "PropertySignature", "name": "commandFor", "value": "string", - "description": "ID of a component that should respond to activations (such as clicks) on this component.\n\nSee `command` for how to control the behavior of the target.", + "description": "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).\n\nWhen both `commandFor` and `href` are set, `commandFor` takes precedence. The command runs and the link doesn't navigate.", "isOptional": true }, { @@ -196910,7 +169003,7 @@ "syntaxKind": "PropertySignature", "name": "defaultChecked", "value": "boolean", - "description": "Whether the control is active by default.", + "description": "Whether the control is checked by default.", "isOptional": true, "defaultValue": "false" }, @@ -196919,7 +169012,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the control, disallowing any interaction.", + "description": "Whether the control is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -196944,7 +169037,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the control that is unique within the nearest containing `Form` component.", + "description": "The name attribute for the control, used to identify its value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -196982,7 +169075,7 @@ "src/surfaces/checkout/components/Switch.ts": { "filePath": "src/surfaces/checkout/components/Switch.ts", "name": "SwitchElementEvents", - "description": "The switch component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", + "description": "", "isPublicDocs": true, "members": [ { @@ -197031,7 +169124,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/Switch.ts", @@ -197514,7 +169607,7 @@ "syntaxKind": "PropertySignature", "name": "checked", "value": "boolean", - "description": "Whether the control is active.", + "description": "Whether the control is currently checked.", "isOptional": true, "defaultValue": "false" }, @@ -197614,7 +169707,7 @@ "syntaxKind": "PropertySignature", "name": "command", "value": "'--auto' | '--show' | '--hide' | '--toggle'", - "description": "Sets the action the `commandFor` should take when this clickable is activated.\n\nSee the documentation of particular components for the actions they support.\n\n- `--auto`: Performs the default action for the target component.\n- `--show`: Displays the target component.\n- `--hide`: Conceals the target component.\n- `--toggle`: Alternates the target component.\n- `--copy`: Copies the target ClipboardItem.", + "description": "Sets the action the `commandFor` target should take when this component is activated.\n\n- `--auto`: Performs the default action for the target component.\n- `--show`: Displays the target component.\n- `--hide`: Conceals the target component.\n- `--toggle`: Alternates the target component.\n- `--copy`: Copies the target ClipboardItem.\n\nLearn more about the [`command` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).", "isOptional": true, "defaultValue": "'--auto'" }, @@ -197623,7 +169716,7 @@ "syntaxKind": "PropertySignature", "name": "commandFor", "value": "string", - "description": "ID of a component that should respond to activations (such as clicks) on this component.\n\nSee `command` for how to control the behavior of the target.", + "description": "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).\n\nWhen both `commandFor` and `href` are set, `commandFor` takes precedence. The command runs and the link doesn't navigate.", "isOptional": true }, { @@ -197680,7 +169773,7 @@ "syntaxKind": "PropertySignature", "name": "defaultChecked", "value": "boolean", - "description": "Whether the control is active by default.", + "description": "Whether the control is checked by default.", "isOptional": true, "defaultValue": "false" }, @@ -197696,7 +169789,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the control, disallowing any interaction.", + "description": "Whether the control is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -198128,7 +170221,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the control that is unique within the nearest containing `Form` component.", + "description": "The name attribute for the control, used to identify its value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -199100,7 +171193,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/Switch.ts", @@ -199380,7 +171473,7 @@ "syntaxKind": "PropertySignature", "name": "checked", "value": "boolean", - "description": "Whether the control is active.", + "description": "Whether the control is currently checked.", "isOptional": true, "defaultValue": "false" }, @@ -199389,7 +171482,7 @@ "syntaxKind": "PropertySignature", "name": "command", "value": "'--auto' | '--show' | '--hide' | '--toggle'", - "description": "Sets the action the `commandFor` should take when this clickable is activated.\n\nSee the documentation of particular components for the actions they support.\n\n- `--auto`: Performs the default action for the target component.\n- `--show`: Displays the target component.\n- `--hide`: Conceals the target component.\n- `--toggle`: Alternates the target component.\n- `--copy`: Copies the target ClipboardItem.", + "description": "Sets the action the `commandFor` target should take when this component is activated.\n\n- `--auto`: Performs the default action for the target component.\n- `--show`: Displays the target component.\n- `--hide`: Conceals the target component.\n- `--toggle`: Alternates the target component.\n- `--copy`: Copies the target ClipboardItem.\n\nLearn more about the [`command` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).", "isOptional": true, "defaultValue": "'--auto'" }, @@ -199398,7 +171491,7 @@ "syntaxKind": "PropertySignature", "name": "commandFor", "value": "string", - "description": "ID of a component that should respond to activations (such as clicks) on this component.\n\nSee `command` for how to control the behavior of the target.", + "description": "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).\n\nWhen both `commandFor` and `href` are set, `commandFor` takes precedence. The command runs and the link doesn't navigate.", "isOptional": true }, { @@ -199406,7 +171499,7 @@ "syntaxKind": "PropertySignature", "name": "defaultChecked", "value": "boolean", - "description": "Whether the control is active by default.", + "description": "Whether the control is checked by default.", "isOptional": true, "defaultValue": "false" }, @@ -199415,7 +171508,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the control, disallowing any interaction.", + "description": "Whether the control is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -199440,7 +171533,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the control that is unique within the nearest containing `Form` component.", + "description": "The name attribute for the control, used to identify its value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -199467,7 +171560,7 @@ "src/surfaces/checkout/components/Text.ts": { "filePath": "src/surfaces/checkout/components/Text.ts", "name": "TextElementProps", - "description": "The text component displays inline text with specific visual styles or tones. Use text to emphasize or differentiate words or phrases within paragraphs or other block-level components, applying weight, color, or semantic styling.\n\nText supports multiple visual variants, alignment options, and line clamping for flexible inline typography control. For block-level text content, use [paragraph](/docs/api/{API_NAME}/{API_VERSION}/polaris-web-components/typography-and-content/paragraph).", + "description": "", "isPublicDocs": true, "members": [ { @@ -199475,7 +171568,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityVisibility", "value": "'visible' | 'hidden' | 'exclusive'", - "description": "Changes the visibility of the element.\n\n- `visible`: the element is visible to all users.\n- `hidden`: the element is removed from the accessibility tree but remains visible.\n- `exclusive`: the element is visually hidden but remains in the accessibility tree.", + "description": "Controls how the element is exposed to sighted users and to assistive technologies such as screen readers.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", "isOptional": true, "defaultValue": "'visible'" }, @@ -199484,7 +171577,7 @@ "syntaxKind": "PropertySignature", "name": "color", "value": "'base' | 'subdued'", - "description": "Modify the color to be more or less intense.", + "description": "The color emphasis level that controls visual intensity.\n\n- `subdued`: Deemphasized color for secondary text, supporting labels, and less critical interface elements.\n- `base`: Primary color for body text, standard UI elements, and general content with good readability.\n- `strong`: Emphasized color for headings, key labels, and interactive elements that need prominence.", "isOptional": true, "defaultValue": "'base'" }, @@ -199493,11 +171586,7 @@ "syntaxKind": "PropertySignature", "name": "dir", "value": "'ltr' | 'rtl' | 'auto' | ''", -<<<<<<< HEAD - "description": "Indicates the directionality of the element’s text.\n\n- `ltr`: languages written from left to right (such as English)\n- `rtl`: languages written from right to left (such as Arabic)\n- `auto`: the user agent determines the direction based on the content\n- `''`: direction is inherited from parent elements (equivalent to not setting the attribute)", -======= - "description": "Indicates the directionality of the element\u2019s text.\n\n- `ltr`: languages written from left to right (e.g. English)\n- `rtl`: languages written from right to left (e.g. Arabic)\n- `auto`: the user agent determines the direction based on the content\n- `''`: direction is inherited from parent elements (equivalent to not setting the attribute)", ->>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) + "description": "Indicates the directionality of the element’s text.\n\n- `ltr`: The languages written from left to right (such as English).\n- `rtl`: The languages written from right to left (such as Arabic).\n- `auto`: The user agent determines the direction based on the content.\n- `\"\"`: The direction is inherited from parent elements (equivalent to not setting the attribute).\n\nLearn more about the [dir attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/dir).", "isOptional": true, "defaultValue": "''" }, @@ -199506,7 +171595,7 @@ "syntaxKind": "PropertySignature", "name": "display", "value": "MaybeResponsive<\"auto\" | \"none\">", - "description": "Sets the outer display type of the component. The outer type sets a component\u2019s participation in [flow layout](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_flow_layout).\n\n- `auto`: the component\u2019s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.", + "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.\n\nLearn more about the [display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display).", "isOptional": true, "defaultValue": "'auto'" }, @@ -199523,11 +171612,7 @@ "syntaxKind": "PropertySignature", "name": "lang", "value": "string", -<<<<<<< HEAD - "description": "The language of the button's text content. Use this when the button text is in a different language than the rest of the page, so assistive technologies can invoke the correct pronunciation. [Reference of values](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry) (`Subtag` label)\n\nIt is recommended to combine it with the `dir` attribute to ensure the text is rendered correctly if the surrounding content’s direction is different.", -======= - "description": "Indicate the text language. Useful when the text is in a different language than the rest of the page. It will allow assistive technologies such as screen readers to invoke the correct pronunciation. [Reference of values](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry) (\"subtag\" label)\n\nIt is recommended to combine it with the `dir` attribute to ensure the text is rendered correctly if the surrounding content\u2019s direction is different.", ->>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) + "description": "Indicate the text language. Useful when the text is in a different language than the rest of the page. It will allow assistive technologies such as screen readers to invoke the correct pronunciation. [Reference of values](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry) (\"subtag\" label)\n\nIt is recommended to combine it with the `dir` attribute to ensure the text is rendered correctly if the surrounding content’s direction is different.", "isOptional": true, "defaultValue": "''" }, @@ -199536,7 +171621,7 @@ "syntaxKind": "PropertySignature", "name": "tone", "value": "'info' | 'auto' | 'neutral' | 'success' | 'warning' | 'critical' | 'custom'", - "description": "Sets the tone of the component, based on the intention of the information being conveyed.", + "description": "The semantic meaning and color treatment of the component.\n\n- `auto`: Automatically determined based on context.\n- `neutral`: General information without specific intent.\n- `info`: Informational content or helpful tips.\n- `success`: Positive outcomes or successful states.\n- `warning`: Important warnings about potential issues.\n- `critical`: Urgent problems or destructive actions.\n- `custom`: Custom styling controlled by your theme.", "isOptional": true, "defaultValue": "'auto'" }, @@ -199545,12 +171630,12 @@ "syntaxKind": "PropertySignature", "name": "type", "value": "'address' | 'mark' | 'small' | 'strong' | 'generic' | 'redundant' | 'emphasis' | 'offset'", - "description": "Provide semantic meaning and default styling to the text.\n\nOther presentation properties on Text override the default styling.", + "description": "The semantic type and styling treatment for the text content.\n\nOther presentation properties on `s-text` override the default styling.\n\n- `address`: A semantic type that indicates the text is contact information. Typically used for addresses.\n- `redundant`: A semantic type that indicates the text is no longer accurate or no longer relevant.\n- `mark`: A semantic type that indicates the text is marked or highlighted.\n- `emphasis`: A semantic type that indicates emphatic stress.\n- `offset`: A semantic type that indicates an offset from the normal prose.\n- `strong`: A semantic type that indicates strong importance, seriousness, or urgency.\n- `small`: A semantic type that indicates less important text.\n- `generic`: No additional semantics or styling is applied.", "isOptional": true, "defaultValue": "'generic'" } ], - "value": "export interface TextElementProps extends Pick {\n color?: Extract;\n tone?: Extract;\n type?: Extract;\n}" + "value": "export interface TextElementProps extends Pick {\n color?: Extract;\n tone?: Extract;\n /**\n * The semantic type and styling treatment for the text content.\n *\n * Other presentation properties on `s-text` override the default styling.\n *\n * - `address`: A semantic type that indicates the text is contact information. Typically used for addresses.\n * - `redundant`: A semantic type that indicates the text is no longer accurate or no longer relevant.\n * - `mark`: A semantic type that indicates the text is marked or highlighted.\n * - `emphasis`: A semantic type that indicates emphatic stress.\n * - `offset`: A semantic type that indicates an offset from the normal prose.\n * - `strong`: A semantic type that indicates strong importance, seriousness, or urgency.\n * - `small`: A semantic type that indicates less important text.\n * - `generic`: No additional semantics or styling is applied.\n *\n * @default 'generic'\n */\n type?: Extract;\n}" } }, "TextElement": { @@ -199565,7 +171650,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityVisibility", "value": "'visible' | 'hidden' | 'exclusive'", - "description": "Changes the visibility of the element.\n\n- `visible`: the element is visible to all users.\n- `hidden`: the element is removed from the accessibility tree but remains visible.\n- `exclusive`: the element is visually hidden but remains in the accessibility tree.", + "description": "Controls how the element is exposed to sighted users and to assistive technologies such as screen readers.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", "isOptional": true, "defaultValue": "'visible'" }, @@ -199588,7 +171673,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/Text.ts", @@ -200162,7 +172247,7 @@ "syntaxKind": "PropertySignature", "name": "color", "value": "'base' | 'subdued'", - "description": "Modify the color to be more or less intense.", + "description": "The color emphasis level that controls visual intensity.\n\n- `subdued`: Deemphasized color for secondary text, supporting labels, and less critical interface elements.\n- `base`: Primary color for body text, standard UI elements, and general content with good readability.\n- `strong`: Emphasized color for headings, key labels, and interactive elements that need prominence.", "isOptional": true, "defaultValue": "'base'" }, @@ -200220,11 +172305,7 @@ "syntaxKind": "PropertySignature", "name": "dir", "value": "'ltr' | 'rtl' | 'auto' | ''", -<<<<<<< HEAD - "description": "Indicates the directionality of the element’s text.\n\n- `ltr`: languages written from left to right (such as English)\n- `rtl`: languages written from right to left (such as Arabic)\n- `auto`: the user agent determines the direction based on the content\n- `''`: direction is inherited from parent elements (equivalent to not setting the attribute)", -======= - "description": "Indicates the directionality of the element\u2019s text.\n\n- `ltr`: languages written from left to right (e.g. English)\n- `rtl`: languages written from right to left (e.g. Arabic)\n- `auto`: the user agent determines the direction based on the content\n- `''`: direction is inherited from parent elements (equivalent to not setting the attribute)", ->>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) + "description": "Indicates the directionality of the element’s text.\n\n- `ltr`: The languages written from left to right (such as English).\n- `rtl`: The languages written from right to left (such as Arabic).\n- `auto`: The user agent determines the direction based on the content.\n- `\"\"`: The direction is inherited from parent elements (equivalent to not setting the attribute).\n\nLearn more about the [dir attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/dir).", "isOptional": true, "defaultValue": "''" }, @@ -200240,7 +172321,7 @@ "syntaxKind": "PropertySignature", "name": "display", "value": "MaybeResponsive<\"auto\" | \"none\">", - "description": "Sets the outer display type of the component. The outer type sets a component\u2019s participation in [flow layout](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_flow_layout).\n\n- `auto`: the component\u2019s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.", + "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.\n\nLearn more about the [display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display).", "isOptional": true, "defaultValue": "'auto'" }, @@ -200608,11 +172689,7 @@ "syntaxKind": "PropertySignature", "name": "lang", "value": "string", -<<<<<<< HEAD - "description": "The language of the button's text content. Use this when the button text is in a different language than the rest of the page, so assistive technologies can invoke the correct pronunciation. [Reference of values](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry) (`Subtag` label)\n\nIt is recommended to combine it with the `dir` attribute to ensure the text is rendered correctly if the surrounding content’s direction is different.", -======= - "description": "Indicate the text language. Useful when the text is in a different language than the rest of the page. It will allow assistive technologies such as screen readers to invoke the correct pronunciation. [Reference of values](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry) (\"subtag\" label)\n\nIt is recommended to combine it with the `dir` attribute to ensure the text is rendered correctly if the surrounding content\u2019s direction is different.", ->>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) + "description": "Indicate the text language. Useful when the text is in a different language than the rest of the page. It will allow assistive technologies such as screen readers to invoke the correct pronunciation. [Reference of values](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry) (\"subtag\" label)\n\nIt is recommended to combine it with the `dir` attribute to ensure the text is rendered correctly if the surrounding content’s direction is different.", "isOptional": true, "defaultValue": "''" }, @@ -201627,7 +173704,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/Text.ts", @@ -201858,7 +173935,7 @@ "syntaxKind": "PropertySignature", "name": "tone", "value": "'info' | 'auto' | 'neutral' | 'success' | 'warning' | 'critical' | 'custom'", - "description": "Sets the tone of the component, based on the intention of the information being conveyed.", + "description": "The semantic meaning and color treatment of the component.\n\n- `auto`: Automatically determined based on context.\n- `neutral`: General information without specific intent.\n- `info`: Informational content or helpful tips.\n- `success`: Positive outcomes or successful states.\n- `warning`: Important warnings about potential issues.\n- `critical`: Urgent problems or destructive actions.\n- `custom`: Custom styling controlled by your theme.", "isOptional": true, "defaultValue": "'auto'" }, @@ -201874,7 +173951,7 @@ "syntaxKind": "PropertySignature", "name": "type", "value": "'address' | 'mark' | 'small' | 'strong' | 'generic' | 'redundant' | 'emphasis' | 'offset'", - "description": "Provide semantic meaning and default styling to the text.\n\nOther presentation properties on Text override the default styling.", + "description": "The semantic type and styling treatment for the text content.\n\nOther presentation properties on `s-text` override the default styling.\n\n- `address`: A semantic type that indicates the text is contact information. Typically used for addresses.\n- `redundant`: A semantic type that indicates the text is no longer accurate or no longer relevant.\n- `mark`: A semantic type that indicates the text is marked or highlighted.\n- `emphasis`: A semantic type that indicates emphatic stress.\n- `offset`: A semantic type that indicates an offset from the normal prose.\n- `strong`: A semantic type that indicates strong importance, seriousness, or urgency.\n- `small`: A semantic type that indicates less important text.\n- `generic`: No additional semantics or styling is applied.", "isOptional": true, "defaultValue": "'generic'" }, @@ -201909,7 +173986,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityVisibility", "value": "'visible' | 'hidden' | 'exclusive'", - "description": "Changes the visibility of the element.\n\n- `visible`: the element is visible to all users.\n- `hidden`: the element is removed from the accessibility tree but remains visible.\n- `exclusive`: the element is visually hidden but remains in the accessibility tree.", + "description": "Controls how the element is exposed to sighted users and to assistive technologies such as screen readers.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", "isOptional": true, "defaultValue": "'visible'" }, @@ -201918,7 +173995,7 @@ "syntaxKind": "PropertySignature", "name": "color", "value": "'base' | 'subdued'", - "description": "Modify the color to be more or less intense.", + "description": "The color emphasis level that controls visual intensity.\n\n- `subdued`: Deemphasized color for secondary text, supporting labels, and less critical interface elements.\n- `base`: Primary color for body text, standard UI elements, and general content with good readability.\n- `strong`: Emphasized color for headings, key labels, and interactive elements that need prominence.", "isOptional": true, "defaultValue": "'base'" }, @@ -201927,11 +174004,7 @@ "syntaxKind": "PropertySignature", "name": "dir", "value": "'ltr' | 'rtl' | 'auto' | ''", -<<<<<<< HEAD - "description": "Indicates the directionality of the element’s text.\n\n- `ltr`: languages written from left to right (such as English)\n- `rtl`: languages written from right to left (such as Arabic)\n- `auto`: the user agent determines the direction based on the content\n- `''`: direction is inherited from parent elements (equivalent to not setting the attribute)", -======= - "description": "Indicates the directionality of the element\u2019s text.\n\n- `ltr`: languages written from left to right (e.g. English)\n- `rtl`: languages written from right to left (e.g. Arabic)\n- `auto`: the user agent determines the direction based on the content\n- `''`: direction is inherited from parent elements (equivalent to not setting the attribute)", ->>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) + "description": "Indicates the directionality of the element’s text.\n\n- `ltr`: The languages written from left to right (such as English).\n- `rtl`: The languages written from right to left (such as Arabic).\n- `auto`: The user agent determines the direction based on the content.\n- `\"\"`: The direction is inherited from parent elements (equivalent to not setting the attribute).\n\nLearn more about the [dir attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/dir).", "isOptional": true, "defaultValue": "''" }, @@ -201940,7 +174013,7 @@ "syntaxKind": "PropertySignature", "name": "display", "value": "MaybeResponsive<\"auto\" | \"none\">", - "description": "Sets the outer display type of the component. The outer type sets a component\u2019s participation in [flow layout](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_flow_layout).\n\n- `auto`: the component\u2019s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.", + "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.\n\nLearn more about the [display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display).", "isOptional": true, "defaultValue": "'auto'" }, @@ -201957,11 +174030,7 @@ "syntaxKind": "PropertySignature", "name": "lang", "value": "string", -<<<<<<< HEAD - "description": "The language of the button's text content. Use this when the button text is in a different language than the rest of the page, so assistive technologies can invoke the correct pronunciation. [Reference of values](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry) (`Subtag` label)\n\nIt is recommended to combine it with the `dir` attribute to ensure the text is rendered correctly if the surrounding content’s direction is different.", -======= - "description": "Indicate the text language. Useful when the text is in a different language than the rest of the page. It will allow assistive technologies such as screen readers to invoke the correct pronunciation. [Reference of values](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry) (\"subtag\" label)\n\nIt is recommended to combine it with the `dir` attribute to ensure the text is rendered correctly if the surrounding content\u2019s direction is different.", ->>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) + "description": "Indicate the text language. Useful when the text is in a different language than the rest of the page. It will allow assistive technologies such as screen readers to invoke the correct pronunciation. [Reference of values](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry) (\"subtag\" label)\n\nIt is recommended to combine it with the `dir` attribute to ensure the text is rendered correctly if the surrounding content’s direction is different.", "isOptional": true, "defaultValue": "''" }, @@ -201970,7 +174039,7 @@ "syntaxKind": "PropertySignature", "name": "tone", "value": "'info' | 'auto' | 'neutral' | 'success' | 'warning' | 'critical' | 'custom'", - "description": "Sets the tone of the component, based on the intention of the information being conveyed.", + "description": "The semantic meaning and color treatment of the component.\n\n- `auto`: Automatically determined based on context.\n- `neutral`: General information without specific intent.\n- `info`: Informational content or helpful tips.\n- `success`: Positive outcomes or successful states.\n- `warning`: Important warnings about potential issues.\n- `critical`: Urgent problems or destructive actions.\n- `custom`: Custom styling controlled by your theme.", "isOptional": true, "defaultValue": "'auto'" }, @@ -201979,7 +174048,7 @@ "syntaxKind": "PropertySignature", "name": "type", "value": "'address' | 'mark' | 'small' | 'strong' | 'generic' | 'redundant' | 'emphasis' | 'offset'", - "description": "Provide semantic meaning and default styling to the text.\n\nOther presentation properties on Text override the default styling.", + "description": "The semantic type and styling treatment for the text content.\n\nOther presentation properties on `s-text` override the default styling.\n\n- `address`: A semantic type that indicates the text is contact information. Typically used for addresses.\n- `redundant`: A semantic type that indicates the text is no longer accurate or no longer relevant.\n- `mark`: A semantic type that indicates the text is marked or highlighted.\n- `emphasis`: A semantic type that indicates emphatic stress.\n- `offset`: A semantic type that indicates an offset from the normal prose.\n- `strong`: A semantic type that indicates strong importance, seriousness, or urgency.\n- `small`: A semantic type that indicates less important text.\n- `generic`: No additional semantics or styling is applied.", "isOptional": true, "defaultValue": "'generic'" } @@ -201991,7 +174060,7 @@ "src/surfaces/checkout/components/TextArea.ts": { "filePath": "src/surfaces/checkout/components/TextArea.ts", "name": "TextAreaElementProps", - "description": "Configure the following properties on the text area component.", + "description": "", "isPublicDocs": true, "members": [ { @@ -201999,7 +174068,7 @@ "syntaxKind": "PropertySignature", "name": "autocomplete", "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", "isOptional": true, "defaultValue": "'on' for everything else" }, @@ -202016,7 +174085,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -202067,7 +174136,7 @@ "syntaxKind": "PropertySignature", "name": "minLength", "value": "number", - "description": "Specifies the min number of characters allowed.", + "description": "Specifies the minimum number of characters allowed.", "isOptional": true, "defaultValue": "0" }, @@ -202148,11 +174217,7 @@ "syntaxKind": "PropertySignature", "name": "onChange", "value": "(event: Event) => void", -<<<<<<< HEAD - "description": "Callback when the user has **finished editing** a field, for example, once they have blurred the field.", -======= - "description": "A callback fired when the user has **finished editing** a field, such as when they blur the field or press Enter. Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", ->>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) + "description": "A callback fired when the user has **finished editing** a field, such as when they blur the field or press Enter.", "isOptional": true }, { @@ -202168,7 +174233,7 @@ "syntaxKind": "PropertySignature", "name": "onInput", "value": "(event: Event) => void", - "description": "A callback fired when the user makes any changes in the field, such as typing a character. Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).", + "description": "A callback fired when the user makes any changes in the field, such as typing a character.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).", "isOptional": true } ], @@ -202179,7 +174244,7 @@ "src/surfaces/checkout/components/TextArea.ts": { "filePath": "src/surfaces/checkout/components/TextArea.ts", "name": "TextAreaElementEvents", - "description": "The text area component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", + "description": "", "isPublicDocs": true, "members": [ { @@ -202187,11 +174252,7 @@ "syntaxKind": "PropertySignature", "name": "blur", "value": "CallbackEventListener", -<<<<<<< HEAD - "description": "A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", -======= - "description": "A callback fired when the text area loses focus.\n\nLearn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", ->>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) + "description": "<<<<<<< HEAD A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n======= A callback fired when the text area loses focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) \n Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", "isOptional": true }, { @@ -202199,11 +174260,7 @@ "syntaxKind": "PropertySignature", "name": "change", "value": "CallbackEventListener", -<<<<<<< HEAD - "description": "Callback when the user has **finished editing** a field, for example, once they have blurred the field.", -======= - "description": "A callback fired when the text area value changes.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", ->>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) + "description": "<<<<<<< HEAD Callback when the user has **finished editing** a field, for example, once they have blurred the field.\n======= A callback fired when the text area value changes.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) \n Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", "isOptional": true }, { @@ -202211,11 +174268,7 @@ "syntaxKind": "PropertySignature", "name": "focus", "value": "CallbackEventListener", -<<<<<<< HEAD - "description": "A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", -======= - "description": "A callback fired when the text area receives focus.\n\nLearn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", ->>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) + "description": "<<<<<<< HEAD A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n======= A callback fired when the text area receives focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) \n Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", "isOptional": true }, { @@ -202227,11 +174280,7 @@ "isOptional": true } ], -<<<<<<< HEAD - "value": "export interface TextAreaElementEvents {\n /**\n * A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event\n */\n blur?: CallbackEventListener;\n /**\n * Callback when the user has **finished editing** a field, for example, once they have blurred the field.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event\n */\n change?: CallbackEventListener;\n /**\n * A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event\n */\n focus?: CallbackEventListener;\n /**\n * Callback when the user makes any changes in the field.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event\n */\n input?: CallbackEventListener;\n}" -======= - "value": "export interface TextAreaElementEvents {\n /**\n * A callback fired when the text area loses focus.\n *\n * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur?: CallbackEventListener;\n /**\n * A callback fired when the text area value changes.\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change?: CallbackEventListener;\n /**\n * A callback fired when the text area receives focus.\n *\n * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus?: CallbackEventListener;\n /**\n * A callback fired when the user inputs data into the text area.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input?: CallbackEventListener;\n}" ->>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) + "value": "export interface TextAreaElementEvents {\n /**\n<<<<<<< HEAD\n * A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n=======\n * A callback fired when the text area loses focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality)\n *\n * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur?: CallbackEventListener;\n /**\n<<<<<<< HEAD\n * Callback when the user has **finished editing** a field, for example, once they have blurred the field.\n=======\n * A callback fired when the text area value changes.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality)\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change?: CallbackEventListener;\n /**\n<<<<<<< HEAD\n * A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n=======\n * A callback fired when the text area receives focus.\n>>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality)\n *\n * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus?: CallbackEventListener;\n /**\n * A callback fired when the user inputs data into the text area.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input?: CallbackEventListener;\n}" } }, "TextAreaElement": { @@ -202260,7 +174309,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/TextArea.ts", @@ -202701,7 +174750,7 @@ "syntaxKind": "PropertySignature", "name": "autocomplete", "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", "isOptional": true, "defaultValue": "'on' for everything else" }, @@ -202907,7 +174956,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -203365,7 +175414,7 @@ "syntaxKind": "PropertySignature", "name": "minLength", "value": "number", - "description": "Specifies the min number of characters allowed.", + "description": "Specifies the minimum number of characters allowed.", "isOptional": true, "defaultValue": "0" }, @@ -204365,7 +176414,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/TextArea.ts", @@ -204655,7 +176704,7 @@ "syntaxKind": "PropertySignature", "name": "autocomplete", "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", "isOptional": true, "defaultValue": "'on' for everything else" }, @@ -204672,7 +176721,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -204723,7 +176772,7 @@ "syntaxKind": "PropertySignature", "name": "minLength", "value": "number", - "description": "Specifies the min number of characters allowed.", + "description": "Specifies the minimum number of characters allowed.", "isOptional": true, "defaultValue": "0" }, @@ -204748,11 +176797,7 @@ "syntaxKind": "PropertySignature", "name": "onChange", "value": "(event: Event) => void", -<<<<<<< HEAD - "description": "Callback when the user has **finished editing** a field, for example, once they have blurred the field.", -======= - "description": "A callback fired when the user has **finished editing** a field, such as when they blur the field or press Enter. Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", ->>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) + "description": "A callback fired when the user has **finished editing** a field, such as when they blur the field or press Enter.", "isOptional": true }, { @@ -204768,7 +176813,7 @@ "syntaxKind": "PropertySignature", "name": "onInput", "value": "(event: Event) => void", - "description": "A callback fired when the user makes any changes in the field, such as typing a character. Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).", + "description": "A callback fired when the user makes any changes in the field, such as typing a character.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).", "isOptional": true }, { @@ -204824,7 +176869,7 @@ "src/surfaces/checkout/components/Time.ts": { "filePath": "src/surfaces/checkout/components/Time.ts", "name": "TimeElementProps", - "description": "Represents a specific point or duration in time. Use to display dates, times, or durations clearly and consistently. May include a machine-readable `datetime` attribute for improved accessibility and functionality.", + "description": "", "isPublicDocs": true, "members": [ { @@ -204832,7 +176877,7 @@ "syntaxKind": "PropertySignature", "name": "dateTime", "value": "string", - "description": "Set the time and/or date of the element.\n\nIt must be a [valid date string](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/time#valid_datetime_values).", + "description": "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.\n\nThe 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`.", "isOptional": true, "defaultValue": "''" }, @@ -204874,7 +176919,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/Time.ts", @@ -205497,7 +177542,7 @@ "syntaxKind": "PropertySignature", "name": "dateTime", "value": "string", - "description": "Set the time and/or date of the element.\n\nIt must be a [valid date string](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/time#valid_datetime_values).", + "description": "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.\n\nThe 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`.", "isOptional": true, "defaultValue": "''" }, @@ -206892,7 +178937,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/Time.ts", @@ -207156,7 +179201,7 @@ "syntaxKind": "PropertySignature", "name": "dateTime", "value": "string", - "description": "Set the time and/or date of the element.\n\nIt must be a [valid date string](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/time#valid_datetime_values).", + "description": "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.\n\nThe 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`.", "isOptional": true, "defaultValue": "''" }, @@ -207176,7 +179221,7 @@ "src/surfaces/checkout/components/UrlField.ts": { "filePath": "src/surfaces/checkout/components/UrlField.ts", "name": "URLFieldElementProps", - "description": "Configure the following properties on the URL field component.", + "description": "", "isPublicDocs": true, "members": [ { @@ -207184,7 +179229,7 @@ "syntaxKind": "PropertySignature", "name": "autocomplete", "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", "isOptional": true, "defaultValue": "'on' for everything else" }, @@ -207201,7 +179246,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -207252,7 +179297,7 @@ "syntaxKind": "PropertySignature", "name": "minLength", "value": "number", - "description": "Specifies the min number of characters allowed.", + "description": "Specifies the minimum number of characters allowed.", "isOptional": true, "defaultValue": "0" }, @@ -207314,11 +179359,7 @@ "syntaxKind": "PropertySignature", "name": "onChange", "value": "(event: Event) => void", -<<<<<<< HEAD - "description": "Callback when the user has **finished editing** a field, for example, once they have blurred the field.", -======= - "description": "A callback fired when the user has **finished editing** a field, such as when they blur the field or press Enter. Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", ->>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) + "description": "A callback fired when the user has **finished editing** a field, such as when they blur the field or press Enter.", "isOptional": true }, { @@ -207334,7 +179375,7 @@ "syntaxKind": "PropertySignature", "name": "onInput", "value": "(event: Event) => void", - "description": "A callback fired when the user makes any changes in the field, such as typing a character. Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).", + "description": "A callback fired when the user makes any changes in the field, such as typing a character.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).", "isOptional": true } ], @@ -207345,7 +179386,7 @@ "src/surfaces/checkout/components/UrlField.ts": { "filePath": "src/surfaces/checkout/components/UrlField.ts", "name": "URLFieldElementEvents", - "description": "The URL field component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", + "description": "", "isPublicDocs": true, "members": [ { @@ -207353,11 +179394,7 @@ "syntaxKind": "PropertySignature", "name": "blur", "value": "CallbackEventListener", -<<<<<<< HEAD - "description": "A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", -======= "description": "A callback fired when the URL field loses focus.\n\nLearn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", ->>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) "isOptional": true }, { @@ -207365,11 +179402,7 @@ "syntaxKind": "PropertySignature", "name": "change", "value": "CallbackEventListener", -<<<<<<< HEAD - "description": "Callback when the user has **finished editing** a field, for example, once they have blurred the field.", -======= "description": "A callback fired when the URL field value changes.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", ->>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) "isOptional": true }, { @@ -207377,11 +179410,7 @@ "syntaxKind": "PropertySignature", "name": "focus", "value": "CallbackEventListener", -<<<<<<< HEAD - "description": "A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", -======= "description": "A callback fired when the URL field receives focus.\n\nLearn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", ->>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) "isOptional": true }, { @@ -207393,18 +179422,14 @@ "isOptional": true } ], -<<<<<<< HEAD - "value": "export interface URLFieldElementEvents {\n /**\n * A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event\n */\n blur?: CallbackEventListener;\n /**\n * Callback when the user has **finished editing** a field, for example, once they have blurred the field.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event\n */\n change?: CallbackEventListener;\n /**\n * A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event\n */\n focus?: CallbackEventListener;\n /**\n * Callback when the user makes any changes in the field.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event\n */\n input?: CallbackEventListener;\n}" -======= "value": "export interface URLFieldElementEvents {\n /**\n * A callback fired when the URL field loses focus.\n *\n * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur?: CallbackEventListener;\n /**\n * A callback fired when the URL field value changes.\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change?: CallbackEventListener;\n /**\n * A callback fired when the URL field receives focus.\n *\n * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus?: CallbackEventListener;\n /**\n * A callback fired when the user inputs data into the URL field.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input?: CallbackEventListener;\n}" ->>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) } }, "URLFieldElementSlots": { "src/surfaces/checkout/components/UrlField.ts": { "filePath": "src/surfaces/checkout/components/UrlField.ts", "name": "URLFieldElementSlots", - "description": "The URL field component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", + "description": "", "isPublicDocs": true, "members": [ { @@ -207445,7 +179470,7 @@ "syntaxKind": "MethodSignature", "name": "addEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", - "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" }, { "filePath": "src/surfaces/checkout/components/UrlField.ts", @@ -207886,7 +179911,7 @@ "syntaxKind": "PropertySignature", "name": "autocomplete", "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", "isOptional": true, "defaultValue": "'on' for everything else" }, @@ -208092,7 +180117,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -208550,7 +180575,7 @@ "syntaxKind": "PropertySignature", "name": "minLength", "value": "number", - "description": "Specifies the min number of characters allowed.", + "description": "Specifies the minimum number of characters allowed.", "isOptional": true, "defaultValue": "0" }, @@ -209533,7 +181558,7 @@ "syntaxKind": "MethodSignature", "name": "removeEventListener", "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", - "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" }, { "filePath": "src/surfaces/checkout/components/UrlField.ts", @@ -209814,7 +181839,7 @@ "syntaxKind": "PropertySignature", "name": "autocomplete", "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", - "description": "A hint as to the intended content of the field.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.", "isOptional": true, "defaultValue": "'on' for everything else" }, @@ -209831,7 +181856,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -209882,7 +181907,7 @@ "syntaxKind": "PropertySignature", "name": "minLength", "value": "number", - "description": "Specifies the min number of characters allowed.", + "description": "Specifies the minimum number of characters allowed.", "isOptional": true, "defaultValue": "0" }, @@ -209907,11 +181932,7 @@ "syntaxKind": "PropertySignature", "name": "onChange", "value": "(event: Event) => void", -<<<<<<< HEAD - "description": "Callback when the user has **finished editing** a field, for example, once they have blurred the field.", -======= - "description": "A callback fired when the user has **finished editing** a field, such as when they blur the field or press Enter. Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", ->>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) + "description": "A callback fired when the user has **finished editing** a field, such as when they blur the field or press Enter.", "isOptional": true }, { @@ -209927,7 +181948,7 @@ "syntaxKind": "PropertySignature", "name": "onInput", "value": "(event: Event) => void", - "description": "A callback fired when the user makes any changes in the field, such as typing a character. Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).", + "description": "A callback fired when the user makes any changes in the field, such as typing a character.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).", "isOptional": true }, { @@ -210130,7 +182151,7 @@ "syntaxKind": "PropertySignature", "name": "onAfterToggle", "value": "(event: ToggleEvent$1) => void", - "description": "A callback fired when the element state changes, after any toggle animations have finished.\n\n- If the element transitioned from hidden to showing, the `oldState` property will be set to `closed` and the `newState` property will be set to `open`.\n- If the element transitioned from showing to hidden, the `oldState` property will be set to `open` and the `newState` will be `closed`.\n\nLearn more about [ToggleEvent.newState](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/newState) and [ToggleEvent.oldState](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/oldState).", + "description": "A callback fired when the element state changes, after any toggle animations have finished.\n\n- If the element transitioned from hidden to showing, the `oldState` property will be set to `closed` and the `newState` property will be set to `open`.\n- If the element transitioned from showing to hidden, the `oldState` property will be set to `open` and the `newState` will be `closed`.\n\nLearn more about [`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).", "isOptional": true }, { @@ -210138,11 +182159,11 @@ "syntaxKind": "PropertySignature", "name": "onToggle", "value": "(event: ToggleEvent$1) => void", - "description": "A callback fired immediately when the element state changes, before any animations.\n\n- If the element is transitioning from hidden to showing, the `oldState` property will be set to `closed` and the `newState` property will be set to `open`.\n- If the element is transitioning from showing to hidden, then `oldState` property will be set to `open` and the `newState` will be `closed`.\n\nLearn more about the [toggle event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/toggle_event), [ToggleEvent.newState](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/newState), and [ToggleEvent.oldState](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/oldState).", + "description": "A callback fired immediately when the element state changes, before any animations.\n\n- If the element is transitioning from hidden to showing, the `oldState` property will be set to `closed` and the `newState` property will be set to `open`.\n- If the element is transitioning from showing to hidden, then the `oldState` property will be set to `open` and the `newState` will be `closed`.\n\nLearn more about the [`toggle` event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/toggle_event), [`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).", "isOptional": true } ], - "value": "export interface ToggleEventProps {\n\t/**\n\t * A callback fired when the element state changes, after any toggle animations have finished.\n\t *\n\t * - If the element transitioned from hidden to showing, the `oldState` property will be set to `closed` and the\n\t * `newState` property will be set to `open`.\n\t * - If the element transitioned from showing to hidden, the `oldState` property will be set to `open` and the\n\t * `newState` will be `closed`.\n\t *\n\t * Learn more about [ToggleEvent.newState](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/newState) and [ToggleEvent.oldState](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/oldState).\n\t */\n\tonAfterToggle?: (event: ToggleEvent$1) => void;\n\t/**\n\t * A callback fired immediately when the element state changes, before any animations.\n\t *\n\t * - If the element is transitioning from hidden to showing, the `oldState` property will be set to `closed` and the\n\t * `newState` property will be set to `open`.\n\t * - If the element is transitioning from showing to hidden, then `oldState` property will be set to `open` and the\n\t * `newState` will be `closed`.\n\t *\n\t * Learn more about the [toggle event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/toggle_event), [ToggleEvent.newState](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/newState), and [ToggleEvent.oldState](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/oldState).\n\t */\n\tonToggle?: (event: ToggleEvent$1) => void;\n}" + "value": "export interface ToggleEventProps {\n\t/**\n\t * A callback fired when the element state changes, after any toggle animations have finished.\n\t *\n\t * - If the element transitioned from hidden to showing, the `oldState` property will be set to `closed` and the\n\t * `newState` property will be set to `open`.\n\t * - If the element transitioned from showing to hidden, the `oldState` property will be set to `open` and the\n\t * `newState` will be `closed`.\n\t *\n\t * Learn more about [`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).\n\t */\n\tonAfterToggle?: (event: ToggleEvent$1) => void;\n\t/**\n\t * A callback fired immediately when the element state changes, before any animations.\n\t *\n\t * - If the element is transitioning from hidden to showing, the `oldState` property will be set to `closed` and the\n\t * `newState` property will be set to `open`.\n\t * - If the element is transitioning from showing to hidden, then the `oldState` property will be set to `open` and the\n\t * `newState` will be `closed`.\n\t *\n\t * Learn more about the [`toggle` event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/toggle_event), [`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).\n\t */\n\tonToggle?: (event: ToggleEvent$1) => void;\n}" } }, "ExtendableEvent": { @@ -210414,12 +182435,12 @@ "syntaxKind": "PropertySignature", "name": "display", "value": "MaybeResponsive<\"auto\" | \"none\">", - "description": "Sets the outer display type of the component. The outer type sets a component\u2019s participation in [flow layout](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_flow_layout).\n\n- `auto`: the component\u2019s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.", + "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.", "isOptional": true, "defaultValue": "'auto'" } ], - "value": "export interface DisplayProps {\n\t/**\n\t * Sets the outer display type of the component. The outer type sets a component\u2019s participation in [flow layout](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_flow_layout).\n\t *\n\t * - `auto`: the component\u2019s initial value. The actual value depends on the component and context.\n\t * - `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.\n\t *\n\t * @see https://developer.mozilla.org/en-US/docs/Web/CSS/display\n\t * @default 'auto'\n\t */\n\tdisplay?: MaybeResponsive<\"auto\" | \"none\">;\n}" + "value": "export interface DisplayProps {\n\t/**\n\t * 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).\n\t *\n\t * - `auto`: the component’s initial value. The actual value depends on the component and context.\n\t * - `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.\n\t *\n\t * @see https://developer.mozilla.org/en-US/docs/Web/CSS/display\n\t * @default 'auto'\n\t */\n\tdisplay?: MaybeResponsive<\"auto\" | \"none\">;\n}" } }, "AccessibilityRoleProps": { @@ -210434,12 +182455,12 @@ "syntaxKind": "PropertySignature", "name": "accessibilityRole", "value": "AccessibilityRole", - "description": "The semantic meaning of the component\u2019s content. When set, assistive technologies use this role to help users navigate the page.", + "description": "The semantic meaning of the component’s content. When set, assistive technologies use this role to help users navigate the page.", "isOptional": true, "defaultValue": "'generic'" } ], - "value": "export interface AccessibilityRoleProps {\n\t/**\n\t * The semantic meaning of the component\u2019s content. When set, assistive technologies use this role to help users navigate the page.\n\t *\n\t * @default 'generic'\n\t */\n\taccessibilityRole?: AccessibilityRole;\n}" + "value": "export interface AccessibilityRoleProps {\n\t/**\n\t * The semantic meaning of the component’s content. When set, assistive technologies use this role to help users navigate the page.\n\t *\n\t * @default 'generic'\n\t */\n\taccessibilityRole?: AccessibilityRole;\n}" } }, "AccessibilityVisibilityProps": { @@ -210637,7 +182658,7 @@ "syntaxKind": "TypeAliasDeclaration", "name": "BorderRadiusKeyword", "value": "SizeKeyword | \"max\" | \"none\"", - "description": "The corner radius of a border, using the design system's `SizeKeyword` scale with additional options:\n\n- `max`: The maximum possible radius, creating a pill or circular shape.\n- `none`: No rounding \u2014 corners are sharp (0 radius).", + "description": "The corner radius of a border, using the design system's `SizeKeyword` scale with additional options:\n\n- `max`: The maximum possible radius, creating a pill or circular shape.\n- `none`: No rounding — corners are sharp (0 radius).", "isPublicDocs": true } }, @@ -210841,7 +182862,7 @@ "syntaxKind": "PropertySignature", "name": "display", "value": "MaybeResponsive<\"auto\" | \"none\">", - "description": "Sets the outer display type of the component. The outer type sets a component\u2019s participation in [flow layout](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_flow_layout).\n\n- `auto`: the component\u2019s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.", + "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.", "isOptional": true, "defaultValue": "'auto'" }, @@ -210986,7 +183007,7 @@ "syntaxKind": "PropertySignature", "name": "accessibilityRole", "value": "AccessibilityRole", - "description": "The semantic meaning of the component\u2019s content. When set, assistive technologies use this role to help users navigate the page.", + "description": "The semantic meaning of the component’s content. When set, assistive technologies use this role to help users navigate the page.", "isOptional": true, "defaultValue": "'generic'" }, @@ -211087,7 +183108,7 @@ "syntaxKind": "PropertySignature", "name": "display", "value": "MaybeResponsive<\"auto\" | \"none\">", - "description": "Sets the outer display type of the component. The outer type sets a component\u2019s participation in [flow layout](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_flow_layout).\n\n- `auto`: the component\u2019s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.", + "description": "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).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.", "isOptional": true, "defaultValue": "'auto'" }, @@ -211224,7 +183245,7 @@ "syntaxKind": "PropertySignature", "name": "command", "value": "'--auto' | '--show' | '--hide' | '--toggle' | '--copy'", - "description": "Sets the action the `commandFor` should take when this clickable is activated.\n\nSee the documentation of particular components for the actions they support.\n\n- `--auto`: a default action for the target component.\n- `--show`: shows the target component.\n- `--hide`: hides the target component.\n- `--toggle`: toggles the target component.\n- `--copy`: copies the target ClipboardItem.", + "description": "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).\n\nSee the documentation of particular components for the actions they support.\n\n- `--auto`: a default action for the target component.\n- `--show`: shows the target component.\n- `--hide`: hides the target component.\n- `--toggle`: toggles the target component.\n- `--copy`: copies the target ClipboardItem.", "isOptional": true, "defaultValue": "'--auto'" }, @@ -211233,7 +183254,7 @@ "syntaxKind": "PropertySignature", "name": "commandFor", "value": "string", - "description": "ID of a component that should respond to activations (such as clicks) on this component.\n\nSee `command` for how to control the behavior of the target.", + "description": "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).", "isOptional": true }, { @@ -211250,7 +183271,7 @@ "syntaxKind": "PropertySignature", "name": "interestFor", "value": "string", - "description": "The ID of the component to show when users hover over or focus on this component. Pair with a target component that supports interest-based interactions. Learn more about the [interestFor attribute](https://open-ui.org/components/interest-invokers.explainer/#the-pitch-in-code).", + "description": "The ID of the component to show when users hover over or focus on this component. Use this to connect interactive components to popovers or tooltips that provide additional context or information.", "isOptional": true }, { @@ -211311,7 +183332,7 @@ "syntaxKind": "PropertySignature", "name": "command", "value": "'--auto' | '--show' | '--hide' | '--toggle' | '--copy'", - "description": "Sets the action the `commandFor` should take when this clickable is activated.\n\nSee the documentation of particular components for the actions they support.\n\n- `--auto`: a default action for the target component.\n- `--show`: shows the target component.\n- `--hide`: hides the target component.\n- `--toggle`: toggles the target component.\n- `--copy`: copies the target ClipboardItem.", + "description": "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).\n\nSee the documentation of particular components for the actions they support.\n\n- `--auto`: a default action for the target component.\n- `--show`: shows the target component.\n- `--hide`: hides the target component.\n- `--toggle`: toggles the target component.\n- `--copy`: copies the target ClipboardItem.", "isOptional": true, "defaultValue": "'--auto'" }, @@ -211320,7 +183341,7 @@ "syntaxKind": "PropertySignature", "name": "commandFor", "value": "string", - "description": "ID of a component that should respond to activations (such as clicks) on this component.\n\nSee `command` for how to control the behavior of the target.", + "description": "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).", "isOptional": true }, { @@ -211344,7 +183365,7 @@ "syntaxKind": "PropertySignature", "name": "interestFor", "value": "string", - "description": "The ID of the component to show when users hover over or focus on this component. Pair with a target component that supports interest-based interactions. Learn more about the [interestFor attribute](https://open-ui.org/components/interest-invokers.explainer/#the-pitch-in-code).", + "description": "The ID of the component to show when users hover over or focus on this component. Use this to connect interactive components to popovers or tooltips that provide additional context or information.", "isOptional": true }, { @@ -211381,11 +183402,7 @@ "defaultValue": "'auto'" } ], -<<<<<<< HEAD "value": "export interface LinkBehaviorProps extends InteractionProps, FocusEventProps {\n\t/**\n\t * The URL to navigate to when clicked. The `click` event fires first, then navigation occurs.\n\t *\n\t * - If set, it will navigate to the location specified by `href` after executing the `click` event.\n\t * - If a `commandFor` is set, the `command` will be executed instead of the navigation.\n\t */\n\thref?: string;\n\t/**\n\t * Specifies where to display the linked URL.\n\t *\n\t * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#target\n\t *\n\t * 'auto': The target is automatically determined based on the origin of the URL.\n\t *\n\t * @implementation Surfaces can set specific rules on how they handle each URL.\n\t * @implementation It’s expected that the behavior of `auto` is as `_self` except in specific cases.\n\t * @implementation For example, a surface could decide to open cross-origin URLs in a new window (as `_blank`).\n\t *\n\t * @default 'auto'\n\t */\n\ttarget?: \"auto\" | \"_blank\" | \"_self\" | \"_parent\" | \"_top\" | AnyString;\n\t/**\n\t * Causes the browser to treat the linked URL as a download with the string being the file name.\n\t * Download only works for same-origin URLs or the `blob:` and `data:` schemes.\n\t * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#download\n\t */\n\tdownload?: string;\n\t/**\n\t * A callback fired when the link is activated, before navigating to the location specified by `href`. Learn more about the [click event](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event).\n\t */\n\tonClick?: (event: Event) => void;\n}" -======= - "value": "export interface LinkBehaviorProps extends InteractionProps, FocusEventProps {\n\t/**\n\t * The URL to link to.\n\t *\n\t * - If set, it will navigate to the location specified by `href` after executing the `click` event.\n\t * - If a `commandFor` is set, the `command` will be executed instead of the navigation.\n\t */\n\thref?: string;\n\t/**\n\t * Specifies where to display the linked URL.\n\t *\n\t * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#target\n\t *\n\t * 'auto': The target is automatically determined based on the origin of the URL.\n\t *\n\t * @implementation Surfaces can set specific rules on how they handle each URL.\n\t * @implementation It\u2019s expected that the behavior of `auto` is as `_self` except in specific cases.\n\t * @implementation For example, a surface could decide to open cross-origin URLs in a new window (as `_blank`).\n\t *\n\t * @default 'auto'\n\t */\n\ttarget?: \"auto\" | \"_blank\" | \"_self\" | \"_parent\" | \"_top\" | AnyString;\n\t/**\n\t * Causes the browser to treat the linked URL as a download with the string being the file name.\n\t * Download only works for same-origin URLs or the `blob:` and `data:` schemes.\n\t * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#download\n\t */\n\tdownload?: string;\n\t/**\n\t * Callback when the link is activated.\n\t * This will be called before navigating to the location specified by `href`.\n\t *\n\t * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event\n\t */\n\tonClick?: (event: Event) => void;\n}" ->>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) } }, "InteractionProps": { @@ -211400,7 +183417,7 @@ "syntaxKind": "PropertySignature", "name": "command", "value": "'--auto' | '--show' | '--hide' | '--toggle' | '--copy'", - "description": "Sets the action the `commandFor` should take when this clickable is activated.\n\nSee the documentation of particular components for the actions they support.\n\n- `--auto`: a default action for the target component.\n- `--show`: shows the target component.\n- `--hide`: hides the target component.\n- `--toggle`: toggles the target component.\n- `--copy`: copies the target ClipboardItem.", + "description": "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).\n\nSee the documentation of particular components for the actions they support.\n\n- `--auto`: a default action for the target component.\n- `--show`: shows the target component.\n- `--hide`: hides the target component.\n- `--toggle`: toggles the target component.\n- `--copy`: copies the target ClipboardItem.", "isOptional": true, "defaultValue": "'--auto'" }, @@ -211409,7 +183426,7 @@ "syntaxKind": "PropertySignature", "name": "commandFor", "value": "string", - "description": "ID of a component that should respond to activations (such as clicks) on this component.\n\nSee `command` for how to control the behavior of the target.", + "description": "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).", "isOptional": true }, { @@ -211417,11 +183434,11 @@ "syntaxKind": "PropertySignature", "name": "interestFor", "value": "string", - "description": "The ID of the component to show when users hover over or focus on this component. Pair with a target component that supports interest-based interactions. Learn more about the [interestFor attribute](https://open-ui.org/components/interest-invokers.explainer/#the-pitch-in-code).", + "description": "The ID of the component to show when users hover over or focus on this component. Use this to connect interactive components to popovers or tooltips that provide additional context or information.", "isOptional": true } ], - "value": "export interface InteractionProps {\n\t/**\n\t * ID of a component that should respond to activations (such as clicks) on this component.\n\t *\n\t * See `command` for how to control the behavior of the target.\n\t *\n\t * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#commandfor\n\t */\n\tcommandFor?: string;\n\t/**\n\t * Sets the action the `commandFor` should take when this clickable is activated.\n\t *\n\t * See the documentation of particular components for the actions they support.\n\t *\n\t * - `--auto`: a default action for the target component.\n\t * - `--show`: shows the target component.\n\t * - `--hide`: hides the target component.\n\t * - `--toggle`: toggles the target component.\n\t * - `--copy`: copies the target ClipboardItem.\n\t *\n\t * @default '--auto'\n\t *\n\t * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command\n\t */\n\tcommand?: \"--auto\" | \"--show\" | \"--hide\" | \"--toggle\" | \"--copy\";\n\t/**\n\t * The ID of the component to show when users hover over or focus on this component. Pair with a target component that supports interest-based interactions. Learn more about the [interestFor attribute](https://open-ui.org/components/interest-invokers.explainer/#the-pitch-in-code).\n\t */\n\tinterestFor?: string;\n}" + "value": "export interface InteractionProps {\n\t/**\n\t * 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).\n\t */\n\tcommandFor?: string;\n\t/**\n\t * 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).\n\t *\n\t * See the documentation of particular components for the actions they support.\n\t *\n\t * - `--auto`: a default action for the target component.\n\t * - `--show`: shows the target component.\n\t * - `--hide`: hides the target component.\n\t * - `--toggle`: toggles the target component.\n\t * - `--copy`: copies the target ClipboardItem.\n\t *\n\t * @default '--auto'\n\t */\n\tcommand?: \"--auto\" | \"--show\" | \"--hide\" | \"--toggle\" | \"--copy\";\n\t/**\n\t * The ID of the component to show when users hover over or focus on this component. Use this to connect interactive components to popovers or tooltips that provide additional context or information.\n\t */\n\tinterestFor?: string;\n}" } }, "BaseClickableProps": { @@ -211436,7 +183453,7 @@ "syntaxKind": "PropertySignature", "name": "command", "value": "'--auto' | '--show' | '--hide' | '--toggle' | '--copy'", - "description": "Sets the action the `commandFor` should take when this clickable is activated.\n\nSee the documentation of particular components for the actions they support.\n\n- `--auto`: a default action for the target component.\n- `--show`: shows the target component.\n- `--hide`: hides the target component.\n- `--toggle`: toggles the target component.\n- `--copy`: copies the target ClipboardItem.", + "description": "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).\n\nSee the documentation of particular components for the actions they support.\n\n- `--auto`: a default action for the target component.\n- `--show`: shows the target component.\n- `--hide`: hides the target component.\n- `--toggle`: toggles the target component.\n- `--copy`: copies the target ClipboardItem.", "isOptional": true, "defaultValue": "'--auto'" }, @@ -211445,7 +183462,7 @@ "syntaxKind": "PropertySignature", "name": "commandFor", "value": "string", - "description": "ID of a component that should respond to activations (such as clicks) on this component.\n\nSee `command` for how to control the behavior of the target.", + "description": "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).", "isOptional": true }, { @@ -211478,7 +183495,7 @@ "syntaxKind": "PropertySignature", "name": "interestFor", "value": "string", - "description": "The ID of the component to show when users hover over or focus on this component. Pair with a target component that supports interest-based interactions. Learn more about the [interestFor attribute](https://open-ui.org/components/interest-invokers.explainer/#the-pitch-in-code).", + "description": "The ID of the component to show when users hover over or focus on this component. Use this to connect interactive components to popovers or tooltips that provide additional context or information.", "isOptional": true }, { @@ -211669,11 +183686,11 @@ "syntaxKind": "PropertySignature", "name": "values", "value": "string[]", - "description": "An array of the `value`s of the selected options.\n\nThis is a convenience prop for setting the `selected` prop on child options.", + "description": "An array of `value` attributes for the currently selected options.\n\nThis is a convenience prop for setting the `selected` prop on child options.", "isOptional": true } ], - "value": "export interface MultipleInputProps extends BaseInputProps {\n\t/**\n\t * Callback when the user has selected option(s).\n\t *\n\t * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event\n\t */\n\tonChange?: (event: Event) => void;\n\t/**\n\t * Callback when the user has selected option(s).\n\t *\n\t * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event\n\t */\n\tonInput?: (event: Event) => void;\n\t/**\n\t * An array of the `value`s of the selected options.\n\t *\n\t * This is a convenience prop for setting the `selected` prop on child options.\n\t */\n\tvalues?: string[];\n}" + "value": "export interface MultipleInputProps extends BaseInputProps {\n\t/**\n\t * Callback when the user has selected option(s).\n\t *\n\t * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event\n\t */\n\tonChange?: (event: Event) => void;\n\t/**\n\t * Callback when the user has selected option(s).\n\t *\n\t * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event\n\t */\n\tonInput?: (event: Event) => void;\n\t/**\n\t * An array of `value` attributes for the currently selected options.\n\t *\n\t * This is a convenience prop for setting the `selected` prop on child options.\n\t */\n\tvalues?: string[];\n}" } }, "FileInputProps": { @@ -212140,7 +184157,7 @@ "syntaxKind": "PropertySignature", "name": "controls", "value": "'auto' | 'stepper' | 'none'", - "description": "Sets the type of controls displayed in the field.\n\n- `stepper`: displays buttons to increase or decrease the value of the field by the stepping interval defined in the `step` property. Appropriate mouse and [keyboard interactions](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/spinbutton_role#keyboard_interactions) to control the value of the field are enabled.\n- `none`: no controls are displayed and users must input the value manually. Arrow keys and scroll wheels can\u2019t be used either to avoid accidental changes.\n- `auto`: the presence of the controls depends on the surface and context.", + "description": "Sets the type of controls displayed in the field.\n\n- `stepper`: displays buttons to increase or decrease the value of the field by the stepping interval defined in the `step` property. Appropriate mouse and [keyboard interactions](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/spinbutton_role#keyboard_interactions) to control the value of the field are enabled.\n- `none`: no controls are displayed and users must input the value manually. Arrow keys and scroll wheels can’t be used either to avoid accidental changes.\n- `auto`: the presence of the controls depends on the surface and context.", "isOptional": true, "defaultValue": "'auto'" }, @@ -212172,7 +184189,7 @@ "defaultValue": "1" } ], - "value": "export interface NumberConstraintsProps {\n\t/**\n\t * The highest decimal or integer to be accepted for the field.\n\t * When used with `step` the value will round down to the max number.\n\t *\n\t * Note: a user will still be able to use the keyboard to input a number higher than\n\t * the max. It is up to the developer to add appropriate validation.\n\t *\n\t * @default Infinity\n\t */\n\tmax?: number;\n\t/**\n\t * The lowest decimal or integer to be accepted for the field.\n\t * When used with `step` the value will round up to the min number.\n\t *\n\t * Note: a user will still be able to use the keyboard to input a number lower than\n\t * the min. It is up to the developer to add appropriate validation.\n\t *\n\t * @default -Infinity\n\t */\n\tmin?: number;\n\t/**\n\t * The amount the value can increase or decrease by. This can be an integer or decimal.\n\t * If a `max` or `min` is specified with `step` when increasing/decreasing the value\n\t * via the buttons, the final value will always round to the `max` or `min`\n\t * rather than the closest valid amount.\n\t *\n\t * @default 1\n\t */\n\tstep?: number;\n\t/**\n\t * Sets the type of controls displayed in the field.\n\t *\n\t * - `stepper`: displays buttons to increase or decrease the value of the field by the stepping interval defined in the `step` property.\n\t * Appropriate mouse and [keyboard interactions](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/spinbutton_role#keyboard_interactions) to control the value of the field are enabled.\n\t * - `none`: no controls are displayed and users must input the value manually. Arrow keys and scroll wheels can\u2019t be used either to avoid accidental changes.\n\t * - `auto`: the presence of the controls depends on the surface and context.\n\t *\n\t * @default 'auto'\n\t */\n\tcontrols?: \"auto\" | \"stepper\" | \"none\";\n}" + "value": "export interface NumberConstraintsProps {\n\t/**\n\t * The highest decimal or integer to be accepted for the field.\n\t * When used with `step` the value will round down to the max number.\n\t *\n\t * Note: a user will still be able to use the keyboard to input a number higher than\n\t * the max. It is up to the developer to add appropriate validation.\n\t *\n\t * @default Infinity\n\t */\n\tmax?: number;\n\t/**\n\t * The lowest decimal or integer to be accepted for the field.\n\t * When used with `step` the value will round up to the min number.\n\t *\n\t * Note: a user will still be able to use the keyboard to input a number lower than\n\t * the min. It is up to the developer to add appropriate validation.\n\t *\n\t * @default -Infinity\n\t */\n\tmin?: number;\n\t/**\n\t * The amount the value can increase or decrease by. This can be an integer or decimal.\n\t * If a `max` or `min` is specified with `step` when increasing/decreasing the value\n\t * via the buttons, the final value will always round to the `max` or `min`\n\t * rather than the closest valid amount.\n\t *\n\t * @default 1\n\t */\n\tstep?: number;\n\t/**\n\t * Sets the type of controls displayed in the field.\n\t *\n\t * - `stepper`: displays buttons to increase or decrease the value of the field by the stepping interval defined in the `step` property.\n\t * Appropriate mouse and [keyboard interactions](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/spinbutton_role#keyboard_interactions) to control the value of the field are enabled.\n\t * - `none`: no controls are displayed and users must input the value manually. Arrow keys and scroll wheels can’t be used either to avoid accidental changes.\n\t * - `auto`: the presence of the controls depends on the surface and context.\n\t *\n\t * @default 'auto'\n\t */\n\tcontrols?: \"auto\" | \"stepper\" | \"none\";\n}" } }, "MinMaxLengthProps": { @@ -212323,7 +184340,7 @@ "syntaxKind": "PropertySignature", "name": "command", "value": "'--auto' | '--show' | '--hide' | '--toggle' | '--copy'", - "description": "Sets the action the `commandFor` should take when this clickable is activated.\n\nSee the documentation of particular components for the actions they support.\n\n- `--auto`: a default action for the target component.\n- `--show`: shows the target component.\n- `--hide`: hides the target component.\n- `--toggle`: toggles the target component.\n- `--copy`: copies the target ClipboardItem.", + "description": "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).\n\nSee the documentation of particular components for the actions they support.\n\n- `--auto`: a default action for the target component.\n- `--show`: shows the target component.\n- `--hide`: hides the target component.\n- `--toggle`: toggles the target component.\n- `--copy`: copies the target ClipboardItem.", "isOptional": true, "defaultValue": "'--auto'" }, @@ -212332,7 +184349,7 @@ "syntaxKind": "PropertySignature", "name": "commandFor", "value": "string", - "description": "ID of a component that should respond to activations (such as clicks) on this component.\n\nSee `command` for how to control the behavior of the target.", + "description": "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).", "isOptional": true }, { @@ -212358,7 +184375,7 @@ "syntaxKind": "PropertySignature", "name": "interestFor", "value": "string", - "description": "The ID of the component to show when users hover over or focus on this component. Pair with a target component that supports interest-based interactions. Learn more about the [interestFor attribute](https://open-ui.org/components/interest-invokers.explainer/#the-pitch-in-code).", + "description": "The ID of the component to show when users hover over or focus on this component. Use this to connect interactive components to popovers or tooltips that provide additional context or information.", "isOptional": true }, { @@ -212474,6 +184491,16 @@ "isPublicDocs": true } }, + "ConsentPolicy": { + "src/surfaces/checkout/components/components.ts": { + "filePath": "src/surfaces/checkout/components/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "ConsentPolicy", + "value": "\"sms-marketing\"", + "description": "", + "isPublicDocs": true + } + }, "PhoneAutocompleteField": { "src/surfaces/checkout/components/components.ts": { "filePath": "src/surfaces/checkout/components/components.ts", @@ -212643,11 +184670,7 @@ "syntaxKind": "PropertySignature", "name": "dir", "value": "'ltr' | 'rtl' | 'auto' | ''", -<<<<<<< HEAD "description": "Indicates the directionality of the element’s text.\n\n- `ltr`: languages written from left to right (such as English)\n- `rtl`: languages written from right to left (such as Arabic)\n- `auto`: the user agent determines the direction based on the content\n- `''`: direction is inherited from parent elements (equivalent to not setting the attribute)", -======= - "description": "Indicates the directionality of the element\u2019s text.\n\n- `ltr`: languages written from left to right (e.g. English)\n- `rtl`: languages written from right to left (e.g. Arabic)\n- `auto`: the user agent determines the direction based on the content\n- `''`: direction is inherited from parent elements (equivalent to not setting the attribute)", ->>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) "isOptional": true, "defaultValue": "''" }, @@ -212665,11 +184688,7 @@ "syntaxKind": "PropertySignature", "name": "lang", "value": "string", -<<<<<<< HEAD "description": "The language of the button's text content. Use this when the button text is in a different language than the rest of the page, so assistive technologies can invoke the correct pronunciation. [Reference of values](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry) (\"subtag\" label)\n\nIt is recommended to combine it with the `dir` attribute to ensure the text is rendered correctly if the surrounding content’s direction is different.", -======= - "description": "Indicate the text language. Useful when the text is in a different language than the rest of the page. It will allow assistive technologies such as screen readers to invoke the correct pronunciation. [Reference of values](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry) (\"subtag\" label)\n\nIt is recommended to combine it with the `dir` attribute to ensure the text is rendered correctly if the surrounding content\u2019s direction is different.", ->>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) "isOptional": true, "defaultValue": "''" }, @@ -212683,11 +184702,7 @@ "defaultValue": "'auto'" } ], -<<<<<<< HEAD "value": "export interface BaseTypographyProps {\n\t/**\n\t * Modify the color to be more or less intense.\n\t *\n\t * @default 'base'\n\t */\n\tcolor?: ColorKeyword;\n\t/**\n\t * Sets the tone of the component, based on the intention of the information being conveyed.\n\t *\n\t * @default 'auto'\n\t */\n\ttone?: ToneKeyword;\n\t/**\n\t * Set the numeric properties of the font.\n\t *\n\t * @see https://developer.mozilla.org/en-US/docs/Web/CSS/font-variant-numeric\n\t *\n\t * @default 'auto' - inherit from the parent element\n\t */\n\tfontVariantNumeric?: \"auto\" | \"normal\" | \"tabular-nums\";\n\t/**\n\t * The language of the button's text content. Use this when the button text is in a different language than the rest of the page, so assistive technologies can invoke the correct pronunciation.\n\t * [Reference of values](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry) (\"subtag\" label)\n\t *\n\t * 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.\n\t *\n\t * @default ''\n\t */\n\tlang?: string;\n\t/**\n\t * Indicates the directionality of the element’s text.\n\t *\n\t * - `ltr`: languages written from left to right (such as English)\n\t * - `rtl`: languages written from right to left (such as Arabic)\n\t * - `auto`: the user agent determines the direction based on the content\n\t * - `''`: direction is inherited from parent elements (equivalent to not setting the attribute)\n\t *\n\t * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/dir\n\t *\n\t * @default ''\n\t */\n\tdir?: \"ltr\" | \"rtl\" | \"auto\" | \"\";\n}" -======= - "value": "export interface BaseTypographyProps {\n\t/**\n\t * Modify the color to be more or less intense.\n\t *\n\t * @default 'base'\n\t */\n\tcolor?: ColorKeyword;\n\t/**\n\t * Sets the tone of the component, based on the intention of the information being conveyed.\n\t *\n\t * @default 'auto'\n\t */\n\ttone?: ToneKeyword;\n\t/**\n\t * Set the numeric properties of the font.\n\t *\n\t * @see https://developer.mozilla.org/en-US/docs/Web/CSS/font-variant-numeric\n\t *\n\t * @default 'auto' - inherit from the parent element\n\t */\n\tfontVariantNumeric?: \"auto\" | \"normal\" | \"tabular-nums\";\n\t/**\n\t * Indicate the text language. Useful when the text is in a different language than the rest of the page.\n\t * It will allow assistive technologies such as screen readers to invoke the correct pronunciation.\n\t * [Reference of values](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry) (\"subtag\" label)\n\t *\n\t * It is recommended to combine it with the `dir` attribute to ensure the text is rendered correctly if the surrounding content\u2019s direction is different.\n\t *\n\t * @default ''\n\t */\n\tlang?: string;\n\t/**\n\t * Indicates the directionality of the element\u2019s text.\n\t *\n\t * - `ltr`: languages written from left to right (e.g. English)\n\t * - `rtl`: languages written from right to left (e.g. Arabic)\n\t * - `auto`: the user agent determines the direction based on the content\n\t * - `''`: direction is inherited from parent elements (equivalent to not setting the attribute)\n\t *\n\t * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/dir\n\t *\n\t * @default ''\n\t */\n\tdir?: \"ltr\" | \"rtl\" | \"auto\" | \"\";\n}" ->>>>>>> eb0f07393 (Improve Forms component descriptions to match admin quality) } }, "BlockTypographyProps": { @@ -212974,4 +184989,4 @@ "isPublicDocs": true } } -} +} \ No newline at end of file diff --git a/packages/ui-extensions/src/surfaces/checkout/components/Paragraph.d.ts b/packages/ui-extensions/src/surfaces/checkout/components/Paragraph.d.ts index f0ddcc6d6f..17b11c3ae7 100644 --- a/packages/ui-extensions/src/surfaces/checkout/components/Paragraph.d.ts +++ b/packages/ui-extensions/src/surfaces/checkout/components/Paragraph.d.ts @@ -10,14 +10,16 @@ /// import type {ParagraphProps$1} from './components-shared.d.ts'; -/** @publicDocs */ +/** + * The base properties for elements that don't have children, providing essential attributes like keys and refs for component management. + */ export interface BaseElementProps { key?: preact.Key; ref?: preact.Ref; slot?: Lowercase; } /** - * Used when an element has children. + * The base properties for elements that have children, extending `BaseElementProps` with children support. * @publicDocs */ export interface BaseElementPropsWithChildren extends BaseElementProps { @@ -30,16 +32,12 @@ export interface ParagraphElementProps extends Pick; tone?: Extract; /** - * The semantic type and styling treatment for the paragraph content. - * - * Other presentation properties on `s-paragraph` override the default styling. - * - * - `paragraph`: A semantic type that indicates a structural grouping of related content. - * - `small`: A semantic type that indicates less important text. + * Sets the alignment of the text. + * @see https://developer.mozilla.org/en-US/docs/Web/CSS/text-align * - * @default 'paragraph' + * @default 'auto' */ - type?: Extract; + textAlign?: 'start' | 'end' | 'center' | 'auto'; } /** @publicDocs */ export interface ParagraphElement extends ParagraphElementProps, Omit {